From 1632ff37d0fcfe8e9db260b0aaf3b547533f5a08 Mon Sep 17 00:00:00 2001 From: Ying Li Date: Wed, 26 Apr 2023 21:22:15 +0900 Subject: Minor fixes for documentation (#2979) --- docs/topics/runners/dokka-cli.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/topics/runners/dokka-cli.md') 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. | | `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

The set of visibility modifiers that should be documented.

- 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 protected/internal/private declarations, + as well as if you want to exclude public declarations and only document internal API.

This can be configured on per-package basis.

@@ -674,17 +674,17 @@ You can add package configurations for all source sets together at the same time

The set of visibility modifiers that should be documented.

- 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 protected/internal/private declarations within this package, + as well as if you want to exclude public declarations and only document internal API.

Can be configured on source set level.

Default: PUBLIC

-### 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 -- cgit