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

Jonathan Gibbons jjg at openjdk.org
Thu Feb 22 00:17:29 UTC 2024


> 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 two additional commits since the last revision:

 - update DocCommentParser and tests to improve handling of code blocks and code spans in Markdown documentation comments
 - fix indentation, for consistency

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

Changes:
  - all: https://git.openjdk.org/jdk/pull/16388/files
  - new: https://git.openjdk.org/jdk/pull/16388/files/25921fd0..5fc9c84a

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=16388&range=37
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=16388&range=36-37

  Stats: 1240 lines in 4 files changed: 918 ins; 275 del; 47 mod
  Patch: https://git.openjdk.org/jdk/pull/16388.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/16388/head:pull/16388

PR: https://git.openjdk.org/jdk/pull/16388


More information about the build-dev mailing list