From 059c1d1a5108f2ce3e8f572dbd8f9c80bcfd0a77 Mon Sep 17 00:00:00 2001 From: mduigou Date: Fri, 25 Mar 2011 11:24:06 -0700 Subject: [PATCH] 7030442: Add missing @param tag for Collections.reverseOrder() Reviewed-by: darcy, alanb --- src/share/classes/java/util/Collections.java | 28 +++++++++++--------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/src/share/classes/java/util/Collections.java b/src/share/classes/java/util/Collections.java index 1ea0ecb04..826cbe759 100644 --- a/src/share/classes/java/util/Collections.java +++ b/src/share/classes/java/util/Collections.java @@ -3533,20 +3533,20 @@ public class Collections { } /** - * Returns a comparator that imposes the reverse of the natural - * ordering on a collection of objects that implement the - * Comparable interface. (The natural ordering is the ordering - * imposed by the objects' own compareTo method.) This enables a + * Returns a comparator that imposes the reverse of the natural + * ordering 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 Comparable 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:
      *          Arrays.sort(a, Collections.reverseOrder());
      * 
sorts the array in reverse-lexicographic (alphabetical) order.

* * The returned comparator is serializable. * - * @return a comparator that imposes the reverse of the natural + * @return A comparator that imposes the reverse of the natural * ordering on a collection of objects that implement * the Comparable interface. * @see Comparable @@ -3575,16 +3575,18 @@ public class Collections { /** * 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 natural ordering on a - * collection of objects that implement the Comparable interface). + * comparator that imposes the reverse of the natural ordering on + * a collection of objects that implement the Comparable interface). * *

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 Comparator reverseOrder(Comparator cmp) { -- GitLab