Problem parsing unknown Javadoc tag

[TheMarvelFan]

Referencing issue

• fixes Problem parsing unknown Javadoc tag #3750

What's changed?

Modified the sourceBefore() method and visiteReturn() method to handle leading curly brace '{' with return annotations, i.e., cases like '{@return}' and '{@return}'. I will be adding commits that also modify the JavaDocPrinter to include the leading '{' when printing the modified javadoc.

Anyone you would like to review specifically?

@traceyyoshima or @timtebeek

Checklist

• I've added unit tests to cover both positive and negative cases
• I've read and applied the recipe conventions and best practices
• I've used the IntelliJ IDEA auto-formatter on affected files

[timtebeek]

Thanks for getting this started @TheMarvelFan ! I've removed two classes from your other PR, which squash merge should resolve

• Use Tree.randomId() to construct LST elements, not UUID.randomUUID() #3784

As for the changes here probably best to add a test to verify that the changes here correctly handle the cases mentioned in #3750 (comment)

[timtebeek]

Once we're satisfied with the changes (but only then!), we should replicate the same to the other parsers to also fix this in Java 8, 11 and 21.

[TheMarvelFan]

Hi @timtebeek,
Please review the modified files, and suggest changes if required.

[timtebeek]

Hi @TheMarvelFan ; you seem to have added two files to the root of your repository fork:
https://github.com/TheMarvelFan/rewrite/tree/rewrite1

You likely intended to add those elsewhere; what's the reason you're using the file upload and not a git push?

[TheMarvelFan]

Hi,
I initially intended to contribute to both this issue and issue #3757 using the same repository fork. For this purpose, I created another branch named "rewrite1", but I think I made a mistake somwhere, and when I tried pushing to rewrite one from origin on my local machine, I got an error which told me to "fetch first" and then push. I tried to fetch as well, but the error remained. So, I decided to upload the files to the rewrite1 branch instead of pushing. I am still not sure if the same cloned repository can be used to push different commits to two different open pull requests of the same upstream. I apologize for the inconvenience due to this.

[timtebeek]

Yes you can use the same fork for multiple open pull requests, but it helps to start a branch for each new development you start, and not commit to the main branch. Otherwise you indeed run the risk of conflicts and diverging commits on the main branch.

[TheMarvelFan]

I understand. I am still quite new to contributing to open source, but with time I will get better. Is there something I can do right now to correct this problem?

[traceyyoshima]

Hi @TheMarvelFan! The changes are looking good so far, thank you for fixing this bug!

I've added a few comments with information on the changes. Please let me know if you have any questions!

[TheMarvelFan]

Hi @traceyyoshima,
Thanks for suggesting the changes. Please review the modified files and let me know if more changes are required.

[traceyyoshima]

Once we're satisfied with the changes (but only then!), we should replicate the same to the other parsers to also fix this in Java 8, 11 and 21.

@timtebeek It looks like the build is failing due to the marker implementation. Once that's fixed, I think the changes look good and we're ready to update the other parsers. What do you think?

[traceyyoshima]

Nearly there!

[traceyyoshima]

@TheMarvelFan I've updated the PR with a few finishing touches, thank you for your work on this PR!