Prettify hover response

Makes symbol name the same size as the rest of text, and puts a dividing line between declaration and the rest of the documentation. It makes the output similar to other language servers (dart, typescript, C)

Author: Trzyipolkostkicukru

Sources/SourceKit/sourcekitd/CommentXML.swift

@@ -77,8 +77,8 @@ private struct XMLToMarkdown {
       newlineIfNeeded(count: 2)
       out += "```\n"
       toMarkdown(node.children)
-      out += "\n```"
-
+      out += "\n```\n\n---\n"
+      
     case "Name", "USR", "Direction":
       break
 

Sources/SourceKit/sourcekitd/SwiftLanguageServer.swift

@@ -624,7 +624,7 @@ extension SwiftLanguageServer {
         return String(str.flatMap({ ($0 == "*" || $0 == "_") ? ["\\", $0] : [$0] }))
       }
 
-      var result = "# \(escapeNameMarkdown(name))"
+      var result = escapeNameMarkdown(name)
       if let doc = cursorInfo.documentationXML {
         result += """
 

Tests/SourceKitTests/LocalSwiftTests.swift

@@ -787,20 +787,29 @@ final class LocalSwiftTests: XCTestCase {
       ```
       func foo(_ bar: Baz)
       ```
+
+      ---
+
       """)
     XCTAssertEqual(try! xmlDocumentationToMarkdown("""
       <Declaration>func foo() -&gt; <Type>Bar</Type></Declaration>
       """), """
       ```
       func foo() -> Bar
       ```
+
+      ---
+
       """)
     XCTAssertEqual(try! xmlDocumentationToMarkdown("""
       <Declaration>func replacingOccurrences&lt;Target, Replacement&gt;(of target: Target, with replacement: Replacement, options: <Type usr="s:SS">String</Type>.<Type usr="s:SS10FoundationE14CompareOptionsa">CompareOptions</Type> = default, range searchRange: <Type usr="s:Sn">Range</Type>&lt;<Type usr="s:SS">String</Type>.<Type usr="s:SS5IndexV">Index</Type>&gt;? = default) -&gt; <Type usr="s:SS">String</Type> where Target : <Type usr="s:Sy">StringProtocol</Type>, Replacement : <Type usr="s:Sy">StringProtocol</Type></Declaration>
       """), """
       ```
       func replacingOccurrences<Target, Replacement>(of target: Target, with replacement: Replacement, options: String.CompareOptions = default, range searchRange: Range<String.Index>? = default) -> String where Target : StringProtocol, Replacement : StringProtocol
       ```
+
+      ---
+
       """)
   }
 
@@ -811,6 +820,9 @@ final class LocalSwiftTests: XCTestCase {
       ```
       var foo
       ```
+
+      ---
+
       """)
 
     XCTAssertEqual(try! xmlDocumentationToMarkdown("""
@@ -819,13 +831,19 @@ final class LocalSwiftTests: XCTestCase {
       ```
       var foo
       ```
+
+      ---
+
       """)
     XCTAssertEqual(try! xmlDocumentationToMarkdown("""
       <Class><USR>asdf</USR><Declaration>var foo</Declaration><Name>foo</Name></Class>
       """), """
       ```
       var foo
       ```
+
+      ---
+
       """)
 
     XCTAssertEqual(try! xmlDocumentationToMarkdown("""
@@ -841,6 +859,9 @@ final class LocalSwiftTests: XCTestCase {
       ```
       var foo
       ```
+
+      ---
+
       """)
 
     XCTAssertEqual(try! xmlDocumentationToMarkdown("""
@@ -970,6 +991,7 @@ final class LocalSwiftTests: XCTestCase {
       struct String
       ```
 
+      ---
       A Unicode s
 
       ### Discussion
@@ -1135,11 +1157,12 @@ final class LocalSwiftTests: XCTestCase {
         }
         XCTAssertEqual(content.kind, .markdown)
         XCTAssertEqual(content.value, """
-          # S
+          S
           ```
           struct S
           ```
 
+          ---
           This is a doc comment for S.
 
           ### Discussion
@@ -1186,11 +1209,12 @@ final class LocalSwiftTests: XCTestCase {
         }
         XCTAssertEqual(content.kind, .markdown)
         XCTAssertEqual(content.value, ##"""
-          # test(\_:\_:)
+          test(\_:\_:)
           ```
           func test(_ a: Int, _ b: Int)
           ```
 
+          ---
           this is **bold** documentation
           """##)
       }
@@ -1210,11 +1234,12 @@ final class LocalSwiftTests: XCTestCase {
         }
         XCTAssertEqual(content.kind, .markdown)
         XCTAssertEqual(content.value, ##"""
-          # \*%\*(\_:\_:)
+          \*%\*(\_:\_:)
           ```
           func *%* (lhs: String, rhs: String)
           ```
 
+          ---
           this is *italic* documentation
           """##)
       }