Skip to content

Commit 2d43bcd

Browse files
sharwellsharwell
committed
Change DOC103 to DOC200 (portability rules)
1 parent 5e0e9be commit 2d43bcd

13 files changed

Lines changed: 277 additions & 78 deletions

File tree

‎DOCUMENTATION.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ DocumentationAnalyzers provides warnings that indicate documentation rule violat
66

77
Rules related to the style of documentation comments.
88

9+
**[Portability Rules (DOC200-)](docs/PortabilityRules.md)**
10+
11+
Rules related to the portability of documentation comments.
12+
913
**[Refactorings (DOC900-)](docs/Refactorings.md)**
1014

1115
Additional refactorings provided when the analyzer is installed.

DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/StyleRules/DOC103CodeFixProvider.cs renamed to DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/PortabilityRules/DOC200CodeFixProvider.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
22
// Licensed under the MIT license. See LICENSE in the project root for license information.
33

4-
namespace DocumentationAnalyzers.StyleRules
4+
namespace DocumentationAnalyzers.PortabilityRules
55
{
66
using System.Collections.Immutable;
77
using System.Composition;
@@ -14,12 +14,12 @@ namespace DocumentationAnalyzers.StyleRules
1414
using Microsoft.CodeAnalysis.CSharp;
1515
using Microsoft.CodeAnalysis.CSharp.Syntax;
1616

17-
[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(DOC103CodeFixProvider))]
17+
[ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(DOC200CodeFixProvider))]
1818
[Shared]
19-
internal class DOC103CodeFixProvider : CodeFixProvider
19+
internal class DOC200CodeFixProvider : CodeFixProvider
2020
{
2121
public override ImmutableArray<string> FixableDiagnosticIds { get; }
22-
= ImmutableArray.Create(DOC103UseXmlDocumentationSyntax.DiagnosticId);
22+
= ImmutableArray.Create(DOC200UseXmlDocumentationSyntax.DiagnosticId);
2323

2424
public override FixAllProvider GetFixAllProvider()
2525
=> CustomFixAllProviders.BatchFixer;
@@ -35,9 +35,9 @@ public override Task RegisterCodeFixesAsync(CodeFixContext context)
3535

3636
context.RegisterCodeFix(
3737
CodeAction.Create(
38-
StyleResources.DOC103CodeFix,
38+
PortabilityResources.DOC200CodeFix,
3939
token => GetTransformedDocumentAsync(context.Document, diagnostic, token),
40-
nameof(DOC103CodeFixProvider)),
40+
nameof(DOC200CodeFixProvider)),
4141
diagnostic);
4242
}
4343

DocumentationAnalyzers/DocumentationAnalyzers.Test.CSharp7/StyleRules/DOC103CSharp7UnitTests.cs renamed to DocumentationAnalyzers/DocumentationAnalyzers.Test.CSharp7/PortabilityRules/DOC200CSharp7UnitTests.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
22
// Licensed under the MIT license. See LICENSE in the project root for license information.
33

4-
namespace DocumentationAnalyzers.Test.CSharp7.StyleRules
4+
namespace DocumentationAnalyzers.Test.CSharp7.PortabilityRules
55
{
6-
using DocumentationAnalyzers.Test.StyleRules;
6+
using DocumentationAnalyzers.Test.PortabilityRules;
77

8-
public class DOC103CSharp7UnitTests : DOC103UnitTests
8+
public class DOC200CSharp7UnitTests : DOC200UnitTests
99
{
1010
}
1111
}

DocumentationAnalyzers/DocumentationAnalyzers.Test/StyleRules/DOC103UnitTests.cs renamed to DocumentationAnalyzers/DocumentationAnalyzers.Test/PortabilityRules/DOC200UnitTests.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
22
// Licensed under the MIT license. See LICENSE in the project root for license information.
33

4-
namespace DocumentationAnalyzers.Test.StyleRules
4+
namespace DocumentationAnalyzers.Test.PortabilityRules
55
{
66
using System.Threading.Tasks;
7-
using DocumentationAnalyzers.StyleRules;
7+
using DocumentationAnalyzers.PortabilityRules;
88
using Xunit;
9-
using Verify = Microsoft.CodeAnalysis.CSharp.Testing.CSharpCodeFixVerifier<DocumentationAnalyzers.StyleRules.DOC103UseXmlDocumentationSyntax, DocumentationAnalyzers.StyleRules.DOC103CodeFixProvider, Microsoft.CodeAnalysis.Testing.Verifiers.XUnitVerifier>;
9+
using Verify = Microsoft.CodeAnalysis.CSharp.Testing.CSharpCodeFixVerifier<DocumentationAnalyzers.PortabilityRules.DOC200UseXmlDocumentationSyntax, DocumentationAnalyzers.PortabilityRules.DOC200CodeFixProvider, Microsoft.CodeAnalysis.Testing.Verifiers.XUnitVerifier>;
1010

1111
/// <summary>
12-
/// This class contains unit tests for <see cref="DOC103UseXmlDocumentationSyntax"/>.
12+
/// This class contains unit tests for <see cref="DOC200UseXmlDocumentationSyntax"/>.
1313
/// </summary>
14-
public class DOC103UnitTests
14+
public class DOC200UnitTests
1515
{
1616
[Fact]
1717
public async Task TestHtmlParagraphAsync()

‎DocumentationAnalyzers/DocumentationAnalyzers/AnalyzerCategory.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ internal static class AnalyzerCategory
1313
/// </summary>
1414
public const string StyleRules = nameof(DocumentationAnalyzers) + "." + nameof(StyleRules);
1515

16+
/// <summary>
17+
/// Category definition for portability rules.
18+
/// </summary>
19+
public const string PortabilityRules = nameof(DocumentationAnalyzers) + "." + nameof(PortabilityRules);
20+
1621
/// <summary>
1722
/// Category definition for refactorings.
1823
/// </summary>

DocumentationAnalyzers/DocumentationAnalyzers/StyleRules/DOC103UseXmlDocumentationSyntax.cs renamed to DocumentationAnalyzers/DocumentationAnalyzers/PortabilityRules/DOC200UseXmlDocumentationSyntax.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
22
// Licensed under the MIT license. See LICENSE in the project root for license information.
33

4-
namespace DocumentationAnalyzers.StyleRules
4+
namespace DocumentationAnalyzers.PortabilityRules
55
{
66
using System.Collections.Immutable;
77
using Microsoft.CodeAnalysis;
@@ -13,20 +13,20 @@ namespace DocumentationAnalyzers.StyleRules
1313
/// Use XML documentation syntax.
1414
/// </summary>
1515
[DiagnosticAnalyzer(LanguageNames.CSharp)]
16-
internal class DOC103UseXmlDocumentationSyntax : DiagnosticAnalyzer
16+
internal class DOC200UseXmlDocumentationSyntax : DiagnosticAnalyzer
1717
{
1818
/// <summary>
19-
/// The ID for diagnostics produced by the <see cref="DOC103UseXmlDocumentationSyntax"/> analyzer.
19+
/// The ID for diagnostics produced by the <see cref="DOC200UseXmlDocumentationSyntax"/> analyzer.
2020
/// </summary>
21-
public const string DiagnosticId = "DOC103";
22-
private const string HelpLink = "https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC103.md";
21+
public const string DiagnosticId = "DOC200";
22+
private const string HelpLink = "https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC200.md";
2323

24-
private static readonly LocalizableString Title = new LocalizableResourceString(nameof(StyleResources.DOC103Title), StyleResources.ResourceManager, typeof(StyleResources));
25-
private static readonly LocalizableString MessageFormat = new LocalizableResourceString(nameof(StyleResources.DOC103MessageFormat), StyleResources.ResourceManager, typeof(StyleResources));
26-
private static readonly LocalizableString Description = new LocalizableResourceString(nameof(StyleResources.DOC103Description), StyleResources.ResourceManager, typeof(StyleResources));
24+
private static readonly LocalizableString Title = new LocalizableResourceString(nameof(PortabilityResources.DOC200Title), PortabilityResources.ResourceManager, typeof(PortabilityResources));
25+
private static readonly LocalizableString MessageFormat = new LocalizableResourceString(nameof(PortabilityResources.DOC200MessageFormat), PortabilityResources.ResourceManager, typeof(PortabilityResources));
26+
private static readonly LocalizableString Description = new LocalizableResourceString(nameof(PortabilityResources.DOC200Description), PortabilityResources.ResourceManager, typeof(PortabilityResources));
2727

2828
private static readonly DiagnosticDescriptor Descriptor =
29-
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.StyleRules, DiagnosticSeverity.Info, AnalyzerConstants.EnabledByDefault, Description, HelpLink);
29+
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.PortabilityRules, DiagnosticSeverity.Info, AnalyzerConstants.EnabledByDefault, Description, HelpLink);
3030

3131
/// <inheritdoc/>
3232
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; }

‎DocumentationAnalyzers/DocumentationAnalyzers/PortabilityRules/PortabilityResources.Designer.cs‎

Lines changed: 100 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎DocumentationAnalyzers/DocumentationAnalyzers/PortabilityRules/PortabilityResources.resx‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="DOC200CodeFix" xml:space="preserve">
121+
<value>Use XML documentation syntax</value>
122+
</data>
123+
<data name="DOC200Description" xml:space="preserve">
124+
<value>Use XML documentation syntax</value>
125+
</data>
126+
<data name="DOC200MessageFormat" xml:space="preserve">
127+
<value>Use XML documentation syntax</value>
128+
</data>
129+
<data name="DOC200Title" xml:space="preserve">
130+
<value>Use XML documentation syntax</value>
131+
</data>
132+
</root>

0 commit comments

Comments
 (0)