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

Use Delombok for Javadoc #295

Open
Marcono1234 opened this issue Nov 24, 2024 · 3 comments
Open

Use Delombok for Javadoc #295

Marcono1234 opened this issue Nov 24, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Marcono1234
Copy link

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?

@seart-bot
Copy link
Member

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

@seart-bot seart-bot added the stale Inactive for a long period label Dec 25, 2024
@Marcono1234
Copy link
Author

@dabico, what do you think?

Also, it might be good to adjust the configuration of the 'Stale' action? (#300)

@seart-bot seart-bot removed the stale Inactive for a long period label Dec 29, 2024
@dabico dabico self-assigned this Jan 9, 2025
@dabico dabico added the documentation Improvements or additions to documentation label Jan 9, 2025
@dabico
Copy link
Member

dabico commented Jan 9, 2025

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 #300.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants