You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by br...@apache.org on 2016/09/11 12:53:53 UTC

[2/2] [lang] Better JavaDoc for removeAllOccurences variants

Better JavaDoc for removeAllOccurences variants


Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/ee6f3fa7
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/ee6f3fa7
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/ee6f3fa7

Branch: refs/heads/master
Commit: ee6f3fa7a6d82bbedde4fece8704a7ce42dda3fe
Parents: 5ceb5f5
Author: Benedikt Ritter <br...@apache.org>
Authored: Sun Sep 11 14:53:32 2016 +0200
Committer: Benedikt Ritter <br...@apache.org>
Committed: Sun Sep 11 14:53:32 2016 +0200

----------------------------------------------------------------------
 .../org/apache/commons/lang3/ArrayUtils.java    | 81 +++++++++++++-------
 1 file changed, 54 insertions(+), 27 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-lang/blob/ee6f3fa7/src/main/java/org/apache/commons/lang3/ArrayUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
index 90e99c7..cc16828 100644
--- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
@@ -7639,10 +7639,13 @@ public class ArrayUtils {
     }
 
     /**
+     * Removes the occurrences of the specified element from the specified boolean array.
+     *
      * <p>
-     * Removes the occurrences of the specified element from the specified array. All subsequent elements are shifted to
-     * the left (subtracts one from their indices). If the array doesn't contains such an element, no elements are
-     * removed from the array. <code>null</code> will be returned if the input array is <code>null</code>
+     * All subsequent elements are shifted to the left (subtracts one from their indices).
+     * If the array doesn't contains such an element, no elements are removed from the array.
+     * <code>null</code> will be returned if the input array is <code>null</code>.
+     * </p>
      *
      * @param element the element to remove
      * @param array the input array
@@ -7668,10 +7671,13 @@ public class ArrayUtils {
     }
 
     /**
+     * Removes the occurrences of the specified element from the specified char array.
+     *
      * <p>
-     * Removes the occurrences of the specified element from the specified array. All subsequent elements are shifted to
-     * the left (subtracts one from their indices). If the array doesn't contains such an element, no elements are
-     * removed from the array. <code>null</code> will be returned if the input array is <code>null</code>
+     * All subsequent elements are shifted to the left (subtracts one from their indices).
+     * If the array doesn't contains such an element, no elements are removed from the array.
+     * <code>null</code> will be returned if the input array is <code>null</code>.
+     * </p>
      *
      * @param element the element to remove
      * @param array the input array
@@ -7697,10 +7703,13 @@ public class ArrayUtils {
     }
 
     /**
+     * Removes the occurrences of the specified element from the specified byte array.
+     *
      * <p>
-     * Removes the occurrences of the specified element from the specified array. All subsequent elements are shifted to
-     * the left (subtracts one from their indices). If the array doesn't contains such an element, no elements are
-     * removed from the array. <code>null</code> will be returned if the input array is <code>null</code>
+     * All subsequent elements are shifted to the left (subtracts one from their indices).
+     * If the array doesn't contains such an element, no elements are removed from the array.
+     * <code>null</code> will be returned if the input array is <code>null</code>.
+     * </p>
      *
      * @param element the element to remove
      * @param array the input array
@@ -7726,10 +7735,13 @@ public class ArrayUtils {
     }
 
     /**
+     * Removes the occurrences of the specified element from the specified short array.
+     *
      * <p>
-     * Removes the occurrences of the specified element from the specified array. All subsequent elements are shifted to
-     * the left (subtracts one from their indices). If the array doesn't contains such an element, no elements are
-     * removed from the array. <code>null</code> will be returned if the input array is <code>null</code>
+     * All subsequent elements are shifted to the left (subtracts one from their indices).
+     * If the array doesn't contains such an element, no elements are removed from the array.
+     * <code>null</code> will be returned if the input array is <code>null</code>.
+     * </p>
      *
      * @param element the element to remove
      * @param array the input array
@@ -7755,10 +7767,13 @@ public class ArrayUtils {
     }
 
     /**
+     * Removes the occurrences of the specified element from the specified int array.
+     *
      * <p>
-     * Removes the occurrences of the specified element from the specified array. All subsequent elements are shifted to
-     * the left (subtracts one from their indices). If the array doesn't contains such an element, no elements are
-     * removed from the array. <code>null</code> will be returned if the input array is <code>null</code>
+     * All subsequent elements are shifted to the left (subtracts one from their indices).
+     * If the array doesn't contains such an element, no elements are removed from the array.
+     * <code>null</code> will be returned if the input array is <code>null</code>.
+     * </p>
      *
      * @param element the element to remove
      * @param array the input array
@@ -7784,10 +7799,13 @@ public class ArrayUtils {
     }
 
     /**
+     * Removes the occurrences of the specified element from the specified long array.
+     *
      * <p>
-     * Removes the occurrences of the specified element from the specified array. All subsequent elements are shifted to
-     * the left (subtracts one from their indices). If the array doesn't contains such an element, no elements are
-     * removed from the array. <code>null</code> will be returned if the input array is <code>null</code>
+     * All subsequent elements are shifted to the left (subtracts one from their indices).
+     * If the array doesn't contains such an element, no elements are removed from the array.
+     * <code>null</code> will be returned if the input array is <code>null</code>.
+     * </p>
      *
      * @param element the element to remove
      * @param array the input array
@@ -7813,10 +7831,13 @@ public class ArrayUtils {
     }
 
     /**
+     * Removes the occurrences of the specified element from the specified float array.
+     *
      * <p>
-     * Removes the occurrences of the specified element from the specified array. All subsequent elements are shifted to
-     * the left (subtracts one from their indices). If the array doesn't contains such an element, no elements are
-     * removed from the array. <code>null</code> will be returned if the input array is <code>null</code>
+     * All subsequent elements are shifted to the left (subtracts one from their indices).
+     * If the array doesn't contains such an element, no elements are removed from the array.
+     * <code>null</code> will be returned if the input array is <code>null</code>.
+     * </p>
      *
      * @param element the element to remove
      * @param array the input array
@@ -7842,10 +7863,13 @@ public class ArrayUtils {
     }
 
     /**
+     * Removes the occurrences of the specified element from the specified double array.
+     *
      * <p>
-     * Removes the occurrences of the specified element from the specified array. All subsequent elements are shifted to
-     * the left (subtracts one from their indices). If the array doesn't contains such an element, no elements are
-     * removed from the array. <code>null</code> will be returned if the input array is <code>null</code>
+     * All subsequent elements are shifted to the left (subtracts one from their indices).
+     * If the array doesn't contains such an element, no elements are removed from the array.
+     * <code>null</code> will be returned if the input array is <code>null</code>.
+     * </p>
      *
      * @param element the element to remove
      * @param array the input array
@@ -7871,10 +7895,13 @@ public class ArrayUtils {
     }
 
     /**
+     * Removes the occurrences of the specified element from the specified array.
+     *
      * <p>
-     * Removes the occurrences of the specified element from the specified array. All subsequent elements are shifted to
-     * the left (subtracts one from their indices). If the array doesn't contains such an element, no elements are
-     * removed from the array. <code>null</code> will be returned if the input array is <code>null</code>
+     * All subsequent elements are shifted to the left (subtracts one from their indices).
+     * If the array doesn't contains such an element, no elements are removed from the array.
+     * <code>null</code> will be returned if the input array is <code>null</code>.
+     * </p>
      *
      * @param <T> the type of object in the array
      * @param element the element to remove