[GitHub] [commons-lang] garydgregory commented on a diff in pull request #956: Improve JavaDocs
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-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-lang] garydgregory commented on a diff in pull request #956: Improve JavaDocs
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 @@
* Flags and data can be retrieved from the integer:
*
*
- *// 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-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-lang] garydgregory commented on a diff in pull request #956: Improve JavaDocs
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 @@
* Flags and data can be retrieved from the integer:
*
*
- *// 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-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [commons-lang] garydgregory commented on a diff in pull request #956: Improve JavaDocs
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 {
*
*
* @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-unsubscr...@commons.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
