RFR: JDK-8298405: Support Markdown in Documentation Comments [v44]

Pavel Rappo prappo at openjdk.org
Mon Mar 4 15:19:05 UTC 2024


On Mon, 4 Mar 2024 14:40:06 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

> 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> { }
> ```

Scratch that. After experimenting a bit more with **traditional** javadoc comments, I realised that it might be expected that `@param` would be lost in that `<p>...</p>` block; okay.

Still, I find it surprising that the description of the `@param` tag in the above comment, hosted in `///` or `/**...*/`, is a single node of type `RawText` with the following content:

    hello
    </p>

(Note, the content includes `</p>`.)

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

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


More information about the build-dev mailing list