Skip to content

Commit 17a534d

Browse files
committed
Improve documentation comment styles
1 parent 08a1750 commit 17a534d

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402SettingsConfiguration.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ public enum SA1402SettingsConfiguration
1111
KeepDefaultConfiguration,
1212

1313
/// <summary>
14-
/// Provide custom settings that configure the tested type as being a top level type.
14+
/// Provide custom settings that configure the tested type as being a top-level type.
1515
/// </summary>
1616
ConfigureAsTopLevelType,
1717

1818
/// <summary>
19-
/// Provide custom settings that configure the tested type as not being a top level type.
19+
/// Provide custom settings that configure the tested type as not being a top-level type.
2020
/// </summary>
2121
ConfigureAsNonTopLevelType,
2222
}

StyleCop.Analyzers/StyleCop.Analyzers/Helpers/MemberOrderHelper.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,17 @@ private enum ModifierFlags
103103
None = 0,
104104

105105
/// <summary>
106-
/// Readonly modifier.
106+
/// <see langword="readonly"/> modifier.
107107
/// </summary>
108108
Readonly = 1,
109109

110110
/// <summary>
111-
/// Static modifier.
111+
/// <see langword="static"/> modifier.
112112
/// </summary>
113113
Static = 1 << 2,
114114

115115
/// <summary>
116-
/// Const modifier.
116+
/// <see langword="const"/> modifier.
117117
/// </summary>
118118
Const = 1 << 3,
119119
}

StyleCop.Analyzers/StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ internal enum ModifierType
1919
None,
2020

2121
/// <summary>
22-
/// Represents any of access modifiers i.e public, protected, internal, private.
22+
/// Represents any of access modifiers, i.e <see langword="public"/>, <see langword="protected"/>, <see langword="internal"/>, <see langword="private"/>.
2323
/// </summary>
2424
Access,
2525

2626
/// <summary>
27-
/// Represents static modifier.
27+
/// Represents <see langword="static"/> modifier.
2828
/// </summary>
2929
Static,
3030

3131
/// <summary>
32-
/// Represents other modifiers i.e partial, virtual, abstract, override, extern, unsafe, new, async, const, sealed, readonly, volatile, fixed, ref.
32+
/// Represents other modifiers, i.e <see langword="partial"/>, <see langword="virtual"/>, <see langword="abstract"/>, <see langword="override"/>, <see langword="extern"/>, <see langword="unsafe"/>, <see langword="new"/>, <see langword="async"/>, <see langword="const"/>, <see langword="sealed"/>, <see langword="readonly"/>, <see langword="volatile"/>, <see langword="fixed"/>, <see langword="ref"/>.
3333
/// </summary>
3434
Other,
3535
}

StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/FileNamingConvention.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ namespace StyleCop.Analyzers.Settings.ObjectModel
66
internal enum FileNamingConvention
77
{
88
/// <summary>
9-
/// Files are named using the StyleCop convention (e.g. TypeName{T1,T2}).
9+
/// Files are named using the StyleCop convention (e.g. <c>TypeName{T1,T2}</c>).
1010
/// </summary>
1111
StyleCop,
1212

1313
/// <summary>
14-
/// Files are named using the metadata convention (e.g. TypeName`2).
14+
/// Files are named using the metadata convention (e.g. <c>TypeName`2</c>).
1515
/// </summary>
1616
Metadata,
1717
}

0 commit comments

Comments
 (0)