documentation for header decoration

Author: zitzltho

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

@@ -194,6 +194,11 @@
               "description": "Determines whether the file header should be wrapped in the StyleCop-standard XML structure.",
               "default": true
             },
+			"headerDecoration": {
+              "type": "boolean",
+              "description": "The text used as decoration for the copyright header comment.",
+              "default": null
+			}
             "fileNamingConvention": {
               "type": "string",
               "description": "Specifies the preferred naming convention for files. The default value \"stylecop\" uses the naming convention defined by StyleCop Classic, while \"metadata\" uses a file naming convention that matches the metadata names of types.",

documentation/Configuration.md

@@ -324,6 +324,7 @@ The following properties are used to configure copyright headers in StyleCop Ana
 | `copyrightText` | `"Copyright (c) {companyName}. All rights reserved."` | Specifies the default copyright text which should appear in copyright headers |
 | `xmlHeader` | **true** | Specifies whether file headers should use standard StyleCop XML format, where the copyright notice is wrapped in a `<copyright>` element |
 | `variables` | n/a | Specifies replacement variables which can be referenced in the `copyrightText` value |
+| `headerDecoration` | n/a | This value can be set to add a decoration for the header comment so that the headers look similar to the ones generated by the StyleCop classic R# fix | 
 
 #### Configuring Copyright Text
 
@@ -373,6 +374,35 @@ When the `xmlHeader` property is explicitly set to **false**, StyleCop Analyzers
 // {copyrightText}
 ```
 
+#### Configuring Copyright Text Header Decoration
+
+The `headerDecoration` property is a string which can contain a string that's used for decorating the generated header so that the headers look similar to the ones generated by the StyleCop classic R# fix.
+
+The default value for the `headerDecoration` property is empty, so no decoration will be added. 
+> The header decoration is not checked, it's only used for fixing the header.
+
+```json
+{
+  "settings": {
+    "documentationRules": {
+      "companyName": "FooCorp",
+      "copyrightText": "Copyright (c) {companyName}. All rights reserved.",
+      "headerDecoration": "-----------------------------------------------------------------------"
+    }
+  }
+}
+```
+
+With the above configuration, the fix for a file **TypeName.cs** would look like the following header.
+
+```csharp
+// -----------------------------------------------------------------------
+// <copyright file="TypeName.cs" company="FooCorp">
+// Copyright (c) FooCorp. All rights reserved.
+// </copyright>
+// -----------------------------------------------------------------------
+```
+
 ### Documentation Requirements
 
 StyleCop Analyzers includes rules which require developers to document the majority of a code base by default. This requirement can easily overwhelm a team which did not use StyleCop for the entire development process. To help guide developers towards a properly documented code base, several properties are available in **stylecop.json** to progressively increase the documentation requirements.