DocumentationContext

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

class DocumentationContext

Mentioned In

Discussion

A DocumentationWorkspace discovers serialized documentation bundles from a variety of sources (files on disk, databases, or web services), provides them to the DocumentationContext, and notifies the context when bundles are added or removed using the DocumentationContextDataProviderDelegate protocol.

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

Getting documentation relationships

Structures

struct Configuration
A collection of configuration to apply to a documentation context during initialization.

Instance Properties

Instance Methods

Type Aliases

typealias ReferenceCheck
A closure type getting the information about a reference in a context and returns any possible problems with it.

Type Methods

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