Skip to content

Commit 1632ff3

Browse files
authored
Minor fixes for documentation (#2979)
1 parent 79aaba0 commit 1632ff3

File tree

6 files changed

+26
-25
lines changed

6 files changed

+26
-25
lines changed

docs/topics/dokka-module-and-package-docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ It also appears under the first-level heading on your package's page.
3333
3434
## Level 2 heading for package org.jetbrains.kotlin.demo
3535
36-
Content after this heading is also part of documentation for org.jetbrains.kotlin.demo
36+
Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo`
3737
3838
# Package org.jetbrains.kotlin.demo2
3939
4040
This content appears under your package name in the packages list.
4141
It also appears under the first-level heading on your package's page.
4242
43-
## Level 2 heading for package org.jetbrains.kotlin.demo
43+
## Level 2 heading for package org.jetbrains.kotlin.demo2
4444
4545
Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo2`
4646
```

docs/topics/formats/dokka-javadoc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[//]: # (title: Javadoc)
22

3-
> The Javadoc output format is still in Alpha so you may find bugs and experience migration issues when using it.
3+
> The Javadoc output format is still in Alpha, so you may find bugs and experience migration issues when using it.
44
> Successful integration with tools that accept Java's Javadoc HTML as input is not guaranteed.
55
> **You use it at your own risk.**
66
>

docs/topics/formats/dokka-markdown.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[//]: # (title: Markdown)
22

3-
> 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.**
3+
> The Markdown output formats are still in Alpha, so you may find bugs and experience migration issues when using them.
4+
> **You use them at your own risk.**
45
>
56
{type="warning"}
67

docs/topics/runners/dokka-cli.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Short summary:
203203
| `displayName` | Display name of the source set, used both internally and externally. |
204204
| `classpath` | Classpath for analysis and interactive samples. Accepts multiple paths separated by semicolons. |
205205
| `src` | Source code roots to be analyzed and documented. Accepts multiple paths separated by semicolons. |
206-
| `dependentSourceSets` | Names of the dependent source sets in format `moduleName/sourceSetName`. Accepts multiple paths separated by semicolons. |
206+
| `dependentSourceSets` | Names of the dependent source sets in format `moduleName/sourceSetName`. Accepts multiple values separated by semicolons. |
207207
| `samples` | List of directories or files that contain sample functions. Accepts multiple paths separated by semicolons. <anchor name="includes-cli"/> |
208208
| `includes` | Markdown files that contain [module and package documentation](dokka-module-and-package-docs.md). Accepts multiple paths separated by semicolons. |
209209
| `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
436436
<def title="documentedVisibilities">
437437
<p>The set of visibility modifiers that should be documented.</p>
438438
<p>
439-
This can be used if you want to document protected/internal/private declarations,
440-
as well as if you want to exclude public declarations and only document internal API.
439+
This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations,
440+
as well as if you want to exclude <code>public</code> declarations and only document internal API.
441441
</p>
442442
<p>This can be configured on per-package basis.</p>
443443
<p>
@@ -674,17 +674,17 @@ You can add package configurations for all source sets together at the same time
674674
<def title="documentedVisibilities">
675675
<p>The set of visibility modifiers that should be documented.</p>
676676
<p>
677-
This can be used if you want to document protected/internal/private declarations within this package,
678-
as well as if you want to exclude public declarations and only document internal API.
677+
This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations within this package,
678+
as well as if you want to exclude <code>public</code> declarations and only document internal API.
679679
</p>
680680
<p>Can be configured on source set level.</p>
681681
<p>Default: <code>PUBLIC</code></p>
682682
</def>
683683
</deflist>
684684

685-
### External documentation configuration
685+
### External documentation links configuration
686686

687-
The `externalDocumentationLink` block allows the creation of links that lead to the externally hosted documentation of
687+
The `externalDocumentationLinks` block allows the creation of links that lead to the externally hosted documentation of
688688
your dependencies.
689689

690690
For example, if you are using types from `kotlinx.serialization`, by default they are unclickable in your

docs/topics/runners/dokka-gradle.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ plugins {
3636
</tab>
3737
</tabs>
3838

39-
When documenting [multi-project](dokka-gradle.md#multi-project-builds) builds, you need to apply the Gradle plugin for Dokka
39+
When documenting [multi-project](#multi-project-builds) builds, you need to apply the Gradle plugin for Dokka
4040
within subprojects as well. You can use `allprojects {}` or `subprojects {}` Gradle configurations to achieve that:
4141

4242
<tabs group="build-script">
@@ -451,8 +451,8 @@ plugins {
451451
tasks.withType(DokkaTask.class) {
452452
dokkaSourceSets.configureEach {
453453
documentedVisibilities.set([
454-
DokkaConfiguration.Visibility.PUBLIC,
455-
DokkaConfiguration.Visibility.PROTECTED
454+
Visibility.PUBLIC,
455+
Visibility.PROTECTED
456456
])
457457
458458
perPackageOption {
@@ -942,8 +942,8 @@ tasks.withType(DokkaTask.class) {
942942
<def title="documentedVisibilities">
943943
<p>The set of visibility modifiers that should be documented.</p>
944944
<p>
945-
This can be used if you want to document protected/internal/private declarations,
946-
as well as if you want to exclude public declarations and only document internal API.
945+
This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations,
946+
as well as if you want to exclude <code>public</code> declarations and only document internal API.
947947
</p>
948948
<p>This can be configured on per-package basis.</p>
949949
<p>Default: <code>DokkaConfiguration.Visibility.PUBLIC</code></p>
@@ -1025,7 +1025,7 @@ tasks.withType(DokkaTask.class) {
10251025
</def>
10261026
<def title="noAndroidSdkLink">
10271027
<anchor name="includes"/>
1028-
<p>Whether to generate external documentation links to the Android SDK API reference</p>
1028+
<p>Whether to generate external documentation links to the Android SDK API reference.</p>
10291029
<p>This is only relevant in Android projects, ignored otherwise.</p>
10301030
<p>Note: Links <b>are</b> generated when <code>noAndroidSdkLink</code> is set to <code>false</code>.</p>
10311031
<p>Default: <code>false</code></p>
@@ -1272,8 +1272,8 @@ tasks.withType(DokkaTask.class) {
12721272
<def title="documentedVisibilities">
12731273
<p>The set of visibility modifiers that should be documented.</p>
12741274
<p>
1275-
This can be used if you want to document protected/internal/private declarations within this package,
1276-
as well as if you want to exclude public declarations and only document internal API.
1275+
This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations within this package,
1276+
as well as if you want to exclude <code>public</code> declarations and only document internal API.
12771277
</p>
12781278
<p>This can be configured on source set level.</p>
12791279
<p>Default: <code>DokkaConfiguration.Visibility.PUBLIC</code></p>

docs/topics/runners/dokka-maven.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,8 @@ with [all configuration options](#complete-configuration) applied at the bottom
288288
<def title="documentedVisibilities">
289289
<p>The set of visibility modifiers that should be documented.</p>
290290
<p>
291-
This can be used if you want to document protected/internal/private declarations,
292-
as well as if you want to exclude public declarations and only document internal API.
291+
This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations,
292+
as well as if you want to exclude <code>public</code> declarations and only document internal API.
293293
</p>
294294
<p>Can be configured on per-package basis.</p>
295295
<p>Default: <code>PUBLIC</code></p>
@@ -450,9 +450,9 @@ function in `kotlinx.coroutines`.
450450
</def>
451451
</deflist>
452452

453-
#### External documentation links configuration
453+
### External documentation links configuration
454454

455-
The `externalDocumentationLink` block allows the creation of links that lead to the externally hosted documentation of
455+
The `externalDocumentationLinks` block allows the creation of links that lead to the externally hosted documentation of
456456
your dependencies.
457457

458458
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
545545
<def title="documentedVisibilities">
546546
<p>The set of visibility modifiers that should be documented.</p>
547547
<p>
548-
This can be used if you want to document protected/internal/private declarations within this package,
549-
as well as if you want to exclude public declarations and only document internal API.
548+
This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations within this package,
549+
as well as if you want to exclude <code>public</code> declarations and only document internal API.
550550
</p>
551551
<p>Default: <code>PUBLIC</code></p>
552552
</def>

0 commit comments

Comments
 (0)