rdar://147920933 (Support HeaderDoc tag)

Author: binamaniar

Package.resolved

@@ -134,7 +134,7 @@ if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
     // Building standalone, so fetch all dependencies remotely.
     package.dependencies += [
         .package(url: "https://github.com/apple/swift-nio.git", from: "2.53.0"),
-        .package(url: "https://github.com/swiftlang/swift-markdown.git", branch: "main"),
+        .package(url: "https://github.com/binamaniar/swift-markdown.git", branch: "support_abstract_headerdoc"),
         .package(url: "https://github.com/swiftlang/swift-lmdb.git", branch: "main"),
         .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.2"),
         .package(url: "https://github.com/swiftlang/swift-docc-symbolkit.git", branch: "main"),

Package.swift

@@ -359,6 +359,10 @@ struct RenderContentCompiler: MarkupVisitor {
         return renderableDirective.render(blockDirective, with: &self)
     }
 
+    mutating func visitDoxygenAbstract(_ doxygenAbstract: DoxygenAbstract) -> [any RenderContent] {
+        doxygenAbstract.children.flatMap { self.visit($0)}
+    }
+
     mutating func visitDoxygenDiscussion(_ doxygenDiscussion: DoxygenDiscussion) -> [any RenderContent] {
         doxygenDiscussion.children.flatMap { self.visit($0) }
     }

Sources/SwiftDocC/Model/Rendering/RenderContentCompiler.swift

@@ -19,6 +19,7 @@ class DoxygenTests: XCTestCase {
     func testDoxygenDiscussionAndNote() throws {
         let documentationLines: [SymbolGraph.LineList.Line] = """
             This is an abstract.
+            @abstract This is description with abstract.
 
             @discussion This is a discussion linking to ``AnotherClass`` and ``AnotherClass/prop``.
 
@@ -96,6 +97,7 @@ class DoxygenTests: XCTestCase {
 
         XCTAssertEqual(symbol.abstract?.format(), "This is an abstract.")
         XCTAssertEqual(symbol.discussion?.content.map { $0.format() }, [
+            #"\abstract This is description with abstract."#,
             #"\discussion This is a discussion linking to ``doc://unit-test/documentation/ModuleName/AnotherClass`` and ``doc://unit-test/documentation/ModuleName/AnotherClass/prop``."#,
             #"\note This is a note linking to ``doc://unit-test/documentation/ModuleName/Class3`` and ``Class3/prop2``."#
         ])
@@ -108,10 +110,10 @@ class DoxygenTests: XCTestCase {
         XCTAssertEqual(renderNode.primaryContentSections.count, 1)
 
         let overviewSection = try XCTUnwrap(renderNode.primaryContentSections.first as? ContentRenderSection)
-        XCTAssertEqual(overviewSection.content.count, 3)
+        XCTAssertEqual(overviewSection.content.count, 4)
         XCTAssertEqual(overviewSection.content, [
             .heading(.init(level: 2, text: "Overview", anchor: "overview")),
-
+            .paragraph(.init(inlineContent: [.text("This is description with abstract.")])),
             .paragraph(.init(inlineContent: [
                 .text("This is a discussion linking to "),
                 .reference(