docs: Add XML doc comments to resolve missing-documentation warnings - #17
Open
henrikottesorensen wants to merge 1 commit into
Open
henrikottesorensen wants to merge 1 commit into
henrikottesorensen wants to merge 1 commit into
Conversation
Adds mechanical, house-style XML doc comments to the svcutil-generated BPI and SPSA DTOs (matching the existing xsd.exe-generated VEU DTO style), and hand-written doc comments to the service clients, SOAP request generators, and SOAP helper classes. Resolves all ~877 missing XML doc comment warnings without changing any runtime behavior. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
DTOs/BPI,DTOs/SPSA) had no doc comments at all, unlike the xsd.exe-generated VEU DTOs (DTOs/VEU), which already carry formulaic docs. These now get mechanical, house-style docs (e.g.Gets or sets the <see cref="X"/> value.) matching the existing VEU convention, including boolean properties phrased per StyleCop'sGets or sets a value indicating whether...rule.StilVeuServiceClient.cs.SA1615gap once their methods gained summaries.Test plan
dotnet build src/STIL.ServiceClient.sln -c Release— 0 errors, 0 CS1591/SA1600/SA1602 warnings (down from 877 combined)dotnet test src/STIL.ServiceClient.sln -c Release— 20/20 tests pass🤖 Generated with Claude Code