Dokkatoo Gradle Plugin/dev.adamko.dokkatoo.formats/DokkatooFormatPlugin

DokkatooFormatPlugin

abstract class DokkatooFormatPlugin(val formatName: String) : Plugin<Project> (source)

Base Gradle Plugin for setting up a Dokka Publication for a specific format.

DokkatooBasePlugin must be applied for this plugin (or any subclass) to have an effect.

Anyone can use this class as a basis for a generating a Dokka Publication in a custom format.

Inheritors

DokkatooGfmPlugin

DokkatooHtmlPlugin

DokkatooJavadocPlugin

DokkatooJekyllPlugin

Constructors

DokkatooFormatPlugin

constructor(formatName: String)

Types

object Companion

DokkatooFormatPluginContext

@DokkatooInternalApi

class DokkatooFormatPluginContext(val project: Project, val dokkatooExtension: DokkatooExtension, val dokkatooTasks: DokkatooFormatTasks, val formatDependencies: FormatDependenciesManager, formatName: String)

Properties

val formatName: String

Functions

open override fun apply(target: Project)

open fun DokkatooFormatPlugin.DokkatooFormatPluginContext.configure()

Format specific configuration - to be implemented by subclasses