Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[23] Parsing details for markdown comments #2824 #2831

Conversation

stephan-herrmann
Copy link
Contributor

@stephan-herrmann stephan-herrmann commented Aug 17, 2024

  • codeblock cannot interrupt a paragraph
  • separate handling of code blocks indented vs fenced
    • fence does not terminate indented code block
    • handle various forms of fences:
      • ` vs. ~
      • different fence lengths
      • no mixed fences
      • fences inside fenced region
  • handle (and require) escaping of [ ] inside references (method arguments)

fixes #2824

@stephan-herrmann stephan-herrmann added this to the BETA_JAVA23 milestone Aug 17, 2024
@stephan-herrmann
Copy link
Contributor Author

Note: since in DOM tests we cannot see how code block is handled in the end, I will add corresponding tests also to org.eclipse.jdt.ui.tests.hover.MarkdownCommentTests.

+ codeblock cannot interrupt a paragraph
+ separate handling of code blocks indented vs fenced
  + fence does not terminate indented code block

fixes eclipse-jdt#2824
@stephan-herrmann stephan-herrmann changed the title [23] markdown javadoc should detect code regions [23] Parsing details for markdown comments #2824 Aug 17, 2024
@stephan-herrmann stephan-herrmann merged commit 9b33f16 into eclipse-jdt:BETA_JAVA23 Aug 18, 2024
4 checks passed
@stephan-herrmann stephan-herrmann deleted the markdown_codeBlocks_2 branch August 18, 2024 21:25
stephan-herrmann added a commit to stephan-herrmann/eclipse.jdt.ui that referenced this pull request Aug 19, 2024
stephan-herrmann added a commit to eclipse-jdt/eclipse.jdt.ui that referenced this pull request Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant