core/org.jetbrains.dokka/DokkaGenerator

DokkaGenerator

class DokkaGenerator(configuration: DokkaConfiguration, logger: DokkaLogger)

DokkaGenerator is the main entry point for generating documentation

generate method has been split into submethods for test reasons

Constructors

DokkaGenerator

fun DokkaGenerator(configuration: DokkaConfiguration, logger: DokkaLogger)

Functions

createAllModulePage

fun createAllModulePage(context: DokkaContext): RootPageNode

createDocumentationModels

fun createDocumentationModels(context: DokkaContext): List<DModule>

createPages

fun createPages(transformedDocumentation: DModule, context: DokkaContext): RootPageNode

equals

open operator fun equals(other: Any?): Boolean

generate

generateAllModulesPage

fun generateAllModulesPage()

hashCode

open fun hashCode(): Int

initializePlugins

fun initializePlugins(configuration: DokkaConfiguration, logger: DokkaLogger, additionalPlugins: List<DokkaPlugin> = emptyList()): DokkaContext

mergeDocumentationModels

fun mergeDocumentationModels(modulesFromPlatforms: List<DModule>, context: DokkaContext): DModule

render

fun render(transformedPages: RootPageNode, context: DokkaContext)

reportAfterRendering

fun reportAfterRendering(context: DokkaContext)

toString

open fun toString(): String

transformAllModulesPage

fun transformAllModulesPage(pages: RootPageNode, context: DokkaContext): RootPageNode

transformDocumentationModelAfterMerge

fun transformDocumentationModelAfterMerge(documentationModel: DModule, context: DokkaContext): DModule

transformDocumentationModelBeforeMerge

fun transformDocumentationModelBeforeMerge(modulesFromPlatforms: List<DModule>, context: DokkaContext): List<DModule>

transformPages

fun transformPages(pages: RootPageNode, context: DokkaContext): RootPageNode

validityCheck

fun validityCheck(context: DokkaContext)