Java (OpenJDK) using commonmark-java

[robinst]

Since this pull request, Java (OpenJDK) has included a copy of commonmark-java:

• 8298405: Implement JEP 467: Markdown Documentation Comments openjdk/jdk#16388

When they copied the source files, they made a few adjustments too. There's a list here:

// This module is primarily an import from a recent tagged version of
//     https://github.com/commonmark/commonmark-java
//
// The following parts are imported:
//
// * commonmark/src/main/java
// * commonmark/src/main/resources
// * commonmark-ext-gfm-tables/src/main/java
// * commonmark-ext-gfm-tables/src/main/resources
//
// For source and resource files, the following transformations are applied:
//
// * legal headers are added
// * package and import statements are updated
// * characters outside the ASCII range are converted to Unicode escapes
// * @SuppressWarnings("fallthrough") is added to getSetextHeadingLevel
// * the value for ENTITY_PATH is updated with the modified package
// * the file `entities.properties` is renamed to `entities.txt`

Let's make it easier for them next time by adopting some of the changes.

[robinst]

Hi @jonathan-gibbons! I saw that OpenJDK recently included commonmark-java for Markdown parsing in Javadoc:

• 8298405: Implement JEP 467: Markdown Documentation Comments openjdk/jdk#16388

Just wanted to recommend upgrading to version 0.24.0, with these changes:

• Fix source spans of blocks with lazy continuation lines #339
  • This was released in 0.23.0 and is a fix for source positions being incorrect with some lazy continuation lines
• Also include "input index" in SourceSpan #348
  • This should simplify the source position mapping (this code in MarkdownTransformer.java can be removed)
• Adopt vendoring changes from OpenJDK #343
  • This should make it easier to update the vendored copy