diff options
| -rw-r--r-- | docs/topics/dokka-module-and-package-docs.md | 18 | ||||
| -rw-r--r-- | docs/topics/runners/dokka-gradle.md | 134 |
2 files changed, 82 insertions, 70 deletions
diff --git a/docs/topics/dokka-module-and-package-docs.md b/docs/topics/dokka-module-and-package-docs.md index edfa150f..d8ceb3fa 100644 --- a/docs/topics/dokka-module-and-package-docs.md +++ b/docs/topics/dokka-module-and-package-docs.md @@ -53,14 +53,24 @@ To pass these files to Dokka, you need to use the relevant **includes** option f <tabs group="build-script"> <tab title="Gradle" group-key="gradle"> -Use the <a href="dokka-gradle.md#includes">includes</a> option in <a href="dokka-gradle.md#source-set-configuration">Source set configuration</a>. + +Use the [includes](dokka-gradle.md#includes) option in [Source set configuration](dokka-gradle.md#source-set-configuration). + </tab> + <tab title="Maven" group-key="mvn"> -Use the <a href="dokka-maven.md#includes">includes</a> option in <a href="dokka-maven.md#general-configuration">General configuration</a>. + +Use the [includes](dokka-maven.md#includes) option in [General configuration](dokka-maven.md#general-configuration). + </tab> + <tab title="CLI" group-key="cli"> -If you are using command line configuration, use the <a href="dokka-cli.md#includes-cli">includes</a> option in <a href="dokka-cli.md#source-set-options">Source set options</a>. -If you are using JSON configuration, use the <a href="dokka-cli.md#includes-json">includes</a> option in <a href="dokka-cli.md#general-configuration">General configuration</a>. +If you are using command line configuration, use the [includes](dokka-cli.md#includes-cli) option in +[Source set options](dokka-cli.md#source-set-options). + +If you are using JSON configuration, use the [includes](dokka-cli.md#includes-json) option in +[General configuration](dokka-cli.md#general-configuration). + </tab> </tabs> diff --git a/docs/topics/runners/dokka-gradle.md b/docs/topics/runners/dokka-gradle.md index f81ffe1d..ae8b003b 100644 --- a/docs/topics/runners/dokka-gradle.md +++ b/docs/topics/runners/dokka-gradle.md @@ -826,40 +826,41 @@ tasks.withType<DokkaTask>().configureEach { // general configuration section // .. - // configuration exclusive to the 'linux' source set - named("linux") { - dependsOn("native") - sourceRoots.from(file("linux/src")) - } - - dokkaSourceSets.configureEach { - suppress.set(false) - displayName.set(name) - documentedVisibilities.set(setOf(Visibility.PUBLIC)) - reportUndocumented.set(false) - skipEmptyPackages.set(true) - skipDeprecated.set(false) - suppressGeneratedFiles.set(true) - jdkVersion.set(8) - languageVersion.set("1.7") - apiVersion.set("1.7") - noStdlibLink.set(false) - noJdkLink.set(false) - noAndroidSdkLink.set(false) - includes.from(project.files(), "packages.md", "extra.md") - platform.set(Platform.DEFAULT) - sourceRoots.from(file("src")) - classpath.from(project.files(), file("libs/dependency.jar")) - samples.from(project.files(), "samples/Basic.kt", "samples/Advanced.kt") - - sourceLink { - // Source link section - } - externalDocumentationLink { - // External documentation link section + dokkaSourceSets { + // configuration exclusive to the 'linux' source set + named("linux") { + dependsOn("native") + sourceRoots.from(file("linux/src")) } - perPackageOption { - // Package options section + configureEach { + suppress.set(false) + displayName.set(name) + documentedVisibilities.set(setOf(Visibility.PUBLIC)) + reportUndocumented.set(false) + skipEmptyPackages.set(true) + skipDeprecated.set(false) + suppressGeneratedFiles.set(true) + jdkVersion.set(8) + languageVersion.set("1.7") + apiVersion.set("1.7") + noStdlibLink.set(false) + noJdkLink.set(false) + noAndroidSdkLink.set(false) + includes.from(project.files(), "packages.md", "extra.md") + platform.set(Platform.DEFAULT) + sourceRoots.from(file("src")) + classpath.from(project.files(), file("libs/dependency.jar")) + samples.from(project.files(), "samples/Basic.kt", "samples/Advanced.kt") + + sourceLink { + // Source link section + } + externalDocumentationLink { + // External documentation link section + } + perPackageOption { + // Package options section + } } } } @@ -881,41 +882,42 @@ tasks.withType(DokkaTask.class) { // .. // general configuration section // .. - - // configuration exclusive to the 'linux' source set - named("linux") { - dependsOn("native") - sourceRoots.from(file("linux/src")) - } - dokkaSourceSets.configureEach { - suppress.set(false) - displayName.set(name) - documentedVisibilities.set([Visibility.PUBLIC]) - reportUndocumented.set(false) - skipEmptyPackages.set(true) - skipDeprecated.set(false) - suppressGeneratedFiles.set(true) - jdkVersion.set(8) - languageVersion.set("1.7") - apiVersion.set("1.7") - noStdlibLink.set(false) - noJdkLink.set(false) - noAndroidSdkLink.set(false) - includes.from(project.files(), "packages.md", "extra.md") - platform.set(Platform.DEFAULT) - sourceRoots.from(file("src")) - classpath.from(project.files(), file("libs/dependency.jar")) - samples.from(project.files(), "samples/Basic.kt", "samples/Advanced.kt") - - sourceLink { - // Source link section - } - externalDocumentationLink { - // External documentation link section + dokkaSourceSets { + // configuration exclusive to the 'linux' source set + named("linux") { + dependsOn("native") + sourceRoots.from(file("linux/src")) } - perPackageOption { - // Package options section + configureEach { + suppress.set(false) + displayName.set(name) + documentedVisibilities.set([Visibility.PUBLIC]) + reportUndocumented.set(false) + skipEmptyPackages.set(true) + skipDeprecated.set(false) + suppressGeneratedFiles.set(true) + jdkVersion.set(8) + languageVersion.set("1.7") + apiVersion.set("1.7") + noStdlibLink.set(false) + noJdkLink.set(false) + noAndroidSdkLink.set(false) + includes.from(project.files(), "packages.md", "extra.md") + platform.set(Platform.DEFAULT) + sourceRoots.from(file("src")) + classpath.from(project.files(), file("libs/dependency.jar")) + samples.from(project.files(), "samples/Basic.kt", "samples/Advanced.kt") + + sourceLink { + // Source link section + } + externalDocumentationLink { + // External documentation link section + } + perPackageOption { + // Package options section + } } } } |