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 +++++++------- docs/topics/runners/dokka-gradle.md | 16 ++++++++-------- docs/topics/runners/dokka-maven.md | 12 ++++++------ 3 files changed, 21 insertions(+), 21 deletions(-) (limited to 'docs/topics/runners') 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 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 { -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: @@ -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) {

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.

Default: DokkaConfiguration.Visibility.PUBLIC

@@ -1025,7 +1025,7 @@ tasks.withType(DokkaTask.class) { -

Whether to generate external documentation links to the Android SDK API reference

+

Whether to generate external documentation links to the Android SDK API reference.

This is only relevant in Android projects, ignored otherwise.

Note: Links are generated when noAndroidSdkLink is set to false.

Default: false

@@ -1272,8 +1272,8 @@ tasks.withType(DokkaTask.class) {

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.

This can be configured on source set level.

Default: DokkaConfiguration.Visibility.PUBLIC

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

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.

Can be configured on per-package basis.

Default: PUBLIC

@@ -450,9 +450,9 @@ function in `kotlinx.coroutines`. -#### 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

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.

Default: PUBLIC

 -- cgit