You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@logging.apache.org by "vy (via GitHub)" <gi...@apache.org> on 2023/02/12 20:54:35 UTC
[GitHub] [logging-log4j2] vy opened a new issue, #1275: Javadoc is broken
vy opened a new issue, #1275:
URL: https://github.com/apache/logging-log4j2/issues/1275
Dozens of modules are failing on `javadoc:javadoc` goal. Causes need to be fixed and `javadoc:javadoc` should be attached to the `verify` phase.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Javadoc is broken (logging-log4j2)
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy commented on issue #1275:
URL: https://github.com/apache/logging-log4j2/issues/1275#issuecomment-1681235306
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. :heart_eyes: Keep up the great job! :100:)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Javadoc is broken (logging-log4j2)
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy closed issue #1275: Javadoc is broken
URL: https://github.com/apache/logging-log4j2/issues/1275
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Javadoc is broken (logging-log4j2)
Posted by "lukaszspyra (via GitHub)" <gi...@apache.org>.
lukaszspyra commented on issue #1275:
URL: https://github.com/apache/logging-log4j2/issues/1275#issuecomment-1703844557
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Javadoc is broken (logging-log4j2)
Posted by "lukaszspyra (via GitHub)" <gi...@apache.org>.
lukaszspyra commented on issue #1275:
URL: https://github.com/apache/logging-log4j2/issues/1275#issuecomment-1674335463
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](https://docs.oracle.com/en/java/javase/11/docs/specs/doc-comment-spec.html,) 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 <p> 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](https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#additional-options-provided-by-the-standard-doclet) (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)?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Javadoc is broken (logging-log4j2)
Posted by "vy (via GitHub)" <gi...@apache.org>.
vy commented on issue #1275:
URL: https://github.com/apache/logging-log4j2/issues/1275#issuecomment-1757448766
Thanks to hard work of @lukaszspyra in #1753, the situation is improved.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org