Skip to content
This repository was archived by the owner on Jan 22, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions gradle/dokka/dokka-customFormat-example/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
import org.jetbrains.dokka.gradle.DokkaTask

plugins {
kotlin("jvm") version "1.4.0-rc"
id("org.jetbrains.dokka") version ("1.4.0-rc")
kotlin("jvm") version "1.4.0"
id("org.jetbrains.dokka") version ("1.4.0")
}

repositories {
mavenCentral()
jcenter()
maven("https://dl.bintray.com/kotlin/kotlin-eap")
maven("https://dl.bintray.com/kotlin/kotlin-dev")
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}

tasks.register<DokkaTask>("dokkaCustomFormat") {
dependencies {
// Using the javadoc plugin as "custom format". Can use any plugin here!
plugins("org.jetbrains.dokka:javadoc-plugin:1.4.0-rc")
plugins("org.jetbrains.dokka:javadoc-plugin:1.4.0")
}
}

Expand Down
3 changes: 2 additions & 1 deletion gradle/dokka/dokka-customFormat-example/settings.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
pluginManagement {
repositories {
gradlePluginPortal()
jcenter()
mavenCentral()
maven("https://dl.bintray.com/kotlin/kotlin-eap")
maven("https://dl.bintray.com/kotlin/kotlin-dev")
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}
}

Expand Down
22 changes: 12 additions & 10 deletions gradle/dokka/dokka-gradle-example/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,32 +1,34 @@
import org.jetbrains.dokka.gradle.DokkaTask
import java.net.URL

plugins {
kotlin("jvm") version "1.4.0-rc"
id("org.jetbrains.dokka") version ("1.4.0-rc")
kotlin("jvm") version "1.4.0"
id("org.jetbrains.dokka") version ("1.4.0")
}

repositories {
mavenCentral()
jcenter()
maven("https://dl.bintray.com/kotlin/kotlin-eap")
maven("https://dl.bintray.com/kotlin/kotlin-dev")
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}

dependencies {
implementation(kotlin("stdlib"))
testImplementation(kotlin("test-junit"))
}

tasks.withType<DokkaTask> {
tasks.withType<DokkaTask>().configureEach {
dokkaSourceSets {
register("main") {
moduleDisplayName = "Dokka Gradle Example"
includes = listOf("Module.md")
named("main") {
moduleDisplayName.set("Dokka Gradle Example")
includes.from("Module.md")
sourceLink {
path = "src/main/kotlin"
url = "https://github.com/Kotlin/kotlin-examples/tree/master/" +
localDirectory.set(file("src/main/kotlin"))
remoteUrl.set(URL("https://github.com/Kotlin/kotlin-examples/tree/master/" +
"gradle/dokka/dokka-gradle-example/src/main/kotlin"
lineSuffix = "#L"
))
remoteLineSuffix.set("#L")
}
}
}
Expand Down
3 changes: 2 additions & 1 deletion gradle/dokka/dokka-gradle-example/settings.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
pluginManagement {
repositories {
gradlePluginPortal()
jcenter()
mavenCentral()
maven("https://dl.bintray.com/kotlin/kotlin-eap")
maven("https://dl.bintray.com/kotlin/kotlin-dev")
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}
}

Expand Down
12 changes: 6 additions & 6 deletions gradle/dokka/dokka-kotlinAsJava-example/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
plugins {
kotlin("jvm") version "1.4.0-rc"
id("org.jetbrains.dokka") version ("1.4.0-rc")
kotlin("jvm") version "1.4.0"
id("org.jetbrains.dokka") version ("1.4.0")
}

repositories {
mavenCentral()
jcenter()
maven("https://dl.bintray.com/kotlin/kotlin-eap")
maven("https://dl.bintray.com/kotlin/kotlin-dev")
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}

dependencies {
implementation(kotlin("stdlib"))
testImplementation(kotlin("test-junit"))

// Will apply the plugin to all dokka tasks
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.0-rc")
dokkaPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.0")

// Will apply the plugin only to the `:dokkaHtml` task
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.0-rc")
//dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.0")

// Will apply the plugin only to the `:dokkaGfm` task
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.0-rc")
//dokkaGfmPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.0")
}
3 changes: 2 additions & 1 deletion gradle/dokka/dokka-kotlinAsJava-example/settings.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
pluginManagement {
repositories {
gradlePluginPortal()
jcenter()
mavenCentral()
maven("https://dl.bintray.com/kotlin/kotlin-eap")
maven("https://dl.bintray.com/kotlin/kotlin-dev")
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}
}

Expand Down
10 changes: 5 additions & 5 deletions gradle/dokka/dokka-library-publishing-example/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
plugins {
kotlin("jvm") version "1.4.0-rc"
id("org.jetbrains.dokka") version ("1.4.0-rc")
kotlin("jvm") version "1.4.0"
id("org.jetbrains.dokka") version ("1.4.0")
`java-library`
`maven-publish`
}
Expand All @@ -9,7 +9,7 @@ repositories {
mavenCentral()
jcenter()
maven("https://dl.bintray.com/kotlin/kotlin-eap")
maven("https://dl.bintray.com/kotlin/kotlin-dev")
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}

dependencies {
Expand All @@ -19,13 +19,13 @@ dependencies {

val dokkaJavadocJar by tasks.register<Jar>("dokkaJavadocJar") {
dependsOn(tasks.dokkaJavadoc)
from(tasks.dokkaJavadoc.get().getOutputDirectoryAsFile())
from(tasks.dokkaJavadoc.flatMap { it.outputDirectory })
archiveClassifier.set("javadoc")
}

val dokkaHtmlJar by tasks.register<Jar>("dokkaHtmlJar") {
dependsOn(tasks.dokkaHtml)
from(tasks.dokkaHtml.get().getOutputDirectoryAsFile())
from(tasks.dokkaHtml.flatMap { it.outputDirectory })
archiveClassifier.set("html-doc")
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
pluginManagement {
repositories {
gradlePluginPortal()
jcenter()
mavenCentral()
maven("https://dl.bintray.com/kotlin/kotlin-eap")
maven("https://dl.bintray.com/kotlin/kotlin-dev")
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}
}

Expand Down
1 change: 1 addition & 0 deletions gradle/dokka/dokka-multimodule-example/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ subprojects {
repositories {
mavenCentral()
jcenter()
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ dependencies {
* Configuring the html multimodule task
* Run ./gradlew :parentProject:dokkaHtmlMultimodule
*/
tasks.dokkaHtmlMultimodule {
documentationFileName = "Module.md"
tasks.dokkaHtmlMultiModule {
documentationFileName.set("Module.md")
}

Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ dependencies {
implementation(kotlin("stdlib"))
}

tasks.withType<DokkaTask> {
tasks.withType<DokkaTask>().configureEach {
dokkaSourceSets {
configureEach {
includes = listOf("Module.md")
includes.from("Module.md")
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ dependencies {
implementation(kotlin("stdlib"))
}

tasks.withType<DokkaTask> {
tasks.withType<DokkaTask>().configureEach {
dokkaSourceSets {
configureEach {
includes = listOf("Module.md")
includes.from("Module.md")
}
}
}
6 changes: 4 additions & 2 deletions gradle/dokka/dokka-multimodule-example/settings.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
pluginManagement {
plugins {
kotlin("jvm") version "1.4.0-rc"
id("org.jetbrains.dokka") version ("1.4.0-rc")
kotlin("jvm") version "1.4.0"
id("org.jetbrains.dokka") version ("1.4.0")
}
repositories {
gradlePluginPortal()
jcenter()
mavenCentral()
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}
}

Expand Down
46 changes: 15 additions & 31 deletions gradle/dokka/dokka-multiplatform-example/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
@file:Suppress("UNUSED_VARIABLE")

import org.jetbrains.dokka.gradle.DokkaTask
import org.jetbrains.dokka.Platform

plugins {
kotlin("multiplatform") version "1.4.0-rc"
id("org.jetbrains.dokka") version "1.4.0-rc"
kotlin("multiplatform") version "1.4.0"
id("org.jetbrains.dokka") version "1.4.0"
}

repositories {
jcenter()
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}

group = "org.test"
Expand All @@ -23,47 +25,29 @@ kotlin {
val commonMain by getting {
dependencies {
implementation(kotlin("stdlib-common"))
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.8-1.4.0-rc")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9")
}
}
}
}

tasks.withType<DokkaTask>().configureEach {
dokkaSourceSets {
register("commonMain") {
sourceRoot { path = "src/commonMain/kotlin" }
}

register("jsMain") {
dependsOn("commonMain")
sourceRoot { path = "src/jsMain/kotlin" }
}

register("jvmMain") {
dependsOn("commonMain")
sourceRoot { path = "src/jvmMain/kotlin" }
}

register("linuxMain") {
dependsOn("commonMain")
sourceRoot { path = "src/linuxMain/kotlin" }
}

register("macosMain") {
dependsOn("commonMain")
sourceRoot { path = "src/macosMain/kotlin" }
/*
Giving all 'native' source sets the same name will make them displayed by a single bubble.
*/
configureEach {
if (platform.get() == Platform.native) {
displayName.set("native")
}
}

/*
Create custom source set (not known to the Kotlin Gradle Plugin)
*/
register("customSourceSet") {
this.jdkVersion = 9
this.displayName = "Custom JDK 10 Source Set"
this.sourceRoot {
this.path = "src/customJdk10/kotlin"
}
this.jdkVersion.set(9)
this.displayName.set("custom")
this.sourceRoots.from(file("src/customJdk10/kotlin"))
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ pluginManagement {
repositories {
gradlePluginPortal()
jcenter()
maven("https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev")
}
}
rootProject.name = "dokka-multiplatform-example"
Expand Down