Add support for markdown doc-comments as described in JEP 467. #1
Conversation
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
noeppi-noeppi
force-pushed
the
feature/jep467
branch
from
b614215 to
e978f42
Compare
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.
JEP 467 which is included in JDK 23 introduces Markdown documentation comments. This pull request implements support for these in JavaDocletMeta by converting the markdown to HTML by using the CommonMark library. Inline javadoc tags are processed in the usual way, producing the respective tags.
It is not planned to provide markdown in the generated metadata json files directly.
This feature has been implemented as a draft pull request because it requires APIs introduced in JDK 23 and can therefore only be merged, once JavaDocletMeta updates to the upcoming LTS version.