[GitHub] [commons-lang] garydgregory commented on a change in pull request #551: [LANG-1550] Optimize ArrayUtils::isArrayIndexValid method.

[GitBox <gi...@apache.org>]

garydgregory commented on a change in pull request #551:
URL: https://github.com/apache/commons-lang/pull/551#discussion_r439734790



##########
File path: src/main/java/org/apache/commons/lang3/ArrayUtils.java
##########
@@ -3110,19 +3110,22 @@ public static int indexOf(final short[] array, final short valueToFind, int star
     }
 
     /**
-     * Returns whether a given array can safely be accessed at the given index.
+     * <p>Returns whether a given array can safely be accessed at the given index.
+     *
+     * <pre>
+     * ArrayUtils.isArrayIndexValid(null, 0)       = false
+     * ArrayUtils.isArrayIndexValid([], 0)         = false
+     * ArrayUtils.isArrayIndexValid(["a"], 0)      = true
+     * </pre>

Review comment:
       Unfortunately, Javadoc created with a closed pre tag after an EOL appear with an extra blank line. so pre tags should be closed at the end of the last line.
   

##########
File path: src/main/java/org/apache/commons/lang3/ArrayUtils.java
##########
@@ -3110,19 +3110,22 @@ public static int indexOf(final short[] array, final short valueToFind, int star
     }
 
     /**
-     * Returns whether a given array can safely be accessed at the given index.
+     * <p>Returns whether a given array can safely be accessed at the given index.

Review comment:
       Paragraph tags are not needed for the first paragraph of a Javadoc comment. When you do use HTML tags (elsewhere), you should close them.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org