aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKamil Doległo <kamilok1965@interia.pl>2019-06-17 12:51:24 +0200
committerKamil Doległo <kamilok1965@interia.pl>2019-06-17 12:51:59 +0200
commit5f063e60e0dd26027ef1afd487fa007396699f86 (patch)
treefad9db044dfc85ad699b900430963109546780fe
parent06bf55243ec4248d8cc4a72be033edcfa51ccd41 (diff)
downloaddokka-5f063e60e0dd26027ef1afd487fa007396699f86.tar.gz
dokka-5f063e60e0dd26027ef1afd487fa007396699f86.tar.bz2
dokka-5f063e60e0dd26027ef1afd487fa007396699f86.zip
Readme update
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index fa11fefe..57ee6cbd 100644
--- a/README.md
+++ b/README.md
@@ -72,11 +72,15 @@ dokka {
outputFormat = 'html'
outputDirectory = "$buildDir/javadoc"
- // These tasks will be used to determine source directories and classpath
+ // [Deprecated] These tasks will be used to determine source directories and classpath
kotlinTasks {
defaultKotlinTasks() + [':some:otherCompileKotlin', project("another").compileKotlin]
}
+ // In case of Gradle multiproject build, you can include subprojects here to get merged documentation
+ // Note however, that you have to have the Kotlin plugin available in the root project
+ subProjects = ["subproject1", "subproject2"]
+
// List of files with module and package documentation
// https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation
includes = ['packages.md', 'extra.md']