diff options
8 files changed, 23 insertions, 23 deletions
@@ -51,7 +51,7 @@ dokka { Kotlin ```kotlin -tasks.dokkaKdoc { +tasks.dokkaHtml { outputDirectory = "$buildDir/dokka" } ``` @@ -190,7 +190,7 @@ kotlin { // Kotlin Multiplatform plugin configuration js("customName") // Define a js platform named "customName" If you want to generate docs for it, you need to have this name in dokka configuration below } -dokkaKdoc { +dokkaHtml { outputDirectory = "$buildDir/dokka" multiplatform { @@ -220,7 +220,7 @@ kotlin { // Kotlin Multiplatform plugin configuration js("customName") } -dokkaKdoc { +dokkaHtml { outputDirectory = "$buildDir/dokka" multiplatform { @@ -246,7 +246,7 @@ dokkaKdoc { For convenience, there is also a reserved block called `global`, which is a top-level configuration of `perPackageOptions`, `externalDocumentationLinks`, and `sourceLinks` shared by every platform. Eg. ```groovy -dokkaKdoc { +dokkaHtml { multiplatform { global { // perPackageOptions, sourceLinks and externalDocumentationLinks from here will be copied to every other platform (jvm and js in eg.) perPackageOption { diff --git a/integration-tests/gradle/projects/it-basic-groovy/build.gradle b/integration-tests/gradle/projects/it-basic-groovy/build.gradle index 05b680a1..1ffa75bc 100644 --- a/integration-tests/gradle/projects/it-basic-groovy/build.gradle +++ b/integration-tests/gradle/projects/it-basic-groovy/build.gradle @@ -9,8 +9,8 @@ dependencies { implementation "org.jetbrains.kotlin:kotlin-stdlib" } -dokkaKdoc { - outputDirectory = "$buildDir/dokka/customKdoc" +dokkaHtml { + outputDirectory = "$buildDir/dokka/customHtml" failOnWarning = false dokkaSourceSets { diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt index 87460080..9ea47d96 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt @@ -29,21 +29,21 @@ class BasicGradleIntegrationTest(override val versions: BuildVersions) : Abstrac @Test fun execute() { - val result = createGradleRunner("dokkaKdoc", "dokkaJavadoc", "dokkaGfm", "dokkaJekyll", "--stacktrace").build() + val result = createGradleRunner("dokkaHtml", "dokkaJavadoc", "dokkaGfm", "dokkaJekyll", "--stacktrace").build() - assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaKdoc")).outcome) + assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaHtml")).outcome) assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaJavadoc")).outcome) assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaGfm")).outcome) assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaJekyll")).outcome) - File(projectDir, "build/dokka/kdoc").assertKdocOutputDir() + File(projectDir, "build/dokka/html").assertKdocOutputDir() File(projectDir, "build/dokka/javadoc").assertJavadocOutputDir() File(projectDir, "build/dokka/gfm").assertGfmOutputDir() File(projectDir, "build/dokka/jekyll").assertJekyllOutputDir() } private fun File.assertKdocOutputDir() { - assertTrue(isDirectory, "Missing dokka kdoc output directory") + assertTrue(isDirectory, "Missing dokka html output directory") val imagesDir = File(this, "images") assertTrue(imagesDir.isDirectory, "Missing images directory") diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGroovyIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGroovyIntegrationTest.kt index ffd04ae0..7a620d9c 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGroovyIntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGroovyIntegrationTest.kt @@ -32,21 +32,21 @@ class BasicGroovyIntegrationTest(override val versions: BuildVersions) : Abstrac @Test fun execute() { - val result = createGradleRunner("dokkaKdoc", "dokkaJavadoc", "dokkaGfm", "dokkaJekyll", "--stacktrace").build() + val result = createGradleRunner("dokkaHtml", "dokkaJavadoc", "dokkaGfm", "dokkaJekyll", "--stacktrace").build() - assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaKdoc")).outcome) + assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaHtml")).outcome) assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaJavadoc")).outcome) assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaGfm")).outcome) assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaJekyll")).outcome) - File(projectDir, "build/dokka/customKdoc").assertKdocOutputDir() + File(projectDir, "build/dokka/customHtml").assertKdocOutputDir() File(projectDir, "build/dokka/customJavadoc").assertJavadocOutputDir() File(projectDir, "build/dokka/customGfm").assertGfmOutputDir() File(projectDir, "build/dokka/customJekyll").assertJekyllOutputDir() } private fun File.assertKdocOutputDir() { - assertTrue(isDirectory, "Missing dokka kdoc output directory") + assertTrue(isDirectory, "Missing dokka html output directory") val imagesDir = File(this, "images") assertTrue(imagesDir.isDirectory, "Missing images directory") diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multimodule0IntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multimodule0IntegrationTest.kt index 75ef547a..95b6e683 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multimodule0IntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multimodule0IntegrationTest.kt @@ -26,11 +26,11 @@ class Multimodule0IntegrationTest(override val versions: BuildVersions) : Abstra @Test fun execute() { - val result = createGradleRunner("dokkaKdoc", ":moduleA:dokkaKdocMultimodule", "--stacktrace").build() + val result = createGradleRunner("dokkaHtml", ":moduleA:dokkaHtmlMultimodule", "--stacktrace").build() - assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":moduleA:dokkaKdocMultimodule")).outcome) + assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":moduleA:dokkaHtmlMultimodule")).outcome) - val outputDir = File(projectDir, "moduleA/build/dokka/kdocMultimodule") + val outputDir = File(projectDir, "moduleA/build/dokka/htmlMultimodule") assertTrue(outputDir.isDirectory, "Missing dokka output directory") assertTrue( diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt index 8fa1d3de..0a8c4fe0 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt @@ -27,11 +27,11 @@ class Multiplatform0GradleIntegrationTest(override val versions: BuildVersions) @Test fun execute() { - val result = createGradleRunner("dokkaKdoc", "--stacktrace").build() + val result = createGradleRunner("dokkaHtml", "--stacktrace").build() - assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaKdoc")).outcome) + assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaHtml")).outcome) - val dokkaOutputDir = File(projectDir, "build/dokka/kdoc") + val dokkaOutputDir = File(projectDir, "build/dokka/html") assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory") dokkaOutputDir.allHtmlFiles().forEach { file -> diff --git a/plugins/base/build.gradle.kts b/plugins/base/build.gradle.kts index 1cedf354..1fe3dbc2 100644 --- a/plugins/base/build.gradle.kts +++ b/plugins/base/build.gradle.kts @@ -39,4 +39,4 @@ publishing { } } -configureBintrayPublication("basePlugin")
\ No newline at end of file +configureBintrayPublication("basePlugin") diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt index 46b49660..ccb7ae0e 100644 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt @@ -10,11 +10,11 @@ open class DokkaPlugin : Plugin<Project> { project.createDokkaTasks("dokka") { outputDirectory = defaultDokkaOutputDirectory(project.buildDir, "dokkaKdoc").absolutePath doFirst { - logger.warn(":dokka task is deprecated in favor of :dokkaKdoc") + logger.warn(":dokka task is deprecated in favor of :dokkaHtml") } } - project.createDokkaTasks("dokkaKdoc") + project.createDokkaTasks("dokkaHtml") project.createDokkaTasks("dokkaJavadoc") { plugins.dependencies.add(project.dokkaArtifacts.javadocPlugin) |