Implement new block-level documentation diagnostics#610
Closed
sharwell wants to merge 4 commits intoDotNetAnalyzers:masterfrom
Closed
Implement new block-level documentation diagnostics#610sharwell wants to merge 4 commits intoDotNetAnalyzers:masterfrom
sharwell wants to merge 4 commits intoDotNetAnalyzers:masterfrom
Conversation
03858a7 to
5358a4e
Compare
…ntsOfTheSameKind Fixes DotNetAnalyzers#603
89f1c73 to
cd49792
Compare
Member
Author
|
I rebased and renumbered these rules to account for SA1652 (EnableXmlDocumentationOutput) which was added in the meantime. I also fixed some warnings which appeared due to new style rules being enforced. 😄 |
Member
Author
|
Some statistics on number of violations:
|
Contributor
There was a problem hiding this comment.
❓ Should this get wrapped in <para>?
Member
Author
There was a problem hiding this comment.
Yes, as part of SA1654 it would be wrapped in <para> elements, but this test is for SA1655. SA1655 says the documentation for ArgumentException contains blocks, and therefore the documentation for all <exception> elements should be written as blocks. The diagnostic is reported on ArgumentNullException since it contains only inline content.
Contributor
|
👍 |
Member
Author
|
I'm going to move this to a new project. |
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
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.
This pull request includes the implementation of three brand-new StyleCop rules, along with code fixes for each. A description of each of these rules can be found on the associated issue: