aboutsummaryrefslogtreecommitdiff
path: root/docs/topics
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
parent79aaba062ebcb9e22599263b0f2a9dee3be688d1 (diff)
downloaddokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.tar.gz
dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.tar.bz2
dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.zip
Minor fixes for documentation (#2979)
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/dokka-module-and-package-docs.md4
-rw-r--r--docs/topics/formats/dokka-javadoc.md2
-rw-r--r--docs/topics/formats/dokka-markdown.md3
-rw-r--r--docs/topics/runners/dokka-cli.md14
-rw-r--r--docs/topics/runners/dokka-gradle.md16
-rw-r--r--docs/topics/runners/dokka-maven.md12
6 files changed, 26 insertions, 25 deletions
diff --git a/docs/topics/dokka-module-and-package-docs.md b/docs/topics/dokka-module-and-package-docs.md
index d8ceb3fa..9bf78619 100644
--- a/docs/topics/dokka-module-and-package-docs.md
+++ b/docs/topics/dokka-module-and-package-docs.md
@@ -33,14 +33,14 @@ It also appears under the first-level heading on your package's page.
## Level 2 heading for package org.jetbrains.kotlin.demo
-Content after this heading is also part of documentation for org.jetbrains.kotlin.demo
+Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo`
# Package org.jetbrains.kotlin.demo2
This content appears under your package name in the packages list.
It also appears under the first-level heading on your package's page.
-## Level 2 heading for package org.jetbrains.kotlin.demo
+## Level 2 heading for package org.jetbrains.kotlin.demo2
Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo2`
```
diff --git a/docs/topics/formats/dokka-javadoc.md b/docs/topics/formats/dokka-javadoc.md
index e9d4a6f1..9ea78fd9 100644
--- a/docs/topics/formats/dokka-javadoc.md
+++ b/docs/topics/formats/dokka-javadoc.md
@@ -1,6 +1,6 @@
[//]: # (title: Javadoc)
-> The Javadoc output format is still in Alpha so you may find bugs and experience migration issues when using it.
+> The Javadoc output format is still in Alpha, so you may find bugs and experience migration issues when using it.
> Successful integration with tools that accept Java's Javadoc HTML as input is not guaranteed.
> **You use it at your own risk.**
>
diff --git a/docs/topics/formats/dokka-markdown.md b/docs/topics/formats/dokka-markdown.md
index d4919a5c..0c863f35 100644
--- a/docs/topics/formats/dokka-markdown.md
+++ b/docs/topics/formats/dokka-markdown.md
@@ -1,6 +1,7 @@
[//]: # (title: Markdown)
-> The Markdown output formats are still in Alpha so you may find bugs and experience migration issues when using them. **You use them at your own risk.**
+> The Markdown output formats are still in Alpha, so you may find bugs and experience migration issues when using them.
+> **You use them at your own risk.**
>
{type="warning"}
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
diff --git a/docs/topics/runners/dokka-gradle.md b/docs/topics/runners/dokka-gradle.md
index ae8b003b..a3287293 100644
--- a/docs/topics/runners/dokka-gradle.md
+++ b/docs/topics/runners/dokka-gradle.md
@@ -36,7 +36,7 @@ plugins {
</tab>
</tabs>
-When documenting [multi-project](dokka-gradle.md#multi-project-builds) builds, you need to apply the Gradle plugin for Dokka
+When documenting [multi-project](#multi-project-builds) builds, you need to apply the Gradle plugin for Dokka
within subprojects as well. You can use `allprojects {}` or `subprojects {}` Gradle configurations to achieve that:
<tabs group="build-script">
@@ -451,8 +451,8 @@ plugins {
tasks.withType(DokkaTask.class) {
dokkaSourceSets.configureEach {
documentedVisibilities.set([
- DokkaConfiguration.Visibility.PUBLIC,
- DokkaConfiguration.Visibility.PROTECTED
+ Visibility.PUBLIC,
+ Visibility.PROTECTED
])
perPackageOption {
@@ -942,8 +942,8 @@ tasks.withType(DokkaTask.class) {
<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>Default: <code>DokkaConfiguration.Visibility.PUBLIC</code></p>
@@ -1025,7 +1025,7 @@ tasks.withType(DokkaTask.class) {
</def>
<def title="noAndroidSdkLink">
<anchor name="includes"/>
- <p>Whether to generate external documentation links to the Android SDK API reference</p>
+ <p>Whether to generate external documentation links to the Android SDK API reference.</p>
<p>This is only relevant in Android projects, ignored otherwise.</p>
<p>Note: Links <b>are</b> generated when <code>noAndroidSdkLink</code> is set to <code>false</code>.</p>
<p>Default: <code>false</code></p>
@@ -1272,8 +1272,8 @@ tasks.withType(DokkaTask.class) {
<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>This can be configured on source set level.</p>
<p>Default: <code>DokkaConfiguration.Visibility.PUBLIC</code></p>
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>