diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-01-19 04:10:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-19 04:10:57 +0100 |
| commit | 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 (patch) | |
| tree | bb62ab50a59cbeca06de6fd1eb5c75ff27bc5bd0 /examples/gradle/dokka-gradle-example/build.gradle.kts | |
| parent | 1fa8552994fb292729eca8c0de6a1561380b008c (diff) | |
| download | dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.gz dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.bz2 dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.zip | |
Revise README documentation for examples and plugins (#2736)
Diffstat (limited to 'examples/gradle/dokka-gradle-example/build.gradle.kts')
| -rw-r--r-- | examples/gradle/dokka-gradle-example/build.gradle.kts | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/examples/gradle/dokka-gradle-example/build.gradle.kts b/examples/gradle/dokka-gradle-example/build.gradle.kts index ac62fccd..db3d91b9 100644 --- a/examples/gradle/dokka-gradle-example/build.gradle.kts +++ b/examples/gradle/dokka-gradle-example/build.gradle.kts @@ -18,8 +18,14 @@ dependencies { tasks.withType<DokkaTask>().configureEach { dokkaSourceSets { named("main") { + // used as project name in the header moduleName.set("Dokka Gradle Example") + + // contains descriptions for the module and the packages includes.from("Module.md") + + // adds source links that lead to this repository, allowing readers + // to easily find source code for inspected declarations sourceLink { localDirectory.set(file("src/main/kotlin")) remoteUrl.set(URL("https://github.com/Kotlin/dokka/tree/master/" + |