Skip to content

Commit a3244cd

Browse files
committed
fix: Fixed missing xml param doc for required deprecated properties.
1 parent 067f548 commit a3244cd

17 files changed

+75
-1
lines changed

src/libs/AutoSDK/Sources/Sources.Models.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ public sealed partial class {modelData.ClassName}
105105
/// <summary>
106106
/// Initializes a new instance of the <see cref=""{modelData.ClassName}"" /> class.
107107
/// </summary>
108-
{modelData.Properties.Where(static x => !x.IsDeprecated).Select(x => $@"
108+
{modelData.Properties.Where(static x => x.IsRequired || !x.IsDeprecated).Select(x => $@"
109109
{x.Summary.ToXmlDocumentationForParam(x.ParameterName, level: 8)}").Inject()}
110110
{(modelData.Settings.TargetFramework.StartsWith("net8", StringComparison.OrdinalIgnoreCase) ? "[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]" : " ")}
111111
public {modelData.ClassName}(

src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/NewtonsoftJson/_#G.Models.Transcript.g.verified.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -568,6 +568,12 @@ public sealed partial class Transcript
568568
/// <param name="error">
569569
/// Error message of why the transcript failed
570570
/// </param>
571+
/// <param name="languageModel">
572+
/// The language model that was used for the transcript
573+
/// </param>
574+
/// <param name="acousticModel">
575+
/// The acoustic model that was used for the transcript
576+
/// </param>
571577
public Transcript(
572578
global::System.Guid id,
573579
string audioUrl,

src/tests/AutoSDK.SnapshotTests/Snapshots/AssemblyAi/SystemTextJson/_#G.Models.Transcript.g.verified.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,12 @@ public sealed partial class Transcript
588588
/// <param name="error">
589589
/// Error message of why the transcript failed
590590
/// </param>
591+
/// <param name="languageModel">
592+
/// The language model that was used for the transcript
593+
/// </param>
594+
/// <param name="acousticModel">
595+
/// The acoustic model that was used for the transcript
596+
/// </param>
591597
[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
592598
public Transcript(
593599
global::System.Guid id,

src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/NewtonsoftJson/_#G.Models.Repository.g.verified.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -911,6 +911,11 @@ public sealed partial class Repository
911911
/// Example: true
912912
/// </param>
913913
/// <param name="hasPages"></param>
914+
/// <param name="hasDownloads">
915+
/// Whether downloads are enabled.<br/>
916+
/// Default Value: true<br/>
917+
/// Example: true
918+
/// </param>
914919
/// <param name="hasDiscussions">
915920
/// Whether discussions are enabled.<br/>
916921
/// Default Value: false<br/>

src/tests/AutoSDK.SnapshotTests/Snapshots/Filtering/SystemTextJson/_#G.Models.Repository.g.verified.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -988,6 +988,11 @@ public sealed partial class Repository
988988
/// Example: true
989989
/// </param>
990990
/// <param name="hasPages"></param>
991+
/// <param name="hasDownloads">
992+
/// Whether downloads are enabled.<br/>
993+
/// Default Value: true<br/>
994+
/// Example: true
995+
/// </param>
991996
/// <param name="hasDiscussions">
992997
/// Whether discussions are enabled.<br/>
993998
/// Default Value: false<br/>

src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.NullableRepository.g.verified.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -911,6 +911,11 @@ public sealed partial class NullableRepository
911911
/// Example: true
912912
/// </param>
913913
/// <param name="hasPages"></param>
914+
/// <param name="hasDownloads">
915+
/// Whether downloads are enabled.<br/>
916+
/// Default Value: true<br/>
917+
/// Example: true
918+
/// </param>
914919
/// <param name="hasDiscussions">
915920
/// Whether discussions are enabled.<br/>
916921
/// Default Value: false<br/>

src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ public sealed partial class ReposUpdateBranchProtectionRequestRequiredStatusChec
3939
/// <param name="strict">
4040
/// Require branches to be up to date before merging.
4141
/// </param>
42+
/// <param name="contexts">
43+
/// **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.
44+
/// </param>
4245
/// <param name="checks">
4346
/// The list of status checks to require in order to merge into this branch.
4447
/// </param>

src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/NewtonsoftJson/_#G.Models.Repository.g.verified.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -911,6 +911,11 @@ public sealed partial class Repository
911911
/// Example: true
912912
/// </param>
913913
/// <param name="hasPages"></param>
914+
/// <param name="hasDownloads">
915+
/// Whether downloads are enabled.<br/>
916+
/// Default Value: true<br/>
917+
/// Example: true
918+
/// </param>
914919
/// <param name="hasDiscussions">
915920
/// Whether discussions are enabled.<br/>
916921
/// Default Value: false<br/>

src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.NullableRepository.g.verified.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -988,6 +988,11 @@ public sealed partial class NullableRepository
988988
/// Example: true
989989
/// </param>
990990
/// <param name="hasPages"></param>
991+
/// <param name="hasDownloads">
992+
/// Whether downloads are enabled.<br/>
993+
/// Default Value: true<br/>
994+
/// Example: true
995+
/// </param>
991996
/// <param name="hasDiscussions">
992997
/// Whether discussions are enabled.<br/>
993998
/// Default Value: false<br/>

src/tests/AutoSDK.SnapshotTests/Snapshots/GitHub/SystemTextJson/_#G.Models.ReposUpdateBranchProtectionRequestRequiredStatusChecks.g.verified.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ public sealed partial class ReposUpdateBranchProtectionRequestRequiredStatusChec
4141
/// <param name="strict">
4242
/// Require branches to be up to date before merging.
4343
/// </param>
44+
/// <param name="contexts">
45+
/// **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.
46+
/// </param>
4447
/// <param name="checks">
4548
/// The list of status checks to require in order to merge into this branch.
4649
/// </param>

0 commit comments

Comments
 (0)