On 3/23/2011 3:32 PM, Mike Duigou wrote:
Hi All;
More documentation nits for review. :-) (and more of these to come as we push
closer to Java 7 code freeze)
This one adds the missing @param cmp tag for Collections.reverseOrder. The
description text is adapted from the general method javadoc.
http://cr.openjdk.java.net/~mduigou/7030442/0/webrev/
There is one phrase I would like to change but thus far have not--replacing in the method javadoc
the use of the phrase "on a collection of objects" with "for objects" since
Comparable doesn't directly interact with collections. Opinions?
Thanks,
Mike
Hello.
A few minor comments. In
+ * @return A comparator that imposes the reverse of the <i>natural
* ordering</i> on a collection of objects that implement
The "<i>" tag was not replaced with "<em>". For
+ * @param cmp a comparator who's ordering is to be reversed by the
returned
+ * comparator {@code null} if a comparator which imposes the
reverse of the
+ * <em>natural ordering</em> for {@code Comparable} objects is desired.
I don't think it is necessary to try to specify the null behavior in
this amount of details in an @param tag.
-Joe
