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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 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 converter from documentation nodes to render nodes.
public struct DocumentationNodeConverter {
/// The context the converter uses to resolve references it finds in the documentation node's content.
let context: DocumentationContext
/// The bundle that contains the content from which the documentation node originated.
let bundle: DocumentationBundle
/// Creates a new node converter for the given bundle and context.
///
/// The converter uses bundle and context to resolve references to other documentation and describe the documentation hierarchy.
///
/// - Parameters:
/// - bundle: The bundle that contains the content from which the documentation node originated.
/// - context: The context that the converter uses to to resolve references it finds in the documentation node's content.
public init(bundle: DocumentationBundle, context: DocumentationContext) {
self.bundle = bundle
self.context = context
}
/// Converts a documentation node to a render node.
///
/// Convert a documentation node into a render node to get a self-contained, persistable representation of a given topic's data, so you can write it to disk, send it over a network, or otherwise process it.
/// - Parameters:
/// - node: The documentation node to convert.
/// - source: The source file for the documentation node.
/// - Returns: The render node representation of the documentation node.
public func convert(_ node: DocumentationNode, at source: URL?) throws -> RenderNode {
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference, source: source)
return translator.visit(node.semantic) as! RenderNode
}
}
|
