@@ -13,11 +13,11 @@ public import Foundation
1313
1414/// A request to convert in-memory documentation.
1515public struct ConvertRequest : Codable {
16- /// Information about the documentation bundle to convert.
16+ /// Information about the documentation catalog to convert.
1717 ///
1818 /// ## See Also
19- /// - ``DocumentationBundle/Info``
2019 public var bundleInfo : DocumentationContext . Inputs . Info
20+ /// - ``DocumentationContext/Inputs/Info``
2121
2222 /// Feature flags to enable when performing this convert request.
2323 public var featureFlags : FeatureFlags
@@ -51,16 +51,16 @@ public struct ConvertRequest: Codable {
5151 /// Whether the conversion's render reference store should be included in the response.
5252 ///
5353 /// The ``RenderReferenceStore`` contains compiled information for documentation nodes registered in a context. This
54- /// information can be used as a lightweight index of the available documentation content in the bundle that's been converted.
54+ /// information can be used as a lightweight index of the available documentation content in the context that's been converted.
5555 public var includeRenderReferenceStore : Bool ?
5656
57- /// The file location of the bundle to convert, if any.
57+ /// The file location of the catalog to convert, if any.
5858 public var bundleLocation : URL ?
5959
60- /// The symbols graph data included in the documentation bundle to convert.
60+ /// The symbols graph data included in the documentation catalog to convert.
6161 ///
6262 /// ## See Also
63- /// - ``DocumentationBundle /symbolGraphURLs``
63+ /// - ``DocumentationContext/Inputs /symbolGraphURLs``
6464 public var symbolGraphs : [ Data ]
6565
6666 /// The mapping of external symbol identifiers to lines of a documentation comment that overrides the value in the symbol graph.
@@ -72,20 +72,20 @@ public struct ConvertRequest: Codable {
7272 /// Whether the conversion's rendered documentation should include source file location metadata.
7373 public var emitSymbolSourceFileURIs : Bool
7474
75- /// The article and documentation extension file data included in the documentation bundle to convert.
75+ /// The article and documentation extension file data included in the documentation catalog to convert.
7676 ///
7777 /// ## See Also
78- /// - ``DocumentationBundle /markupURLs``
78+ /// - ``DocumentationContext/Inputs /markupURLs``
7979 public var markupFiles : [ Data ]
8080
8181
82- /// The tutorial file data included in the documentation bundle to convert.
82+ /// The tutorial file data included in the documentation catalog to convert.
8383 public var tutorialFiles : [ Data ]
8484
85- /// The on-disk resources in the documentation bundle to convert.
85+ /// The on-disk resources in the documentation catalog to convert.
8686 ///
8787 /// ## See Also
88- /// - ``DocumentationBundle /miscResourceURLs``
88+ /// - ``DocumentationContext/Inputs /miscResourceURLs``
8989 public var miscResourceURLs : [ URL ]
9090
9191 /// The symbol identifiers that have an expanded documentation page available if they meet the associated access level requirement.
@@ -97,22 +97,22 @@ public struct ConvertRequest: Codable {
9797
9898 /// Creates a request to convert in-memory documentation.
9999 /// - Parameters:
100- /// - bundleInfo: Information about the bundle to convert.
100+ /// - bundleInfo: Information about the catalog to convert.
101101 /// - featureFlags: Feature flags to enable when performing this convert request.
102102 /// - externalIDsToConvert: The external IDs of the symbols to convert.
103103 /// - documentPathsToConvert: The paths of the documentation nodes to convert.
104104 /// - includeRenderReferenceStore: Whether the conversion's render reference store should be included in the
105105 /// response.
106- /// - bundleLocation: The file location of the documentation bundle to convert, if any.
107- /// - symbolGraphs: The symbols graph data included in the documentation bundle to convert.
106+ /// - bundleLocation: The file location of the documentation catalog to convert, if any.
107+ /// - symbolGraphs: The symbols graph data included in the documentation catalog to convert.
108108 /// - overridingDocumentationComments: The mapping of external symbol identifiers to lines of a
109109 /// documentation comment that overrides the value in the symbol graph.
110110 /// - emitSymbolSourceFileURIs: Whether the conversion's rendered documentation should include source file location metadata.
111111 /// - knownDisambiguatedSymbolPathComponents: The mapping of external symbol identifiers to
112112 /// known disambiguated symbol path components.
113- /// - markupFiles: The article and documentation extension file data included in the documentation bundle to convert.
114- /// - tutorialFiles: The tutorial file data included in the documentation bundle to convert.
115- /// - miscResourceURLs: The on-disk resources in the documentation bundle to convert.
113+ /// - markupFiles: The article and documentation extension file data included in the documentation catalog to convert.
114+ /// - tutorialFiles: The tutorial file data included in the documentation catalog to convert.
115+ /// - miscResourceURLs: The on-disk resources in the documentation catalog to convert.
116116 /// - symbolIdentifiersWithExpandedDocumentation: A dictionary of identifiers to requirements for these symbols to have expanded
117117 /// documentation available.
118118 public init (
0 commit comments