diff options
| -rw-r--r-- | README.md | 3 | ||||
| -rw-r--r-- | docs/src/doc/docs/user_guide/gradle/usage.md | 3 |
2 files changed, 2 insertions, 4 deletions
@@ -108,11 +108,10 @@ For documenting Gradle multi-module projects, you can use `dokka${format}Multimo ```kotlin tasks.dokkaHtmlMultiModule.configure { outputDirectory.set(buildDir.resolve("dokkaCustomMultiModuleOutput")) - documentationFileName.set("README.md") } ``` -`DokkaMultiModule` depends on all Dokka tasks in the subprojects, runs them, and creates a toplevel page (based on the `documentationFile`) +`DokkaMultiModule` depends on all Dokka tasks in the subprojects, runs them, and creates a toplevel page with links to all generated (sub)documentations ### Using the Maven plugin diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md index e48dd7ef..6a18a1e0 100644 --- a/docs/src/doc/docs/user_guide/gradle/usage.md +++ b/docs/src/doc/docs/user_guide/gradle/usage.md @@ -308,11 +308,10 @@ For documenting Gradle multi-module projects, you can use `dokka${format}MultiMo ```kotlin tasks.dokkaHtmlMultiModule.configure { outputDirectory.set(buildDir.resolve("dokkaCustomMultiModuleOutput")) - documentationFileName.set("README.md") } ``` -`DokkaMultiModule` depends on all Dokka tasks in the subprojects, runs them, and creates a toplevel page (based on the `documentationFile`) +`DokkaMultiModule` depends on all Dokka tasks in the subprojects, runs them, and creates a toplevel page with links to all generated (sub)documentations ## Example project |