Merge branch 'master' into KT-64377/maven-dev-publish

Kotlin · Feb 23, 2024 · b963d07 · b963d07
2 parents b29f542 + 936cb3f
commit b963d07
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 33 deletions.
diff --git a/docs/topics/runners/dokka-gradle.md b/docs/topics/runners/dokka-gradle.md
@@ -367,11 +367,11 @@ plugins {
 }
 
 tasks.dokkaHtml {
-    outputDirectory.set(buildDir.resolve("documentation/html"))
+    outputDirectory.set(layout.buildDirectory.dir("documentation/html"))
 }
 
 tasks.dokkaGfm {
-    outputDirectory.set(buildDir.resolve("documentation/markdown"))
+    outputDirectory.set(layout.buildDirectory.dir("documentation/markdown"))
 }
 ```
 
@@ -543,7 +543,7 @@ subprojects {
 
     // configure only the HTML task
     tasks.dokkaHtmlPartial {
-        outputDirectory.set(buildDir.resolve("docs/partial"))
+        outputDirectory.set(layout.buildDirectory.dir("docs/partial"))
     }
 
     // configure all format tasks at once
@@ -602,7 +602,7 @@ apply(plugin = "org.jetbrains.dokka")
 
 // configuration for subproject-A only.
 tasks.dokkaHtmlPartial {
-    outputDirectory.set(buildDir.resolve("docs/partial"))
+    outputDirectory.set(layout.buildDirectory.dir("docs/partial"))
 }
 ```
 
@@ -690,7 +690,7 @@ import org.jetbrains.dokka.gradle.DokkaTask
 tasks.withType<DokkaTask>().configureEach {
     moduleName.set(project.name)
     moduleVersion.set(project.version.toString())
-    outputDirectory.set(buildDir.resolve("dokka/$name"))
+    outputDirectory.set(layout.buildDirectory.dir("dokka/$name"))
     failOnWarning.set(false)
     suppressObviousFunctions.set(true)
     suppressInheritedMembers.set(false)
@@ -1400,7 +1400,7 @@ import java.net.URL
 tasks.withType<DokkaTask>().configureEach {
     moduleName.set(project.name)
     moduleVersion.set(project.version.toString())
-    outputDirectory.set(buildDir.resolve("dokka/$name"))
+    outputDirectory.set(layout.buildDirectory.dir("dokka/$name"))
     failOnWarning.set(false)
     suppressObviousFunctions.set(true)
     suppressInheritedMembers.set(false)

diff --git a/...-gradle-plugin-classic/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaSourceSetMapper.kt b/...-gradle-plugin-classic/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaSourceSetMapper.kt
@@ -63,7 +63,7 @@ private fun GradleDokkaSourceSetBuilder.externalDocumentationLinksWithDefaults()
 
 private fun GradleDokkaSourceSetBuilder.suppressedFilesWithDefaults(): Set<File> {
     val suppressedGeneratedFiles = if (suppressGeneratedFiles.get()) {
-        val generatedRoot = project.buildDir.resolve("generated").absoluteFile
+        val generatedRoot = project.layout.buildDirectory.dir("generated").get().asFile
         sourceRoots
             .filter { it.startsWith(generatedRoot) }
             .flatMap { it.walk().toList() }

diff --git a/...-plugin-classic/src/main/kotlin/org/jetbrains/dokka/gradle/dokkaDefaultOutputDirectory.kt b/...-plugin-classic/src/main/kotlin/org/jetbrains/dokka/gradle/dokkaDefaultOutputDirectory.kt
diff --git a/...gin-classic/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderTest.kt b/...gin-classic/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderTest.kt
@@ -453,20 +453,21 @@ class GradleDokkaSourceSetBuilderTest {
         val sourceSet = GradleDokkaSourceSetBuilder("", project)
         assertTrue(sourceSet.build().suppressedFiles.isEmpty(), "Expected no suppressed files by default")
 
-        val file = project.buildDir.resolve("generated").also { it.mkdirs() }
+        val file = project.layout.buildDirectory.dir("generated").get().asFile.also { it.mkdirs() }
         file.resolve("suppressed.kt").writeText("class A")
 
-        sourceSet.sourceRoots.from(project.buildDir.resolve("generated"))
+        sourceSet.sourceRoots.from(project.layout.buildDirectory.dir("generated"))
 
         val suppressedConfiguration = sourceSet.build()
         sourceSet.suppressGeneratedFiles.set(false)
         val unsuppressedConfiguration = sourceSet.build()
 
         assertEquals(
             setOf(
-                project.buildDir.resolve("generated"),
-                project.buildDir.resolve("generated").resolve("suppressed.kt")
-            ), suppressedConfiguration.suppressedFiles,
+                project.layout.buildDirectory.dir("generated").get().asFile,
+                project.layout.buildDirectory.dir("generated/suppressed.kt").get().asFile,
+            ),
+            suppressedConfiguration.suppressedFiles,
             "Expected all suppressed files to be present after build"
         )
 

diff --git a/...ugin-classic/src/test/kotlin/org/jetbrains/dokka/gradle/tasks/DokkaMultiModuleTaskTest.kt b/...ugin-classic/src/test/kotlin/org/jetbrains/dokka/gradle/tasks/DokkaMultiModuleTaskTest.kt
@@ -74,7 +74,7 @@ class DokkaMultiModuleTaskTest {
         multiModuleTask.apply {
             moduleVersion.set("1.5.0")
             moduleName.set("custom Module Name")
-            outputDirectory.set(project.buildDir.resolve("customOutputDirectory"))
+            outputDirectory.set(project.layout.buildDirectory.dir("customOutputDirectory"))
             cacheRoot.set(File("customCacheRoot"))
             pluginsConfiguration.add(
                 PluginConfigurationImpl(
@@ -93,8 +93,8 @@ class DokkaMultiModuleTaskTest {
             DokkaConfigurationImpl(
                 moduleName = "custom Module Name",
                 moduleVersion = "1.5.0",
-                outputDir = multiModuleTask.project.buildDir.resolve("customOutputDirectory"),
-                cacheRoot = multiModuleTask.project.projectDir.resolve("customCacheRoot"),
+                outputDir = multiModuleTask.project.layout.buildDirectory.dir("customOutputDirectory").get().asFile,
+                cacheRoot = multiModuleTask.project.layout.projectDirectory.dir("customCacheRoot").asFile,
                 pluginsConfiguration = mutableListOf(
                     PluginConfigurationImpl(
                         "pluginA",
@@ -236,7 +236,7 @@ class DokkaMultiModuleTaskTest {
         })
 
         assertEquals(
-            listOf(parent.project.buildDir.resolve("child")),
+            listOf(parent.project.layout.buildDirectory.dir("child").get().asFile),
             parentTask.targetChildOutputDirectories.get().map { it.asFile },
             "Expected child target output directory being present"
         )