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

Javadoc is broken #1275

Closed
vy opened this issue Feb 12, 2023 · 4 comments
Closed

Javadoc is broken #1275

vy opened this issue Feb 12, 2023 · 4 comments
Assignees
Labels
api Affects the public API bug Incorrect, unexpected, or unintended behavior of existing code documentation Pull requests or issues that affect documentation enhancement Additions or updates to features
Milestone

Comments

@vy
Copy link
Member

vy commented Feb 12, 2023

Dozens of modules are failing on javadoc:javadoc goal. Causes need to be fixed and javadoc:javadoc should be attached to the verify phase.

@jvz jvz added bug Incorrect, unexpected, or unintended behavior of existing code documentation Pull requests or issues that affect documentation labels Mar 5, 2023
@lukaszspyra
Copy link
Contributor

Hi,

I have done some checks on modules currently used for HTML javadoc (according to pom.xml, log4j-api and log4j-core). Different maven plugin options for javadoc doclet resulted in:

  1. for doclet turned off: 24 warnings (mostly referenes not found, wrong param names)

  2. for doclet fully on: 200 warnings,119 errors (all kinds of html tags not supported in HTML5, missing closing tags, empty

    tags, missing docs on public members e.g. on getters (whilst most of them are self explanatory) - very strict approach

  3. for doclet partly off (ignores missing docs and high-level HTML issues): around 40 errors / 60 warnings

What would be the recommended approach for fixing javadoc?
I'd say at least excluding missing docs, and maybe html strict semantics (otherwise some tags would have to be replaced by external .css as not supported in HTML5 - e.g. align in table cells)?

@vy
Copy link
Member Author

vy commented Aug 16, 2023

I would be in favor of a spotless javadoc:javadoc run. Though it all depends on how far you want to push.

(@lukaszspyra, PMC really appreciates your recent interest and work on the project. 😍 Keep up the great job! 💯)

@lukaszspyra
Copy link
Contributor

Hi,
Corrected some javadocs with PR #1753.
There are still many failures remaining, but first need to figure out best way how to fix links to docs in modules, which are excluded from javadoc creation.

@vy
Copy link
Member Author

vy commented Oct 11, 2023

Thanks to hard work of @lukaszspyra in #1753, the situation is improved.

@vy vy closed this as completed Oct 11, 2023
@vy vy self-assigned this Oct 11, 2023
@vy vy added this to the 2.21.0 milestone Oct 11, 2023
@vy vy added enhancement Additions or updates to features api Affects the public API bug Incorrect, unexpected, or unintended behavior of existing code and removed bug Incorrect, unexpected, or unintended behavior of existing code labels Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Affects the public API bug Incorrect, unexpected, or unintended behavior of existing code documentation Pull requests or issues that affect documentation enhancement Additions or updates to features
Projects
None yet
Development

No branches or pull requests

3 participants