diff options
author | Ying Li <liying.cn.2010@gmail.com> | 2023-04-26 21:22:15 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-04-26 14:22:15 +0200 |
commit | 1632ff37d0fcfe8e9db260b0aaf3b547533f5a08 (patch) | |
tree | d434cde3e6e431432da3fd19aaac0171bc2270ff /docs/topics/runners/dokka-gradle.md | |
parent | 79aaba062ebcb9e22599263b0f2a9dee3be688d1 (diff) | |
download | dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.tar.gz dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.tar.bz2 dokka-1632ff37d0fcfe8e9db260b0aaf3b547533f5a08.zip |
Minor fixes for documentation (#2979)
Diffstat (limited to 'docs/topics/runners/dokka-gradle.md')
-rw-r--r-- | docs/topics/runners/dokka-gradle.md | 16 |
1 files changed, 8 insertions, 8 deletions
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> |