Skip to content

Commit e3cb4fb

Browse files
committed
Migrate doc generation from Javadoc to Dokka
Replace the raw javadoc invocation in tools/generate_doc.sh with ./gradlew dokkaHtmlMultiModule. Add the Dokka Gradle plugin (1.9.20) to the buildscript classpath, apply it at the root for multi-module aggregation, and to all :libs:* subprojects for per-module docs. Output directory remains doc/ at the repo root.
1 parent 3b19ac6 commit e3cb4fb

2 files changed

Lines changed: 15 additions & 1 deletion

File tree

build.gradle.kts

Lines changed: 14 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:1.9.20")
1819
}
1920
}
2021

@@ -32,3 +33,16 @@ allprojects {
3233
}
3334
}
3435
}
36+
37+
apply(plugin = "org.jetbrains.dokka")
38+
39+
subprojects {
40+
if (path.startsWith(":libs:")) {
41+
apply(plugin = "org.jetbrains.dokka")
42+
}
43+
}
44+
45+
tasks.named<org.jetbrains.dokka.gradle.DokkaMultiModuleTask>("dokkaHtmlMultiModule") {
46+
moduleName.set("SalesforceSDK 14.0 API")
47+
outputDirectory.set(rootDir.resolve("doc"))
48+
}

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 dokkaHtmlMultiModule
77
fi

0 commit comments

Comments
 (0)