Skip to content

Use Delombok for Javadoc #295

@Marcono1234

Description

@Marcono1234

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?

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions