support documentation block comments

Author: matthewbastien

Sources/SourceKitLSP/Documentation/DocumentationManager.swift

@@ -156,31 +156,31 @@ fileprivate final class DocumentableSymbolFinder: SyntaxAnyVisitor {
     return visitor.result
   }
 
-  @discardableResult private func setResult(
-    node: some SyntaxProtocol,
-    position: AbsolutePosition
-  ) -> SyntaxVisitorContinueKind {
-    return setResult(
-      position,
-      node.leadingTrivia.compactMap { trivia in
-        switch trivia {
-        case .docLineComment(let comment):
-          return String(comment.dropFirst(3).trimmingCharacters(in: .whitespaces))
-        default:
-          return nil
+  private func setResult(node: some SyntaxProtocol, position: AbsolutePosition) {
+    setResult(
+      result: Symbol(
+        position: position,
+        documentationComments: node.leadingTrivia.flatMap { trivia -> [String] in
+          switch trivia {
+          case .docLineComment(let comment):
+            return [String(comment.dropFirst(3).trimmingCharacters(in: .whitespaces))]
+          case .docBlockComment(let comment):
+            return comment.dropFirst(3)
+              .dropLast(2)
+              .split(separator: "\n")
+              .map { String($0).trimmingCharacters(in: .whitespaces) }
+          default:
+            return []
+          }
         }
-      }
+      )
     )
   }
 
-  @discardableResult private func setResult(
-    _ symbolPosition: AbsolutePosition,
-    _ documentationComments: [String]
-  ) -> SyntaxVisitorContinueKind {
+  private func setResult(result symbol: Symbol) {
     if result == nil {
-      result = Symbol(position: symbolPosition, documentationComments: documentationComments)
+      result = symbol
     }
-    return .skipChildren
   }
 
   private func visitNamedDeclWithMemberBlock(
@@ -195,7 +195,7 @@ fileprivate final class DocumentableSymbolFinder: SyntaxAnyVisitor {
       in: memberBlock.children(viewMode: .sourceAccurate),
       at: cursorPosition
     ) {
-      setResult(child.position, child.documentationComments)
+      setResult(result: child)
     } else if node.range.contains(cursorPosition) {
       setResult(node: node, position: name.positionAfterSkippingLeadingTrivia)
     }

Tests/SourceKitLSPTests/ConvertDocumentationTests.swift

@@ -292,7 +292,7 @@ final class ConvertDocumentationTests: XCTestCase {
     )
   }
 
-  func testEditCommentInSwiftFile() async throws {
+  func testEditDocLineCommentInSwiftFile() async throws {
     let testClient = try await TestSourceKitLSPClient()
     let uri = DocumentURI(for: .swift)
     let positions = testClient.openDocument(
@@ -332,7 +332,7 @@ final class ConvertDocumentationTests: XCTestCase {
     )
   }
 
-  func testEditMultiLineCommentInSwiftFile() async throws {
+  func testEditMultipleDocLineCommentsInSwiftFile() async throws {
     let testClient = try await TestSourceKitLSPClient()
     let uri = DocumentURI(for: .swift)
     let positions = testClient.openDocument(
@@ -373,6 +373,50 @@ final class ConvertDocumentationTests: XCTestCase {
       expectedResponses: [.renderNode(kind: .symbol, containing: "This is an amazing description")]
     )
   }
+
+  func testEditDocBlockCommentInSwiftFile() async throws {
+    let testClient = try await TestSourceKitLSPClient()
+    let uri = DocumentURI(for: .swift)
+    let positions = testClient.openDocument(
+      """
+      /**
+      A structure containing important information
+
+      This is a0️⃣ description
+      */
+      public struct Structure {
+        let number: Int
+      }
+      """,
+      uri: uri
+    )
+
+    // Make sure that the initial documentation comment is present in the response
+    await convertDocumentation(
+      testClient: testClient,
+      uri: uri,
+      positions: positions,
+      expectedResponses: [.renderNode(kind: .symbol, containing: "This is a description")]
+    )
+
+    // Change the content of the documentation comment
+    testClient.send(
+      DidChangeTextDocumentNotification(
+        textDocument: VersionedTextDocumentIdentifier(uri, version: 2),
+        contentChanges: [
+          TextDocumentContentChangeEvent(range: positions["0️⃣"]..<positions["0️⃣"], text: "n amazing")
+        ]
+      )
+    )
+
+    // Make sure that the new documentation comment is present in the response
+    await convertDocumentation(
+      testClient: testClient,
+      uri: uri,
+      positions: positions,
+      expectedResponses: [.renderNode(kind: .symbol, containing: "This is an amazing description")]
+    )
+  }
 }
 
 fileprivate enum PartialConvertResponse {