From 1c58360b39945fc8d111b11913fcadf39e563790 Mon Sep 17 00:00:00 2001
From: Oleg Yukhnevich <whyoleg@gmail.com>
Date: Wed, 17 Jan 2024 16:46:46 +0200
Subject: [PATCH] minor cleanup

---
 .../jetbrains/dokka/gradle/dsl/DokkaAggregationExtension.kt   | 4 ++--
 .../kotlin/org/jetbrains/dokka/gradle/examples/plugins.kt     | 2 +-
 .../src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux.kt | 2 +-
 .../test/kotlin/org/jetbrains/dokka/gradle/examples/ux_2.kt   | 2 +-
 .../kotlin/org/jetbrains/dokka/gradle/examples/ux_settings.kt | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/dokka-runners/runner-gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/dsl/DokkaAggregationExtension.kt b/dokka-runners/runner-gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/dsl/DokkaAggregationExtension.kt
index cb2ebe08d6..e2fd7b0b66 100644
--- a/dokka-runners/runner-gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/dsl/DokkaAggregationExtension.kt
+++ b/dokka-runners/runner-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/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/plugins.kt b/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/plugins.kt
index e0139cec8d..8d802333e7 100644
--- a/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/plugins.kt
+++ b/dokka-runners/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
index 5d8c1aacb8..ef1f2d426d 100644
--- 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/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_2.kt b/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_2.kt
index 5db37849dd..8f3ea0b662 100644
--- a/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_2.kt
+++ b/dokka-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/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_settings.kt b/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_settings.kt
index 442fb89db5..e19860fc9e 100644
--- a/dokka-runners/runner-gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/examples/ux_settings.kt
+++ b/dokka-runners/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.