DocumentationContext

The documentation context manages the in-memory model for the built documentation.

class DocumentationContext

Mentioned In

Overview

When a documentation bundle is registered with the context, all of its content is loaded into memory and relationships between documentation entities are built. When this is done, the context can be queried about documentation entities, resources, and relationships between entities.

Topics

Getting documentation resources

func entity(with: ResolvedTopicReference) throws(ContextError) -> DocumentationNode
Look for a documentation node among the registered bundles and via any external resolvers.
func resource(with: ResourceReference, trait: DataTraitCollection) throws -> Data
Look for a secondary resource among the registered bundles.

Getting documentation relationships

func children(of: ResolvedTopicReference, kind: DocumentationNode.Kind?) -> [(reference: ResolvedTopicReference, kind: DocumentationNode.Kind)]
Fetch the child nodes of a documentation node with the given reference, optionally filtering to only children of the given kind.
func parents(of: ResolvedTopicReference) -> [ResolvedTopicReference]
Fetches the parents of the documentation node with the given reference.

Structures

struct Configuration
A collection of configuration to apply to a documentation context during initialization.
struct Inputs
A collection of the build inputs for a unit of documentation.
struct InputsProvider
A type that provides inputs for a unit of documentation.

Initializers

init(inputs: DocumentationContext.Inputs, dataProvider: any DataProvider, diagnosticEngine: DiagnosticEngine, configuration: Configuration) async throws
Initializes a documentation context from a collection of input files.

Instance Properties

let configuration: Configuration
A collection of configuration for this context.
var diagnosticEngine: DiagnosticEngine
The engine that collects diagnostics encountered while registering and processing the documentation bundles in this context.
var diagnostics: [Diagnostic]
A convenient accessor for the diagnostic engine’s list of diagnostics.
var knownIdentifiers: [ResolvedTopicReference]
The references of all nodes in the topic graph.
var knownPages: [ResolvedTopicReference]
The references of all the pages in the topic graph.
var linkResolver: LinkResolver
A class that resolves documentation links by orchestrating calls to other link resolver implementations.
var manuallyCuratedReferences: Set<ResolvedTopicReference>?
The set of all manually curated references if shouldStoreManuallyCuratedReferences was true at the time of processing and has remained true since.. Nil if curation has not been processed yet.
var problems: [Problem]
var rootModules: [ResolvedTopicReference]!
The root module nodes of the Topic Graph.
var tutorialTableOfContentsReferences: [ResolvedTopicReference]
The tutorial table-of-contents nodes in the topic graph.

Instance Methods

func documentURL(for: ResolvedTopicReference) -> URL?
Returns the document URL for the given article or tutorial reference.
func documentationExtensionURL(for: ResolvedTopicReference) -> URL?
Returns the URL of the documentation extension of the given reference.
func identifier(forAssetName: String, in: ResolvedTopicReference) -> String?
Finds the identifier for a given asset name.
func referenceForFileURL(URL) -> ResolvedTopicReference?
Attempt to locate the reference for a given file.
func registeredDownloadsAssets(for: DocumentationContext.Inputs.Identifier) -> [DataAsset]
Returns a list of all the download assets that registered for a given bundleIdentifier.
func registeredImageAssets(for: DocumentationContext.Inputs.Identifier) -> [DataAsset]
Returns a list of all the image assets that registered for a given bundleIdentifier.
func registeredVideoAssets(for: DocumentationContext.Inputs.Identifier) -> [DataAsset]
Returns a list of all the video assets that registered for a given bundleIdentifier.
func resolve(TopicReference, in: ResolvedTopicReference, fromSymbolLink: Bool) -> TopicReferenceResolutionResult
Attempt to resolve a TopicReference .
func resolveAsset(named: String, in: ResolvedTopicReference, withType: AssetType?) -> DataAsset?
Attempt to resolve an asset given its name and the topic it’s referenced in.
func resourceExists(with: ResourceReference, ofType: AssetType?) -> Bool
Returns true if a resource with the given identifier exists in the registered bundle.
func sourceLanguages(for: ResolvedTopicReference) -> Set<SourceLanguage>
Returns the set of languages the entity corresponding to the given reference is available in.
func title(for: ResolvedTopicReference) -> String?
Attempt to retrieve the title for a given reference.
func updateAsset(named: String, asset: DataAsset, in: ResolvedTopicReference)
Update the asset with a new value given the assets name and the topic it’s referenced in.

Type Methods

static func isFileExtension(String, supported: AssetType) -> Bool
Checks if a given fileExtension is supported as a type of asset.

Enumerations

enum AssetType
A type of asset.
enum ContextError
An error that’s encountered while interacting with a DocumentationContext .