Migrate doc generation from Javadoc to Dokka#2882
Draft
wmathurin wants to merge 1 commit into
Draft
Conversation
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.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #2882 +/- ##
=============================================
- Coverage 65.59% 55.03% -10.57%
+ Complexity 3024 2496 -528
=============================================
Files 223 226 +3
Lines 17629 17752 +123
Branches 2300 2316 +16
=============================================
- Hits 11563 9769 -1794
- Misses 4988 6985 +1997
+ Partials 1078 998 -80
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
javadocCLI invocation intools/generate_doc.shwith./gradlew dokkaHtmlMultiModulebuild.gradle.kts:libs:*subprojectsdoc/at the repo root — no change to the release/gh-pages workflowWhy Dokka
Dokka is JetBrains' official documentation engine for Kotlin. It understands KDoc natively (Javadoc does not), produces modern searchable HTML, and integrates directly with Gradle — no separate tool installation required. As the codebase moves to Kotlin-first, this ensures doc comments are rendered correctly.
Test plan
./tools/generate_doc.shfrom the repo root and verifydoc/index.htmlis generateddoc/index.htmland confirm all six library modules appear (SalesforceAnalytics, SalesforceSDK, SmartStore, MobileSync, SalesforceHybrid, SalesforceReact)