Update after review

Author: vweijsters

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1629UnitTests.cs

@@ -767,7 +767,7 @@ public async Task TestConfigurationSettingsAsync()
 {
   ""settings"": {
     ""documentationRules"": {
-      ""excludedFromEndWithAPeriod"": ""typeparam,example, exception ,permission,author""
+      ""excludeFromPunctuationCheck"": [ ""typeparam"",""example"",""exception"",""permission"",""author"" ]
     }
   }
 }
@@ -817,7 +817,7 @@ public async Task TestConfigurationSettingsEmptyAsync()
 {
   ""settings"": {
     ""documentationRules"": {
-      ""excludedFromEndWithAPeriod"": """"
+      ""excludeFromPunctuationCheck"": [ ]
     }
   }
 }

StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1629DocumentationTextMustEndWithAPeriod.cs

@@ -105,7 +105,7 @@ protected override void HandleCompleteDocumentation(SyntaxNodeAnalysisContext co
         private static void HandleSectionOrBlockXmlElement(SyntaxNodeAnalysisContext context, StyleCopSettings settings, XmlElementSyntax xmlElement, bool startingWithFinalParagraph)
         {
             var startTag = xmlElement.StartTag?.Name?.LocalName.ValueText;
-            if (settings.DocumentationRules.ExcludedFromEndWithAPeriod.Contains(startTag))
+            if (settings.DocumentationRules.ExcludeFromPunctuationCheck.Contains(startTag))
             {
                 return;
             }

StyleCop.Analyzers/StyleCop.Analyzers/Settings/ObjectModel/DocumentationSettings.cs

@@ -28,9 +28,9 @@ internal class DocumentationSettings
         internal const string DefaultDocumentationCulture = "en-US";
 
         /// <summary>
-        /// The default value for the <see cref="ExcludedFromEndWithAPeriod"/> property.
+        /// The default value for the <see cref="ExcludeFromPunctuationCheck"/> property.
         /// </summary>
-        internal const string DefaultExcludedFromEndWithAPeriod = "seealso";
+        internal static readonly ImmutableArray<string> DefaultExcludeFromPunctuationCheck = ImmutableArray.Create("seealso");
 
         /// <summary>
         /// This is the backing field for the <see cref="CompanyName"/> property.
@@ -93,9 +93,9 @@ internal class DocumentationSettings
         private readonly string documentationCulture;
 
         /// <summary>
-        /// This is the backing field for the <see cref="ExcludedFromEndWithAPeriod"/> property.
+        /// This is the backing field for the <see cref="ExcludeFromPunctuationCheck"/> property.
         /// </summary>
-        private readonly string excludedFromEndWithAPeriod;
+        private readonly ImmutableArray<string> excludeFromPunctuationCheck;
 
         /// <summary>
         /// This is the cache for the <see cref="GetCopyrightText(string)"/> method.
@@ -123,7 +123,7 @@ protected internal DocumentationSettings()
 
             this.documentationCulture = DefaultDocumentationCulture;
 
-            this.excludedFromEndWithAPeriod = DefaultExcludedFromEndWithAPeriod;
+            this.excludeFromPunctuationCheck = DefaultExcludeFromPunctuationCheck;
         }
 
         /// <summary>
@@ -198,8 +198,15 @@ protected internal DocumentationSettings(JsonObject documentationSettingsObject)
                     this.documentationCulture = kvp.ToStringValue();
                     break;
 
-                case "excludedFromEndWithAPeriod":
-                    this.excludedFromEndWithAPeriod = kvp.ToStringValue();
+                case "excludeFromPunctuationCheck":
+                    kvp.AssertIsArray();
+                    var excludedTags = ImmutableArray.CreateBuilder<string>();
+                    foreach (var value in kvp.Value.AsJsonArray)
+                    {
+                        excludedTags.Add(value.AsString);
+                    }
+
+                    this.excludeFromPunctuationCheck = excludedTags.ToImmutable();
                     break;
 
                 default:
@@ -261,16 +268,8 @@ public bool XmlHeader
         public string DocumentationCulture =>
             this.documentationCulture;
 
-        public ImmutableArray<string> ExcludedFromEndWithAPeriod
-        {
-            get
-            {
-                return this.excludedFromEndWithAPeriod
-                    .Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries)
-                    .Select(s => s.Trim())
-                    .ToImmutableArray();
-            }
-        }
+        public ImmutableArray<string> ExcludeFromPunctuationCheck
+            => this.excludeFromPunctuationCheck;
 
         public string GetCopyrightText(string fileName)
         {

StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json

@@ -248,10 +248,12 @@
               "description": "The culture that should be used for documentation comments.",
               "default": "en-US"
             },
-            "excludedFromEndWithAPeriod": {
-              "type": "string",
-              "description": "Specifies the comma separated list of top-level tags within XML documentation that will be excluded from analysis for text ending with a period.",
-              "default": "seealso"
+            "excludeFromPunctuationCheck": {
+              "type": "array",
+              "description": "Specifies the top-level tags within XML documentation that will be excluded from punctuation analysis.",
+              "default": [
+                "seealso"
+              ]
             }
           }
         }

documentation/Configuration.md

@@ -596,7 +596,7 @@ The [SA1629 Documentation Text Must End With A Period](SA1629.md) analyzer check
 
 | Property | Default Value | Minimum Version | Summary |
 | --- | --- | --- | --- |
-| `excludedFromEndWithAPeriod` | `"seealso"` |  1.1.0 | Specifies the comma separated list of top-level tags within XML documentation that will be excluded from analysis. |
+| `excludeFromPunctuationCheck` | `[ "seealso" ]` |  1.1.0 | Specifies the top-level tags within XML documentation that will be excluded from analysis. |
 
 ## Sharing configuration among solutions