diff options
author | Ying Li <liying.cn.2010@gmail.com> | 2023-04-26 21:22:15 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-04-26 14:22:15 +0200 |
commit | 1632ff37d0fcfe8e9db260b0aaf3b547533f5a08 (patch) | |
tree | d434cde3e6e431432da3fd19aaac0171bc2270ff /docs/topics/runners/dokka-maven.md | |
parent | 79aaba062ebcb9e22599263b0f2a9dee3be688d1 (diff) | |
download | dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.tar.gz dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.tar.bz2 dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.zip |
Minor fixes for documentation (#2979)
Diffstat (limited to 'docs/topics/runners/dokka-maven.md')
-rw-r--r-- | docs/topics/runners/dokka-maven.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/topics/runners/dokka-maven.md b/docs/topics/runners/dokka-maven.md index 3331bce1..14551c91 100644 --- a/docs/topics/runners/dokka-maven.md +++ b/docs/topics/runners/dokka-maven.md @@ -288,8 +288,8 @@ with [all configuration options](#complete-configuration) applied at the bottom <def title="documentedVisibilities"> <p>The set of visibility modifiers that should be documented.</p> <p> - This can be used if you want to document protected/internal/private declarations, - as well as if you want to exclude public declarations and only document internal API. + This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations, + as well as if you want to exclude <code>public</code> declarations and only document internal API. </p> <p>Can be configured on per-package basis.</p> <p>Default: <code>PUBLIC</code></p> @@ -450,9 +450,9 @@ function in `kotlinx.coroutines`. </def> </deflist> -#### External documentation links configuration +### External documentation links configuration -The `externalDocumentationLink` block allows the creation of links that lead to the externally hosted documentation of +The `externalDocumentationLinks` block allows the creation of links that lead to the externally hosted documentation of your dependencies. For example, if you are using types from `kotlinx.serialization`, by default they are unclickable in your @@ -545,8 +545,8 @@ The `perPackageOptions` configuration block allows setting some options for spec <def title="documentedVisibilities"> <p>The set of visibility modifiers that should be documented.</p> <p> - This can be used if you want to document protected/internal/private declarations within this package, - as well as if you want to exclude public declarations and only document internal API. + This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations within this package, + as well as if you want to exclude <code>public</code> declarations and only document internal API. </p> <p>Default: <code>PUBLIC</code></p> </def> |