Dokkatoo Gradle Plugin/dev.adamko.dokkatoo.dokka.plugins/DokkaHtmlPluginParameters

DokkaHtmlPluginParameters

abstract class DokkaHtmlPluginParameters @DokkatooInternalApi @Inject constructor(name: String) : DokkaPluginParametersBaseSpec(source)

Configuration for Dokka's base HTML format

More information is available in the Dokka docs.

Constructors

Link copied to clipboard
@DokkatooInternalApi
@Inject
constructor(name: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:Optional
abstract val customAssets: ConfigurableFileCollection

List of paths for image assets to be bundled with documentation. The image assets can have any file extension.

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:Optional
abstract val customStyleSheets: ConfigurableFileCollection

List of paths for .css stylesheets to be bundled with documentation and used for rendering.

Link copied to clipboard
@get:Input
@get:Optional
abstract val footerMessage: Property<String>

The text displayed in the footer.

Link copied to clipboard
@get:Input
@get:Optional
abstract val homepageLink: Property<String>

Creates a link to the project's homepage URL in the HTML header.

Link copied to clipboard
@get:Input
@get:Optional
abstract val mergeImplicitExpectActualDeclarations: Property<Boolean>

This is a boolean option. If set to true, Dokka merges declarations that are not declared as expect/actual, but have the same fully qualified name. This can be useful for legacy codebases.

Link copied to clipboard
@get:Input
open val pluginFqn: String
Link copied to clipboard
@get:Input
@get:Optional
abstract val separateInheritedMembers: Property<Boolean>

This is a boolean option. If set to true, Dokka renders properties/functions and inherited properties/inherited functions separately.

Link copied to clipboard
@get:InputDirectory
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:Optional
abstract val templatesDir: DirectoryProperty

Path to the directory containing custom HTML templates.

Functions

Link copied to clipboard
@Input
open override fun getName(): String
Link copied to clipboard
open override fun jsonEncode(): String