Add some javadoc comments.

[TP_POO.git] / Piles / Pile.java

diff --git a/Piles/Pile.java b/Piles/Pile.java
index 4e240d3902ad60a7015d956c9b886264351d66b0..1c808c21880b75fd231d62e891dde9aad5acfca9 100644 (file)
--- a/Piles/Pile.java
+++ b/Piles/Pile.java
@@ -2,38 +2,38 @@
 /**
  *
  */
-class Pile {
+public class Pile {
     private int int_array[];
     private int array_size;
     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;
@@ -102,7 +102,7 @@ class Pile {
 
     /**
      * The main() function
-     * @param String[] args main() function arguments
+     * @param String[] args main() function arguments array
      */
     public static void main(String[] args) {
         Pile stack = new Pile(5);