RFR: JDK-8298405: Support Markdown in Documentation Comments [v44]
Pavel Rappo
prappo at openjdk.org
Mon Mar 4 14:43:03 UTC 2024
On Fri, 1 Mar 2024 21:49:29 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:
>
> Revise `Markdown.update` to better handle container blocks.
I have a test case to report. The following results in no `@param` information being rendered, which I think is a bug:
/// Hello, _Markdown_ world!
///
/// <p>
/// @param <T> hello
/// </p>
///
public class C<T> { }
-------------
PR Comment: https://git.openjdk.org/jdk/pull/16388#issuecomment-1976734010
More information about the compiler-dev
mailing list