1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
public import Foundation
public import Markdown
/**
A general purpose comment directive. All contents inside are stripped from
> Warning: Content inside a comment should be considered absolutely confidential to the author. Never emit comments in anything that an end-user can receive. As an example, comments should not be emitted in ``RenderNode`` JSON.
*/
public final class Comment: Semantic, DirectiveConvertible {
public static let directiveName = "Comment"
public static let introducedVersion = "5.5"
public let originalMarkup: BlockDirective
/// The comment content.
public let content: MarkupContainer
override var children: [Semantic] {
return [content]
}
init(originalMarkup: BlockDirective, content: MarkupContainer) {
self.originalMarkup = originalMarkup
self.content = content
}
public convenience init?(from directive: BlockDirective, source: URL?, for _: DocumentationBundle, problems: inout [Problem]) {
precondition(directive.name == Comment.directiveName)
self.init(originalMarkup: directive, content: MarkupContainer(directive.children))
}
}
|
