Search Gradle plugins

org.jetbrains.dokka-javadoc

Dokka is the API documentation engine for Kotlin. This plugin generates output that looks like Javadoc websites. See https://kotlinlang.org/docs/dokka-javadoc.html for more information. The Javadoc output format is still in Alpha, so you may find bugs and experience migration issues when using it. Successful integration with tools that accept Java's Javadoc HTML as input is not guaranteed. You use it at your own risk.

https://kotl.in/dokka

Sources: https://github.com/kotlin/dokka.git

Version 2.0.0 (latest)

Created 16 December 2024.

Add this plugin to your build using the plugins DSL:

plugins {
  id("org.jetbrains.dokka-javadoc") version "2.0.0"
}

See also:

Adding the plugin to build logic for usage in precompiled script plugins.

See the relevant documentation for more information.

Add this plugin as a dependency to <convention-plugins-build>/build.gradle(.kts):
```
dependencies {
  implementation("org.jetbrains.dokka-javadoc:org.jetbrains.dokka-javadoc.gradle.plugin:2.0.0")
}
```
It can then be applied in the precompiled script plugin:
```
plugins {
  id("org.jetbrains.dokka-javadoc")
}
```

The legacy method of plugin application.

See the relevant documentation for more information.

buildscript {
  repositories {
    gradlePluginPortal()
  }
  dependencies {
    classpath("org.jetbrains.dokka-javadoc:org.jetbrains.dokka-javadoc.gradle.plugin:2.0.0")
  }
}

apply(plugin = "org.jetbrains.dokka-javadoc")

Applying plugins to all subprojects .