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

Pavel Rappo prappo at openjdk.org
Thu May 16 15:08:26 UTC 2024


On Thu, 16 May 2024 14:53:17 GMT, Chen Liang <liach at openjdk.org> wrote:

> 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 */`.

It is certainly not a Java language change. The Java language and JLS have never bothered with the javadoc comments.

If you are concerned with it being a lint warning rather than a **doc**lint warning, then it's a technicality: doclint sees less than lint sees, and sadly not enough for that check. Thus, that check was put in `lint.

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

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


More information about the build-dev mailing list