From ee6f3fa7a6d82bbedde4fece8704a7ce42dda3fe Mon Sep 17 00:00:00 2001
From: Benedikt Ritter <britter@apache.org>
Date: Sun, 11 Sep 2016 14:53:32 +0200
Subject: [PATCH] Better JavaDoc for removeAllOccurences variants

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

diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
index 90e99c7c3..cc16828c9 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 static boolean isSorted(boolean[] array) {
     }
 
     /**
+     * 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 static boolean[] removeAllOccurences(final boolean[] array, final boolean
     }
 
     /**
+     * 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 static char[] removeAllOccurences(final char[] array, final char element)
     }
 
     /**
+     * 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 static byte[] removeAllOccurences(final byte[] array, final byte element)
     }
 
     /**
+     * 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 static short[] removeAllOccurences(final short[] array, final short eleme
     }
 
     /**
+     * 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 static int[] removeAllOccurences(final int[] array, final int element) {
     }
 
     /**
+     * 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 static long[] removeAllOccurences(final long[] array, final long element)
     }
 
     /**
+     * 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 static float[] removeAllOccurences(final float[] array, final float eleme
     }
 
     /**
+     * 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 static double[] removeAllOccurences(final double[] array, final double el
     }
 
     /**
+     * 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