Skip to content

Commit

Permalink
fix: Fixed missing xml param doc for required deprecated properties.
Browse files Browse the repository at this point in the history
  • Loading branch information
HavenDV committed Nov 12, 2024
1 parent 067f548 commit a3244cd
Show file tree
Hide file tree
Showing 17 changed files with 75 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/libs/AutoSDK/Sources/Sources.Models.cs
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ public sealed partial class {modelData.ClassName}
/// <summary>
/// Initializes a new instance of the <see cref=""{modelData.ClassName}"" /> class.
/// </summary>
{modelData.Properties.Where(static x => !x.IsDeprecated).Select(x => $@"
{modelData.Properties.Where(static x => x.IsRequired || !x.IsDeprecated).Select(x => $@"
{x.Summary.ToXmlDocumentationForParam(x.ParameterName, level: 8)}").Inject()}
{(modelData.Settings.TargetFramework.StartsWith("net8", StringComparison.OrdinalIgnoreCase) ? "[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]" : " ")}
public {modelData.ClassName}(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -568,6 +568,12 @@ public sealed partial class Transcript
/// <param name="error">
/// Error message of why the transcript failed
/// </param>
/// <param name="languageModel">
/// The language model that was used for the transcript
/// </param>
/// <param name="acousticModel">
/// The acoustic model that was used for the transcript
/// </param>
public Transcript(
global::System.Guid id,
string audioUrl,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,12 @@ public sealed partial class Transcript
/// <param name="error">
/// Error message of why the transcript failed
/// </param>
/// <param name="languageModel">
/// The language model that was used for the transcript
/// </param>
/// <param name="acousticModel">
/// The acoustic model that was used for the transcript
/// </param>
[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
public Transcript(
global::System.Guid id,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -911,6 +911,11 @@ public sealed partial class Repository
/// Example: true
/// </param>
/// <param name="hasPages"></param>
/// <param name="hasDownloads">
/// Whether downloads are enabled.<br/>
/// Default Value: true<br/>
/// Example: true
/// </param>
/// <param name="hasDiscussions">
/// Whether discussions are enabled.<br/>
/// Default Value: false<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,11 @@ public sealed partial class Repository
/// Example: true
/// </param>
/// <param name="hasPages"></param>
/// <param name="hasDownloads">
/// Whether downloads are enabled.<br/>
/// Default Value: true<br/>
/// Example: true
/// </param>
/// <param name="hasDiscussions">
/// Whether discussions are enabled.<br/>
/// Default Value: false<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -911,6 +911,11 @@ public sealed partial class NullableRepository
/// Example: true
/// </param>
/// <param name="hasPages"></param>
/// <param name="hasDownloads">
/// Whether downloads are enabled.<br/>
/// Default Value: true<br/>
/// Example: true
/// </param>
/// <param name="hasDiscussions">
/// Whether discussions are enabled.<br/>
/// Default Value: false<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ public sealed partial class ReposUpdateBranchProtectionRequestRequiredStatusChec
/// <param name="strict">
/// Require branches to be up to date before merging.
/// </param>
/// <param name="contexts">
/// **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.
/// </param>
/// <param name="checks">
/// The list of status checks to require in order to merge into this branch.
/// </param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -911,6 +911,11 @@ public sealed partial class Repository
/// Example: true
/// </param>
/// <param name="hasPages"></param>
/// <param name="hasDownloads">
/// Whether downloads are enabled.<br/>
/// Default Value: true<br/>
/// Example: true
/// </param>
/// <param name="hasDiscussions">
/// Whether discussions are enabled.<br/>
/// Default Value: false<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,11 @@ public sealed partial class NullableRepository
/// Example: true
/// </param>
/// <param name="hasPages"></param>
/// <param name="hasDownloads">
/// Whether downloads are enabled.<br/>
/// Default Value: true<br/>
/// Example: true
/// </param>
/// <param name="hasDiscussions">
/// Whether discussions are enabled.<br/>
/// Default Value: false<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ public sealed partial class ReposUpdateBranchProtectionRequestRequiredStatusChec
/// <param name="strict">
/// Require branches to be up to date before merging.
/// </param>
/// <param name="contexts">
/// **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.
/// </param>
/// <param name="checks">
/// The list of status checks to require in order to merge into this branch.
/// </param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -988,6 +988,11 @@ public sealed partial class Repository
/// Example: true
/// </param>
/// <param name="hasPages"></param>
/// <param name="hasDownloads">
/// Whether downloads are enabled.<br/>
/// Default Value: true<br/>
/// Example: true
/// </param>
/// <param name="hasDiscussions">
/// Whether discussions are enabled.<br/>
/// Default Value: false<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ public sealed partial class OpenAIFile
/// <param name="purpose">
/// The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` and `vision`.
/// </param>
/// <param name="status">
/// Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`.
/// </param>
public OpenAIFile(
string id,
int bytes,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ public sealed partial class OpenAIFile
/// <param name="purpose">
/// The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` and `vision`.
/// </param>
/// <param name="status">
/// Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`.
/// </param>
[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
public OpenAIFile(
string id,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ public sealed partial class Channel
/// <param name="isLive">
/// A Boolean value that determines whether the broadcaster is streaming live. Is **true** if the broadcaster is streaming live; otherwise, **false**.
/// </param>
/// <param name="tagIds">
/// **IMPORTANT** As of February 28, 2023, this field is deprecated and returns only an empty array. If you use this field, please update your code to use the `tags` field. <br/>
/// <br/>
/// The list of tags that apply to the stream. The list contains IDs only when the channel is steaming live. For a list of possible tags, see [List of All Tags](https://www.twitch.tv/directory/all/tags). The list doesn’t include Category Tags.
/// </param>
/// <param name="tags">
/// The tags applied to the channel.
/// </param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,11 @@ public sealed partial class Stream
/// <param name="thumbnailUrl">
/// A URL to an image of a frame from the last 5 minutes of the stream. Replace the width and height placeholders in the URL (`{width}x{height}`) with the size of the image you want, in pixels.
/// </param>
/// <param name="tagIds">
/// **IMPORTANT** As of February 28, 2023, this field is deprecated and returns only an empty array. If you use this field, please update your code to use the `tags` field. <br/>
/// <br/>
/// The list of tags that apply to the stream. The list contains IDs only when the channel is steaming live. For a list of possible tags, see [List of All Tags](https://www.twitch.tv/directory/all/tags). The list doesn’t include Category Tags.
/// </param>
/// <param name="tags">
/// The tags applied to the stream.
/// </param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,11 @@ public sealed partial class Channel
/// <param name="isLive">
/// A Boolean value that determines whether the broadcaster is streaming live. Is **true** if the broadcaster is streaming live; otherwise, **false**.
/// </param>
/// <param name="tagIds">
/// **IMPORTANT** As of February 28, 2023, this field is deprecated and returns only an empty array. If you use this field, please update your code to use the `tags` field. <br/>
/// <br/>
/// The list of tags that apply to the stream. The list contains IDs only when the channel is steaming live. For a list of possible tags, see [List of All Tags](https://www.twitch.tv/directory/all/tags). The list doesn’t include Category Tags.
/// </param>
/// <param name="tags">
/// The tags applied to the channel.
/// </param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,11 @@ public sealed partial class Stream
/// <param name="thumbnailUrl">
/// A URL to an image of a frame from the last 5 minutes of the stream. Replace the width and height placeholders in the URL (`{width}x{height}`) with the size of the image you want, in pixels.
/// </param>
/// <param name="tagIds">
/// **IMPORTANT** As of February 28, 2023, this field is deprecated and returns only an empty array. If you use this field, please update your code to use the `tags` field. <br/>
/// <br/>
/// The list of tags that apply to the stream. The list contains IDs only when the channel is steaming live. For a list of possible tags, see [List of All Tags](https://www.twitch.tv/directory/all/tags). The list doesn’t include Category Tags.
/// </param>
/// <param name="tags">
/// The tags applied to the stream.
/// </param>
Expand Down

0 comments on commit a3244cd

Please sign in to comment.