Docs

Kotlin · Mar 26, 2021 · dbc0560 · dbc0560
1 parent c8813a9
commit dbc0560
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 3 deletions.
diff --git a/docs/src/doc/docs/user_guide/cli/usage.md b/docs/src/doc/docs/user_guide/cli/usage.md
@@ -20,6 +20,7 @@ Dokka supports the following command line arguments:
   * `-globalPackageOptions` - per package options added to all source sets
   * `-globalLinks` - external documentation links added to all source sets
   * `-globalSrcLink` - source links added to all source sets
+  * `-noSuppressObviousFunctions` - don't suppress obvious functions like default `toString` or `equals`
   * `-sourceSet` - (repeatable) - configuration for a single source set. Following this argument, you can pass other arguments:
     * `-sourceSetName` - source set name as a part of source set ID when declaring dependent source sets
     * `-displayName` - source set name displayed in the generated documentation

diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md
@@ -89,6 +89,10 @@ dokkaHtml {
     // to enable package-list caching
     // When this is set to default, caches are stored in $USER_HOME/.cache/dokka
     cacheRoot.set(file("default"))
+
+    // Suppress obvious functions like default toString or equals. Defaults to true
+    suppressObviousFunctions.set(false)
+
     dokkaSourceSets {
         configureEach { // Or source set name, for single-platform the default source sets are `main` and `test`
 

diff --git a/docs/src/doc/docs/user_guide/maven/usage.md b/docs/src/doc/docs/user_guide/maven/usage.md
@@ -84,7 +84,10 @@ The available configuration options are shown below:
         <samples>
             <dir>src/test/samples</dir>
         </samples>
-
+
+        <!-- Suppress obvious functions like default toString or equals. Defaults to true -->
+        <suppressObviousFunctions>false</suppressObviousFunctions>
+
         <!-- Used for linking to JDK, default: 6 -->
         <jdkVersion>6</jdkVersion>
 

diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTaskPartial.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTaskPartial.kt
@@ -44,7 +44,8 @@ abstract class DokkaTaskPartial : AbstractDokkaTask() {
             sourceSets = unsuppressedSourceSets.build(),
             pluginsConfiguration = buildPluginsConfiguration(),
             pluginsClasspath = plugins.resolve().toList(),
-            delayTemplateSubstitution = true
+            delayTemplateSubstitution = true,
+            suppressObviousFunctions = suppressObviousFunctions.getSafe(),
         )
     }
 }
diff --git a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt
@@ -156,7 +156,7 @@ abstract class AbstractDokkaMojo(private val defaultDokkaPlugins: List<Dependenc
     @Parameter
     var failOnWarning: Boolean = DokkaDefaults.failOnWarning
 
-    @Parameter
+    @Parameter(defaultValue = "${DokkaDefaults.suppressObviousFunctions}")
     var suppressObviousFunctions: Boolean = DokkaDefaults.suppressObviousFunctions
 
     @Parameter