DocumentedFunction

data class DocumentedFunction(val data: DocsFunction, val rawData: DocsWalker.Result<*>, val documentationAsMarkup: MarkupContent?)

Cached information extracted from the Quarkdown documentation about a function.

Parameters

data

the processed function data

rawData

the raw data from the documentation walker

documentationAsMarkup

the documentation content as markup, if available, supported by the LSP

Constructors

Link copied to clipboard
constructor(data: DocsFunction, rawData: DocsWalker.Result<*>, documentationAsMarkup: MarkupContent?)

Properties

Link copied to clipboard
Link copied to clipboard
val documentationAsMarkup: MarkupContent?
Link copied to clipboard

The name of the function.

Link copied to clipboard

Functions

Link copied to clipboard
fun DocumentedFunction.toCompletionItem(chained: Boolean): CompletionItem

Converts a DocumentedFunction to a CompletionItem for use in function name completion.