added Documentation for Turtle / Tortoise

Author: lynnlangit

src/org/teachingextensions/logo/MultiTurtlePanel.java

@@ -114,6 +114,12 @@ public synchronized Animals getAnimal()
     }
     return animal;
   }
+  /**
+   * Sets the Animal
+   * <div><b>Example:</b> {@code  multiTurtlePanel.setAnimal(animal)} </div>
+   * 
+   * @see Animals
+   */
   public synchronized void setAnimal(Animals animal)
   {
     this.animal = animal;

src/org/teachingextensions/logo/PenColors.java

@@ -1532,6 +1532,11 @@ private static int increase(int amount, int increaseBy)
   {
     return Math.min(255, amount + increaseBy);
   }
+  /**
+   * Gets a random pen color
+   * <div><b>Example:</b> {@code  penColors.getRandomColor( )} </div>
+   * 
+   */
   public static Color getRandomColor()
   {
     return new Color(RANDOM.nextInt(255), RANDOM.nextInt(255), RANDOM.nextInt(255));

src/org/teachingextensions/logo/Tortoise.java

@@ -7,7 +7,7 @@
 
 /**
  * <img src="https://lh5.googleusercontent.com/-B3Q59gpYW8o/T4tA2k_TYUI/AAAAAAAAAjo/WiqdoXjbkb0/s65/Tortoise.png" align="left" >
- * The Tortoise allows you to draw lines and shapes by moving it around on the canvas
+ * The Tortoise allows you to draw lines and shapes by moving it around on the window
  */
 public class Tortoise
 {
@@ -42,11 +42,11 @@ public static int getSpeed()
   }
   /**
    * Sets the color drawn by the Tortoise. <br/>
-   * <div><b>Example:</b> {@code  Tortoise.setPenColor(Colors.Reds.Red)}</div>
+   * <div><b>Example:</b> {@code  Tortoise.setPenColor(PenColors.Reds.Red)}</div>
    * 
    * @param color
    *          the color of the pen
-   * @see Colors
+   * @see PenColors
    */
   public static void setPenColor(Color color)
   {
@@ -178,26 +178,24 @@ public static double getAngle()
    * Changes the type of animal you are using. <br/>
    * <div><b>Example:</b> {@code  Tortoise.setAnimal(Animals.Spider);}</div>
    * 
-   * @return the angle in degrees of the Tortoise
    * @see Animals
    */
   public static void setAnimal(Animals animal)
   {
     turtle().setAnimal(animal);
   }
   /**
-   * Changes the type of animal you are using. <br/>
-   * <div><b>Example:</b> {@code  Tortoise.setAnimal(Animals.Spider);}</div>
+   * Blows up your turtle! <br/>
+   * <div><b>Example:</b> {@code  Tortoise.explode(Animals.ExplodedTurtle);}</div>
    * 
-   * @return the angle in degrees of the Tortoise
    * @see Animals
    */
   public static void explode()
   {
     turtle().setAnimal(Animals.ExplodedTurtle);
   }
   /**
-   * Makes it so the tortoise will not draw a line of color out of it's butt. <br/>
+   * Makes it so the tortoise will not draw a line of color out of its butt. <br/>
    * <b>Example:</b> {@code  Tortoise.penUp()}
    */
   public static void penUp()
@@ -221,7 +219,7 @@ public static void clear()
     turtle().clear();
   }
   /**
-   * Hides the tortoise, you will still see the pen markings it made before and after it hid. <br/>
+   * Hides the tortoise, you will still see the pen markings it made before and after it's hidden. <br/>
    * <b>Example:</b> {@code  Tortoise.hide()}
    */
   public static void hide()

src/org/teachingextensions/logo/Turtle.java

@@ -17,6 +17,10 @@
 import com.spun.util.persistence.Saver;
 import com.spun.util.persistence.SavingException;
 
+/**
+ * <img src="https://lh5.googleusercontent.com/-B3Q59gpYW8o/T4tA2k_TYUI/AAAAAAAAAjo/WiqdoXjbkb0/s65/Tortoise.png" align="left" >
+ * The Turtle allows you to draw lines and shapes by moving it around on the window, and you can put more than one turtle on the same window...
+ */
 public class Turtle
 {
   /**
@@ -77,6 +81,7 @@ public Double save(Double save) throws SavingException
   private boolean             penDown         = true;
   private boolean             hidden;
   private Animals             animal;
+  //
   public BufferedImage getImage()
   {
     BufferedImage image = ComponentApprovalWriter.drawComponent(getPanel());