aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index 383d238b..170ecfa6 100644
--- a/README.md
+++ b/README.md
@@ -72,7 +72,7 @@ dokka {
skipDeprecated = false
// Emit warnings about not documented members. Applies globally, also can be overridden by packageOptions
- reportNotDocumented = true
+ reportUndocumented = true
skipEmptyPackages = true // Do not create index pages for empty packages
@@ -132,6 +132,11 @@ dokka {
reportUndocumented = true // Emit warnings about not documented members
includeNonPublic = false
}
+ // Suppress a package
+ packageOptions {
+ prefix = "kotlin.internal" // will match kotlin.internal and all sub-packages of it
+ suppress = true
+ }
}
```
@@ -236,7 +241,7 @@ The available configuration options are shown below:
<!-- Default: ${project.artifactId} -->
<moduleName>data</moduleName>
<!-- See list of possible formats below -->
- <outFormat>html</outFormat>
+ <outputFormat>html</outputFormat>
<!-- Default: ${project.basedir}/target/dokka -->
<outputDir>some/out/dir</outputDir>