Add XML comments to public members (resolves CS1591 warnings)#225
Open
michaelchart wants to merge 1 commit intomodelsbuilder:v8/devfrom
Open
Add XML comments to public members (resolves CS1591 warnings)#225michaelchart wants to merge 1 commit intomodelsbuilder:v8/devfrom
michaelchart wants to merge 1 commit intomodelsbuilder:v8/devfrom
Conversation
When XML documentation is enabled for the project, the CS1591 compiler warning means that any public members must have a comment to prevent a warning. There's also currently no way to disable this documentation requirement for generated code: dotnet/roslyn#12702. This commit adds <summary> comments to the previously uncommented members of the generated models classes.
Author
|
@zpqrtbnk Any thoughts on whether this PR is OK, and if it can be merged soon? |
Collaborator
|
Hey. Sorry for delay. PR is OK and will be merged somehow. But, as you may be aware, ModelsBuilder development is being reorganized at the moment. Will announce dates, eventually. |
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
2 participants
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.
When XML documentation is enabled for the project (see screenshot below), the CS1591 compiler warning means that any public members of classes must have a documentation comment to prevent a warning.
There's currently no way to disable this documentation requirement for generated code so there seems to be no workaround for this issue - see dotnet/roslyn#12702.
This PR adds
<summary>comments to the previously uncommented public members of the generated models classes. An alternative approach could be to add#pragma warning disable 1591comments around these members, but it seemed just as easy to add a simple documentation comment. Resolves #164