Fix malformed Javadoc comments

Author: garydgregory

src/changes/changes.xml

@@ -41,6 +41,7 @@
     <action type="fix" dev="ggregory" due-to="Gary Gregory" >Fix SortedProperties.stringPropertyNames() returned an unsorted Set.</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory" >Fix SortedProperties.forEach() called its consumer out of order.</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix Apache RAT plugin console warnings.</action>
+    <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix malformed Javadoc comments.</action>
     <!-- ADD -->
     <action type="add" dev="ggregory" due-to="Gary Gregory">Add generics to UnmodifiableIterator for the wrapped type.</action>
     <action type="add" dev="ggregory" due-to="Gary Gregory">Add a Maven benchmark profile for JMH.</action>

src/main/java/org/apache/commons/collections4/ClosureUtils.java

@@ -35,25 +35,25 @@
  * {@code ClosureUtils} provides reference implementations and utilities
  * for the Closure functor interface. The supplied closures are:
  * <ul>
- * <li>Invoker - invokes a method on the input object
- * <li>For - repeatedly calls a closure for a fixed number of times
- * <li>While - repeatedly calls a closure while a predicate is true
- * <li>Chained - chains two or more closures together
- * <li>If - calls one closure or another based on a predicate
- * <li>Switch - calls one closure based on one or more predicates
- * <li>SwitchMap - calls one closure looked up from a Map
- * <li>Transformer - wraps a Transformer as a Closure
- * <li>NOP - does nothing
- * <li>Exception - always throws an exception
+ * <li>Invoker - invokes a method on the input object</li>
+ * <li>For - repeatedly calls a closure for a fixed number of times</li>
+ * <li>While - repeatedly calls a closure while a predicate is true</li>
+ * <li>Chained - chains two or more closures together</li>
+ * <li>If - calls one closure or another based on a predicate</li>
+ * <li>Switch - calls one closure based on one or more predicates</li>
+ * <li>SwitchMap - calls one closure looked up from a Map</li>
+ * <li>Transformer - wraps a Transformer as a Closure</li>
+ * <li>NOP - does nothing</li>
+ * <li>Exception - always throws an exception</li>
  * </ul>
  * <p>
  * Since v4.1 only closures which are considered to be safe are
  * Serializable. Closures considered to be unsafe for serialization are:
  * </p>
  * <ul>
- * <li>Invoker
- * <li>For
- * <li>While
+ * <li>Invoker</li>
+ * <li>For</li>
+ * <li>While</li>
  * </ul>
  *
  * @since 3.0

src/main/java/org/apache/commons/collections4/CollectionUtils.java

@@ -1838,11 +1838,11 @@ public static <O, R extends Collection<? super O>> R selectRejected(final Iterab
      * This method can handles objects as follows
      * </p>
      * <ul>
-     * <li>Collection - the collection size
-     * <li>Map - the map size
-     * <li>Array - the array size
-     * <li>Iterator - the number of elements remaining in the iterator
-     * <li>Enumeration - the number of elements remaining in the enumeration
+     * <li>Collection - the collection size</li>
+     * <li>Map - the map size</li>
+     * <li>Array - the array size</li>
+     * <li>Iterator - the number of elements remaining in the iterator</li>
+     * <li>Enumeration - the number of elements remaining in the enumeration</li>
      * </ul>
      *
      * @param object  the object to get the size of, may be null
@@ -1887,11 +1887,11 @@ public static int size(final Object object) {
      * This method can handles objects as follows
      * </p>
      * <ul>
-     * <li>Collection - via collection isEmpty
-     * <li>Map - via map isEmpty
-     * <li>Array - using array size
-     * <li>Iterator - via hasNext
-     * <li>Enumeration - via hasMoreElements
+     * <li>Collection - via collection isEmpty</li>
+     * <li>Map - via map isEmpty</li>
+     * <li>Array - using array size</li>
+     * <li>Iterator - via hasNext</li>
+     * <li>Enumeration - via hasMoreElements</li>
      * </ul>
      * <p>
      * Note: This method is named to avoid clashing with

src/main/java/org/apache/commons/collections4/FactoryUtils.java

@@ -25,19 +25,19 @@
  * {@code FactoryUtils} provides reference implementations and utilities
  * for the Factory functor interface. The supplied factories are:
  * <ul>
- * <li>Prototype - clones a specified object
- * <li>Instantiate - creates objects using reflection
- * <li>Constant - always returns the same object
- * <li>Null - always returns null
- * <li>Exception - always throws an exception
+ * <li>Prototype - clones a specified object</li>
+ * <li>Instantiate - creates objects using reflection</li>
+ * <li>Constant - always returns the same object</li>
+ * <li>Null - always returns null</li>
+ * <li>Exception - always throws an exception</li>
  * </ul>
  * <p>
  * Since v4.1 only factories which are considered to be safe are
  * Serializable. Factories considered to be unsafe for serialization are:
  * </p>
  * <ul>
- * <li>Prototype
- * <li>Instantiate
+ * <li>Prototype</li>
+ * <li>Instantiate</li>
  * </ul>
  *
  * @since 3.0

src/main/java/org/apache/commons/collections4/FluentIterable.java

@@ -35,12 +35,11 @@
  * </p>
  * <ul>
  *   <li>fluent methods which return a new {@code FluentIterable} instance,
- *       providing a view of the original iterable (for example filter(Predicate));
+ *       providing a view of the original iterable (for example filter(Predicate));</li>
  *   <li>conversion methods which copy the FluentIterable's contents into a
- *       new collection or array (for example toList());
+ *       new collection or array (for example toList());</li>
  *   <li>utility methods which answer questions about the FluentIterable's
- *       contents (for example size(), anyMatch(Predicate)).
- *   <li>
+ *       contents (for example size(), anyMatch(Predicate)).</li>
  * </ul>
  * <p>
  * The following example outputs the first 3 even numbers in the range [1, 10]
@@ -218,8 +217,8 @@ public Enumeration<E> asEnumeration() {
      * Example: natural ordering
      * </p>
      * <ul>
-     *   <li>this contains elements [1, 3, 5, 7]
-     *   <li>other contains elements [2, 4, 6, 8]
+     *   <li>this contains elements [1, 3, 5, 7]</li>
+     *   <li>other contains elements [2, 4, 6, 8]</li>
      * </ul>
      * <p>
      * The returned iterable will traverse the elements in the following
@@ -243,8 +242,8 @@ public FluentIterable<E> collate(final Iterable<? extends E> other) {
      * Example: descending order
      * </p>
      * <ul>
-     *   <li>this contains elements [7, 5, 3, 1]
-     *   <li>other contains elements [8, 6, 4, 2]
+     *   <li>this contains elements [7, 5, 3, 1]</li>
+     *   <li>other contains elements [8, 6, 4, 2]</li>
      * </ul>
      * <p>
      * The returned iterable will traverse the elements in the following

src/main/java/org/apache/commons/collections4/IterableUtils.java

@@ -39,10 +39,10 @@
  * </p>
  * <ul>
  * <li>All decorator methods are <em>not</em> null-safe for the provided Iterable argument; for example, they will throw a {@link NullPointerException} if a
- * null Iterable is passed as argument.
+ * null Iterable is passed as argument.</li>
  * <li>All other utility methods are null-safe for the provided Iterable argument; for example, they will treat a null Iterable the same way as an empty one.
  * For other arguments which are null, a {@link Predicate} will result in a {@link NullPointerException}. Exception: passing a null {@link Comparator} is
- * equivalent to a Comparator with natural ordering.
+ * equivalent to a Comparator with natural ordering.</li>
  * </ul>
  *
  * @since 4.1

src/main/java/org/apache/commons/collections4/IteratorUtils.java

@@ -866,17 +866,17 @@ static <E> E get(final Iterator<E> iterator, final int index, final IntFunction<
      * This method can handle objects as follows
      * </p>
      * <ul>
-     * <li>null - empty iterator
-     * <li>Iterator - returned directly
-     * <li>Enumeration - wrapped
-     * <li>Collection - iterator from collection returned
-     * <li>Map - values iterator returned
-     * <li>Dictionary - values (elements) enumeration returned as iterator
-     * <li>array - iterator over array returned
-     * <li>object with iterator() public method accessed by reflection
-     * <li>object - singleton iterator
-     * <li>NodeList - iterator over the list
-     * <li>Node - iterator over the child nodes
+     * <li>null - empty iterator</li>
+     * <li>Iterator - returned directly</li>
+     * <li>Enumeration - wrapped</li>
+     * <li>Collection - iterator from collection returned</li>
+     * <li>Map - values iterator returned</li>
+     * <li>Dictionary - values (elements) enumeration returned as iterator</li>
+     * <li>array - iterator over array returned</li>
+     * <li>object with iterator() public method accessed by reflection</li>
+     * <li>object - singleton iterator</li>
+     * <li>NodeList - iterator over the list</li>
+     * <li>Node - iterator over the child nodes</li>
      * </ul>
      *
      * @param obj  the object to convert to an iterator

src/main/java/org/apache/commons/collections4/MapUtils.java

@@ -60,19 +60,19 @@
  * </p>
  *
  * <ul>
- * <li>{@link #fixedSizeMap(Map)}
- * <li>{@link #fixedSizeSortedMap(SortedMap)}
- * <li>{@link #lazyMap(Map,Factory)}
- * <li>{@link #lazyMap(Map,Transformer)}
- * <li>{@link #lazySortedMap(SortedMap,Factory)}
- * <li>{@link #lazySortedMap(SortedMap,Transformer)}
- * <li>{@link #predicatedMap(Map,Predicate,Predicate)}
- * <li>{@link #predicatedSortedMap(SortedMap,Predicate,Predicate)}
- * <li>{@link #transformedMap(Map, Transformer, Transformer)}
- * <li>{@link #transformedSortedMap(SortedMap, Transformer, Transformer)}
- * <li>{@link #multiValueMap(Map)}
- * <li>{@link #multiValueMap(Map, Class)}
- * <li>{@link #multiValueMap(Map, Factory)}
+ * <li>{@link #fixedSizeMap(Map)}</li>
+ * <li>{@link #fixedSizeSortedMap(SortedMap)}</li>
+ * <li>{@link #lazyMap(Map,Factory)}</li>
+ * <li>{@link #lazyMap(Map,Transformer)}</li>
+ * <li>{@link #lazySortedMap(SortedMap,Factory)}</li>
+ * <li>{@link #lazySortedMap(SortedMap,Transformer)}</li>
+ * <li>{@link #predicatedMap(Map,Predicate,Predicate)}</li>
+ * <li>{@link #predicatedSortedMap(SortedMap,Predicate,Predicate)}</li>
+ * <li>{@link #transformedMap(Map, Transformer, Transformer)}</li>
+ * <li>{@link #transformedSortedMap(SortedMap, Transformer, Transformer)}</li>
+ * <li>{@link #multiValueMap(Map)}</li>
+ * <li>{@link #multiValueMap(Map, Class)}</li>
+ * <li>{@link #multiValueMap(Map, Factory)}</li>
  * </ul>
  *
  * @since 1.0

src/main/java/org/apache/commons/collections4/PredicateUtils.java

@@ -45,24 +45,24 @@
  * {@code PredicateUtils} provides reference implementations and utilities
  * for the Predicate functor interface. The supplied predicates are:
  * <ul>
- * <li>Invoker - returns the result of a method call on the input object
- * <li>InstanceOf - true if the object is an instanceof a class
- * <li>Equal - true if the object equals() a specified object
- * <li>Identity - true if the object == a specified object
- * <li>Null - true if the object is null
- * <li>NotNull - true if the object is not null
- * <li>Unique - true if the object has not already been evaluated
- * <li>And/All - true if all of the predicates are true
- * <li>Or/Any - true if any of the predicates is true
- * <li>Either/One - true if only one of the predicate is true
- * <li>Neither/None - true if none of the predicates are true
- * <li>Not - true if the predicate is false, and vice versa
- * <li>Transformer - wraps a Transformer as a Predicate
- * <li>True - always return true
- * <li>False - always return false
- * <li>Exception - always throws an exception
- * <li>NullIsException/NullIsFalse/NullIsTrue - check for null input
- * <li>Transformed - transforms the input before calling the predicate
+ * <li>Invoker - returns the result of a method call on the input object</li>
+ * <li>InstanceOf - true if the object is an instanceof a class</li>
+ * <li>Equal - true if the object equals() a specified object</li>
+ * <li>Identity - true if the object == a specified object</li>
+ * <li>Null - true if the object is null</li>
+ * <li>NotNull - true if the object is not null</li>
+ * <li>Unique - true if the object has not already been evaluated</li>
+ * <li>And/All - true if all of the predicates are true</li>
+ * <li>Or/Any - true if any of the predicates is true</li>
+ * <li>Either/One - true if only one of the predicate is true</li>
+ * <li>Neither/None - true if none of the predicates are true</li>
+ * <li>Not - true if the predicate is false, and vice versa</li>
+ * <li>Transformer - wraps a Transformer as a Predicate</li>
+ * <li>True - always return true</li>
+ * <li>False - always return false</li>
+ * <li>Exception - always throws an exception</li>
+ * <li>NullIsException/NullIsFalse/NullIsTrue - check for null input</li>
+ * <li>Transformed - transforms the input before calling the predicate</li>
  * </ul>
  * <p>
  * All the supplied predicates are Serializable.

src/main/java/org/apache/commons/collections4/TransformerUtils.java

@@ -40,31 +40,31 @@
  * {@code TransformerUtils} provides reference implementations and
  * utilities for the Transformer functor interface. The supplied transformers are:
  * <ul>
- * <li>Invoker - returns the result of a method call on the input object
- * <li>Clone - returns a clone of the input object
- * <li>Constant - always returns the same object
- * <li>Closure - performs a Closure and returns the input object
- * <li>Predicate - returns the result of the predicate as a Boolean
- * <li>Factory - returns a new object from a factory
- * <li>Chained - chains two or more transformers together
- * <li>If - calls one transformer or another based on a predicate
- * <li>Switch - calls one transformer based on one or more predicates
- * <li>SwitchMap - calls one transformer looked up from a Map
- * <li>Instantiate - the Class input object is instantiated
- * <li>Map - returns an object from a supplied Map
- * <li>Null - always returns null
- * <li>NOP - returns the input object, which should be immutable
- * <li>Exception - always throws an exception
- * <li>StringValue - returns a {@link String} representation of the input object
+ * <li>Invoker - returns the result of a method call on the input object</li>
+ * <li>Clone - returns a clone of the input object</li>
+ * <li>Constant - always returns the same object</li>
+ * <li>Closure - performs a Closure and returns the input object</li>
+ * <li>Predicate - returns the result of the predicate as a Boolean</li>
+ * <li>Factory - returns a new object from a factory</li>
+ * <li>Chained - chains two or more transformers together</li>
+ * <li>If - calls one transformer or another based on a predicate</li>
+ * <li>Switch - calls one transformer based on one or more predicates</li>
+ * <li>SwitchMap - calls one transformer looked up from a Map</li>
+ * <li>Instantiate - the Class input object is instantiated</li>
+ * <li>Map - returns an object from a supplied Map</li>
+ * <li>Null - always returns null</li>
+ * <li>NOP - returns the input object, which should be immutable</li>
+ * <li>Exception - always throws an exception</li>
+ * <li>StringValue - returns a {@link String} representation of the input object</li>
  * </ul>
  * <p>
  * Since v4.1 only transformers which are considered to be safe are
  * Serializable. Transformers considered to be unsafe for serialization are:
  * </p>
  * <ul>
- * <li>Invoker
- * <li>Clone
- * <li>Instantiate
+ * <li>Invoker</li>
+ * <li>Clone</li>
+ * <li>Instantiate</li>
  * </ul>
  *
  * @since 3.0