Bypass AST model -> HTML Conversion for Markdown Comments #3332
+204
−11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rgrunber
force-pushed
the
skip-html-conv
branch
from
710ef38 to
0bc3479
Compare
rgrunber
changed the title
rgrunber
force-pushed
the
skip-html-conv
branch
from
0bc3479 to
dcc12e4
Compare
- For JEP 467, JDT parses the markdown comments into the AST Model as a Javadoc node (TagElement & TextElement and Name/MemberRef/MethodRef for links), converting to HTML. JDT-LS converts the HTML back to Markdown using Remark. - This bypasses the AST model -> HTML conversion by attempting to render the Javadoc comments directly as Markdown, in part because the content is already (mostly) Markdown Signed-off-by: Roland Grunberg <[email protected]>
Signed-off-by: Roland Grunberg <[email protected]>
rgrunber
force-pushed
the
skip-html-conv
branch
from
dcc12e4 to
387eeab
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before
After
Things left to address :
As seen from the screenshot, we introduce a newline after each newUpdate: This can't be done because the AST model doesn't include empty/// ..., while I think we should treat consecutive text elements as a continuation. An empty///is meant to signify a newline IIRC.///lines currently. At least we no longer insert a newline for every now///line.java.utilbut I'm not sure why. Seems a corner case@see,@throws/@exceptionare meant to be combined under a single heading, and not listed separately (see screenshot).