Search Gradle plugins

org.jetbrains.dokka-javadoc

Owner: Kotlin Team

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-Beta (latest)

2.0.0-Beta

Created 03 October 2024.

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.

Using the plugins DSL:

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

Using legacy plugin application:

buildscript {
  repositories {
    maven {
      url = uri("https://plugins.gradle.org/m2/")
    }
  }
  dependencies {
    classpath("org.jetbrains.dokka:dokka-gradle-plugin:2.0.0-Beta")
  }
}

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

Using the plugins DSL:

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

Using legacy plugin application:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "org.jetbrains.dokka:dokka-gradle-plugin:2.0.0-Beta"
  }
}

apply plugin: "org.jetbrains.dokka-javadoc"

Learn how to apply plugins to subprojects