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

IndexedFunction

@Serializable

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

A function entry of a DocsIndex.

Parameters

name

the name of the documentation resource

moduleName

the name of the Quarkdown module containing the function

function

the function data, with parameter descriptions in Markdown

contentMarkdown

the function's documentation content, in Markdown

Constructors

IndexedFunction

constructor(name: String, moduleName: String?, function: DocsFunction, contentMarkdown: String?)

Properties

contentMarkdown

val contentMarkdown: String?

val function: DocsFunction

val moduleName: String?

val name: String