aboutsummaryrefslogtreecommitdiff
path: root/examples/gradle/dokka-gradle-example/build.gradle.kts
diff options
context:
space:
mode:
Diffstat (limited to 'examples/gradle/dokka-gradle-example/build.gradle.kts')
-rw-r--r--examples/gradle/dokka-gradle-example/build.gradle.kts6
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/" +