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

Identify issues in XML documentation comments #21

Closed
sharwell opened this issue Nov 17, 2014 · 1 comment
Closed

Identify issues in XML documentation comments #21

sharwell opened this issue Nov 17, 2014 · 1 comment
Labels
agnostic code fix diagnostic

Comments

@sharwell
Copy link
Member

There are many opportunities for XML comment diagnostics, including the following:

  • Identify cases where a known HTML entity is used, but is not supported by XML documentation comments. For example, → is not supported in XML comments but the form → can be used instead.
  • Implement SA1642: ConstructorSummaryDocumentationMustBeginWithStandardText.
  • Add missing <para> element around text.
  • Convert <ul>, <ol>, <p>, and <tt> HTML tags to their XML comment equivalent
@sharwell sharwell mentioned this issue Nov 17, 2014
Closed
@sharwell sharwell mentioned this issue Jan 27, 2015
Closed
@sharwell
Copy link
Member Author

Identify cases where a known HTML entity is used ...

Moved to DotNetAnalyzers/DocumentationAnalyzers#1

Implement SA1642: ConstructorSummaryDocumentationMustBeginWithStandardText

Available in StyleCop Analyzers

Convert <ul>, <ol> ...

Moved to DotNetAnalyzers/DocumentationAnalyzers#2

... <p> ...

Moved to DotNetAnalyzers/DocumentationAnalyzers#3

... <tt> ...

Moved to DotNetAnalyzers/DocumentationAnalyzers#4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
agnostic code fix diagnostic
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sharwell