You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by GitBox <gi...@apache.org> on 2022/09/24 16:57:01 UTC
[GitHub] [commons-lang] arturobernalg opened a new pull request, #956: Improve JavaDocs
arturobernalg opened a new pull request, #956:
URL: https://github.com/apache/commons-lang/pull/956
Jus add a bunch of javadoc improvement in order to make it more readable when the user search information.
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] arturobernalg commented on pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on PR #956:
URL: https://github.com/apache/commons-lang/pull/956#issuecomment-1257015709
BTW sorry the size of the PR. But IMO it was necessary
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] garydgregory commented on a diff in pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
garydgregory commented on code in PR #956:
URL: https://github.com/apache/commons-lang/pull/956#discussion_r979279531
##########
src/main/java/org/apache/commons/lang3/CharSetUtils.java:
##########
@@ -45,8 +45,8 @@ public class CharSetUtils {
* </pre>
*
* @see CharSet#getInstance(String...) for set-syntax.
- * @param str String to look for characters in, may be null
- * @param set String[] set of characters to identify, may be null
+ * @param str String to look for characters in, may be {@code null}
Review Comment:
Is there a reason why "String" is sometimes linked and sometimes not?
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] arturobernalg closed pull request #956: Improve JavaDocs
Posted by "arturobernalg (via GitHub)" <gi...@apache.org>.
arturobernalg closed pull request #956: Improve JavaDocs
URL: https://github.com/apache/commons-lang/pull/956
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] arturobernalg commented on pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on PR #956:
URL: https://github.com/apache/commons-lang/pull/956#issuecomment-1264459344
So do I have to change something? should I close the pr?
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] arturobernalg commented on a diff in pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on code in PR #956:
URL: https://github.com/apache/commons-lang/pull/956#discussion_r990793715
##########
src/main/java/org/apache/commons/lang3/BitField.java:
##########
@@ -56,15 +56,15 @@
* <p>Flags and data can be retrieved from the integer:</p>
*
*<pre>
- * // Prints true if red, green or blue is non-zero
+ * // Prints {@code true} if red, green or blue is non-zero
Review Comment:
ups. Sorry @garydgregory
it's done.
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] garydgregory commented on a diff in pull request #956: Improve JavaDocs
Posted by "garydgregory (via GitHub)" <gi...@apache.org>.
garydgregory commented on code in PR #956:
URL: https://github.com/apache/commons-lang/pull/956#discussion_r1135493662
##########
src/main/java/org/apache/commons/lang3/BitField.java:
##########
@@ -281,7 +281,7 @@ public byte setByte(final byte holder) {
}
/**
- * Sets a boolean BitField.
+ * Sets a {@code boolean} BitField.
Review Comment:
Hi @arturobernalg
In this case, the bit field is a `short`, not a `boolean`, right? It's the bits in the bit field that represent booleans. I think If we are going to touch Javadocs we should make sure they are correct first ;-) See the other setters as well.
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] garydgregory commented on pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
garydgregory commented on PR #956:
URL: https://github.com/apache/commons-lang/pull/956#issuecomment-1257033216
You really need to build the project locally before you create the PR, see the Javadoc errors.
Aside from that, I'm starting to think that this is really making the code harder to read and that it would be better handled by a Doclet.
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] garydgregory commented on a diff in pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
garydgregory commented on code in PR #956:
URL: https://github.com/apache/commons-lang/pull/956#discussion_r990637290
##########
src/main/java/org/apache/commons/lang3/BitField.java:
##########
@@ -56,15 +56,15 @@
* <p>Flags and data can be retrieved from the integer:</p>
*
*<pre>
- * // Prints true if red, green or blue is non-zero
+ * // Prints {@code true} if red, green or blue is non-zero
Review Comment:
This is a code comment, not a Javadoc comment, so using Javadoc decorations is wrong. Please review all the files and revert this type of change please.
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] arturobernalg commented on pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on PR #956:
URL: https://github.com/apache/commons-lang/pull/956#issuecomment-1257046060
HI @garydgregory
> You really need to build the project locally before you create the PR, see the Javadoc errors.
>
> Aside from that, I'm starting to think that this is really making the code harder to read and that it would be better handled by a Doclet.
I lose track of what apache jenkings does. I do not have access
`[INFO] Configuration changed, re-generating javadoc.
[WARNING] Javadoc Warnings
[WARNING] warning: URL https://docs.oracle.com/javase/8/docs/api/element-list was redirected to https://docs.oracle.com/en/java/javase/19/ -- Update the command-line options to suppress this warning.
[WARNING] 1 warning
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 03:28 min
[INFO] Finished at: 2022-09-24T21:01:26+02:00
[INFO] ------------------------------------------------------------------------
abernal@Arturo-MacBook-Pro ~/IdeaProyect/commons-lang feature/better_javadoc `
> You really need to build the project locally before you create the PR, see the Javadoc errors.
None.
>
> Aside from that, I'm starting to think that this is really making the code harder to read and that it would be better handled by a Doclet.
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] codecov-commenter commented on pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
codecov-commenter commented on PR #956:
URL: https://github.com/apache/commons-lang/pull/956#issuecomment-1257016163
# [Codecov](https://codecov.io/gh/apache/commons-lang/pull/956?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
> Merging [#956](https://codecov.io/gh/apache/commons-lang/pull/956?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (5b3342d) into [master](https://codecov.io/gh/apache/commons-lang/commit/9a52b9c7cd4bf6599510d259ee62b2effcb30bf2?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (9a52b9c) will **decrease** coverage by `0.00%`.
> The diff coverage is `n/a`.
```diff
@@ Coverage Diff @@
## master #956 +/- ##
============================================
- Coverage 91.99% 91.99% -0.01%
+ Complexity 7432 7431 -1
============================================
Files 189 189
Lines 15668 15668
Branches 2913 2913
============================================
- Hits 14414 14413 -1
Misses 677 677
- Partials 577 578 +1
```
| [Impacted Files](https://codecov.io/gh/apache/commons-lang/pull/956?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | Coverage Δ | |
|---|---|---|
| [...main/java/org/apache/commons/lang3/ArrayUtils.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQXJyYXlVdGlscy5qYXZh) | `95.71% <ø> (ø)` | |
| [...c/main/java/org/apache/commons/lang3/BitField.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQml0RmllbGQuamF2YQ==) | `100.00% <ø> (ø)` | |
| [...in/java/org/apache/commons/lang3/BooleanUtils.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQm9vbGVhblV0aWxzLmphdmE=) | `94.94% <ø> (ø)` | |
| [.../main/java/org/apache/commons/lang3/CharRange.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQ2hhclJhbmdlLmphdmE=) | `95.94% <ø> (ø)` | |
| [...va/org/apache/commons/lang3/CharSequenceUtils.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQ2hhclNlcXVlbmNlVXRpbHMuamF2YQ==) | `91.12% <ø> (ø)` | |
| [...rc/main/java/org/apache/commons/lang3/CharSet.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQ2hhclNldC5qYXZh) | `96.36% <ø> (ø)` | |
| [...in/java/org/apache/commons/lang3/CharSetUtils.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQ2hhclNldFV0aWxzLmphdmE=) | `98.21% <ø> (ø)` | |
| [.../main/java/org/apache/commons/lang3/CharUtils.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQ2hhclV0aWxzLmphdmE=) | `100.00% <ø> (ø)` | |
| [...c/main/java/org/apache/commons/lang3/Charsets.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQ2hhcnNldHMuamF2YQ==) | `75.00% <ø> (ø)` | |
| [...ava/org/apache/commons/lang3/ClassLoaderUtils.java](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-c3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2NvbW1vbnMvbGFuZzMvQ2xhc3NMb2FkZXJVdGlscy5qYXZh) | `40.00% <ø> (ø)` | |
| ... and [75 more](https://codecov.io/gh/apache/commons-lang/pull/956/diff?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | |
:mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] aherbert commented on pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
aherbert commented on PR #956:
URL: https://github.com/apache/commons-lang/pull/956#issuecomment-1257068878
FYI: This javadoc warning:
```
[WARNING] Javadoc Warnings
[WARNING] warning: URL https://docs.oracle.com/javase/8/docs/api/element-list was
redirected to https://docs.oracle.com/en/java/javase/19/
-- Update the command-line options to suppress this warning.
```
Is due to the `<links>` added to the `maven-javadoc-plugin` in commons-parent for JDK classes. This seems to not be required when building on recent JDK LTS versions (tested on 8, 11, and 17). Only JDK 17 puts out this warning as it attempts to look up an element-list and not a package-list for the javadoc at the provided URL.
Note: To test locally you simply run maven with the default goal: `mvn`. Most of the commons GH actions builds are configured to use the default goal.
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] garydgregory commented on pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
garydgregory commented on PR #956:
URL: https://github.com/apache/commons-lang/pull/956#issuecomment-1257057493
I'm not sure what Jenkins has to do with this. In any case, you can see the failure here:
https://github.com/apache/commons-lang/actions/runs/3119069043/jobs/5058792919
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] arturobernalg commented on a diff in pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on code in PR #956:
URL: https://github.com/apache/commons-lang/pull/956#discussion_r979290913
##########
src/main/java/org/apache/commons/lang3/CharSetUtils.java:
##########
@@ -45,8 +45,8 @@ public class CharSetUtils {
* </pre>
*
* @see CharSet#getInstance(String...) for set-syntax.
- * @param str String to look for characters in, may be null
- * @param set String[] set of characters to identify, may be null
+ * @param str String to look for characters in, may be {@code null}
Review Comment:
No Reason at all.
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] arturobernalg commented on a diff in pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
arturobernalg commented on code in PR #956:
URL: https://github.com/apache/commons-lang/pull/956#discussion_r990676380
##########
src/main/java/org/apache/commons/lang3/BitField.java:
##########
@@ -56,15 +56,15 @@
* <p>Flags and data can be retrieved from the integer:</p>
*
*<pre>
- * // Prints true if red, green or blue is non-zero
+ * // Prints {@code true} if red, green or blue is non-zero
Review Comment:
done. Looks like only was this mistake.
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-lang] garydgregory commented on a diff in pull request #956: Improve JavaDocs
Posted by GitBox <gi...@apache.org>.
garydgregory commented on code in PR #956:
URL: https://github.com/apache/commons-lang/pull/956#discussion_r990705792
##########
src/main/java/org/apache/commons/lang3/BitField.java:
##########
@@ -56,15 +56,15 @@
* <p>Flags and data can be retrieved from the integer:</p>
*
*<pre>
- * // Prints true if red, green or blue is non-zero
+ * // Prints {@code true} if red, green or blue is non-zero
Review Comment:
@arturobernalg
You need to update the PR...
--
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: issues-unsubscribe@commons.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org