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.

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

Implement generics related documentation rules #873

Merged
merged 9 commits into from
May 25, 2015

Conversation

pdelvo
Copy link
Member

@pdelvo pdelvo commented May 24, 2015

This implements all documentation rules for generics

Fixes #138.
Fixes #139.
Fixes #140.
Fixes #141.
Fixes #142.

@@ -28,13 +34,16 @@ public class SA1620GenericTypeParameterDocumentationMustMatchTypeParameters : Di
/// </summary>
public const string DiagnosticId = "SA1620";
private const string Title = "Generic type parameter documentation must match type parameters";
private const string MessageFormat = "TODO: Message format";
private const string MessageFormat = "{0}";
Copy link
Member

Choose a reason for hiding this comment

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

💡 You can create two DiagnosticDescriptor instances that have the same ID but different message formats. Only return one of them from SupportedDiagnostics but the other can still be used when the second message is needed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay I will change that

@sharwell sharwell modified the milestone: 1.0.0 Alpha 8 May 25, 2015
@sharwell sharwell merged commit c67b0be into DotNetAnalyzers:master May 25, 2015
sharwell added a commit that referenced this pull request May 25, 2015
@sharwell sharwell self-assigned this May 25, 2015
@pdelvo pdelvo deleted the DocGenerics branch August 27, 2015 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment