DocsIndex

@Serializable
data class DocsIndex(val functions: List<IndexedFunction>)

Pre-extracted documentation index, generated at documentation build time by the Quarkdoc Dokka plugin, so that consumers (e.g. the language server) can read function documentation without parsing HTML.

The JSON format is defined by docs-index.schema.json in the Quarkdoc module's root.

Parameters

functions

the indexed functions

Constructors

Link copied to clipboard
constructor(functions: List<IndexedFunction>)

Properties

Link copied to clipboard