6 ms·
How different is the javadoc markdown dialect from that of github?
by java-man 3y ago
How different is the javadoc markdown dialect from that of github?
- wpollock 3y agoGithub Flavored Markdown (GFM) is a superset of commonmark. The differences are indicated in the GFM spec at https://github.github.com/gfm/ https://github.github.com/gfm/.
- masklinn 3y agoExtensions aside the major difference is the handling of line breaks: in markdown they get discarded, you need two to separate paragraphs. In GFM, individual line break are translated to line breaks in the output.
- infogulch 3y ago> Markdown documentation comments are written in the CommonMark variant of Markdown. There are enhancements to links, to allow convenient linking to other program elements. Simple GFM pipe tables are supported, as are all JavaDoc tags. https://openjdk.org/jeps/467#Syntax https://openjdk.org/jeps/467#Syntax