Skip to content

Commit 1cb0018

Browse files
committed
Fix violations of SA1623 (PropertySummaryDocumentationMustMatchAccessors)
1 parent f7d9f6a commit 1cb0018

3 files changed

Lines changed: 7 additions & 2 deletions

File tree

StyleCop.Analyzers/StyleCop.Analyzers.Test/SpacingRules/SA1019UnitTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ namespace StyleCop.Analyzers.Test.SpacingRules
2020
public class SA1019UnitTests : CodeFixVerifier
2121
{
2222
/// <summary>
23-
/// The members access operators to test.
23+
/// Gets the members access operators to test.
2424
/// </summary>
2525
/// <value>The members access operators to test.</value>
2626
public static IEnumerable<object[]> Operators

StyleCop.Analyzers/StyleCop.Analyzers.Test/Verifiers/CodeFixVerifier.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ public int IndentationSize
4747
}
4848

4949
/// <summary>
50-
/// Gets or sets the value of the <see cref="FormattingOptions.UseTabs"/> to apply to the test workspace.
50+
/// Gets or sets a value indicating whether the <see cref="FormattingOptions.UseTabs"/> option is applied to the
51+
/// test workspace.
5152
/// </summary>
5253
/// <value>
5354
/// The value of the <see cref="FormattingOptions.UseTabs"/> to apply to the test workspace.

StyleCop.Analyzers/StyleCop.Analyzers/AnalyzerConstants.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ static AnalyzerConstants()
2929
/// to disable a diagnostic which is currently untested.
3030
/// </value>
3131
[ExcludeFromCodeCoverage]
32+
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1623:Property summary documentation must match accessors.", Justification = "This property behaves more like an opaque value than a Boolean.")]
3233
internal static bool DisabledNoTests { get; }
3334

3435
/// <summary>
@@ -43,6 +44,7 @@ static AnalyzerConstants()
4344
/// to indicate that the diagnostic is disabled by default because it is an alternative to a reference StyleCop
4445
/// rule.
4546
/// </value>
47+
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1623:Property summary documentation must match accessors.", Justification = "This property behaves more like an opaque value than a Boolean.")]
4648
internal static bool DisabledAlternative => false;
4749

4850
/// <summary>
@@ -55,6 +57,7 @@ static AnalyzerConstants()
5557
/// <see cref="DiagnosticDescriptor(string, string, string, string, DiagnosticSeverity, bool, string, string, string[])"/>
5658
/// to indicate that the diagnostic should be enabled by default.
5759
/// </value>
60+
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1623:Property summary documentation must match accessors.", Justification = "This property behaves more like an opaque value than a Boolean.")]
5861
internal static bool EnabledByDefault => true;
5962

6063
/// <summary>
@@ -67,6 +70,7 @@ static AnalyzerConstants()
6770
/// <see cref="DiagnosticDescriptor(string, string, string, string, DiagnosticSeverity, bool, string, string, string[])"/>
6871
/// to indicate that the diagnostic should be disabled by default.
6972
/// </value>
73+
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1623:Property summary documentation must match accessors.", Justification = "This property behaves more like an opaque value than a Boolean.")]
7074
internal static bool DisabledByDefault => false;
7175
}
7276
}

0 commit comments

Comments
 (0)