Skip to content

[Markdown] Snippet tag failed to generate javadoc#5003

Merged
subyssurendran666 merged 1 commit into
eclipse-jdt:masterfrom
subyssurendran666:snippet_tag_failed_to_generate_markdown_4968
May 11, 2026
Merged

[Markdown] Snippet tag failed to generate javadoc#5003
subyssurendran666 merged 1 commit into
eclipse-jdt:masterfrom
subyssurendran666:snippet_tag_failed_to_generate_markdown_4968

Conversation

@subyssurendran666
Copy link
Copy Markdown
Contributor

@subyssurendran666 subyssurendran666 commented Apr 16, 2026

The @snippet tag content was not being rendered in the Javadoc view because plain snippet text was not captured during parsing. This change ensures snippet content is properly extracted and displayed, similar to standard Javadoc elements.

Fix: #4968

What it does

How to test

Scenario

/// {@snippet :
/// var s = "";
/// 	int x = 2;
/// String name = "eclipse";
/// }

Author checklist

@subyssurendran666 subyssurendran666 force-pushed the snippet_tag_failed_to_generate_markdown_4968 branch from 8ce645f to adc3441 Compare April 16, 2026 15:56
@iloveeclipse iloveeclipse requested a review from Copilot April 16, 2026 16:00
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes Markdown doc comment parsing so {@snippet ...} content (especially plain inlined snippet text) is extracted and can be rendered in the Javadoc view (Issue #4968).

Changes:

  • Update the compiler’s comment parser to capture Markdown snippet text and adjust snippet validity handling.
  • Add Markdown-focused regression tests for @snippet tags.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.

File Description
org.eclipse.jdt.core.tests.model/src/org/eclipse/jdt/core/tests/dom/ASTConverterMarkdownTest.java Adds new Markdown snippet parsing tests.
org.eclipse.jdt.core.compiler.batch/src/org/eclipse/jdt/internal/compiler/parser/AbstractCommentParser.java Adjusts snippet parsing to capture Markdown snippet content and set snippet validity.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@subyssurendran666 subyssurendran666 force-pushed the snippet_tag_failed_to_generate_markdown_4968 branch 2 times, most recently from c239168 to b2c5808 Compare April 29, 2026 05:50
@subyssurendran666 subyssurendran666 force-pushed the snippet_tag_failed_to_generate_markdown_4968 branch from b2c5808 to 66b4411 Compare May 4, 2026 05:14
@jarthana
Copy link
Copy Markdown
Member

jarthana commented May 4, 2026

@subyssurendran666 Are you planning to address the review comments raised by CoPilot? Please disable it otherwise. There's just too much information here.

@subyssurendran666 subyssurendran666 force-pushed the snippet_tag_failed_to_generate_markdown_4968 branch from 66b4411 to e172b4b Compare May 4, 2026 13:17
@subyssurendran666
Copy link
Copy Markdown
Contributor Author

@subyssurendran666 Are you planning to address the review comments raised by CoPilot? Please disable it otherwise. There's just too much information here.

I have addressed the problems addressed by the co-pilot and added necessary comments.

@subyssurendran666 subyssurendran666 force-pushed the snippet_tag_failed_to_generate_markdown_4968 branch from e172b4b to ee31b69 Compare May 5, 2026 06:11
The @snippet tag content was not being rendered in the Javadoc view
because plain snippet text was not captured during parsing. This change
ensures snippet content is properly extracted and displayed, similar to
standard Javadoc elements.

Fix: eclipse-jdt#4968
@subyssurendran666 subyssurendran666 force-pushed the snippet_tag_failed_to_generate_markdown_4968 branch from ee31b69 to 59b2847 Compare May 11, 2026 01:30
@subyssurendran666 subyssurendran666 merged commit 5044341 into eclipse-jdt:master May 11, 2026
13 checks passed
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.

[Markdown] Snippet tag failed to generate javadoc

3 participants