Merge pull request DotNetAnalyzers#49 from sharwell/install-analyzers

Install documentation analyzers 1.0.0-beta.33
sharwell · Sep 20, 2018 · bfe856e · bfe856e
2 parents fd0571d + 04a3d10
commit bfe856e
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 13 deletions.
diff --git a/DocumentationAnalyzers/Directory.Build.props b/DocumentationAnalyzers/Directory.Build.props
@@ -44,6 +44,7 @@
   <ItemGroup>
     <PackageReference Include="AsyncUsageAnalyzers" Version="1.0.0-alpha003" PrivateAssets="all" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta009" PrivateAssets="all" />
+    <PackageReference Include="DotNetAnalyzers.DocumentationAnalyzers" Version="1.0.0-beta.33" PrivateAssets="all" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/Helpers/CustomFixAllProviders.cs b/DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/Helpers/CustomFixAllProviders.cs
@@ -19,9 +19,9 @@ internal static class CustomFixAllProviders
         /// <see cref="FixAllScope.Document"/>, <see cref="FixAllScope.Project"/> and <see cref="FixAllScope.Solution"/>.
         /// </summary>
         /// <remarks>
-        /// The batch fix all provider only batches operations (i.e. <see cref="CodeActionOperation"/>) of type
+        /// <para>The batch fix all provider only batches operations (i.e. <see cref="CodeActionOperation"/>) of type
         /// <see cref="ApplyChangesOperation"/> present within the individual diagnostic fixes. Other types of
-        /// operations present within these fixes are ignored.
+        /// operations present within these fixes are ignored.</para>
         /// </remarks>
         /// <value>
         /// The default batch fix all provider.

diff --git a/...Analyzers.CodeFixes/RefactoringRules/DOC900CodeFixProvider+DocumentationCommentPrinter.cs b/...Analyzers.CodeFixes/RefactoringRules/DOC900CodeFixProvider+DocumentationCommentPrinter.cs
@@ -43,7 +43,7 @@ internal static class DocumentationCommentPrinter
             /// <summary>
             /// Convert a block list to HTML.  Returns 0 on success, and sets result.
             /// </summary>
-            /// <remarks>Orig: blocks_to_html.</remarks>
+            /// <remarks><para>Orig: blocks_to_html.</para></remarks>
             public static void BlocksToHtml(System.IO.TextWriter writer, Block block, CommonMarkSettings settings, ISymbol documentedSymbol)
             {
                 var wrapper = new DocumentationCommentTextWriter(writer);
@@ -53,7 +53,7 @@ public static void BlocksToHtml(System.IO.TextWriter writer, Block block, Common
             /// <summary>
             /// Escapes special URL characters.
             /// </summary>
-            /// <remarks>Orig: escape_html(inp, preserve_entities).</remarks>
+            /// <remarks><para>Orig: escape_html(inp, preserve_entities).</para></remarks>
             private static void EscapeUrl(string input, DocumentationCommentTextWriter target)
             {
                 if (input == null)
@@ -125,7 +125,7 @@ private static void EscapeUrl(string input, DocumentationCommentTextWriter targe
             /// <summary>
             /// Escapes special HTML characters.
             /// </summary>
-            /// <remarks>Orig: escape_html(inp, preserve_entities).</remarks>
+            /// <remarks><para>Orig: escape_html(inp, preserve_entities).</para></remarks>
             private static void EscapeHtml(string input, DocumentationCommentTextWriter target)
             {
                 if (input.Length == 0)
@@ -176,7 +176,7 @@ private static void EscapeHtml(string input, DocumentationCommentTextWriter targ
             /// <summary>
             /// Escapes special HTML characters.
             /// </summary>
-            /// <remarks>Orig: escape_html(inp, preserve_entities).</remarks>
+            /// <remarks><para>Orig: escape_html(inp, preserve_entities).</para></remarks>
             private static void EscapeHtml(StringContent inp, DocumentationCommentTextWriter target)
             {
                 int pos;

diff --git a/DocumentationAnalyzers/DocumentationAnalyzers.Status.Generator/DocumentationDiagnostic.cs b/DocumentationAnalyzers/DocumentationAnalyzers.Status.Generator/DocumentationDiagnostic.cs
@@ -42,10 +42,10 @@ public class DocumentationDiagnostic
         /// </summary>
         /// <value>
         /// <list type="bullet">
-        /// <item>DisabledNoTests</item>
-        /// <item>DisabledAlternative</item>
-        /// <item>EnabledByDefault</item>
-        /// <item>DisabledByDefault</item>
+        /// <item><description>DisabledNoTests</description></item>
+        /// <item><description>DisabledAlternative</description></item>
+        /// <item><description>EnabledByDefault</description></item>
+        /// <item><description>DisabledByDefault</description></item>
         /// </list>
         /// </value>
         public string Status { get; set; }

diff --git a/DocumentationAnalyzers/DocumentationAnalyzers/NoCodeFixAttribute.cs b/DocumentationAnalyzers/DocumentationAnalyzers/NoCodeFixAttribute.cs
@@ -13,8 +13,8 @@ namespace DocumentationAnalyzers
     /// <para>There are several reasons an analyzer does not have a code fix, including but not limited to the
     /// following:</para>
     /// <list type="bullet">
-    /// <item>Visual Studio provides a built-in code fix.</item>
-    /// <item>A code fix could not provide a useful solution.</item>
+    /// <item><description>Visual Studio provides a built-in code fix.</description></item>
+    /// <item><description>A code fix could not provide a useful solution.</description></item>
     /// </list>
     /// <para>The <see cref="Reason"/> should be provided.</para>
     /// </remarks>

diff --git a/...ntationAnalyzers/DocumentationAnalyzers/StyleRules/BlockLevelDocumentationAnalyzerBase.cs b/...ntationAnalyzers/DocumentationAnalyzers/StyleRules/BlockLevelDocumentationAnalyzerBase.cs
@@ -28,7 +28,7 @@ public override void Initialize(AnalysisContext context)
         /// <summary>
         /// Determines if a particular node is a block-level documentation element.
         /// </summary>
-        /// <param name="node">The syntax node to examine.</param>
+        /// <param name="node"><para>The syntax node to examine.</para></param>
         /// <param name="includePotentialElements">
         /// <para><see langword="true"/> to only check for elements that are always block level elements.</para>
         /// <para>-or-</para>