diff options
| author | Martin Bonnin <martin@mbonnin.net> | 2020-11-18 12:48:03 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-18 12:48:03 +0100 |
| commit | 1959b914c0838be814d45f617517ac73fa33cd47 (patch) | |
| tree | 899805a421b45625ceffd599520a3f3e3d237e5a /docs/src/doc | |
| parent | d6c798e44381fd436a264229f94f19528382c136 (diff) | |
| download | dokka-1959b914c0838be814d45f617517ac73fa33cd47.tar.gz dokka-1959b914c0838be814d45f617517ac73fa33cd47.tar.bz2 dokka-1959b914c0838be814d45f617517ac73fa33cd47.zip | |
Add matchingRegex (#598)
* add matchingRegex as a simpler replacement for `prefix`
* remove useless check
* added a note about the order of the matchingRegex
Diffstat (limited to 'docs/src/doc')
| -rw-r--r-- | docs/src/doc/docs/user_guide/cli/usage.md | 2 | ||||
| -rw-r--r-- | docs/src/doc/docs/user_guide/gradle/usage.md | 5 | ||||
| -rw-r--r-- | docs/src/doc/docs/user_guide/maven/usage.md | 2 |
3 files changed, 5 insertions, 4 deletions
diff --git a/docs/src/doc/docs/user_guide/cli/usage.md b/docs/src/doc/docs/user_guide/cli/usage.md index 6f9ca84a..1f6b1124 100644 --- a/docs/src/doc/docs/user_guide/cli/usage.md +++ b/docs/src/doc/docs/user_guide/cli/usage.md @@ -31,7 +31,7 @@ Dokka supports the following command line arguments: * `-skipDeprecated` - if set, deprecated elements are not included in the generated documentation * `-reportUndocumented` - warn about undocumented members * `-skipEmptyPackages` - do not create index pages for empty packages - * `-packageOptions` - list of package options in format `prefix,-deprecated,-privateApi,+reportUndocumented;prefix, ...`, separated by `;` + * `-packageOptions` - list of package options in format `matchingRegex,-deprecated,-privateApi,+reportUndocumented;matchingRegex, ...`, separated by `;` * `-links` - list of external documentation links in format `url^packageListUrl^^url2...`, separated by `;` * `-srcLink` - mapping between a source directory and a Web site for browsing the code in format `<path>=<url>[#lineSuffix]` * `-noStdlibLink` - disable linking to online kotlin-stdlib documentation diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md index 5ca0eb30..cea1f80e 100644 --- a/docs/src/doc/docs/user_guide/gradle/usage.md +++ b/docs/src/doc/docs/user_guide/gradle/usage.md @@ -169,8 +169,9 @@ dokkaHtml { // Allows to customize documentation generation options on a per-package basis // Repeat for multiple packageOptions + // If multiple packages match the same matchingRegex, the longuest matchingRegex will be used perPackageOption { - prefix.set("kotlin") // will match kotlin and all sub-packages of it + matchingRegex.set("kotlin($|\\.).*") // will match kotlin and all sub-packages of it // All options are optional, default values are below: skipDeprecated.set(false) reportUndocumented.set(true) // Emit warnings about not documented members @@ -178,7 +179,7 @@ dokkaHtml { } // Suppress a package perPackageOption { - prefix.set("kotlin.internal") // will match kotlin.internal and all sub-packages of it + matchingRegex.set(".*\.internal.*") // will match all .internal packages and sub-packages suppress.set(true) } } diff --git a/docs/src/doc/docs/user_guide/maven/usage.md b/docs/src/doc/docs/user_guide/maven/usage.md index 812737fa..feb53048 100644 --- a/docs/src/doc/docs/user_guide/maven/usage.md +++ b/docs/src/doc/docs/user_guide/maven/usage.md @@ -142,7 +142,7 @@ The available configuration options are shown below: <perPackageOptions> <packageOptions> <!-- Will match kotlin and all sub-packages of it --> - <prefix>kotlin</prefix> + <matchingRegex>kotlin($|\.).*</matchingRegex> <!-- All options are optional, default values are below: --> <skipDeprecated>false</skipDeprecated> |