Repository navigation
Name Dokka docs after the artifact instead of :lib - #6
Merged
Merged
Conversation
Dokka defaults its module name (and source-set name) to the Gradle module path, so the published -javadoc.jar — and javadoc.io — labeled the docs `:lib` and `:lib/main`. Set `moduleName` to `webview-bundle-android` and relabel the source set to `android`, so no `:lib` leaks into the published docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XDfLFUFoRLa9WiyBxSPa3j
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
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.
Problem
The published API docs on javadoc.io label the module
:lib(and the platform-filter chip:lib/main).Cause
The library is the Gradle module
:lib(include("lib")). Dokka defaults its module name and source-set name to the Gradle module path, and no name was set — so:lib/:lib/mainend up in the published-javadoc.jarthat javadoc.io hosts.Fix
Set the Dokka names in
lib/build.gradle.kts:dokka { moduleName.set("webview-bundle-android") dokkaSourceSets.configureEach { displayName.set("android") } }Verification
Regenerated the docs locally (
./gradlew :lib:dokkaGeneratePublicationHtml):webview-bundle-android(was:lib)webview-bundle-android/dev.wvb/…android(was:lib/main):libin any visible text node (only the internaldata-filterable-setattribute Dokka's JS uses for filtering, which is never rendered)Takes effect on the next publish, which javadoc.io re-hosts from Maven Central.
🤖 Generated with Claude Code
https://claude.ai/code/session_01XDfLFUFoRLa9WiyBxSPa3j
Summary by cubic
Update Dokka so the published API docs use the artifact name, not the Gradle module path. Sets
moduleNametowebview-bundle-androidand source-setdisplayNametoandroid, replacing:lib/:lib/mainin the-javadoc.jarand on javadoc.io.Written for commit 073caa7. Summary will update on new commits.