Skip to content

Commit

Permalink
Fix SA1629 "... should end with a period" in generated xml docs
Browse files Browse the repository at this point in the history
Also, <remarks><para>... is generated like:

/// <para><see href="https://docs.microsoft.com/windows/win32/api/iphlpapi/nf-iphlpapi-sendarp">Learn more about this API from docs.microsoft.com.</see></para>

while the end of <summary> is generated as:

/// <para><see href="https://docs.microsoft.com/windows/win32/api/iphlpapi/nf-iphlpapi-sendarp#parameters">Read more on docs.microsoft.com</see>.</para>

thus, beeing SA1629 compliant.
  • Loading branch information
georg-jung committed Jul 13, 2021
1 parent 14443c0 commit 7d6a511
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/Microsoft.Windows.CsWin32/Generator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2020,7 +2020,7 @@ private T AddApiDocumentation<T>(string api, T memberDeclaration)
else if (docs.HelpLink is object)
{
docCommentsBuilder.AppendLine();
docCommentsBuilder.AppendLine($@"/// <para><see href=""{docs.HelpLink}"">Learn more about this API from docs.microsoft.com.</see></para>");
docCommentsBuilder.AppendLine($@"/// <para><see href=""{docs.HelpLink}"">Learn more about this API from docs.microsoft.com</see>.</para>");
docCommentsBuilder.Append("/// ");
}

Expand Down

0 comments on commit 7d6a511

Please sign in to comment.