Fix documentation comment watson

QuickInfo could crash when showing a documentation comment whose exceptions section included a cref to a constructor. Fixes https://devdiv.visualstudio.com/DevDiv/_workitems?id=403665&_a=edit
dotnet · Aug 30, 2017 · 80bd4f5 · 80bd4f5
1 parent 8772d46
commit 80bd4f5
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/src/EditorFeatures/CSharpTest/QuickInfo/SemanticQuickInfoSourceTests.cs b/src/EditorFeatures/CSharpTest/QuickInfo/SemanticQuickInfoSourceTests.cs
@@ -5015,5 +5015,23 @@ void S()
 ",
             MainDescription("T Test.F<T>()"));
         }
+
+
+        [Fact, Trait(Traits.Feature, Traits.Features.QuickInfo)]
+        [WorkItem(403665, "https://devdiv.visualstudio.com/DevDiv/_workitems?id=403665&_a=edit")]
+        public async Task TestExceptionWithCrefToConstructorDoesNotCrash()
+        {
+            await TestAsync(
+@"
+class Test
+{
+    /// <summary>
+    /// </summary>
+    /// <exception cref=""Test.Test""/>
+    public Test$$() {}
+}
+",
+            MainDescription("Test.Test()"));
+        }
     }
 }
diff --git a/...ures/Core/Portable/DocumentationComments/AbstractDocumentationCommentFormattingService.cs b/...ures/Core/Portable/DocumentationComments/AbstractDocumentationCommentFormattingService.cs
@@ -213,6 +213,7 @@ internal static IEnumerable<SymbolDisplayPart> CrefToSymbolDisplayParts(
                 var symbol = DocumentationCommentId.GetFirstSymbolForDeclarationId(crefValue, semanticModel.Compilation);
                 if (symbol != null)
                 {
+                    format = format ?? SymbolDisplayFormat.MinimallyQualifiedFormat;
                     if (symbol.IsConstructor())
                     {
                         format = format.WithMemberOptions(SymbolDisplayMemberOptions.IncludeParameters | SymbolDisplayMemberOptions.IncludeExplicitInterface);