quarkdown-quarkdoc-reader/com.quarkdown.quarkdoc.reader.json

Package-level declarations

Types

@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.

DocsIndexContentExtractor

class DocsIndexContentExtractor(function: IndexedFunction) : DocsContentExtractor

Extractor over a pre-extracted IndexedFunction: content is returned in Markdown.

DocsIndexWalker

class DocsIndexWalker(indexes: List<String>) : DocsWalker<DocsIndexContentExtractor>

Walker of pre-extracted DocsIndex payloads, the fast path over com.quarkdown.quarkdoc.reader.dokka.DokkaHtmlWalker: content is already in Markdown and requires no HTML processing.

IndexedFunction

@Serializable

data class IndexedFunction(val name: String, val moduleName: String?, val function: DocsFunction, val contentMarkdown: String?)

A function entry of a DocsIndex.

Properties

DOCS_INDEX_FILE_NAME

const val DOCS_INDEX_FILE_NAME: String

File name of the documentation index within the documentation root directory.

Functions

fromDirectoryOrNull

fun DocsIndexWalker.Companion.fromDirectoryOrNull(docsRoot: File): DocsIndexWalker?

readDocsIndexes

fun readDocsIndexes(docsRoot: File): List<String>

Recursively discovers DOCS_INDEX_FILE_NAME index files within docsRoot and reads their content. A documentation tree may carry multiple index files, one per documentation module.