Add support for @Comment in doc comments

Adds support for `@Comment` directives in documentation comments. They don't hurt anyone, so might as well allow them.
swiftlang · Dec 11, 2024 · a5c523e · a5c523e
1 parent 7e9579a
commit a5c523e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/Sources/SwiftDocC/Model/DocumentationNode.swift b/Sources/SwiftDocC/Model/DocumentationNode.swift
@@ -848,6 +848,7 @@ public struct DocumentationNode {
 }
 
 private let directivesSupportedInDocumentationComments = [
+        Comment.directiveName,
         Metadata.directiveName,
         DeprecationSummary.directiveName,
     ]

diff --git a/Tests/SwiftDocCTests/Semantics/SymbolTests.swift b/Tests/SwiftDocCTests/Semantics/SymbolTests.swift
@@ -1338,6 +1338,19 @@ class SymbolTests: XCTestCase {
             "This is the deprecation summary."
         )
     }
+
+    func testAllowsCommentDirectiveInDocComment() throws {
+        let (_, problems) = try makeDocumentationNodeForSymbol(
+            docComment: """
+                The symbol's abstract.
+
+                @Comment(This is a comment)
+                """,
+            articleContent: nil
+        )
+
+        XCTAssert(problems.isEmpty)
+    }
 
     // MARK: - Helpers