Skip to content

Migrate doc generation from Javadoc to Dokka #2882

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.

Sign up for GitHub

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

Draft
wmathurin wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

Migrate doc generation from Javadoc to Dokka #2882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ buildscript {
classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:2.3.20")
classpath("org.jetbrains.kotlin:compose-compiler-gradle-plugin:2.3.21")
classpath("org.jacoco:org.jacoco.core:0.8.14")
classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.9.20")
}
}

Expand All @@ -32,3 +33,16 @@ allprojects {
}
}
}

apply(plugin = "org.jetbrains.dokka")

subprojects {
if (path.startsWith(":libs:")) {
apply(plugin = "org.jetbrains.dokka")
}
}

tasks.named<org.jetbrains.dokka.gradle.DokkaMultiModuleTask>("dokkaHtmlMultiModule") {
moduleName.set("SalesforceSDK 14.0 API")
outputDirectory.set(rootDir.resolve("doc"))
}
2 changes: 1 addition & 1 deletion tools/generate_doc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ if [ ! -d "external" ]
then
echo "You must run this tool from the root directory of your repo clone"
else
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
./gradlew dokkaHtmlMultiModule
fi
Loading