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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2024 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
*/
import Foundation
/// A parsed Doxygen `\note` command.
///
/// The Doxygen support in Swift-Markdown parses `\note` commands of the form
/// `\note description`, where `description` continues until the next blank
/// line or parsed command.
///
/// ```markdown
/// \note This method is only meant to be called an odd number of times.
/// ```
public struct DoxygenNote: BlockContainer {
public var _data: _MarkupData
init(_ raw: RawMarkup) throws {
guard case .doxygenNote = raw.data else {
throw RawMarkup.Error.concreteConversionError(from: raw, to: DoxygenNote.self)
}
let absoluteRaw = AbsoluteRawMarkup(markup: raw, metadata: MarkupMetadata(id: .newRoot(), indexInParent: 0))
self.init(_MarkupData(absoluteRaw))
}
init(_ data: _MarkupData) {
self._data = data
}
public func accept<V: MarkupVisitor>(_ visitor: inout V) -> V.Result {
return visitor.visitDoxygenNote(self)
}
}
public extension DoxygenNote {
/// Create a new Doxygen note definition.
///
/// - Parameter children: Block child elements.
init<Children: Sequence>(children: Children) where Children.Element == BlockMarkup {
try! self.init(.doxygenNote(parsedRange: nil, children.map({ $0.raw.markup })))
}
/// Create a new Doxygen note definition.
///
/// - Parameter children: Block child elements.
init(children: BlockMarkup...) {
self.init(children: children)
}
}
|
