Skip to content

Implement new block-level documentation diagnostics#610

Closed
sharwell wants to merge 4 commits intoDotNetAnalyzers:masterfrom
sharwell:block-level-diagnostics
Closed

Implement new block-level documentation diagnostics#610
sharwell wants to merge 4 commits intoDotNetAnalyzers:masterfrom
sharwell:block-level-diagnostics

Conversation

@sharwell
Copy link
Member

@sharwell sharwell commented Apr 4, 2015

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:

@sharwell sharwell force-pushed the block-level-diagnostics branch from 89f1c73 to cd49792 Compare August 28, 2015 06:19
@sharwell
Copy link
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. 😄

@sharwell
Copy link
Member Author

Some statistics on number of violations:

Project SA1653 SA1654 SA1655
StyleCopAnalyzers 48 6 9
Roslyn 997 65 6
Code Contracts 60 497 6

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❓ Should this get wrapped in <para>?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Noryoko
Copy link
Contributor

Noryoko commented Aug 29, 2015

👍

@sharwell
Copy link
Member Author

I'm going to move this to a new project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use block-level elements consistently across elements of the same kind Use block-level elements consistently Place text in paragraphs

2 participants