minor cleanup

Kotlin · Jan 17, 2024 · 1c58360 · 1c58360
1 parent a2b0841
commit 1c58360
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/...gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/dsl/DokkaAggregationExtension.kt b/...gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/dsl/DokkaAggregationExtension.kt
@@ -12,8 +12,8 @@ import org.jetbrains.dokka.gradle.dsl.plugins.DokkaPluginsContainer
 @DokkaGradlePluginDsl
 public interface DokkaAggregationExtension {
     public val includedDocumentation: ConfigurableFileCollection
-    public fun includeDocumentation(text: String)
-    public fun includeDocumentationFrom(path: Any)
+    public fun moduleDocumentation(text: String)
+    public fun moduleDocumentationFrom(path: Any)
 
     // TODO: this is rather adhoc, though, not a lot of use cases...
     //   need better naming

diff --git a/...nners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/plugins.kt b/...nners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/plugins.kt
@@ -47,7 +47,7 @@ fun Project.configureSomething() {
         aggregation.includeSubprojects()
         includeSubprojects()
 
-        includeDocumentation("")
+        moduleDocumentation("")
     }
 }
 

diff --git a/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux.kt b/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux.kt
@@ -98,7 +98,7 @@ fun Project.task5() {
 
     dokka {
         // or from file (more complex way)
-        includeDocumentation(
+        moduleDocumentation(
             """
                This is the documentation for the module.
                This text helps users of the API understand what is the purpose of the module, its structure, and usage samples.

diff --git a/...-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_2.kt b/...-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_2.kt
@@ -103,7 +103,7 @@ fun Project.task5_2() {
             // or just in subprojectA build file
             dokka {
                 // or from file (more complex way)
-                includeDocumentation(
+                moduleDocumentation(
                     """
                        This is the documentation for the module.
                        This text helps users of the API understand what is the purpose of the module, its structure, and usage samples.

diff --git a/...s/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_settings.kt b/...s/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_settings.kt
@@ -140,7 +140,7 @@ fun settings_task5(
             // TODO: what should we match here
             perModule(":subprojectA") {
                 // or from file (more complex way)
-                includeDocumentation(
+                moduleDocumentation(
                     """
                        This is the documentation for the module.
                        This text helps users of the API understand what is the purpose of the module, its structure, and usage samples.