java-tree-sitter icon indicating copy to clipboard operation
java-tree-sitter copied to clipboard

Use Delombok for Javadoc

Open Marcono1234 opened this issue 1 year ago • 3 comments

Hello, due to your usage of Lombok, the generated Javadoc currently looks quite incomplete. For example Language#getTotalFields() has a dead link to "fields", and all of the generated getter methods are missing.

It seems this can be solved by first letting Maven run Delombok, and then generating the Javadoc based on that, see https://stackoverflow.com/a/51947792.

Something similar might also work for the Maven -sources.jar, which might make debugging in the IDE easier, see https://stackoverflow.com/q/52362413. However, I don't know if Delombok preserves line numbers, and if not whether this rather causes more issues than it solves when debug line numbers don't match source line numbers.

What do you think?

Marcono1234 avatar Nov 24 '24 01:11 Marcono1234

This issue is stale because it has been open for 30 days with no activity.

seart-bot avatar Dec 25 '24 01:12 seart-bot

@dabico, what do you think?

Also, it might be good to adjust the configuration of the 'Stale' action? (https://github.com/seart-group/java-tree-sitter/discussions/300)

Marcono1234 avatar Dec 28 '24 14:12 Marcono1234

Hi @Marcono1234,

Thank you for raising this concern. Indeed, this was something I was considering doing a while back. However, many other things took precedence, and as such I've never circled back around to it. I can take a look at it now while on vacation, but I cannot give any promises. I no longer work at @seart-group, and this project is in maintenance mode for the foreseeable future.

PS: The action works as I intended it to. Too many people opened issues here, and I never heard back from them even when fixes were issued and questions answered. In spite of this, I will also consider what you have proposed in https://github.com/seart-group/java-tree-sitter/discussions/300.

dabico avatar Jan 09 '25 14:01 dabico