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.

Sign up for GitHub

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

Jump to bottom

New rule proposal: Documentation output should be enabled #1053

Closed
sharwell opened this issue Jul 26, 2015 · 1 comment
Closed

New rule proposal: Documentation output should be enabled #1053

sharwell opened this issue Jul 26, 2015 · 1 comment
Assignees
@sharwell
Labels
category-documentation Documentation rules fixed new rule
Milestone
1.0.0 Beta 2

Comments

@sharwell
Copy link
Member

Category: Documentation
Title: Documentation output should be enabled (could change)
Description: When a project is configured to not produce an XML documentation file with the output (this is the default), the semantics of documentation comments are not checked. This quickly results in several other problems, including the following:
@sharwell sharwell mentioned this issue Jul 26, 2015
Closed
@pdelvo
Copy link
Member

pdelvo commented Jul 26, 2015

Sounds like a good idea. And enabling documentation does not have any negative sideaffect you cant easily suppress.

@sharwell sharwell self-assigned this Jul 26, 2015
@sharwell sharwell added this to the 1.0.0 Beta 2 milestone Jul 26, 2015
sharwell added a commit to sharwell/StyleCopAnalyzers that referenced this issue Jul 26, 2015
@sharwell
Implement new diagnostic SA1652 (EnableXmlDocumentationOutput)
a6602b0 
Fixes DotNetAnalyzers#1053
@sharwell sharwell mentioned this issue Jul 26, 2015
Merged
sharwell added a commit to sharwell/StyleCopAnalyzers that referenced this issue Jul 26, 2015
@sharwell
Implement new diagnostic SA1652 (EnableXmlDocumentationOutput)
07be15b 
Fixes DotNetAnalyzers#1053
sharwell added a commit to sharwell/StyleCopAnalyzers that referenced this issue Jul 26, 2015
@sharwell
Implement new diagnostic SA1652 (EnableXmlDocumentationOutput)
b3ef9d4 
Fixes DotNetAnalyzers#1053
@sharwell sharwell mentioned this issue Jul 30, 2015
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sharwell sharwell

Labels
category-documentation Documentation rules fixed new rule
Projects
None yet
Milestone
1.0.0 Beta 2
Development

No branches or pull requests
2 participants
@sharwell @pdelvo