Skip to content

Name Dokka docs after the artifact instead of :lib - #6

Merged
seokju-na merged 1 commit into
mainfrom
fix-dokka-module-name
Jul 21, 2026
Merged

seokju-na merged 1 commit into
mainfrom
fix-dokka-module-name

Conversation

@seokju-na

@seokju-na seokju-na commented Jul 21, 2026 •

Copy link
Copy Markdown
Member

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/main end up in the published -javadoc.jar that 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):

  • Title / module heading: webview-bundle-android (was :lib)
  • Doc URL path: webview-bundle-android/dev.wvb/…
  • Platform-filter chip: android (was :lib/main)
  • No :lib in any visible text node (only the internal data-filterable-set attribute 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 moduleName to webview-bundle-android and source-set displayName to android, replacing :lib/:lib/main in the -javadoc.jar and on javadoc.io.

Written for commit 073caa7. Summary will update on new commits.

Review in cubic

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

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@seokju-na
seokju-na merged commit 7ffc479 into main Jul 21, 2026
3 checks passed
@seokju-na
seokju-na deleted the fix-dokka-module-name branch July 21, 2026 03:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant