added API documentation

Author: lynnlangit

src/main/java/org/teachingextensions/WindowUtils/MultiTurtleWindow.java

@@ -1,26 +1,26 @@
 package org.teachingextensions.WindowUtils;
 
+import java.util.ArrayList;
+import java.util.List;
+
 import org.teachingextensions.logo.Turtle;
 import org.teachingextensions.logo.utils.ColorUtils.PenColors;
 import org.teachingextensions.logo.utils.InterfaceUtils.MultiTurtlePainter;
 import org.teachingextensions.logo.utils.InterfaceUtils.MultiTurtleTrailPainter;
 import org.teachingextensions.logo.utils.InterfaceUtils.TurtleFrame;
 import org.teachingextensions.logo.utils.LineAndShapeUtils.Paintable;
 
-import java.util.ArrayList;
-import java.util.List;
-
 /**
  * Use this window when you want to put more than one turtle on the same window
  */
-public class MultiTurtleWindow extends TurtleWindow {
+public class MultiTurtleWindow extends TurtleWindow
+{
   private List<Turtle> turtles = new ArrayList<Turtle>();
-
-  public MultiTurtleWindow() {
+  public MultiTurtleWindow()
+  {
     super("Turtles, Turtles, Turtles!");
     this.setBackground(PenColors.Blues.DarkSlateBlue);
   }
-
   /**
    * Adds a turtle instance to a window
    * NOTE: this method must be called BEFORE calling any other methods on turtle instances
@@ -29,52 +29,55 @@ public MultiTurtleWindow() {
    * @param turtle
    *     A turtle instance
    */
-  public void addTurtle(Turtle turtle) {
-    if (turtle == null) {
-      return;
-    }
+  public void addTurtle(Turtle turtle)
+  {
+    if (turtle == null) { return; }
     turtle.setFrame(this.getFrame());
     turtle.setPanel(this);
-
     this.turtles.add(turtle);
     clearPainters();
     configurePainters();
   }
-
   @Override
-  public TurtleWindow init(Turtle turtle, TurtleFrame frame) {
+  public TurtleWindow init(Turtle turtle, TurtleFrame frame)
+  {
     return this;
   }
-
   @Override
-  protected Paintable createTurtleTrailPainter() {
+  protected Paintable createTurtleTrailPainter()
+  {
     this.setTrailPainter(new MultiTurtleTrailPainter(this.turtles));
     return this.getTrailPainter();
   }
-
   @Override
-  protected Paintable createTurtlePainter() {
+  protected Paintable createTurtlePainter()
+  {
     this.setTurtlePainter(new MultiTurtlePainter(this.turtles, this.getImage()));
     return this.getTurtlePainter();
   }
-
-  public int getTurtleCount() {
+  /**
+   * Gets a count of turtles for a window 
+   * <p><b>Example:</b> {@code multiTurtleWindow.getTurtlesCount()}</p>
+   *
+   */
+  public int getTurtleCount()
+  {
     return this.turtles.size();
   }
-
   /**
    * Adds a turtle instance to a window and shows it on the window
    * <p><b>Example:</b> {@code multiTurtleWindow.addAndShowTurtle(myTurtle)}</p>
    *
    * @param turtle
    *     A turtle instance
    */
-  public void addAndShowTurtle(Turtle turtle) {
+  public void addAndShowTurtle(Turtle turtle)
+  {
     this.addTurtle(turtle);
     this.showTurtle(turtle);
   }
-
-  private void showTurtle(Turtle turtle) {
+  private void showTurtle(Turtle turtle)
+  {
     turtle.show();
   }
 }

src/main/java/org/teachingextensions/logo/Tortoise.java

@@ -1,24 +1,23 @@
 package org.teachingextensions.logo;
 
+import java.awt.Color;
+
 import org.teachingextensions.WindowUtils.TurtleWindow;
 import org.teachingextensions.logo.Turtle.Animals;
+import org.teachingextensions.logo.utils.TortoiseUtils;
 import org.teachingextensions.logo.utils.ColorUtils.PenColors;
 import org.teachingextensions.logo.utils.LineAndShapeUtils.Text;
 import org.teachingextensions.logo.utils.PizzaUtils.Pizza;
 import org.teachingextensions.logo.utils.PizzaUtils.Topping;
-import org.teachingextensions.logo.utils.TortoiseUtils;
 import org.teachingextensions.virtualproctor.VirtualProctor;
 
-import java.awt.*;
-
 /**
  * <img src="https://lh5.googleusercontent.com/-B3Q59gpYW8o/T4tA2k_TYUI/AAAAAAAAAjo/WiqdoXjbkb0/s65/Tortoise.png" style="text-align: left" alt="A tortoise drawing a line" >
  * The Tortoise allows you to draw lines and shapes by moving it around on the window
  */
 public class Tortoise
 {
   private Topping topping;
-
   /**
    * Displays the Tortoise
    * <div><b>Example:</b> {@code  Tortoise.show()} </div>
@@ -27,7 +26,6 @@ public static void show()
   {
     turtle().show();
   }
-
   /**
    * Gets the speed that the tortoise moves
    * <div><b>Example:</b> {@code int speed =  Tortoise.getSpeed(8);}</div>
@@ -38,7 +36,6 @@ public static int getSpeed()
   {
     return turtle().getSpeed();
   }
-
   /**
    * Sets the speed the tortoise moves
    * <div><b>Example:</b> {@code  Tortoise.setSpeed(8)}</div>
@@ -50,7 +47,6 @@ public static void setSpeed(int speed)
   {
     turtle().setSpeed(speed);
   }
-
   /**
    * Moves the Tortoise Forward the number of pixels specified. <br>
    * <div><b>Example:</b> {@code Tortoise.move(72)}</div>
@@ -75,7 +71,6 @@ public static void turn(Number degreesToTheRight)
   {
     turtle().turn(degreesToTheRight.doubleValue());
   }
-
   /**
    * Gives you access to the window the
    * Tortoise is moving on so you can do things like change it's color. <br>
@@ -86,7 +81,6 @@ public static TurtleWindow getBackgroundWindow()
   {
     return turtle().getBackgroundWindow();
   }
-
   /**
    * Gets the current width of the pen drawn by the Tortoise. <br>
    * <div><b>Example:</b> {@code  width = Tortoise.getPenWidth()}</div>
@@ -97,7 +91,6 @@ public static int getPenWidth()
   {
     return turtle().getPenWidth();
   }
-
   /**
    * Sets the width of the pen drawn by the Tortoise. <br>
    * <div><b>Example:</b> {@code  Tortoise.setPenWidth(2)}</div>
@@ -109,7 +102,6 @@ public static void setPenWidth(Number width)
   {
     turtle().setPenWidth(width.intValue());
   }
-
   /**
    * Gets the current color of the pen drawn by the Tortoise. <br>
    * <div><b>Example:</b> {@code  pen = Tortoise.getPenColor()}</div>
@@ -120,20 +112,18 @@ public static Color getPenColor()
   {
     return turtle().getPenColor();
   }
-
   /**
-   * Sets the color drawn by the Tortoise. <br>
+   * Sets the color of the line drawn by the Tortoise. <br>
    * <div><b>Example:</b> {@code  Tortoise.setPenColor(PenColors.Reds.Red)}</div>
    *
    * @param color
-   *          the color of the pen
+   *          the color of the line drawn 
    * @see PenColors
    */
   public static void setPenColor(Color color)
   {
     turtle().setPenColor(color);
   }
-
   /**
    * Gets the current position of the Tortoise on the y axis. <br>
    * (0,0) is the top left of the screen <br>
@@ -145,7 +135,6 @@ public static int getY()
   {
     return turtle().getY();
   }
-
   /**
    * Sets the position of the Tortoise on the y axis. <br>
    * (0,0) is the top left of the screen <br>
@@ -158,7 +147,6 @@ public static void setY(int y)
   {
     turtle().setY(y);
   }
-
   /**
    * Gets the current position of the Tortoise on the x axis. <br>
    * (0,0) is the top left of the screen <br>
@@ -170,7 +158,6 @@ public static int getX()
   {
     return turtle().getX();
   }
-
   /**
    * Sets the position of the Tortoise on the x axis. <br>
    * (0,0) is the top left of the screen <br>
@@ -183,7 +170,6 @@ public static void setX(int x)
   {
     turtle().setX(x);
   }
-
   /**
    * Gets the current heading of the Tortoise. <br>
    * 0 degrees is due north. <br>
@@ -196,7 +182,6 @@ public static double getAngle()
   {
     return turtle().getAngleInDegrees();
   }
-
   /**
    * Sets the angle the Tortoise is facing. <br>
    * 0 is straight up (like 'North') <br>
@@ -209,7 +194,6 @@ public static void setAngle(int angle)
   {
     turtle().setAngleInDegrees(angle);
   }
-
   /**
    * Changes the type of animal you are using. <br>
    * <div><b>Example:</b> {@code  Tortoise.setAnimal(Animals.Spider);}</div>
@@ -221,7 +205,6 @@ public static void setAnimal(Animals animal)
   {
     turtle().setAnimal(animal);
   }
-
   /**
    * Blows up your turtle! <br>
    * <div><b>Example:</b> {@code  Tortoise.explode(Animals.ExplodedTurtle);}</div>
@@ -232,7 +215,6 @@ public static void explode()
   {
     turtle().setAnimal(Animals.ExplodedTurtle);
   }
-
   /**
    * Makes it so the tortoise will not draw a line of color out of its butt. <br>
    * <b>Example:</b> {@code  Tortoise.penUp()}
@@ -241,7 +223,6 @@ public static void setPenUp()
   {
     turtle().penUp();
   }
-
   /**
    * Makes it so a line of color out of will trail from the Tortoise. <br>
    * <b>Example:</b> {@code  Tortoise.penDown()}
@@ -250,7 +231,6 @@ public static void setPenDown()
   {
     turtle().penDown();
   }
-
   /**
    * Removes everything from the window. <br>
    * <b>Example:</b> {@code  Tortoise.clearWindow()}
@@ -260,7 +240,6 @@ public static void clear()
     turtle().clear();
     turtle().getBackgroundWindow().setTurtle(turtle());
   }
-
   /**
    * 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()}
@@ -269,12 +248,10 @@ public static void hide()
   {
     turtle().hide();
   }
-
   private static Turtle turtle()
   {
     return TortoiseUtils.getTurtle();
   }
-
   /**
    * Moves the Tortoise to a particular spot on the canvas. <br>
    * <div><b>Example:</b> {@code  Tortoise.moveTo(100,200);}</div>
@@ -288,12 +265,10 @@ public static void moveTo(int x, int y)
   {
     turtle().moveTo(x, y);
   }
-
   public static TurtleWindow ___()
   {
     return new TurtleWindow();
   }
-
   /**
    * Makes a cool shape fast
    * <div><b>Example: </b> {@code tortoise.drawShape(6,PenColors.Reds.Red, 50, 20)}</div>
@@ -322,7 +297,6 @@ public static void drawShape(int sides, Color color, int length, int width)
     VirtualProctor.setClassName("Grace Hopper's Class");
     VirtualProctor.setName("Jean Bartik");
   }
-
   /**
    * Draws an entire Tortoise --  fast!
    * <div><b>Example: </b> {@code tortoise.drawTortoise()}</div>
@@ -344,7 +318,6 @@ public static void drawTortoise()
     Tortoise.turn(-90);
     Tortoise.makeTortoiseLeg();
   }
-
   private static void makeTortoiseLeg()
   {
     for (int i = 0; i < 4; i++)
@@ -353,7 +326,6 @@ private static void makeTortoiseLeg()
       Tortoise.turn(90);
     }
   }
-
   private static void makeTortoiseBody()
   {
     Tortoise.turn(-90);
@@ -375,13 +347,11 @@ private static void makeTortoiseBody()
     Tortoise.turn(-25);
     Tortoise.move(65);
   }
-
   public static void setVisible(boolean b)
   {
     turtle().setFrameVisible(b);
     turtle().setPanelVisible(b);
   }
-
   /**
    * Checks if a tortoise can eat a slice of a pizza
    * <div><b>Example:</b> {@code  tortoise.eatPizza(pizza)}</div>
@@ -397,7 +367,6 @@ public boolean eatPizza(Pizza pizza)
     if (this.topping != Topping.Cheese) { return pizza.hasTopping(topping); }
     return pizza.wasCooked() && pizza.hasTopping(topping);
   }
-
   /**
    * Checks to see if a tortoise likes a particular kind of pizza topping
    * <div><b>Example:</b> {@code  tortoise.likesTopping(topping)}</div>

src/main/java/org/teachingkidsprogramming/recipes/completed/section08events/DeepDive08Events.java

@@ -39,6 +39,7 @@ public void twoCirclesAgain() throws Exception
     // shows use of different type of properties
     Assert.assertEquals(c2, result);
   }
+  @SuppressWarnings("unused")
   @Test
   public void twoCirclesYetAgain() throws Exception
   {