aboutsummaryrefslogtreecommitdiff
path: root/examples/gradle/dokka-customFormat-example/build.gradle.kts
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-01-19 04:10:57 +0100
committerGitHub <noreply@github.com>2023-01-19 04:10:57 +0100
commit5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 (patch)
treebb62ab50a59cbeca06de6fd1eb5c75ff27bc5bd0 /examples/gradle/dokka-customFormat-example/build.gradle.kts
parent1fa8552994fb292729eca8c0de6a1561380b008c (diff)
downloaddokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.gz
dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.bz2
dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.zip
Revise README documentation for examples and plugins (#2736)
Diffstat (limited to 'examples/gradle/dokka-customFormat-example/build.gradle.kts')
-rw-r--r--examples/gradle/dokka-customFormat-example/build.gradle.kts12
1 files changed, 7 insertions, 5 deletions
diff --git a/examples/gradle/dokka-customFormat-example/build.gradle.kts b/examples/gradle/dokka-customFormat-example/build.gradle.kts
index 8d1d36ce..0c845572 100644
--- a/examples/gradle/dokka-customFormat-example/build.gradle.kts
+++ b/examples/gradle/dokka-customFormat-example/build.gradle.kts
@@ -1,4 +1,6 @@
import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.DokkaBaseConfiguration
plugins {
kotlin("jvm") version "1.7.20"
@@ -15,16 +17,16 @@ repositories {
mavenCentral()
}
-/**
- * Custom format adds a custom logo
- */
-tasks.register<DokkaTask>("dokkaCustomFormat") {
- pluginConfiguration<org.jetbrains.dokka.base.DokkaBase, org.jetbrains.dokka.base.DokkaBaseConfiguration> {
+tasks.dokkaHtml {
+ pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
// Dokka's stylesheets and assets with conflicting names will be overriden.
// In this particular case, logo-styles.css will be overriden and ktor-logo.png will
// be added as an additional image asset
customStyleSheets = listOf(file("logo-styles.css"))
customAssets = listOf(file("ktor-logo.png"))
+
+ // Text used in the footer
+ footerMessage = "(c) Custom Format Dokka example"
}
}