Code review request for 6717780 "(coll spec) LinkedList api documentation provides the wrong method name"

Joe Darcy joe.darcy at oracle.com
Thu Jul 22 02:04:51 UTC 2010


Hello.

Please code review this simple fix to the LinkedList javadoc for bug 
6717780 "(coll spec) LinkedList api documentation provides the wrong 
method name:" in the sentence

"In addition to implementing the List interface, the LinkedList class 
provides uniformly named methods to get, remove and insert an element at 
the beginning and end of the list."

the word "insert" should be "add".  I've also added text to explicitly 
state that the beginning-of-list methods are operationFirst and the end 
of list methods are operationLast.

Patch below, full webrev at
http://cr.openjdk.java.net/~darcy/6717780.0/

Thanks,

-Joe

--- old/src/share/classes/java/util/LinkedList.java    2010-07-21 
18:58:12.000000000 -0700
+++ new/src/share/classes/java/util/LinkedList.java    2010-07-21 
18:58:12.000000000 -0700
@@ -26,14 +26,15 @@
 package java.util;
 
 /**
- * Linked list implementation of the {@code List} interface.  
Implements all
- * optional list operations, and permits all elements (including
- * {@code null}).  In addition to implementing the {@code List} interface,
- * the {@code LinkedList} class provides uniformly named methods to
- * {@code get}, {@code remove} and {@code insert} an element at the
- * beginning and end of the list.  These operations allow linked lists 
to be
- * used as a stack, {@linkplain Queue queue}, or {@linkplain Deque
- * double-ended queue}.
+ * Linked list implementation of the {@code List} interface.
+ * Implements all optional list operations, and permits all elements
+ * (including {@code null}).  In addition to implementing the {@code
+ * List} interface, the {@code LinkedList} class provides uniformly
+ * named methods to {@code get}, {@code remove} and {@code add} an
+ * element at the beginning (<i>operation</i>{@code First}) and end
+ * (<i>operation</i>{@code Last}) of the list.  These operations allow
+ * linked lists to be used as a stack, {@linkplain Queue queue}, or
+ * {@linkplain Deque double-ended queue}.
  *
  * <p>The class implements the {@code Deque} interface, providing
  * first-in-first-out queue operations for {@code add},




More information about the core-libs-dev mailing list