diff options
| author | Marcin Aman <marcin.aman@gmail.com> | 2021-03-26 20:00:46 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-26 20:00:46 +0100 |
| commit | 4ddaafb8ec1a45d2696833d1a441f7dbdbb319dd (patch) | |
| tree | d1309e1f32ececdcf298137d5ecdfd2d55ba65f1 /docs/src | |
| parent | 8166370d57dcc5f8f2af15648761d733200a092b (diff) | |
| download | dokka-4ddaafb8ec1a45d2696833d1a441f7dbdbb319dd.tar.gz dokka-4ddaafb8ec1a45d2696833d1a441f7dbdbb319dd.tar.bz2 dokka-4ddaafb8ec1a45d2696833d1a441f7dbdbb319dd.zip | |
Fix configuration for suppressing obvious functions (#1789)
* Fix suppressObviousFunctions not being present in task configuration
* Docs
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/doc/docs/user_guide/cli/usage.md | 1 | ||||
| -rw-r--r-- | docs/src/doc/docs/user_guide/gradle/usage.md | 4 | ||||
| -rw-r--r-- | docs/src/doc/docs/user_guide/maven/usage.md | 5 |
3 files changed, 9 insertions, 1 deletions
diff --git a/docs/src/doc/docs/user_guide/cli/usage.md b/docs/src/doc/docs/user_guide/cli/usage.md index e77c686e..862b161b 100644 --- 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 index ff5a54f5..7a7761af 100644 --- 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 index feb53048..dec0712c 100644 --- 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> |