aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Haas <jonathan.haas@kappich.de>2017-07-12 14:42:47 +0200
committerSimon Ogorodnik <sem-oro@yandex.ru>2017-07-20 18:40:47 +0300
commit41221f77786f945d7bceb558cfcfdbdcb42951f3 (patch)
tree510652edf90542c726d625ea177bc0fa15510f1a
parentd95a743326a9d31e1261132f911c415f77fa8bf5 (diff)
downloaddokka-41221f77786f945d7bceb558cfcfdbdcb42951f3.tar.gz
dokka-41221f77786f945d7bceb558cfcfdbdcb42951f3.tar.bz2
dokka-41221f77786f945d7bceb558cfcfdbdcb42951f3.zip
Add global configuration "includeNonPublic"
-rw-r--r--README.md3
-rw-r--r--runners/gradle-plugin/src/main/kotlin/main.kt3
2 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0c90b994..e48b2583 100644
--- a/README.md
+++ b/README.md
@@ -64,6 +64,9 @@ dokka {
// When set to default, caches stored in $USER_HOME/.cache/dokka
cacheRoot = 'default'
+ // Use to include or exclude non public members.
+ includeNonPublic = false
+
// Do not output deprecated members. Applies globally, can be overridden by packageOptions
skipDeprecated = false
diff --git a/runners/gradle-plugin/src/main/kotlin/main.kt b/runners/gradle-plugin/src/main/kotlin/main.kt
index dcb664f2..37feccc9 100644
--- a/runners/gradle-plugin/src/main/kotlin/main.kt
+++ b/runners/gradle-plugin/src/main/kotlin/main.kt
@@ -100,6 +100,7 @@ open class DokkaTask : DefaultTask() {
@Input
var dokkaFatJar: Any = "org.jetbrains.dokka:dokka-fatjar:$version"
+ @Input var includeNonPublic = false
@Input var skipDeprecated = false
@Input var skipEmptyPackages = true
@Input var reportNotDocumented = true
@@ -266,7 +267,7 @@ open class DokkaTask : DefaultTask() {
includes.filterNotNull().map { project.file(it).absolutePath },
outputDirectory,
outputFormat,
- false,
+ includeNonPublic,
false,
reportNotDocumented,
skipEmptyPackages,