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

Fix parsing of JDK 17+ Javadoc of methods without HTML a tags. #7833

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

Conversation

t-gergely
Copy link

NetBeans didn't show Javadoc descriptions for a lot of OpenJDK (21) methods. This simple patch works for me, but feel free to drop this PR, and fix the bug whatever way you like.

@neilcsmith-net neilcsmith-net added the JavaDoc [ci] enable java/javadoc tests and build-javadoc target label Oct 18, 2024
@neilcsmith-net neilcsmith-net added this to the NB24 milestone Oct 18, 2024
@neilcsmith-net
Copy link
Member

Linking with #5127 Thanks for this. I think makes sense, but I can't remember the reason I marked state as a_open. Possibly also me not fully understanding the quirks of the state engine! 😄 Hopefully this change doesn't break anything elsewhere. Parsing with a HTML 3.2 parser is becoming more problematic!

It would be good to generate test files for Javadoc 21+ alongside the ones introduced in the other PR. The source files are there. If you felt like adding that to this, that would be a great addition and way to prove your change!

@mbien mbien added the Java [ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form) label Oct 18, 2024
@apache apache locked and limited conversation to collaborators Oct 18, 2024
@apache apache unlocked this conversation Oct 18, 2024
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.

Hi, thanks for the contribution, but we require a valid email address in the commit header, you can check it by looking at the patch file of this PR: https://github.com/apache/netbeans/pull/7833.patch

feel free to force push into this PR once fixed

(we might merge #6630 one day so that CI checks things like that automatically)

@mbien mbien added do not merge Don't merge this PR, it is not ready or just demonstration purposes. ci:dev-build [ci] produce a dev-build zip artifact (7 days expiration, see link on workflow summary page) labels Oct 20, 2024
@t-gergely
Copy link
Author

Hi, thanks for the contribution, but we require a valid email address in the commit header

Yes, it was a bad idea to post this PR. Sorry. I probably should have attached a patch to an issue instead. You may commit the patch yourselves: I don't take credit for anything in it.

It would be good to generate test files for Javadoc 21+ alongside the ones introduced in the other PR

I don't see a good reason for that. OTOH methods testJavadoc8Class() and testJavadoc11Class() also don't test the default constructors. Which has the consequence of the missing (cloned) test case for the current bug. So I recommend adding those tests, too.

@ebarboni ebarboni modified the milestones: NB24, NB25 Oct 22, 2024
@matthiasblaesing
Copy link
Contributor

@t-gergely could you please check the comment from @mbien?

@t-gergely
Copy link
Author

@t-gergely could you please check the comment from @mbien?

I think I've already replied to that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:dev-build [ci] produce a dev-build zip artifact (7 days expiration, see link on workflow summary page) do not merge Don't merge this PR, it is not ready or just demonstration purposes. 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.

5 participants