aboutsummaryrefslogtreecommitdiff
path: root/runners/cli
diff options
context:
space:
mode:
authorMarcin Aman <marcin.aman@gmail.com>2021-03-01 13:50:17 +0100
committerGitHub <noreply@github.com>2021-03-01 13:50:17 +0100
commit7cf644f064868934fe8dcb46ab150f25fab8e8c8 (patch)
tree30d97e4cdaa6017401e7780bd86471f93d6f4d08 /runners/cli
parentab853a866c40771e84a3235f40575efe04c435c5 (diff)
downloaddokka-7cf644f064868934fe8dcb46ab150f25fab8e8c8.tar.gz
dokka-7cf644f064868934fe8dcb46ab150f25fab8e8c8.tar.bz2
dokka-7cf644f064868934fe8dcb46ab150f25fab8e8c8.zip
Add ability to suppress obvious functions like equals, toString... (#1758)
* Add ability to suppress obvious functions like equals, toString... * Add ability to suppress obvious functions like equals, toString...
Diffstat (limited to 'runners/cli')
-rw-r--r--runners/cli/src/main/kotlin/cli/main.kt7
1 files changed, 7 insertions, 0 deletions
diff --git a/runners/cli/src/main/kotlin/cli/main.kt b/runners/cli/src/main/kotlin/cli/main.kt
index 1597ed56..b11ed0dc 100644
--- a/runners/cli/src/main/kotlin/cli/main.kt
+++ b/runners/cli/src/main/kotlin/cli/main.kt
@@ -69,6 +69,13 @@ class GlobalArguments(args: Array<String>) : DokkaConfiguration {
description = "Delay substitution of some elements (usefull for incremental builds of multimodule projects)"
).default(DokkaDefaults.delayTemplateSubstitution)
+ val noSuppressObviousFunctions: Boolean by parser.option(
+ ArgType.Boolean,
+ description = "Document generated or obvious functions like default `toString` or `equals`"
+ ).default(!DokkaDefaults.suppressObviousFunctions)
+
+ override val suppressObviousFunctions: Boolean by lazy{ !noSuppressObviousFunctions }
+
val globalPackageOptions by parser.option(
ArgType.String,
description = "List of package source sets in format \"prefix,-deprecated,-privateApi,+warnUndocumented,+suppress;...\" "