Add some javadoc comments.

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>

diff --git a/Piles/Pile.java b/Piles/Pile.java
index 565432498d47f40d52ead6fe175e57bb81fcb85a..1c808c21880b75fd231d62e891dde9aad5acfca9 100644 (file)
--- a/Piles/Pile.java
+++ b/Piles/Pile.java
@@ -8,32 +8,32 @@ public class Pile {
     private int stack_head_index;
 
     /**
-     * [setSize description]
-     * @param int size [description]
+     * set the size of the internal array
+     * @param int size the size of the array
      */
     private void setSize(int size) {
         array_size = size;
     }
 
     /**
-     * [getSize description]
-     * @return [description]
+     * get the size of the internal array
+     * @return the integer size of the internal array
      */
     private int getSize() {
         return array_size;
     }
 
     /**
-     * [setHeadIndex description]
-     * @param int index [description]
+     * set the stack head index
+     * @param int index the stack head index
      */
     private void setHeadIndex(int index) {
         stack_head_index = index;
     }
 
     /**
-     * [getHeadIndex description]
-     * @return [description]
+     * get the stack head current index
+     * @return the integer stack head index
      */
     private int getHeadIndex() {
         return stack_head_index;