Skip to content

Commit 777b975

Browse files
authored
Include Dokka for language-agnostic doc generation (#176)
1 parent 9fc6f63 commit 777b975

File tree

4 files changed

+22
-9
lines changed

4 files changed

+22
-9
lines changed

build.gradle.kts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ buildscript {
1313
classpath(Libs.gradle_bintray_plugin)
1414
classpath(Libs.android_maven_gradle_plugin)
1515
classpath(Libs.gradle_versions_plugin)
16+
classpath(Libs.dokka_core_plugin)
17+
classpath(Libs.dokka_android_plugin)
1618
}
1719
}
1820

buildSrc/src/main/kotlin/Libs.kt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,18 @@ object Libs {
6464
"com.github.dcendents:android-maven-gradle-plugin:" +
6565
Versions.android_maven_gradle_plugin
6666

67+
/**
68+
* https://github.com/Kotlin/dokka */
69+
const val dokka_core_plugin: String =
70+
"org.jetbrains.dokka:dokka-gradle-plugin:" +
71+
Versions.dokka
72+
73+
/**
74+
* https://github.com/Kotlin/dokka */
75+
const val dokka_android_plugin: String =
76+
"org.jetbrains.dokka:dokka-android-gradle-plugin:" +
77+
Versions.dokka
78+
6779
/**
6880
* https://github.com/zafarkhaja/jsemver */
6981
const val java_semver: String = "com.github.zafarkhaja:java-semver:" + Versions.java_semver

buildSrc/src/main/kotlin/Versions.kt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ object Versions {
2828

2929
const val gradle_versions_plugin: String = "0.20.0"
3030

31-
const val android_maven_gradle_plugin: String = "2.1"
31+
const val android_maven_gradle_plugin: String = "2.1"
32+
33+
const val dokka: String = "0.9.18"
3234

3335
const val java_semver: String = "0.9.0"
3436

gradle/deployment.gradle

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,15 @@ if (targetPlatform == "java") {
5353

5454
// Include javadoc.jar archive in each release
5555
if (targetPlatform == "android") {
56-
task javadoc(type: Javadoc) {
57-
source = android.sourceSets.main.java.srcDirs
58-
excludes = ["**/*.kt"]
59-
failOnError = false
60-
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
61-
}
56+
apply plugin: "org.jetbrains.dokka-android"
57+
} else {
58+
apply plugin: "org.jetbrains.dokka"
6259
}
6360

64-
task javadocJar(type: Jar, dependsOn: javadoc) {
61+
task javadocJar(type: Jar, dependsOn: dokka) {
6562
baseName = artifactId
6663
classifier = "javadoc"
67-
from javadoc.destinationDir
64+
from dokka.outputDirectory
6865
}
6966

7067
// ------------------------------------------------------------------------------------------------

0 commit comments

Comments
 (0)