FunctionDescriptor

data class FunctionDescriptor(val originalName: String, val exportedName: String, val qualifiedName: String, val returnType: KSType, val parameters: List<ParameterDescriptor>, val declaration: KSFunctionDeclaration, val sourceAnnotations: String?, val kdoc: String?)

A native Quarkdown function discovered within a ModuleDescriptor.

Corresponds to a top-level Kotlin function annotated with com.quarkdown.processor.annotation.QFunction inside a com.quarkdown.processor.annotation.QModule file.

Parameters

originalName

Kotlin simple name of the source function (used to invoke the original from the wrapper)

exportedName

name exposed to Quarkdown after applying @Name to the function; falls back to originalName when absent

qualifiedName

fully qualified name of the source function

returnType

resolved return type of the source function

parameters

function parameters in declaration order

declaration

the underlying KSP declaration

sourceAnnotations

verbatim source text of function-level annotations to propagate to the wrapper, or null when the function has none

kdoc

raw KDoc block text of the source function (inner content, no /** */ markers), or null when the function is undocumented; copied to the wrapper by the code generator after names have been substituted

Constructors

Link copied to clipboard
constructor(originalName: String, exportedName: String, qualifiedName: String, returnType: KSType, parameters: List<ParameterDescriptor>, declaration: KSFunctionDeclaration, sourceAnnotations: String?, kdoc: String?)

Properties

Link copied to clipboard
val declaration: KSFunctionDeclaration
Link copied to clipboard
Link copied to clipboard
val kdoc: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val returnType: KSType
Link copied to clipboard