public void HandleTypeDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
BaseTypeDeclarationSyntax declaration = (BaseTypeDeclarationSyntax)context.Node;
if (declaration.Modifiers.Any(SyntaxKind.PartialKeyword))
{
// Handled by SA1601
return;
}
Accessibility declaredAccessibility = declaration.GetDeclaredAccessibility(context.SemanticModel, context.CancellationToken);
Accessibility effectiveAccessibility = declaration.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
if (this.NeedsComment(declaration.Kind(), declaration.Parent.Kind(), declaredAccessibility, effectiveAccessibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
private void HandleEventFieldDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
EventFieldDeclarationSyntax declaration = context.Node as EventFieldDeclarationSyntax;
SyntaxKind defaultVisibility = SyntaxKind.PrivateKeyword;
if (this.IsInterfaceMemberDeclaration(declaration))
{
defaultVisibility = SyntaxKind.PublicKeyword;
}
var variableDeclaration = declaration?.Declaration;
if (variableDeclaration != null && this.NeedsComment(declaration.Modifiers, defaultVisibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
var locations = variableDeclaration.Variables.Select(v => v.Identifier.GetLocation());
foreach (var location in locations)
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, location));
}
}
}
}
public static void HandleEventFieldDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
{
if (context.GetDocumentationMode() == DocumentationMode.None)
{
return;
}
EventFieldDeclarationSyntax declaration = (EventFieldDeclarationSyntax)context.Node;
VariableDeclarationSyntax variableDeclaration = declaration.Declaration;
Accessibility declaredAccessibility = declaration.GetDeclaredAccessibility(context.SemanticModel, context.CancellationToken);
Accessibility effectiveAccessibility = declaration.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
if (variableDeclaration != null && NeedsComment(settings.DocumentationRules, declaration.Kind(), declaration.Parent.Kind(), declaredAccessibility, effectiveAccessibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
var locations = variableDeclaration.Variables.Select(v => v.Identifier.GetLocation());
foreach (var location in locations)
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, location));
}
}
}
}
public static void HandleMethodDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
{
if (context.GetDocumentationMode() == DocumentationMode.None)
{
return;
}
MethodDeclarationSyntax declaration = (MethodDeclarationSyntax)context.Node;
if (!declaration.Modifiers.Any(SyntaxKind.PartialKeyword))
{
return;
}
Accessibility declaredAccessibility = declaration.GetDeclaredAccessibility(context.SemanticModel, context.CancellationToken);
Accessibility effectiveAccessibility = declaration.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
if (SA1600ElementsMustBeDocumented.NeedsComment(settings.DocumentationRules, declaration.Kind(), declaration.Parent.Kind(), declaredAccessibility, effectiveAccessibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
private static void HandleEnumMember(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
EnumMemberDeclarationSyntax enumMemberDeclaration = context.Node as EnumMemberDeclarationSyntax;
if (enumMemberDeclaration != null)
{
if (!XmlCommentHelper.HasDocumentation(enumMemberDeclaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, enumMemberDeclaration.Identifier.GetLocation()));
}
}
}
private void HandleDestructorDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
DestructorDeclarationSyntax declaration = context.Node as DestructorDeclarationSyntax;
if (declaration != null)
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
private void HandleConstructorDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
ConstructorDeclarationSyntax declaration = context.Node as ConstructorDeclarationSyntax;
if (declaration != null && this.NeedsComment(declaration.Modifiers, SyntaxKind.PrivateKeyword))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
public static void HandleEnumMemberDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
EnumMemberDeclarationSyntax declaration = (EnumMemberDeclarationSyntax)context.Node;
Accessibility declaredAccessibility = declaration.GetDeclaredAccessibility();
Accessibility effectiveAccessibility = declaration.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
if (NeedsComment(settings.DocumentationRules, declaration.Kind(), declaration.Parent.Kind(), declaredAccessibility, effectiveAccessibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
public static void HandleEnumMemberDeclaration(SyntaxNodeAnalysisContext context, StyleCopSettings settings)
{
if (context.GetDocumentationMode() == DocumentationMode.None)
{
return;
}
EnumMemberDeclarationSyntax declaration = (EnumMemberDeclarationSyntax)context.Node;
Accessibility declaredAccessibility = declaration.GetDeclaredAccessibility();
Accessibility effectiveAccessibility = declaration.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
if (NeedsComment(settings.DocumentationRules, declaration.Kind(), declaration.Parent.Kind(), declaredAccessibility, effectiveAccessibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
private void HandleTypeDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
BaseTypeDeclarationSyntax declaration = context.Node as BaseTypeDeclarationSyntax;
bool isNestedInClassOrStruct = this.IsNestedType(declaration);
if (declaration != null && this.NeedsComment(declaration.Modifiers, isNestedInClassOrStruct ? SyntaxKind.PrivateKeyword : SyntaxKind.InternalKeyword))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
private void HandleTypeDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
BaseTypeDeclarationSyntax declaration = context.Node as BaseTypeDeclarationSyntax;
bool isNestedInClassOrStruct = this.IsNestedType(declaration);
if (declaration != null && this.NeedsComment(declaration.Modifiers, isNestedInClassOrStruct ? SyntaxKind.PrivateKeyword : SyntaxKind.InternalKeyword))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
public void HandleIndexerDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
IndexerDeclarationSyntax declaration = (IndexerDeclarationSyntax)context.Node;
Accessibility declaredAccessibility = declaration.GetDeclaredAccessibility(context.SemanticModel, context.CancellationToken);
Accessibility effectiveAccessibility = declaration.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
if (this.NeedsComment(declaration.Kind(), declaration.Parent.Kind(), declaredAccessibility, effectiveAccessibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.ThisKeyword.GetLocation()));
}
}
}
private void HandleMethodDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
MethodDeclarationSyntax methodDeclaration = context.Node as MethodDeclarationSyntax;
if (methodDeclaration != null)
{
if (methodDeclaration.Modifiers.Any(SyntaxKind.PartialKeyword))
{
if (!XmlCommentHelper.HasDocumentation(methodDeclaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, methodDeclaration.Identifier.GetLocation()));
}
}
}
}
private void HandleFieldDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
FieldDeclarationSyntax declaration = context.Node as FieldDeclarationSyntax;
var variableDeclaration = declaration?.Declaration;
if (variableDeclaration != null && this.NeedsComment(declaration.Modifiers, SyntaxKind.PrivateKeyword))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
var locations = variableDeclaration.Variables.Select(v => v.Identifier.GetLocation());
foreach (var location in locations)
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, location));
}
}
}
}
private void HandleMethodDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
MethodDeclarationSyntax declaration = context.Node as MethodDeclarationSyntax;
SyntaxKind defaultVisibility = SyntaxKind.PrivateKeyword;
if (this.IsInterfaceMemberDeclaration(declaration) || declaration.ExplicitInterfaceSpecifier != null)
{
defaultVisibility = SyntaxKind.PublicKeyword;
}
if (declaration != null && this.NeedsComment(declaration.Modifiers, defaultVisibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
public void HandleTypeDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
BaseTypeDeclarationSyntax declaration = (BaseTypeDeclarationSyntax)context.Node;
if (declaration.Modifiers.Any(SyntaxKind.PartialKeyword))
{
// Handled by SA1601
return;
}
Accessibility declaredAccessibility = declaration.GetDeclaredAccessibility(context.SemanticModel, context.CancellationToken);
Accessibility effectiveAccessibility = declaration.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
if (this.NeedsComment(declaration.Kind(), declaration.Parent.Kind(), declaredAccessibility, effectiveAccessibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
private void HandleFieldDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
FieldDeclarationSyntax declaration = context.Node as FieldDeclarationSyntax;
var variableDeclaration = declaration?.Declaration;
if (variableDeclaration != null && this.NeedsComment(declaration.Modifiers, SyntaxKind.PrivateKeyword))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
var locations = variableDeclaration.Variables.Select(v => v.Identifier.GetLocation());
foreach (var location in locations)
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, location));
}
}
}
}
private void HandleEventFieldDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
EventFieldDeclarationSyntax declaration = context.Node as EventFieldDeclarationSyntax;
SyntaxKind defaultVisibility = SyntaxKind.PrivateKeyword;
if (this.IsInterfaceMemberDeclaration(declaration))
{
defaultVisibility = SyntaxKind.PublicKeyword;
}
var variableDeclaration = declaration?.Declaration;
if (variableDeclaration != null && this.NeedsComment(declaration.Modifiers, defaultVisibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
var locations = variableDeclaration.Variables.Select(v => v.Identifier.GetLocation());
foreach (var location in locations)
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, location));
}
}
}
}
private void HandleConstructorDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
ConstructorDeclarationSyntax declaration = context.Node as ConstructorDeclarationSyntax;
if (declaration != null && this.NeedsComment(declaration.Modifiers, SyntaxKind.PrivateKeyword))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
public void HandleEventFieldDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
EventFieldDeclarationSyntax declaration = (EventFieldDeclarationSyntax)context.Node;
VariableDeclarationSyntax variableDeclaration = declaration.Declaration;
Accessibility declaredAccessibility = declaration.GetDeclaredAccessibility(context.SemanticModel, context.CancellationToken);
Accessibility effectiveAccessibility = declaration.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
if (variableDeclaration != null && this.NeedsComment(declaration.Kind(), declaration.Parent.Kind(), declaredAccessibility, effectiveAccessibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
var locations = variableDeclaration.Variables.Select(v => v.Identifier.GetLocation());
foreach (var location in locations)
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, location));
}
}
}
}
public void HandleIndexerDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
IndexerDeclarationSyntax declaration = (IndexerDeclarationSyntax)context.Node;
Accessibility declaredAccessibility = declaration.GetDeclaredAccessibility(context.SemanticModel, context.CancellationToken);
Accessibility effectiveAccessibility = declaration.GetEffectiveAccessibility(context.SemanticModel, context.CancellationToken);
if (this.NeedsComment(declaration.Kind(), declaration.Parent.Kind(), declaredAccessibility, effectiveAccessibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.ThisKeyword.GetLocation()));
}
}
}
private void HandleDestructorDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
DestructorDeclarationSyntax declaration = context.Node as DestructorDeclarationSyntax;
if (declaration != null)
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
private void HandleMethodDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
MethodDeclarationSyntax methodDeclaration = context.Node as MethodDeclarationSyntax;
if (methodDeclaration != null)
{
if (methodDeclaration.Modifiers.Any(SyntaxKind.PartialKeyword))
{
if (!XmlCommentHelper.HasDocumentation(methodDeclaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, methodDeclaration.Identifier.GetLocation()));
}
}
}
}
private void HandleMethodDeclaration(SyntaxNodeAnalysisContext context)
{
if (context.GetDocumentationMode() != DocumentationMode.Diagnose)
{
return;
}
MethodDeclarationSyntax declaration = context.Node as MethodDeclarationSyntax;
SyntaxKind defaultVisibility = SyntaxKind.PrivateKeyword;
if (this.IsInterfaceMemberDeclaration(declaration) || declaration.ExplicitInterfaceSpecifier != null)
{
defaultVisibility = SyntaxKind.PublicKeyword;
}
if (declaration != null && this.NeedsComment(declaration.Modifiers, defaultVisibility))
{
if (!XmlCommentHelper.HasDocumentation(declaration))
{
context.ReportDiagnostic(Diagnostic.Create(Descriptor, declaration.Identifier.GetLocation()));
}
}
}
