Re: [PR] Issue 1275 broken javadoc (logging-log4j2)
vy merged PR #1753: URL: https://github.com/apache/logging-log4j2/pull/1753 -- 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-unsubscr...@logging.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] Issue 1275 broken javadoc (logging-log4j2)
vy commented on PR #1753: URL: https://github.com/apache/logging-log4j2/pull/1753#issuecomment-1757399973 @lukaszspyra, you know what, nevermind. I will implement the requested changes myself. We are on a roll with `2.21.0` release and I want to get your changes in before we seal it. -- 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-unsubscr...@logging.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] Issue 1275 broken javadoc (logging-log4j2)
lukaszspyra commented on code in PR #1753: URL: https://github.com/apache/logging-log4j2/pull/1753#discussion_r1349398326 ## pom.xml: ## @@ -1674,6 +1675,13 @@ pre-site + +verify-generate-javadoc + + javadoc + +verify + Review Comment: Javadoc attached to 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-unsubscr...@logging.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] Issue 1275 broken javadoc (logging-log4j2)
lukaszspyra commented on code in PR #1753:
URL: https://github.com/apache/logging-log4j2/pull/1753#discussion_r1349398078
##
pom.xml:
##
@@ -1867,7 +1875,7 @@
[1.8,)
--Xdoclint:none
+${javadoc.doclint}
Review Comment:
Here javadoc validating doclint was totally disabled, but semantics changed
and this was not working anymore (replaced by simple `all`, `none` etc.)
--
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-unsubscr...@logging.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Re: [PR] Issue 1275 broken javadoc (logging-log4j2)
lukaszspyra commented on PR #1753: URL: https://github.com/apache/logging-log4j2/pull/1753#issuecomment-1751507277 Hi @vy , Thanks for the review. 1. Fixed most remaining errors (removed links which could not be fixed due to withdrawn `sun.reflect` API, but are meaningful), except 2 links to other modules - could not find a way to make them 'clickable'. 2. [Standard Doclet](https://docs.oracle.com/en/java/javase/11/docs/specs/doc-comment-spec.html) introduced in JDK8, used for javadoc validation contains many rules, some useful, whilst some annoying. In PR, there is profile created and set to respect `all` validations excluding: - `-missing` javadoc tags - most of them are either on deprecated API, self-explanatory parameters names or due to usage of brief comments in form of javadoc (gives in total ~150 warnings, majority as @param/@return tags not included). I believe it is reasonable to ignore them. - `-html` strict semantics of HTML5 (all kinds of html tags not supported in HTML5 - e.g. align/summary in table cells, self-closing elements not allowed, empty tags). Generally gives ~100 errors, complaining a lot about tables layout options not recognized in javadoc. You can remove this exclusion and assess yourself, as was not sure about recommended approach. 3. javadoc generation attached to maven-verify phase as required in issue description -- 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-unsubscr...@logging.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] Issue 1275 broken javadoc (logging-log4j2)
vy commented on PR #1753: URL: https://github.com/apache/logging-log4j2/pull/1753#issuecomment-1749010754 @lukaszspyra, thanks so much for all these fixes! Much appreciated! :bow: I have two remarks: 1. `./mvnw javadoc:javadoc` is still failing for `-api` and `-core` modules on a few files. Could you also fix them too, please? 2. What is the rationale behind `all,-missing,-html`? I mean, if we are gonna suppress errors with `all,-missing,-html`, how does this contribute to #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-unsubscr...@logging.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
Re: [PR] Issue 1275 broken javadoc (logging-log4j2)
vy commented on code in PR #1753:
URL: https://github.com/apache/logging-log4j2/pull/1753#discussion_r1347482279
##
log4j-core/src/main/java/org/apache/logging/log4j/core/layout/PatternLayout.java:
##
@@ -152,14 +152,14 @@ public boolean requiresLocation() {
/**
* Deprecated, use {@link #newSerializerBuilder()} instead.
*
- * @param configuration
- * @param replace
- * @param pattern
- * @param defaultPattern
- * @param patternSelector
- * @param alwaysWriteExceptions
- * @param noConsoleNoAnsi
- * @return a new Serializer.
+ * @param configuration the current configuration
+ * @param replace Allows portions of the resulting String to be replaced.
+ * @param pattern the current patternt
Review Comment:
```suggestion
* @param pattern the current pattern
```
--
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-unsubscr...@logging.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
