Rename dokkaModuleDirectory, and mark as internal (#3880)

* Rename `dokkaModuleDirectory`, and mark as internal Follow up for #3876 When Dokka produces 'partial' Modules it stores them in a project-local directory. How Dokka processes Modules is an implementation detail, so exposing the directory is not useful for users, and could be confusing. It is useful to have a single property for DGP to use though, so it should be kept. As such, mark it as `internal` to hide it from the DSL.
Kotlin · Oct 24, 2024 · ec28b78 · ec28b78
1 parent 0ddbc9c
commit ec28b78
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 4 deletions.
diff --git a/dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api b/dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api
@@ -83,7 +83,6 @@ public abstract class org/jetbrains/dokka/gradle/DokkaExtension : java/io/Serial
 	public abstract fun getDokkaCacheDirectory ()Lorg/gradle/api/file/DirectoryProperty;
 	public abstract fun getDokkaEngineVersion ()Lorg/gradle/api/provider/Property;
 	public abstract fun getDokkaGeneratorIsolation ()Lorg/gradle/api/provider/Property;
-	public abstract fun getDokkaModuleDirectory ()Lorg/gradle/api/file/DirectoryProperty;
 	public final fun getDokkaPublicationDirectory ()Lorg/gradle/api/file/DirectoryProperty;
 	public final fun getDokkaPublications ()Lorg/gradle/api/NamedDomainObjectContainer;
 	public final fun getDokkaSourceSets ()Lorg/gradle/api/NamedDomainObjectContainer;

diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaBasePlugin.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaBasePlugin.kt
@@ -101,7 +101,7 @@ constructor(
 
             sourceSetScopeDefault.convention(project.path)
             basePublicationsDirectory.convention(layout.buildDirectory.dir("dokka"))
-            dokkaModuleDirectory.convention(layout.buildDirectory.dir("dokka-module"))
+            baseModulesDirectory.convention(layout.buildDirectory.dir("dokka-module"))
 //            @Suppress("DEPRECATION")
 //            dokkaConfigurationsDirectory.convention(layout.buildDirectory.dir("dokka-config"))
 
@@ -158,7 +158,7 @@ constructor(
             moduleVersion.convention(dokkaExtension.moduleVersion)
             offlineMode.convention(false)
             outputDirectory.convention(dokkaExtension.basePublicationsDirectory.dir(formatName))
-            moduleOutputDirectory.convention(dokkaExtension.dokkaModuleDirectory.dir(formatName))
+            moduleOutputDirectory.convention(dokkaExtension.baseModulesDirectory.dir(formatName))
             suppressInheritedMembers.convention(
                 @Suppress("DEPRECATION")
                 dokkaExtension.suppressInheritedMembers

diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaExtension.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaExtension.kt
@@ -57,7 +57,7 @@ constructor(
      * Note that Dokka Modules are intermediate products and must be combined into a completed
      * Dokka Publication. They are not intended to be comprehensible in isolation.
      */
-    abstract val dokkaModuleDirectory: DirectoryProperty
+    internal abstract val baseModulesDirectory: DirectoryProperty
 
     /** Default Dokka Gradle Plugin cache directory */
     abstract val dokkaCacheDirectory: DirectoryProperty