quarkdown-lsp/com.quarkdown.lsp.documentation

Package-level declarations

Types

data class DirectoryDocsIndexSource(directory: File) : DocsIndexSource

A DocsIndexSource that recursively discovers index files within a local directory.

Source of pre-extracted documentation index payloads (DOCS_INDEX_FILE_NAME), abstracting away how the indexes are located and read: from the installation's docs directory on the JVM, or fetched over the network in browser deployments.

Functions

getDocumentation

fun getDocumentation(docs: DocsIndexSource, name: String): DocumentedFunction?

Retrieves the documentation for a function in the specified documentation directory.

getDocumentation

fun FunctionCall.getDocumentation(docs: DocsIndexSource): DocumentedFunction?

Retrieves the documentation for a function call in the specified documentation directory.