QuarkdocDokkaPlugin
Dokka plugin that generates ad-hoc documentation for native Quarkdown functions.
Properties
Like documentPositiveTypeConstraintsTransformer but for the negative case, via @NotForDocumentType.
Given a function annotated with @OnlyForDocumentType which defines constraints about the document type the function supports, this transformer stores this data for documentTypeConstraintsPageTransformer to display it.
Displays the document type constraints produced by documentTypeConstraintsTransformer in the documentation.
Lists enum entries in the documentation for parameters that expect an enum.
Stores enum declarations, to be used in enumParameterEntryListerTransformer.
Generates a new section for likely chained functions.
Quarkdown modules, defined by a com.quarkdown.core.function.library.loader.Module property, contain the functions declared in the same source file and are shown in the documentation as packages.
Stores the modules in which the functions are declared, to be used in moduleAsPackageTransformer.
Generates a new section listing the permissions required by a function, from @permission tags.
Generates Quarkdown signatures for functions in Quarkdown modules.
Suppresses top-level source-side @QFunctions so only the KSP-generated wrappers (which already carry exported names in their signature and rewritten KDoc) reach the docs.
Parameters annotated with @Injected are hidden (suppressed) in the generated documentation.
Renames references of com.quarkdown.core.function.value.Value, and subclasses, in the signature to a more human-readable form.
Generates a new section for the @wiki documentation tag with a link to the corresponding wiki page.