Structure
NavigationIndex
Represents the navigation index for documentation.
struct NavigationIndexOverview
This type parses the index.json file from a DocC archive to build a hierarchical navigation tree for the sidebar.
Topics
Structures
S
NavigationIndex.SchemaVersion
The schema version structure.
Initializers
Instance Properties
V
includedArchiveIdentifiers
The included archive identifiers.
V
interfaceLanguages
The navigation trees organised by interface language.
V
schemaVersion
The schema version of the index.
Instance Methods
F
allModules(language:)
Returns all module nodes in this index.
F
findModule(_:language:)
Finds the navigation tree for a specific module.
Type Methods
?
load(from:)
Loads a navigation index from a JSON file.
?
merge(_:)
Merges multiple navigation indices into a single combined index.