Documentation Indexing

Create documentation indexes optimized for text search or navigation.

Overview

Each rendering model element adopts the TextIndexing protocol in order to provide its indexable text content to an indexer which can be later queried for searching specific content.

Topics

Search Index

Navigation Index

class NavigatorIndex
A NavigatorIndex contains all the necessary information to display the data inside a navigator. The data ranges from the tree to the necessary pieces of information to filter the content and perform actions in a fast way. A navigator index is created per bundle and needs a bundle identifier to correctly work. Anonymous bundles are allowed, but they limit the functionalities of the index.
class NavigatorTree
A NavigatorTree is a class holding information about a tree of data that can be navigated using a tree navigator.
struct RenderIndex
A navigation index of the content in a DocC archive, optimized for rendering.
class NavigatorItem
The NavigatorItem class describes a single entry in a navigator, providing the necessary information to display and process (such as filtering) a single item.