Skip to content

Add javadoc integration with dokka2 - #5

Merged
seokju-na merged 2 commits into
mainfrom
javadoc
Jul 19, 2026
Merged

seokju-na merged 2 commits into
mainfrom
javadoc

Conversation

@seokju-na

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

Copy link
Copy Markdown
Member

Summary by cubic

Enable Dokka 2 to generate HTML API docs and publish the library Javadoc (-javadoc.jar) via com.vanniktech.maven.publish, so docs appear on javadoc.io. Adds the org.jetbrains.dokka 2.2.0 plugin to lib and enables v2 mode via Gradle properties (org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled, org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true).

Written for commit 83e1673. Summary will update on new commits.

Review in cubic

@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.

1 issue found across 3 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="lib/build.gradle.kts">

<violation number="1" location="lib/build.gradle.kts:9">
P2: Applying Dokka here does not make the 0.35.0 publisher use its output: `publishJavadocJar = true` remains the default Javadoc path, so the released `-javadoc.jar` can be empty or contain standard Javadoc instead of Dokka pages. Configuring `AndroidSingleVariantLibrary` with `JavadocJar.Dokka(...)` (or upgrading the publishing plugin to a version with automatic Dokka integration) would make the javadoc.io artifact contain the API reference.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread lib/build.gradle.kts
alias(libs.plugins.vanniktech.maven.publish)
// Generates the API reference that fills the published -javadoc.jar, which
// javadoc.io then hosts automatically from Maven Central.
alias(libs.plugins.dokka)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2: Applying Dokka here does not make the 0.35.0 publisher use its output: publishJavadocJar = true remains the default Javadoc path, so the released -javadoc.jar can be empty or contain standard Javadoc instead of Dokka pages. Configuring AndroidSingleVariantLibrary with JavadocJar.Dokka(...) (or upgrading the publishing plugin to a version with automatic Dokka integration) would make the javadoc.io artifact contain the API reference.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At lib/build.gradle.kts, line 9:

<comment>Applying Dokka here does not make the 0.35.0 publisher use its output: `publishJavadocJar = true` remains the default Javadoc path, so the released `-javadoc.jar` can be empty or contain standard Javadoc instead of Dokka pages. Configuring `AndroidSingleVariantLibrary` with `JavadocJar.Dokka(...)` (or upgrading the publishing plugin to a version with automatic Dokka integration) would make the javadoc.io artifact contain the API reference.</comment>

<file context>
@@ -4,6 +4,9 @@ plugins {
     alias(libs.plugins.vanniktech.maven.publish)
+    // Generates the API reference that fills the published -javadoc.jar, which
+    // javadoc.io then hosts automatically from Maven Central.
+    alias(libs.plugins.dokka)
 }
 
</file context>

@seokju-na
seokju-na merged commit 84b0fa0 into main Jul 19, 2026
3 checks passed
@seokju-na
seokju-na deleted the javadoc branch July 19, 2026 13:04
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