10000 Fix bug in code data-dev-comment conversions. · dotnet/api-docs-sync@dea5237 · GitHub
[go: up one dir, main page]

Skip to content

Commit dea5237

Browse files
committed
Fix bug in code data-dev-comment conversions.
1 parent 1cc3a53 commit dea5237

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

src/PortToDocs/src/libraries/XmlHelper.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,10 @@ internal class XmlHelper
6161
{ @"\<(see|seealso){1} cref\=""object""[ ]*\/\>", "<see cref=\"T:System.Object\" />" },
6262
{ @"\<(see|seealso){1} cref\=""dynamic""[ ]*\/\>", "<see langword=\"dynamic\" />" },
6363
{ @"\<(see|seealso){1} cref\=""string""[ ]*\/\>", "<see cref=\"T:System.String\" />" },
64-
{ @"<code data-dev-comment-type=""(?<elementName>[a-zA-Z0-9_]+)"">(?<elementValue>[a-zA-Z0-9_]+)</code>", "<see ${elementName}=\"${elementValue}\" />" },
65-
{ @"<xref data-throw-if-not-resolved=""[a-zA-Z0-9_]+"" uid=""(?<docId>[a-zA-Z0-9_,\<\>\.\@\#\$%^&`\(\)]+)""><\/xref>", "<see cref=\"T:${docId}\" />" },
64+
{ @"<code data-dev-comment-type=""langword"">(?<elementValue>[a-zA-Z0-9_]+)</code>", "<see langword=\"${elementValue}\" />" },
65+
{ @"<code data-dev-comment-type=""paramref"">(?<elementValue>[a-zA-Z0-9_]+)</code>", "<paramref name=\"${elementValue}\" />" },
66+
{ @"<code data-dev-comment-type=""typeparamref"">(?<elementValue>[a-zA-Z0-9_]+)</code>", "<typeparamref name=\"${elementValue}\" />" },
67+
{ @"<xref data-throw-if-not-resolved=""[a-zA-Z0-9_]+"" uid=""(?<docId>[a-zA-Z0-9_,\<\>\.\@\#\$%^&`\(\)]+)""(><\/xref>|[ ]*/>)", "<see cref=\"T:${docId}\" />" },
6668
};
6769

6870
private static readonly Dictionary<string, string> _replaceableMarkdownPatterns = new Dictionary<string, string> {
@@ -123,7 +125,7 @@ internal class XmlHelper
123125
{ @"\<(typeparamref|paramref){1} name\=""(?'refNameContents'[a-zA-Z0-9_\-]+)""[ ]*\/\>", @"`${refNameContents}`" },
124126
{ @"\<see langword\=""(?'seeLangwordContents'[a-zA-Z0-9_\-]+)""[ ]*\/\>", @"`${seeLangwordContents}`" },
125127
{ @"<code data-dev-comment-type=""[a-zA-Z0-9_]+"">(?<elementValue>[a-zA-Z0-9_]+)</code>", "`${elementValue}`" },
126-
{ @"<xref data-throw-if-not-resolved=""[a-zA-Z0-9_]+"" uid=""(?<docId>[a-zA-Z0-9_,\<\>\.]+)""><\/xref>", "<xref:${docId}>" },
128+
{ @"<xref data-throw-if-not-resolved=""[a-zA-Z0-9_]+"" uid=""(?<docId>[a-zA-Z0-9_,\<\>\.]+)""(><\/xref>|[ ]*/>)", "<xref:${docId}>" },
127129
};
128130

129131
private static readonly string[] _splittingSeparators = new string[] { "\r", "\n", "\r\n" };

src/PortToDocs/tests/PortToDocs.Strings.Tests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2503,7 +2503,7 @@ public void Convert_CodeDataDevCommentType_To_ExpectedElementNames()
25032503
<AssemblyName>MyAssembly</AssemblyName>
25042504
</AssemblyInfo>
25052505
<Docs>
2506-
<summary>Langword <see langword=""true"" />. Paramref <see paramref=""myParam"" />. Typeparamref <see typeparamref=""myTypeParam"" />.</summary>
2506+
<summary>Langword <see langword=""true"" />. Paramref <paramref name=""myParam"" />. Typeparamref <typeparamref name=""myTypeParam"" />.</summary>
25072507
<remarks>
25082508
<format type=""text/markdown""><![CDATA[
25092509

0 commit comments

Comments
 (0)
0