Update/add javadoc comments (for consistency)

Author: phrdang

src/com/codefortomorrow/advanced/chapter16/solutions/LinkedList.java

@@ -9,6 +9,7 @@
  *
  * Implement a simple LinkedList
  * You will need to create a LinkedListNode class, which represents each item/node in the linked list
+ * Assume that the elements in the linked list are all of type int
  * Required functionality...
  * - head(): get head of list
  * - tail(): get tail of list
@@ -31,6 +32,7 @@ public LinkedList() {
 
     /**
      * constructor with first value
+     * @param value  first element in the linked list
      */
     public LinkedList(int value) {
         // create first node
@@ -39,15 +41,15 @@ public LinkedList(int value) {
 
     /**
      * get head of Linked List
-     * @return
+     * @return first element of the linked list
      */
     public LinkedListNode head() {
         return this.head;
     }
 
     /**
      * traverse and get tail of linked list
-     * @return
+     * @return last element of the linked list
      */
     public LinkedListNode tail() {
         LinkedListNode current = head;
@@ -62,6 +64,7 @@ public LinkedListNode tail() {
 
     /**
      * add new element (node) to linked list
+     * @param value  element to add to the end of the linked list
      */
     public void add(int value) {
         LinkedListNode tail = tail();
@@ -73,17 +76,16 @@ public void add(int value) {
     }
 
     /**
-     * push (add to head of linkedlist)
-     * @return
+     * push (add element to head of linkedlist)
      */
     public void push(int value) {
         LinkedListNode newHead = new LinkedListNode(value, head);
         head = newHead;
     }
 
     /**
-     * pop (remove head of linkedlist)
-     * @return
+     * pop (remove and return head of linkedlist)
+     * @return the node that was removed
      */
     public LinkedListNode pop() {
         LinkedListNode popped = head;
@@ -92,8 +94,8 @@ public LinkedListNode pop() {
     }
 
     /**
-     * to String
-     * @return
+     * Returns a String version of the LinkedList
+     * @return a String version of the LinkedList
      */
     @Override
     public String toString() {
@@ -116,11 +118,19 @@ class Node {
     private UUID ID;
     private int value;
 
+    /**
+     * Constructs a list node with the given value
+     * @param value  the value stored in this Node
+     */
     public Node(int value) {
         this.ID = UUID.randomUUID();
         this.value = value;
     }
 
+    /**
+     * Returns the value of this Node
+     * @return the value of this Node
+     */
     public int value() {
         return this.value;
     }
@@ -130,15 +140,28 @@ class LinkedListNode extends Node {
 
     private LinkedListNode next;
 
+    /**
+     * Constructs a LinkedListNode
+     * @param value  the value stored in this node
+     * @param next  the next node
+     */
     public LinkedListNode(int value, LinkedListNode next) {
         super(value);
         this.next = next;
     }
 
+    /**
+     * Returns the next node
+     * @return the next node
+     */
     public LinkedListNode next() {
         return this.next;
     }
 
+    /**
+     * Sets the next node
+     * @param next  the next node
+     */
     public void setNext(LinkedListNode next) {
         this.next = next;
         return;