From badffd144ea84fc39385e508068718179bb23705 Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Sat, 26 Sep 2020 14:07:15 -0700 Subject: [PATCH 1/3] Update to StyleCop.Analyzers 1.2.0-beta.205 --- StyleCop.Analyzers/Directory.Build.props | 2 +- StyleCop.Analyzers/stylecop.json | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/StyleCop.Analyzers/Directory.Build.props b/StyleCop.Analyzers/Directory.Build.props index 6c156d7441..10bf1b5d14 100644 --- a/StyleCop.Analyzers/Directory.Build.props +++ b/StyleCop.Analyzers/Directory.Build.props @@ -45,7 +45,7 @@ - + diff --git a/StyleCop.Analyzers/stylecop.json b/StyleCop.Analyzers/stylecop.json index d9e0e55880..57375f9d0e 100644 --- a/StyleCop.Analyzers/stylecop.json +++ b/StyleCop.Analyzers/stylecop.json @@ -9,6 +9,9 @@ }, "layoutRules": { "newlineAtEndOfFile": "require" + }, + "namingRules": { + "tupleElementNameCasing": "camelCase" } } } From 08a17506024aef47260d63bcd3396d77eff0a204 Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Sat, 26 Sep 2020 14:10:30 -0700 Subject: [PATCH 2/3] Fix SA1629 (Documentation text should end with a period) --- .../CodeFixStatus.cs | 2 +- .../SA1402SettingsConfiguration.cs | 6 +++--- .../StyleCop.Analyzers/Helpers/MemberOrderHelper.cs | 8 ++++---- .../StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs | 8 ++++---- .../Settings/ObjectModel/FileNamingConvention.cs | 4 ++-- .../Settings/ObjectModel/TopLevelType.cs | 10 +++++----- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/CodeFixStatus.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/CodeFixStatus.cs index 1587c4ef6c..63611241d2 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/CodeFixStatus.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/CodeFixStatus.cs @@ -9,7 +9,7 @@ namespace StyleCop.Analyzers.Status.Generator public enum CodeFixStatus { /// - /// This value indicates, that a code fix is implemented + /// This value indicates, that a code fix is implemented. /// Implemented, diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402SettingsConfiguration.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402SettingsConfiguration.cs index 2c9d502415..05f6015459 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402SettingsConfiguration.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402SettingsConfiguration.cs @@ -6,17 +6,17 @@ namespace StyleCop.Analyzers.Test.MaintainabilityRules public enum SA1402SettingsConfiguration { /// - /// Provide no custom settings + /// Provide no custom settings. /// KeepDefaultConfiguration, /// - /// Provide custom settings that configure the tested type as being a top level type + /// Provide custom settings that configure the tested type as being a top level type. /// ConfigureAsTopLevelType, /// - /// Provide custom settings that configure the tested type as not being a top level type + /// Provide custom settings that configure the tested type as not being a top level type. /// ConfigureAsNonTopLevelType, } diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/MemberOrderHelper.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/MemberOrderHelper.cs index a678d23931..f28e7878fd 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/MemberOrderHelper.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/MemberOrderHelper.cs @@ -98,22 +98,22 @@ internal MemberOrderHelper(MemberDeclarationSyntax member, ImmutableArray - /// No modifiers + /// No modifiers. /// None = 0, /// - /// Readonly modifier + /// Readonly modifier. /// Readonly = 1, /// - /// Static modifier + /// Static modifier. /// Static = 1 << 2, /// - /// Const modifier + /// Const modifier. /// Const = 1 << 3, } diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs index 600c62f688..b835e0b310 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs @@ -14,22 +14,22 @@ internal static class ModifierOrderHelper internal enum ModifierType { /// - /// Represents default value + /// Represents default value. /// None, /// - /// Represents any of access modifiers i.e public, protected, internal, private + /// Represents any of access modifiers i.e public, protected, internal, private. /// Access, /// - /// Represents static modifier + /// Represents static modifier. /// Static, /// - /// Represents other modifiers i.e partial, virtual, abstract, override, extern, unsafe, new, async, const, sealed, readonly, volatile, fixed, ref + /// Represents other modifiers i.e partial, virtual, abstract, override, extern, unsafe, new, async, const, sealed, readonly, volatile, fixed, ref. /// Other, } diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/FileNamingConvention.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/FileNamingConvention.cs index b156a6ab56..6a8fa5abe0 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/FileNamingConvention.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/FileNamingConvention.cs @@ -6,12 +6,12 @@ namespace StyleCop.Analyzers.Settings.ObjectModel internal enum FileNamingConvention { /// - /// Files are named using the StyleCop convention (e.g. TypeName{T1,T2}) + /// Files are named using the StyleCop convention (e.g. TypeName{T1,T2}). /// StyleCop, /// - /// Files are named using the metadata convention (e.g. TypeName`2) + /// Files are named using the metadata convention (e.g. TypeName`2). /// Metadata, } diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/TopLevelType.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/TopLevelType.cs index a24ad0784d..439bd50dd9 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/TopLevelType.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/TopLevelType.cs @@ -6,27 +6,27 @@ namespace StyleCop.Analyzers.Settings.ObjectModel internal enum TopLevelType { /// - /// Classes are considered top-level types + /// Classes are considered top-level types. /// Class, /// - /// Interfaces are considered top-level types + /// Interfaces are considered top-level types. /// Interface, /// - /// Structs are considered top-level types + /// Structs are considered top-level types. /// Struct, /// - /// Delegates are considered top-level types + /// Delegates are considered top-level types. /// Delegate, /// - /// Enums are considered top-level types + /// Enums are considered top-level types. /// Enum, } From 17a534dd19d5ebc5f64c01923cd0db97be40bab2 Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Sat, 26 Sep 2020 14:13:04 -0700 Subject: [PATCH 3/3] Improve documentation comment styles --- .../MaintainabilityRules/SA1402SettingsConfiguration.cs | 4 ++-- .../StyleCop.Analyzers/Helpers/MemberOrderHelper.cs | 6 +++--- .../StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs | 6 +++--- .../Settings/ObjectModel/FileNamingConvention.cs | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402SettingsConfiguration.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402SettingsConfiguration.cs index 05f6015459..248ed6cea5 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402SettingsConfiguration.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402SettingsConfiguration.cs @@ -11,12 +11,12 @@ public enum SA1402SettingsConfiguration KeepDefaultConfiguration, /// - /// Provide custom settings that configure the tested type as being a top level type. + /// Provide custom settings that configure the tested type as being a top-level type. /// ConfigureAsTopLevelType, /// - /// Provide custom settings that configure the tested type as not being a top level type. + /// Provide custom settings that configure the tested type as not being a top-level type. /// ConfigureAsNonTopLevelType, } diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/MemberOrderHelper.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/MemberOrderHelper.cs index f28e7878fd..98343aa088 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/MemberOrderHelper.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/MemberOrderHelper.cs @@ -103,17 +103,17 @@ private enum ModifierFlags None = 0, /// - /// Readonly modifier. + /// modifier. /// Readonly = 1, /// - /// Static modifier. + /// modifier. /// Static = 1 << 2, /// - /// Const modifier. + /// modifier. /// Const = 1 << 3, } diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs index b835e0b310..775b2364ac 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/Helpers/ModifierOrderHelper.cs @@ -19,17 +19,17 @@ internal enum ModifierType None, /// - /// Represents any of access modifiers i.e public, protected, internal, private. + /// Represents any of access modifiers, i.e , , , . /// Access, /// - /// Represents static modifier. + /// Represents modifier. /// Static, /// - /// Represents other modifiers i.e partial, virtual, abstract, override, extern, unsafe, new, async, const, sealed, readonly, volatile, fixed, ref. + /// Represents other modifiers, i.e , , , , , , , , , , , , , . /// Other, } diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/FileNamingConvention.cs b/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/FileNamingConvention.cs index 6a8fa5abe0..7151215b15 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/FileNamingConvention.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/FileNamingConvention.cs @@ -6,12 +6,12 @@ namespace StyleCop.Analyzers.Settings.ObjectModel internal enum FileNamingConvention { /// - /// Files are named using the StyleCop convention (e.g. TypeName{T1,T2}). + /// Files are named using the StyleCop convention (e.g. TypeName{T1,T2}). /// StyleCop, /// - /// Files are named using the metadata convention (e.g. TypeName`2). + /// Files are named using the metadata convention (e.g. TypeName`2). /// Metadata, }