Skip to content

Commit 2ddcbf7

Browse files
author
Christian Käser
committed
Remove static texts from SA1642ConstructorSummaryDocumentationMustBeginWithStandardText
1 parent 1f21460 commit 2ddcbf7

1 file changed

Lines changed: 0 additions & 44 deletions

File tree

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1642ConstructorSummaryDocumentationMustBeginWithStandardText.cs

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -112,50 +112,6 @@ internal class SA1642ConstructorSummaryDocumentationMustBeginWithStandardText :
112112

113113
private static readonly Action<SyntaxNodeAnalysisContext> ConstructorDeclarationAction = HandleConstructorDeclaration;
114114

115-
/// <summary>
116-
/// Gets the standard text which is expected to appear at the beginning of the <c>&lt;summary&gt;</c>
117-
/// documentation for a non-private constructor.
118-
/// </summary>
119-
/// <value>
120-
/// The standard text which is expected to appear at the beginning of the <c>&lt;summary&gt;</c> documentation
121-
/// for a non-private constructor. This text appears before the name of the containing class, followed by a
122-
/// <c>&lt;see&gt;</c> element targeting the containing type, and finally followed by <c>class</c> or
123-
/// <c>struct</c> as appropriate for the containing type.
124-
/// </value>
125-
public static string NonPrivateConstructorStandardText { get; } = "Initializes a new instance of the ";
126-
127-
/// <summary>
128-
/// Gets the standard text which is expected to appear at the beginning of the <c>&lt;summary&gt;</c>
129-
/// documentation for a private constructor.
130-
/// </summary>
131-
/// <remarks>
132-
/// <para>In addition to the format given in <see cref="PrivateConstructorStandardText"/>, a private constructor
133-
/// may choose to use <see cref="NonPrivateConstructorStandardText"/> instead. The code fix provided for this
134-
/// diagnostic uses <see cref="NonPrivateConstructorStandardText"/> by default, since this is generally a more
135-
/// accurate representation of a user's intent. In new code, <see langword="static"/> classes provide a
136-
/// superior alternative to private constructors for the purpose of declaring utility types that cannot be
137-
/// instantiated.</para>
138-
/// </remarks>
139-
/// <value>
140-
/// The standard text which is expected to appear at the beginning of the <c>&lt;summary&gt;</c> documentation
141-
/// for a private constructor. The first element appears before the name of the containing class, followed by a
142-
/// <c>&lt;see&gt;</c> element targeting the containing type, then by <c>class</c> or <c>struct</c> as
143-
/// appropriate for the containing type, and finally followed by the second element of this array.
144-
/// </value>
145-
public static ImmutableArray<string> PrivateConstructorStandardText { get; } = ImmutableArray.Create("Prevents a default instance of the ", " from being created");
146-
147-
/// <summary>
148-
/// Gets the standard text which is expected to appear at the beginning of the <c>&lt;summary&gt;</c>
149-
/// documentation for a static constructor.
150-
/// </summary>
151-
/// <value>
152-
/// The standard text which is expected to appear at the beginning of the <c>&lt;summary&gt;</c> documentation
153-
/// for a static constructor. The first element appears before the name of the containing class, followed by a
154-
/// <c>&lt;see&gt;</c> element targeting the containing type, and finally followed by <c>class</c> or
155-
/// <c>struct</c> as appropriate for the containing type.
156-
/// </value>
157-
public static string StaticConstructorStandardText { get; } = "Initializes static members of the ";
158-
159115
/// <inheritdoc/>
160116
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } =
161117
ImmutableArray.Create(Descriptor);

0 commit comments

Comments
 (0)