feat(xml): better error when link not found (#9957)

* feat(xml): better error when link not found * Corrected an alignment problem. --------- Co-authored-by: Yufei Huang <[email protected]>
dotnet · May 29, 2024 · 798e748 · 798e748
1 parent 0790840
commit 798e748
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/src/Docfx.Dotnet/Parsers/XmlComment.cs b/src/Docfx.Dotnet/Parsers/XmlComment.cs
@@ -376,7 +376,18 @@ private void ResolveCrefLink(XNode node, string nodeSelector, Action<string, str
                     }
                 }
 
-                Logger.Log(LogLevel.Warning, $"Invalid cref value \"{cref}\" found in XML documentation comment {detailedInfo}.", code: "InvalidCref");
+                if (detailedInfo.Length == 0 && node is XDocument doc)
+                {
+                    var memberName = (string) doc.Element("member")?.Attribute("name");
+
+                    if (! string.IsNullOrEmpty(memberName))
+                    {
+                        detailedInfo.Append(", member name is ");
+                        detailedInfo.Append(memberName);
+                    }
+                }
+
+                Logger.Log(LogLevel.Warning, $"Invalid cref value \"{cref}\" found in XML documentation comment{detailedInfo}.", code: "InvalidCref");
 
                 if (cref.StartsWith("!:"))
                 {