Skip to content

Commit ca12605

Browse files
authored
Merge pull request #2887 from wmathurin/feature/migrate-doc-generation-to-dokka
Migrate doc generation to Dokka v2
2 parents 138b7ef + 608b88e commit ca12605

9 files changed

Lines changed: 31 additions & 1 deletion

File tree

build.gradle.kts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ buildscript {
1515
classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:2.3.20")
1616
classpath("org.jetbrains.kotlin:compose-compiler-gradle-plugin:2.3.21")
1717
classpath("org.jacoco:org.jacoco.core:0.8.14")
18+
classpath("org.jetbrains.dokka:dokka-gradle-plugin:2.0.0")
1819
}
1920
}
2021

@@ -32,3 +33,25 @@ allprojects {
3233
}
3334
}
3435
}
36+
37+
apply(plugin = "org.jetbrains.dokka")
38+
39+
extensions.configure<org.jetbrains.dokka.gradle.DokkaExtension> {
40+
dokkaPublications.named("html") {
41+
outputDirectory.set(rootDir.resolve("doc"))
42+
}
43+
}
44+
45+
dependencies {
46+
add("dokka", project(":libs:SalesforceAnalytics"))
47+
add("dokka", project(":libs:SalesforceSDK"))
48+
add("dokka", project(":libs:SmartStore"))
49+
add("dokka", project(":libs:MobileSync"))
50+
add("dokka", project(":libs:SalesforceHybrid"))
51+
add("dokka", project(":libs:SalesforceReact"))
52+
}
53+
54+
tasks.register<Jar>("javadocJar") {
55+
from(tasks.named("dokkaGeneratePublicationHtml"))
56+
archiveClassifier.set("javadoc")
57+
}

gradle.properties

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ android.r8.optimizedResourceShrinking=false
1616
android.builtInKotlin=false
1717
# TODO: This should be resolved in a dedicated work item. ECJ20260423
1818
android.newDsl=false
19+
org.jetbrains.dokka.experimental.gradle.pluginMode=V2EnabledWithHelpers

libs/MobileSync/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ plugins {
77
`kotlin-android`
88
`publish-module`
99
jacoco
10+
id("org.jetbrains.dokka")
1011
}
1112

1213
dependencies {

libs/SalesforceAnalytics/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ plugins {
77
`kotlin-android`
88
`publish-module`
99
jacoco
10+
id("org.jetbrains.dokka")
1011
}
1112

1213
dependencies {

libs/SalesforceHybrid/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ plugins {
99
`kotlin-android`
1010
`publish-module`
1111
jacoco
12+
id("org.jetbrains.dokka")
1213
}
1314

1415
dependencies {

libs/SalesforceReact/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ plugins {
1818
`kotlin-android`
1919
`publish-module`
2020
jacoco
21+
id("org.jetbrains.dokka")
2122
}
2223

2324
dependencies {

libs/SalesforceSDK/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ plugins {
1010
kotlin("plugin.serialization") version "2.3.20"
1111
kotlin("plugin.parcelize")
1212
kotlin("plugin.compose")
13+
id("org.jetbrains.dokka")
1314
}
1415

1516
dependencies {

libs/SmartStore/build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ plugins {
77
`kotlin-android`
88
`publish-module`
99
jacoco
10+
id("org.jetbrains.dokka")
1011
}
1112

1213
dependencies {

tools/generate_doc.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ if [ ! -d "external" ]
33
then
44
echo "You must run this tool from the root directory of your repo clone"
55
else
6-
javadoc -d doc -author -version -verbose -use -doctitle "SalesforceSDK 14.0 API" -sourcepath "libs/SalesforceAnalytics/src:libs/SalesforceSDK/src:libs/SmartStore/src:libs/MobileSync/src:libs/SalesforceHybrid/src:libs/SalesforceReact/src" -subpackages com
6+
./gradlew dokkaGeneratePublicationHtml
77
fi

0 commit comments

Comments
 (0)