Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Gradle task dokkaHtml to run Dokka document generation #1466

Merged
merged 14 commits into from
Jul 25, 2022
Merged
3 changes: 3 additions & 0 deletions buildSrc/src/main/kotlin/Plugins.kt
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ object Plugins {
const val navSafeArgs = "androidx.navigation.safeargs.kotlin"
const val spotless = "com.diffplug.spotless"
const val ruler = "com.spotify.ruler"
const val dokka = "org.jetbrains.dokka"
}

// classpath plugins
Expand All @@ -39,5 +40,7 @@ object Plugins {

object Versions {
const val androidGradlePlugin = "7.0.2"
// Use Dokka 1.6.10 until https://github.com/Kotlin/dokka/issues/2472 is resolved.
const val dokka = "1.6.10"
}
}
22 changes: 22 additions & 0 deletions datacapture/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
import java.net.URL

plugins {
id(Plugins.BuildPlugins.androidLib)
id(Plugins.BuildPlugins.kotlinAndroid)
id(Plugins.BuildPlugins.mavenPublish)
jacoco
// Use Dokka 1.6.10 until https://github.com/Kotlin/dokka/issues/2452 is resolved.
id(Plugins.BuildPlugins.dokka).version(Plugins.Versions.dokka)
}

publishArtifact(Releases.DataCapture)
Expand Down Expand Up @@ -87,3 +91,21 @@ dependencies {
testImplementation(Dependencies.truth)
androidTestImplementation(Dependencies.Espresso.espressoCore)
}

tasks.dokkaHtml.configure {
outputDirectory.set(file("../docs/${Releases.DataCapture.artifactId}"))
suppressInheritedMembers.set(true)
dokkaSourceSets {
named("main") {
moduleName.set(Releases.DataCapture.artifactId)
moduleVersion.set(Releases.DataCapture.version)
noAndroidSdkLink.set(false)
externalDocumentationLink {
url.set(URL("https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/"))
packageListUrl.set(
URL("https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/element-list")
)
}
}
}
}
21 changes: 21 additions & 0 deletions engine/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
import codegen.GenerateSourcesTask
import java.net.URL

plugins {
id(Plugins.BuildPlugins.androidLib)
id(Plugins.BuildPlugins.kotlinAndroid)
id(Plugins.BuildPlugins.kotlinKapt)
id(Plugins.BuildPlugins.mavenPublish)
jacoco
// Use Dokka 1.6.10 until https://github.com/Kotlin/dokka/issues/2452 is resolved.
id(Plugins.BuildPlugins.dokka).version(Plugins.Versions.dokka)
}

publishArtifact(Releases.Engine)
Expand Down Expand Up @@ -135,3 +138,21 @@ dependencies {
testImplementation(Dependencies.robolectric)
testImplementation(Dependencies.truth)
}

tasks.dokkaHtml.configure {
outputDirectory.set(file("../docs/${Releases.Engine.artifactId}"))
suppressInheritedMembers.set(true)
dokkaSourceSets {
named("main") {
moduleName.set(Releases.Engine.artifactId)
moduleVersion.set(Releases.Engine.version)
noAndroidSdkLink.set(false)
externalDocumentationLink {
url.set(URL("https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/"))
packageListUrl.set(
URL("https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/element-list")
)
}
}
}
}
21 changes: 21 additions & 0 deletions workflow/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
import java.net.URL

plugins {
id(Plugins.BuildPlugins.androidLib)
id(Plugins.BuildPlugins.kotlinAndroid)
id(Plugins.BuildPlugins.mavenPublish)
jacoco
id(Plugins.BuildPlugins.dokka).version(Plugins.Versions.dokka)
}

publishArtifact(Releases.Workflow)
Expand Down Expand Up @@ -139,3 +142,21 @@ dependencies {
testImplementation(Dependencies.truth)
testImplementation(project(":testing"))
}

tasks.dokkaHtml.configure {
outputDirectory.set(file("../docs/${Releases.Workflow.artifactId}"))
suppressInheritedMembers.set(true)
dokkaSourceSets {
named("main") {
moduleName.set(Releases.Workflow.artifactId)
moduleVersion.set(Releases.Workflow.version)
noAndroidSdkLink.set(false)
externalDocumentationLink {
url.set(URL("https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/"))
packageListUrl.set(
URL("https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/element-list")
)
}
}
}
}