Convert package info to HTML#3
Merged
Merged
Conversation
The package overview was written with `///` Markdown documentation comments (JEP 467), which only render under JDK 23+. javadoc.io serves the published -javadoc.jar as-is rather than rebuilding it, so when the release jar is produced by an older javadoc the `///` lines are treated as ordinary comments and the package description disappears. Rewrite it as traditional `/** */` HTML javadoc so it renders regardless of the javadoc JDK. The Settings example's `/* ... */` placeholders become line comments to avoid prematurely terminating the doc comment. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
https://javadoc.io/doc/dev.hegel/hegel wasn't showing the main package info intro to the library, because we were using markdown package info, which is only supported on JDK 23+.
The two possible fixes were to build on 23+ and to convert to HTML, and I went with the one that lead to broader compatibility because markdown isn't that much of an improvement here.