RFR: 8298405: Implement JEP 467: Markdown Documentation Comments [v56]

Joe Darcy darcy at openjdk.org
Fri Apr 12 17:41:56 UTC 2024


On Thu, 11 Apr 2024 17:52:14 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Please review a patch to add support for Markdown syntax in documentation comments, as described in the associated JEP.
>> 
>> Notable features:
>> 
>> * support for `///` documentation comments in `JavaTokenizer`
>> * new module `jdk.internal.md` -- a private copy of the `commonmark-java` library
>> * updates to `DocCommentParser` to treat `///` comments as Markdown
>> * updates to the standard doclet to render Markdown comments in HTML
>
> Jonathan Gibbons has updated the pull request incrementally with one additional commit since the last revision:
> 
>   address review feedback for updates to Elements and friends

There should be some quick testing of the new default method on Elements using the VacuousElements implementation; see
`test/langtools/tools/javac/processing/model/util/elements`
for some examples.

-------------

PR Comment: https://git.openjdk.org/jdk/pull/16388#issuecomment-2052196439


More information about the build-dev mailing list