Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable CS1591 errors for undocumented API #5223

Merged
merged 4 commits into from
Aug 11, 2023
Merged

Conversation

ViktorHofer
Copy link
Member

Similar as dotnet/extensions#4230, enable the CS1591 compiler errors when a library generates a documentation file.

Similar as dotnet/extensions#4230, enable the CS1591 compiler errors when a library generates a documentation file.
@ViktorHofer
Copy link
Member Author

ViktorHofer commented Aug 1, 2023

@mconnew, @imcarolwang @HongGit can you please help fixing the build failures by documenting these APIs:

/__w/1/s/src/System.ServiceModel.Federation/src/System/ServiceModel/Federation/WSTrustChannelSecurityTokenProvider.cs(111,46): error CS1591: Missing XML comment for publicly visible type or member 'WSTrustChannelSecurityTokenProvider.ClientCredentials' [/__w/1/s/src/System.ServiceModel.Federation/src/System.ServiceModel.Federation.csproj]
/__w/1/s/src/System.ServiceModel.Federation/src/System/ServiceModel/Federation/WSTrustChannelSecurityTokenProvider.cs(439,30): error CS1591: Missing XML comment for publicly visible type or member 'WSTrustChannelSecurityTokenProvider.SupportsTokenCancellation' [/__w/1/s/src/System.ServiceModel.Federation/src/System.ServiceModel.Federation.csproj]
/__w/1/s/src/System.ServiceModel.Federation/src/System/ServiceModel/Federation/WSTrustChannelSecurityTokenProvider.cs(441,30): error CS1591: Missing XML comment for publicly visible type or member 'WSTrustChannelSecurityTokenProvider.SupportsTokenRenewal' [/__w/1/s/src/System.ServiceModel.Federation/src/System.ServiceModel.Federation.csproj]
/__w/1/s/src/System.ServiceModel.Federation/src/System/ServiceModel/Federation/WsTrustTokenParameters.cs(24,37): error CS1591: Missing XML comment for publicly visible type or member 'WSTrustTokenParameters.DefaultCacheIssuedTokens' [/__w/1/s/src/System.ServiceModel.Federation/src/System.ServiceModel.Federation.csproj]
/__w/1/s/src/System.ServiceModel.Federation/src/System/ServiceModel/Federation/WsTrustTokenParameters.cs(25,36): error CS1591: Missing XML comment for publicly visible type or member 'WSTrustTokenParameters.DefaultIssuedTokenRenewalThresholdPercentage' [/__w/1/s/src/System.ServiceModel.Federation/src/System.ServiceModel.Federation.csproj]
/__w/1/s/src/System.ServiceModel.Federation/src/System/ServiceModel/Federation/WsTrustTokenParameters.cs(26,41): error CS1591: Missing XML comment for publicly visible type or member 'WSTrustTokenParameters.DefaultMaxIssuedTokenCachingTime' [/__w/1/s/src/System.ServiceModel.Federation/src/System.ServiceModel.Federation.csproj]
/__w/1/s/src/System.ServiceModel.Federation/src/System/ServiceModel/Federation/WsTrustTokenParameters.cs(27,48): error CS1591: Missing XML comment for publicly visible type or member 'WSTrustTokenParameters.DefaultSecurityKeyType' [/__w/1/s/src/System.ServiceModel.Federation/src/System.ServiceModel.Federation.csproj]
/__w/1/s/src/System.ServiceModel.Federation/src/System/ServiceModel/Federation/WsTrustTokenParameters.cs(160,46): error CS1591: Missing XML comment for publicly visible type or member 'WSTrustTokenParameters.CreateWSFederationTokenParameters(Binding, EndpointAddress)' [/__w/1/s/src/System.ServiceModel.Federation/src/System.ServiceModel.Federation.csproj]
/__w/1/s/src/System.ServiceModel.Federation/src/System/ServiceModel/Federation/WsTrustTokenParameters.cs(172,46): error CS1591: Missing XML comment for publicly visible type or member 'WSTrustTokenParameters.CreateWS2007FederationTokenParameters(Binding, EndpointAddress)' [/__w/1/s/src/System.ServiceModel.Federation/src/System.ServiceModel.Federation.csproj]

@HongGit HongGit requested a review from mconnew August 2, 2023 21:18
@mconnew
Copy link
Member

mconnew commented Aug 9, 2023

@StephenMolloy can you check the language of the documentation comment I've added.
@ViktorHofer, I also fixed the "build -vs" functionality in my update commit.

@ViktorHofer ViktorHofer self-assigned this Aug 10, 2023
@StephenMolloy
Copy link
Member

@StephenMolloy can you check the language of the documentation comment I've added.

Doc comments look fine to me.

@ViktorHofer ViktorHofer merged commit ec03c30 into main Aug 11, 2023
8 checks passed
@ViktorHofer ViktorHofer deleted the ViktorHofer-patch-1 branch August 11, 2023 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants