ConvertOutputConsumer

A consumer for output produced by a documentation conversion.

protocol ConvertOutputConsumer

Discussion

Types that conform to this protocol manage what to do with documentation conversion products, for example persist them to disk or store them in memory.

Topics

Instance Methods

func consume(assets: [RenderReferenceType : [any RenderReference]]) throws
Consumes the assets and their variants that were registered during a conversion.
func consume(assetsInBundle: DocumentationBundle) throws
Consumes a documentation bundle with the purpose of extracting its on-disk assets.
func consume(benchmarks: Benchmark) throws
Consumes benchmarks collected during a conversion.
func consume(buildMetadata: BuildMetadata) throws
Consumes build metadata created during a conversion.
func consume(documentationCoverageInfo: [CoverageDataEntry]) throws
Consumes documentation coverage info created during a conversion.
func consume(indexingRecords: [IndexingRecord]) throws
Consumes the indexing records produced during a conversion.
func consume(linkResolutionInformation: SerializableLinkResolutionInformation) throws
Consumes a file representation of the local link resolution information.
func consume(linkableElementSummaries: [LinkDestinationSummary]) throws
Consumes the linkable element summaries produced during a conversion.
func consume(page: XMLNode, for: ResolvedTopicReference) throws
func consume(renderNode: RenderNode) throws
Consumes a render node that was generated during a conversion.
func consume(renderReferenceStore: RenderReferenceStore) throws
Consumes a render reference store creating during a conversion.