RFR: 8298405: Implement JEP 467: Markdown Documentation Comments [v69]
Chen Liang
liach at openjdk.org
Thu May 16 14:56:21 UTC 2024
On Wed, 15 May 2024 21:04:36 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:
>
> update tests for dangling doc comments, per review feedback
My rationale for a potential preview is that we changed `-Xlint:dangling-doc-comments` as `///` is now dangling doc comment. Is this considered a Java programming language change? There were some community comments objecting the use of `///` for markdown documentation, and called for alternative syntaxes like `/*markdown */`.
-------------
PR Comment: https://git.openjdk.org/jdk/pull/16388#issuecomment-2115466695
More information about the build-dev
mailing list