Better Javadoc

Author: garydgregory

src/main/java/org/apache/commons/io/IOCase.java

@@ -69,7 +69,7 @@ public enum IOCase {
     private static final long serialVersionUID = -6343169151696340687L;
 
     /**
-     * Factory method to create an IOCase from a name.
+     * Looks up an IOCase by name.
      *
      * @param name  the name to find
      * @return the IOCase object
@@ -112,8 +112,8 @@ public static IOCase value(final IOCase value, final IOCase defaultValue) {
     /**
      * Constructs a new instance.
      *
-     * @param name  the name
-     * @param sensitive  the sensitivity
+     * @param name  the name.
+     * @param sensitive  the sensitivity.
      */
     IOCase(final String name, final boolean sensitive) {
         this.name = name;
@@ -127,10 +127,10 @@ public static IOCase value(final IOCase value, final IOCase defaultValue) {
      * into account.
      * </p>
      *
-     * @param str1  the first string to compare, not null
-     * @param str2  the second string to compare, not null
-     * @return true if equal using the case rules
-     * @throws NullPointerException if either string is null
+     * @param str1  the first string to compare, not null.
+     * @param str2  the second string to compare, not null.
+     * @return true if equal using the case rules.
+     * @throws NullPointerException if either string is null.
      */
     public int checkCompareTo(final String str1, final String str2) {
         Objects.requireNonNull(str1, "str1");
@@ -145,9 +145,9 @@ public int checkCompareTo(final String str1, final String str2) {
      * into account.
      * </p>
      *
-     * @param str  the string to check
-     * @param end  the end to compare against
-     * @return true if equal using the case rules, false if either input is null
+     * @param str  the string to check.
+     * @param end  the end to compare against.
+     * @return true if equal using the case rules, false if either input is null.
      */
     public boolean checkEndsWith(final String str, final String end) {
         if (str == null || end == null) {
@@ -164,9 +164,9 @@ public boolean checkEndsWith(final String str, final String end) {
      * into account.
      * </p>
      *
-     * @param str1  the first string to compare, not null
-     * @param str2  the second string to compare, not null
-     * @return true if equal using the case rules
+     * @param str1  the first string to compare.
+     * @param str2  the second string to compare.
+     * @return true if equal using the case rules.
      */
     public boolean checkEquals(final String str1, final String str2) {
         return str1 == str2 || str1 != null && (sensitive ? str1.equals(str2) : str1.equalsIgnoreCase(str2));
@@ -180,11 +180,11 @@ public boolean checkEquals(final String str1, final String str2) {
      * but takes case-sensitivity into account.
      * </p>
      *
-     * @param str  the string to check, not null
-     * @param strStartIndex  the index to start at in str
-     * @param search  the start to search for, not null
+     * @param str  the string to check.
+     * @param strStartIndex  the index to start at in str.
+     * @param search  the start to search for.
      * @return the first index of the search String,
-     *  -1 if no match or {@code null} string input
+     *  -1 if no match or {@code null} string input.
      * @since 2.0
      */
     public int checkIndexOf(final String str, final int strStartIndex, final String search) {
@@ -208,11 +208,11 @@ public int checkIndexOf(final String str, final int strStartIndex, final String
      * but takes case-sensitivity into account.
      * </p>
      *
-     * @param str  the string to check, not null
-     * @param strStartIndex  the index to start at in str
-     * @param search  the start to search for, not null
-     * @return true if equal using the case rules
-     * @throws NullPointerException if either string is null
+     * @param str  the string to check, not null.
+     * @param strStartIndex  the index to start at in str.
+     * @param search  the start to search for, not null.
+     * @return true if equal using the case rules.
+     * @throws NullPointerException if either string is null.
      */
     public boolean checkRegionMatches(final String str, final int strStartIndex, final String search) {
         return str.regionMatches(!sensitive, strStartIndex, search, 0, search.length());
@@ -225,9 +225,9 @@ public boolean checkRegionMatches(final String str, final int strStartIndex, fin
      * into account.
      * </p>
      *
-     * @param str  the string to check
-     * @param start  the start to compare against
-     * @return true if equal using the case rules, false if either input is null
+     * @param str  the string to check.
+     * @param start  the start to compare against.
+     * @return true if equal using the case rules, false if either input is null.
      */
     public boolean checkStartsWith(final String str, final String start) {
         return str != null && start != null && str.regionMatches(!sensitive, 0, start, 0, start.length());
@@ -245,7 +245,7 @@ public String getName() {
     /**
      * Does the object represent case-sensitive comparison.
      *
-     * @return true if case-sensitive
+     * @return true if case-sensitive.
      */
     public boolean isCaseSensitive() {
         return sensitive;
@@ -255,7 +255,7 @@ public boolean isCaseSensitive() {
      * Replaces the enumeration from the stream with a real one.
      * This ensures that the correct flag is set for SYSTEM.
      *
-     * @return the resolved object
+     * @return the resolved object.
      */
     private Object readResolve() {
         return forName(name);
@@ -264,7 +264,7 @@ private Object readResolve() {
     /**
      * Gets a string describing the sensitivity.
      *
-     * @return a string describing the sensitivity
+     * @return a string describing the sensitivity.
      */
     @Override
     public String toString() {