aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcin Aman <marcin.aman@gmail.com>2020-12-16 12:44:45 +0100
committerGitHub <noreply@github.com>2020-12-16 12:44:45 +0100
commit9e344b2047f72051bed509fb4e7ac1ae53f8098e (patch)
tree5170e8ab767e74a444a4676e24eb80472c3465a1
parent7b3bc6f97ee46981bd88852a50ee4a351bd4879d (diff)
downloaddokka-9e344b2047f72051bed509fb4e7ac1ae53f8098e.tar.gz
dokka-9e344b2047f72051bed509fb4e7ac1ae53f8098e.tar.bz2
dokka-9e344b2047f72051bed509fb4e7ac1ae53f8098e.zip
Remove `documentationFileName` from documentation as it is no longer valid (#1657)
-rw-r--r--README.md3
-rw-r--r--docs/src/doc/docs/user_guide/gradle/usage.md3
2 files changed, 2 insertions, 4 deletions
diff --git a/README.md b/README.md
index a2896783..00e63106 100644
--- a/README.md
+++ b/README.md
@@ -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