Skip to content

Commit

Permalink
Minor fixes for documentation (#2979)
Browse files Browse the repository at this point in the history
  • Loading branch information
LiYing2010 authored Apr 26, 2023
1 parent 79aaba0 commit 1632ff3
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 25 deletions.
4 changes: 2 additions & 2 deletions docs/topics/dokka-module-and-package-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
```
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/formats/dokka-javadoc.md
Original file line number Diff line number Diff line change
@@ -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.**
>
Expand Down
3 changes: 2 additions & 1 deletion docs/topics/formats/dokka-markdown.md
Original file line number Diff line number Diff line change
@@ -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"}

Expand Down
14 changes: 7 additions & 7 deletions docs/topics/runners/dokka-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`. |
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions docs/topics/runners/dokka-gradle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -451,8 +451,8 @@ plugins {
tasks.withType(DokkaTask.class) {
dokkaSourceSets.configureEach {
documentedVisibilities.set([
DokkaConfiguration.Visibility.PUBLIC,
DokkaConfiguration.Visibility.PROTECTED
Visibility.PUBLIC,
Visibility.PROTECTED
])
perPackageOption {
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
12 changes: 6 additions & 6 deletions docs/topics/runners/dokka-maven.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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>
Expand Down

0 comments on commit 1632ff3

Please sign in to comment.