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

[NETBEANS-8233] When creating a doc comment tree from a full body, avoid the spliting and merging of the body, and simply use the full body, so that the code generator sees the correct, unsplit, full body. #8245

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

lahodaj
Copy link
Contributor

@lahodaj lahodaj commented Feb 13, 2025

When doing the Markdown work, I (IIRC) tried to canonicalize the way doc comment trees are created. But that does not behave sanely - when full body is split into the first sentence and the rest, the text trees might change, and that may then lead to the code generator doing the wrong thing.

Trying to only create the doc comment tree from the full body, if available (it will split internally anyway, but the split trees won't be used by the code gen, I think: the code gen uses full body).

(Not sure if this should go to 26 or 25 - not sure if it can get enough testing, but then this is probably not too dangerous.)

… and merging of the body, and simply use the full body, so that the backend sees the correct, unsplit, full body.
@lahodaj lahodaj added Java [ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form) ci:all-tests [ci] enable all tests labels Feb 13, 2025
@lahodaj lahodaj added this to the NB26 milestone Feb 13, 2025
@lahodaj lahodaj changed the title When creating a doc comment tree from a full body, avoid the spliting and merging of the body, and simply use the full body, so that the code generator sees the correct, unsplit, full body. [NETBEANS-8233] When creating a doc comment tree from a full body, avoid the spliting and merging of the body, and simply use the full body, so that the code generator sees the correct, unsplit, full body. Feb 13, 2025
@mbien mbien linked an issue Feb 13, 2025 that may be closed by this pull request
@mbien mbien added the JavaDoc [ci] enable java/javadoc tests and build-javadoc target label Feb 13, 2025
Copy link
Member

@mbien mbien left a comment

Choose a reason for hiding this comment

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

can confirm that this fixes the issue.

I think NB26 is fine for this I agree. It already shipped with NB 24 so it is not a high priority regression IMO. (RC2 will likely also be the last RC since the PR queue is empty atm)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:all-tests [ci] enable all tests Java [ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form) JavaDoc [ci] enable java/javadoc tests and build-javadoc target
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor>Rename messes up javadoc comment formatting.
2 participants