Repository navigation
Publish a javadoc jar with content again - #205
Conversation
The javadoc jar has been empty since 0.2.10: with source 17 the javadoc
plugin treats the project as modular (module-info.java in java9 and java17)
and finds no sources. Use ${java.version} like the compiler does, and fail
the build when javadoc fails; jackson-base turns that off. The inherited
Java 8 API link goes: javadoc on JDK 25 rejects its redirect.
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="pom.xml">
<violation number="1" location="pom.xml:279">
P3: This override drops the only external `<link>` (the inherited Java 8 API link), and with the pre-existing `detectJavaApiLink=false` the generated javadoc now has no link to the JDK API at all, so references like `String`, `Map`, or `Optional` in signatures render as plain text. Since the whole point is shipping useful docs again, restore JDK linking: set `detectJavaApiLink` to true (links to the running JDK, i.e. JDK 17 on the release build), or re-add an explicit link such as `https://docs.oracle.com/en/java/javase/17/docs/api/`.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
| <failOnWarnings>false</failOnWarnings> | ||
| <failOnError>true</failOnError> | ||
| <!-- the inherited Java 8 API link redirects, and javadoc on JDK 25 fails on it --> | ||
| <links combine.self="override"/> |
There was a problem hiding this comment.
P3: This override drops the only external <link> (the inherited Java 8 API link), and with the pre-existing detectJavaApiLink=false the generated javadoc now has no link to the JDK API at all, so references like String, Map, or Optional in signatures render as plain text. Since the whole point is shipping useful docs again, restore JDK linking: set detectJavaApiLink to true (links to the running JDK, i.e. JDK 17 on the release build), or re-add an explicit link such as https://docs.oracle.com/en/java/javase/17/docs/api/.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At pom.xml, line 279:
<comment>This override drops the only external `<link>` (the inherited Java 8 API link), and with the pre-existing `detectJavaApiLink=false` the generated javadoc now has no link to the JDK API at all, so references like `String`, `Map`, or `Optional` in signatures render as plain text. Since the whole point is shipping useful docs again, restore JDK linking: set `detectJavaApiLink` to true (links to the running JDK, i.e. JDK 17 on the release build), or re-add an explicit link such as `https://docs.oracle.com/en/java/javase/17/docs/api/`.</comment>
<file context>
@@ -270,10 +270,13 @@
<failOnWarnings>false</failOnWarnings>
+ <failOnError>true</failOnError>
+ <!-- the inherited Java 8 API link redirects, and javadoc on JDK 25 fails on it -->
+ <links combine.self="override"/>
<quiet>true</quiet>
<additionalOptions>
</file context>
Thorsrud22
left a comment
There was a problem hiding this comment.
Confirmed the problem on Central: the javadoc jar is 553 bytes for 0.2.10, 0.2.11 and 0.2.12, against 381 KB for 0.2.9. With this PR merged onto master, clean package on JDK 17 and 21 gives a ~200 KB jar with HTML for every public class in src/main/java. LGTM.
The javadoc jar on Maven Central has been empty since 0.2.10 (553 bytes, no HTML). With
<source>17</source>the javadoc plugin goes into module mode and finds no sources, and jackson-base turnsfailOnErroroff, so the build stays green. This uses${java.version}again and fails the build when javadoc fails. The inherited Java 8 API link goes too: JDK 25 rejects its redirect.Summary by cubic
Fixes the javadoc jar shipping empty (no HTML) since 0.2.10.
<source>17</source>made the javadoc plugin treat sources as modular and find none, while jackson-base disabledfailOnErrorand kept the build green. Javadoc now uses${java.version}, fails the build on errors, and drops the inherited Java 8 API link, which JDK 25 rejects for its redirect.Written for commit 7602cd3. Summary will update on new commits.