Package-level declarations

Types

Link copied to clipboard
class DocsIndexCollectorTransformer(context: DokkaContext) : PreMergeDocumentableTransformer

Transformer that collects the documentation index data of Quarkdown module functions directly from the Dokka model, into DocsIndexStorage.

Link copied to clipboard

Storage of function data collected from the Dokka model by DocsIndexCollectorTransformer, later joined with rendered content and written out by DocsIndexWriterPostAction.

Link copied to clipboard
class DocsIndexWriterPostAction(context: DokkaContext) : PostAction

Post-rendering action that writes the documentation index, DOCS_INDEX_FILE_NAME, into the output directory root.

Link copied to clipboard

Renderer of KDoc DocTag trees to Markdown, used to pre-extract documentation into the docs index directly from the Dokka model.

Link copied to clipboard

Extractor of the main content of Dokka-generated HTML files, used by DocsIndexWriterPostAction to pre-extract each function's documentation.

Link copied to clipboard

Recursive walker of Dokka HTML files.

Link copied to clipboard

Helper to convert documentation HTML to Markdown.

Properties

Link copied to clipboard

A package/directory segment with this name marks a Quarkdown module: module functions live in <package>.module.<Name> synthetic packages.