Package-level declarations
Types
Link copied to clipboard
abstract class DocumentablePageTransformer<D : Documentable>(context: DokkaContext) : PageTransformer
A PageTransformer that features a ready-to-use content builder for building documentation pages for Documentables of type D.
Link copied to clipboard
class DocumentTypeConstraintsPageTransformer(context: DokkaContext) : NewSectionDocumentablePageTransformer<DFunction, List<DocumentType>>
Given a function that is constrained to specific document types, this page transformer explains these constraints in a new section of the documentation page.
Link copied to clipboard
class LikelyChainedPageTransformer(context: DokkaContext) : NewSectionDocumentablePageTransformer<DFunction, Boolean>
Transformer that generates a new section for the @wiki documentation tag of a function, with a link to the corresponding wiki page.
Link copied to clipboard
abstract class NewSectionDocumentablePageTransformer<D : Documentable, T>(title: String, context: DokkaContext) : DocumentablePageTransformer<D>
A org.jetbrains.dokka.transformers.pages.PageTransformer that creates a new titled section in the documentation page of a Documentable. For instance, Parameters, Return, See also, etc. are titled sections.
Link copied to clipboard
class WikiLinkPageTransformer(context: DokkaContext) : NewSectionDocumentablePageTransformer<DFunction, String>
Transformer that generates a new section for the @wiki documentation tag of a function, with a link to the corresponding wiki page.