Repository navigation
Conversation
There was a problem hiding this comment.
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
| 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) |
There was a problem hiding this comment.
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>
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.
Summary by cubic
Enable Dokka 2 to generate HTML API docs and publish the library Javadoc (
-javadoc.jar) viacom.vanniktech.maven.publish, so docs appear on javadoc.io. Adds theorg.jetbrains.dokka2.2.0 plugin toliband 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.