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

DokkatooFormatPluginContext

@DokkatooInternalApi

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

Constructors

DokkatooFormatPluginContext

constructor(project: Project, dokkatooExtension: DokkatooExtension, dokkatooTasks: DokkatooFormatTasks, formatDependencies: FormatDependenciesManager, formatName: String)

Properties

addDefaultDokkaDependencies

var addDefaultDokkaDependencies: Boolean

dokkatooExtension

val dokkatooExtension: DokkatooExtension

val dokkatooTasks: DokkatooFormatTasks

enableVersionAlignment

var enableVersionAlignment: Boolean

formatDependencies

val formatDependencies: FormatDependenciesManager

val project: Project

Functions

fun DependencyHandler.dokka(module: String): Provider<Dependency>

Create a Dependency for a Dokka module

fun DependencyHandler.dokkaGenerator(dependency: String)

fun DependencyHandler.dokkaGenerator(dependency: Provider<Dependency>)

Add a dependency to the Dokka Generator classpath

fun DependencyHandler.dokkaPlugin(dependency: String)

fun DependencyHandler.dokkaPlugin(dependency: Provider<Dependency>)

Add a dependency to the Dokka plugins classpath