Skip to content

Commit 04a3d10

Browse files
committed
Install documentation analyzers 1.0.0-beta.33
Fixes all existing issues.
1 parent 1b61531 commit 04a3d10

File tree

6 files changed

+14
-13
lines changed

6 files changed

+14
-13
lines changed

DocumentationAnalyzers/Directory.Build.props

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
<ItemGroup>
4545
<PackageReference Include="AsyncUsageAnalyzers" Version="1.0.0-alpha003" PrivateAssets="all" />
4646
<PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta009" PrivateAssets="all" />
47+
<PackageReference Include="DotNetAnalyzers.DocumentationAnalyzers" Version="1.0.0-beta.33" PrivateAssets="all" />
4748
</ItemGroup>
4849

4950
<ItemGroup>

DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/Helpers/CustomFixAllProviders.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ internal static class CustomFixAllProviders
1919
/// <see cref="FixAllScope.Document"/>, <see cref="FixAllScope.Project"/> and <see cref="FixAllScope.Solution"/>.
2020
/// </summary>
2121
/// <remarks>
22-
/// The batch fix all provider only batches operations (i.e. <see cref="CodeActionOperation"/>) of type
22+
/// <para>The batch fix all provider only batches operations (i.e. <see cref="CodeActionOperation"/>) of type
2323
/// <see cref="ApplyChangesOperation"/> present within the individual diagnostic fixes. Other types of
24-
/// operations present within these fixes are ignored.
24+
/// operations present within these fixes are ignored.</para>
2525
/// </remarks>
2626
/// <value>
2727
/// The default batch fix all provider.

DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/RefactoringRules/DOC900CodeFixProvider+DocumentationCommentPrinter.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ internal static class DocumentationCommentPrinter
4343
/// <summary>
4444
/// Convert a block list to HTML. Returns 0 on success, and sets result.
4545
/// </summary>
46-
/// <remarks>Orig: blocks_to_html.</remarks>
46+
/// <remarks><para>Orig: blocks_to_html.</para></remarks>
4747
public static void BlocksToHtml(System.IO.TextWriter writer, Block block, CommonMarkSettings settings, ISymbol documentedSymbol)
4848
{
4949
var wrapper = new DocumentationCommentTextWriter(writer);
@@ -53,7 +53,7 @@ public static void BlocksToHtml(System.IO.TextWriter writer, Block block, Common
5353
/// <summary>
5454
/// Escapes special URL characters.
5555
/// </summary>
56-
/// <remarks>Orig: escape_html(inp, preserve_entities).</remarks>
56+
/// <remarks><para>Orig: escape_html(inp, preserve_entities).</para></remarks>
5757
private static void EscapeUrl(string input, DocumentationCommentTextWriter target)
5858
{
5959
if (input == null)
@@ -125,7 +125,7 @@ private static void EscapeUrl(string input, DocumentationCommentTextWriter targe
125125
/// <summary>
126126
/// Escapes special HTML characters.
127127
/// </summary>
128-
/// <remarks>Orig: escape_html(inp, preserve_entities).</remarks>
128+
/// <remarks><para>Orig: escape_html(inp, preserve_entities).</para></remarks>
129129
private static void EscapeHtml(string input, DocumentationCommentTextWriter target)
130130
{
131131
if (input.Length == 0)
@@ -176,7 +176,7 @@ private static void EscapeHtml(string input, DocumentationCommentTextWriter targ
176176
/// <summary>
177177
/// Escapes special HTML characters.
178178
/// </summary>
179-
/// <remarks>Orig: escape_html(inp, preserve_entities).</remarks>
179+
/// <remarks><para>Orig: escape_html(inp, preserve_entities).</para></remarks>
180180
private static void EscapeHtml(StringContent inp, DocumentationCommentTextWriter target)
181181
{
182182
int pos;

DocumentationAnalyzers/DocumentationAnalyzers.Status.Generator/DocumentationDiagnostic.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ public class DocumentationDiagnostic
4242
/// </summary>
4343
/// <value>
4444
/// <list type="bullet">
45-
/// <item>DisabledNoTests</item>
46-
/// <item>DisabledAlternative</item>
47-
/// <item>EnabledByDefault</item>
48-
/// <item>DisabledByDefault</item>
45+
/// <item><description>DisabledNoTests</description></item>
46+
/// <item><description>DisabledAlternative</description></item>
47+
/// <item><description>EnabledByDefault</description></item>
48+
/// <item><description>DisabledByDefault</description></item>
4949
/// </list>
5050
/// </value>
5151
public string Status { get; set; }

DocumentationAnalyzers/DocumentationAnalyzers/NoCodeFixAttribute.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ namespace DocumentationAnalyzers
1313
/// <para>There are several reasons an analyzer does not have a code fix, including but not limited to the
1414
/// following:</para>
1515
/// <list type="bullet">
16-
/// <item>Visual Studio provides a built-in code fix.</item>
17-
/// <item>A code fix could not provide a useful solution.</item>
16+
/// <item><description>Visual Studio provides a built-in code fix.</description></item>
17+
/// <item><description>A code fix could not provide a useful solution.</description></item>
1818
/// </list>
1919
/// <para>The <see cref="Reason"/> should be provided.</para>
2020
/// </remarks>

DocumentationAnalyzers/DocumentationAnalyzers/StyleRules/BlockLevelDocumentationAnalyzerBase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public override void Initialize(AnalysisContext context)
2828
/// <summary>
2929
/// Determines if a particular node is a block-level documentation element.
3030
/// </summary>
31-
/// <param name="node">The syntax node to examine.</param>
31+
/// <param name="node"><para>The syntax node to examine.</para></param>
3232
/// <param name="includePotentialElements">
3333
/// <para><see langword="true"/> to only check for elements that are always block level elements.</para>
3434
/// <para>-or-</para>

0 commit comments

Comments
 (0)