aboutsummaryrefslogtreecommitdiff
path: root/docs/topics/runners/dokka-cli.md
diff options
context:
space:
mode:
authorYing Li <liying.cn.2010@gmail.com>2023-04-26 21:22:15 +0900
committerGitHub <noreply@github.com>2023-04-26 14:22:15 +0200
commit1632ff37d0fcfe8e9db260b0aaf3b547533f5a08 (patch)
treed434cde3e6e431432da3fd19aaac0171bc2270ff /docs/topics/runners/dokka-cli.md
parent79aaba062ebcb9e22599263b0f2a9dee3be688d1 (diff)
downloaddokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.tar.gz
dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.tar.bz2
dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.zip
Minor fixes for documentation (#2979)
Diffstat (limited to 'docs/topics/runners/dokka-cli.md')
-rw-r--r--docs/topics/runners/dokka-cli.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/topics/runners/dokka-cli.md b/docs/topics/runners/dokka-cli.md
index 7d76eefd..ddaf3bbd 100644
--- a/docs/topics/runners/dokka-cli.md
+++ b/docs/topics/runners/dokka-cli.md
@@ -203,7 +203,7 @@ Short summary:
| `displayName` | Display name of the source set, used both internally and externally. |
| `classpath` | Classpath for analysis and interactive samples. Accepts multiple paths separated by semicolons. |
| `src` | Source code roots to be analyzed and documented. Accepts multiple paths separated by semicolons. |
-| `dependentSourceSets` | Names of the dependent source sets in format `moduleName/sourceSetName`. Accepts multiple paths separated by semicolons. |
+| `dependentSourceSets` | Names of the dependent source sets in format `moduleName/sourceSetName`. Accepts multiple values separated by semicolons. |
| `samples` | List of directories or files that contain sample functions. Accepts multiple paths separated by semicolons. <anchor name="includes-cli"/> |
| `includes` | Markdown files that contain [module and package documentation](dokka-module-and-package-docs.md). Accepts multiple paths separated by semicolons. |
| `documentedVisibilities` | Visibilities to be documented. Accepts multiple values separated by semicolons. Possible values: `PUBLIC`, `PRIVATE`, `PROTECTED`, `INTERNAL`, `PACKAGE`. |
@@ -436,8 +436,8 @@ How to configure Kotlin
<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>This can be configured on per-package basis.</p>
<p>
@@ -674,17 +674,17 @@ You can add package configurations for all source sets together at the same time
<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>Can be configured on source set level.</p>
<p>Default: <code>PUBLIC</code></p>
</def>
</deflist>
-### External documentation 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