OpenJDK / portola / portola
changeset 9004:284f923de1bf
7030442: Add missing @param tag for Collections.reverseOrder()
Reviewed-by: darcy, alanb
author | mduigou |
---|---|
date | Fri, 25 Mar 2011 11:24:06 -0700 |
parents | e1b0f0099915 |
children | a329d2b300c9 |
files | jdk/src/share/classes/java/util/Collections.java |
diffstat | 1 files changed, 15 insertions(+), 13 deletions(-) [+] |
line wrap: on
line diff
--- a/jdk/src/share/classes/java/util/Collections.java Fri Mar 25 16:38:09 2011 +0000 +++ b/jdk/src/share/classes/java/util/Collections.java Fri Mar 25 11:24:06 2011 -0700 @@ -3533,20 +3533,20 @@ } /** - * Returns a comparator that imposes the reverse of the <i>natural - * ordering</i> on a collection of objects that implement the - * <tt>Comparable</tt> interface. (The natural ordering is the ordering - * imposed by the objects' own <tt>compareTo</tt> method.) This enables a + * Returns a comparator that imposes the reverse of the <em>natural + * ordering</em> on a collection of objects that implement the + * {@code Comparable} interface. (The natural ordering is the ordering + * imposed by the objects' own {@code compareTo} method.) This enables a * simple idiom for sorting (or maintaining) collections (or arrays) of - * objects that implement the <tt>Comparable</tt> interface in - * reverse-natural-order. For example, suppose a is an array of + * objects that implement the {@code Comparable} interface in + * reverse-natural-order. For example, suppose {@code a} is an array of * strings. Then: <pre> * Arrays.sort(a, Collections.reverseOrder()); * </pre> sorts the array in reverse-lexicographic (alphabetical) order.<p> * * The returned comparator is serializable. * - * @return a comparator that imposes the reverse of the <i>natural + * @return A comparator that imposes the reverse of the <i>natural * ordering</i> on a collection of objects that implement * the <tt>Comparable</tt> interface. * @see Comparable @@ -3575,16 +3575,18 @@ /** * Returns a comparator that imposes the reverse ordering of the specified - * comparator. If the specified comparator is null, this method is + * comparator. If the specified comparator is {@code null}, this method is * equivalent to {@link #reverseOrder()} (in other words, it returns a - * comparator that imposes the reverse of the <i>natural ordering</i> on a - * collection of objects that implement the Comparable interface). + * comparator that imposes the reverse of the <em>natural ordering</em> on + * a collection of objects that implement the Comparable interface). * * <p>The returned comparator is serializable (assuming the specified - * comparator is also serializable or null). + * comparator is also serializable or {@code null}). * - * @return a comparator that imposes the reverse ordering of the - * specified comparator + * @param cmp a comparator who's ordering is to be reversed by the returned + * comparator or {@code null} + * @return A comparator that imposes the reverse ordering of the + * specified comparator. * @since 1.5 */ public static <T> Comparator<T> reverseOrder(Comparator<T> cmp) {