Initializer
init(context:renderContext:emitSymbolSourceFileURIs:emitSymbolAccessLevels:sourceRepository:symbolIdentifiersWithExpandedDocumentation:)
Creates a new node converter for the given context.
init(context: DocumentationContext, renderContext: RenderContext, emitSymbolSourceFileURIs: Bool = false, emitSymbolAccessLevels: Bool = false, sourceRepository: SourceRepository? = nil, symbolIdentifiersWithExpandedDocumentation: [String]? = nil)
Parameters
contextThe context that the converter uses to to resolve references it finds in the documentation node’s content.
renderContextA context that contains common pre-rendered pieces of content.
emitSymbolSourceFileURIsWhether the documentation converter should include source file location metadata in any render nodes representing symbols it creates.
Before passing true please confirm that your use case doesn’t include public distribution of any created render nodes as there are filesystem privacy and security concerns with distributing this data.
emitSymbolAccessLevelsWhether the documentation converter should include access level information for symbols.
sourceRepositoryThe source repository where the documentation’s sources are hosted.
symbolIdentifiersWithExpandedDocumentationA list of symbol IDs that have version of their documentation page with more content that a renderer can link to.
Discussion
The converter uses bundle and context to resolve references to other documentation and describe the documentation hierarchy.