added Javadoc info

Author: lynnlangit

src/org/teachingextensions/logo/ColorWheel.java

@@ -3,6 +3,7 @@
 import java.awt.Color;
 
 /**
+ * <img src="https://cdn0.iconfinder.com/data/icons/pixelo/32/color-palette.png" align="left" >
  * ColorWheel is a place to store a color palette. <br/>
  * <b>Example:</b> If you have a palette of
  * <font color="blue">blue</font>,

src/org/teachingextensions/logo/Pizza.java

@@ -2,15 +2,31 @@
 
 import java.util.ArrayList;
 
+/**
+ * <img src="https://cdn2.iconfinder.com/data/icons/fatcow/32x32/pizza.png" align="left">
+ * The Pizza allows you to make different sizes and kinds of pizza!
+ */
 public class Pizza
 {
   private ArrayList<Topping> toppings = new ArrayList<Topping>();
   private boolean            cooked;
   private int                slices   = 2;
+  /**
+   * Adds a topping to a pizza
+   * <div><b>Example:</b> {@code  pizza.addTopping(Topping.Spam)} </div>
+   * 
+   * @param topping
+   *            A topping from the list 
+   */
   public void addTopping(Topping topping)
   {
     this.toppings.add(topping);
   }
+  /**
+   * Checks to see if a pizza has a particular kind of topping
+   * <div><b>Example:</b> {@code  pizza.hasTopping(topping)}</div>
+   * 
+   */
   public boolean hasTopping(Topping topping)
   {
     for (Topping toppingToday : toppings)
@@ -19,17 +35,35 @@ public boolean hasTopping(Topping topping)
     }
     return false;
   }
+  /**
+   * Cooks a pizza
+   * <div><b>Example:</b> {@code  pizza.cook()}</div>
+   * 
+   */
   public void cook()
   {
     this.cooked = true;
   }
+  /**
+   * Checks whether a pizza was cooked
+   * <div><b>Example:</b> {@code  pizza.wasCooked()}</div>
+   * 
+   * @return whether or not the pizza has been cooked already
+   */
   public boolean wasCooked()
   {
     return this.cooked;
   }
   public void ____()
   {
   }
+  /**
+   * Checks whether you can take a slice of pizza or not
+   * <div><b>Example:</b> {@code  pizza.takeSlice()}</div>
+   * 
+   * @return whether or not the pizza has any more slices to take
+   * If there are still slices, takes one slice 
+   */
   public boolean takeSlice()
   {
     if (0 < this.slices)
@@ -39,6 +73,11 @@ public boolean takeSlice()
     }
     return false;
   }
+  /**
+   * Adds more slices to a pizza
+   * <div><b>Example:</b> {@code  pizza.superSizeIt()}</div>
+   * 
+   */
   public void superSizeIt()
   {
     this.slices = 8;

src/org/teachingextensions/logo/Tortoise.java

@@ -244,6 +244,15 @@ public static void setAngle(int angle)
   {
     turtle().setAngleInDegrees(angle);
   }
+  /**
+   * Moves the Tortoise to a particular spot on the canvas. <br/>
+   * <div><b>Example:</b> {@code  Tortoise.moveTo(100,200);}</div>
+   * 
+   * @param x
+   *          the x position
+   * @param y
+   *          the y position
+   */
   public static void moveTo(int x, int y)
   {
     turtle().moveTo(x, y);
@@ -253,13 +262,28 @@ public static TurtlePanel ___()
     return new TurtlePanel();
   }
   private Topping topping;
+  /**
+   * Checks if a tortoise can eat a slice of a pizza
+   * <div><b>Example:</b> {@code  tortoise.eatPizza(pizza)}</div>
+   * 
+   * @param pizza
+   *            the pizza
+   * @return whether or not there is pizza left to eat that a tortoise likes
+   */
   public boolean eatPizza(Pizza pizza)
   {
     if (!pizza.takeSlice()) { return false; }
     if (this.topping == null) { return true; }
     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>
+   * 
+   * @param topping
+   *            the topping
+   */
   public void likesTopping(Topping topping)
   {
     this.topping = topping;

src/org/teachingextensions/logo/shapes/Circle.java

@@ -9,6 +9,10 @@
 import org.teachingextensions.logo.Paintable;
 import org.teachingextensions.windows.ProgramWindow;
 
+/**
+ * <img src="http://www2.psd100.com/ppp/2013/11/2701/Blue-circle-1127210229.png" align="left" >
+ * The Circle allows you to draw circles on the canvas
+ */
 public class Circle implements Paintable
 {
   private final int   radius;
@@ -21,22 +25,54 @@ public Circle(int radius, Color color)
     this.radius = radius;
     this.mainColor = color;
   }
+  /**
+   * Sets the center the circle
+   * <div><b>Example:</b> {@code  circle.setCenter(8,10)}</div>
+   * 
+   * @param x
+   *          The x value
+   * @param y
+   *          The y value
+   */
   public void setCenter(int x, int y)
   {
     this.x = x;
     this.y = y;
   }
+  /**
+   * Adds a circle to the window
+   * <div><b>Example:</b> {@code  circle.addTo(panel)}</div>
+   * 
+   * @param panel
+   *          the ProgramWindow or panel
+   */
   public void addTo(ProgramWindow panel)
   {
     panel.addPaintable(this);
   }
+  /**
+   * Paints a circle
+   * <div><b>Example:</b> {@code  circle.paint(g,caller)}</div>
+   * 
+   * @param g
+   *          the graphics object
+   * @param caller
+   *          the Program Window or panel
+   */
   @Override
   public void paint(Graphics2D g, JPanel caller)
   {
     Color color2 = Colors.getTransparentVersion(mainColor, percentTransparent);
     g.setColor(color2);
     g.fillOval(x - radius, y - radius, radius * 2, radius * 2);
   }
+  /**
+   * Sets the transparency of the circle
+   * <div><b>Example:</b> {@code  circle.setTransparency(80)}</div>
+   * 
+   * @param percentTransparent
+   *          The percentage of transparency of the circle
+   */
   public void setTransparency(int percentTransparent)
   {
     this.percentTransparent = percentTransparent;

src/org/teachingextensions/logo/shapes/Text.java

@@ -8,6 +8,10 @@
 import org.teachingextensions.logo.Paintable;
 import org.teachingextensions.logo.TurtlePanel;
 
+/**
+ * <img src="http://www.iconeasy.com/icon/thumbnails/System/BlankOn/Text%20Icon.jpg" align="left" >
+ * The Text allows you to write text on the canvas
+ */
 public class Text implements Paintable
 {
   private final String string;
@@ -17,12 +21,28 @@ public Text(String string)
   {
     this.string = string;
   }
+  /**
+   * Sets text position
+   * <div><b>Example:</b> {@code  text.setTopLeft(x,y)}</div>
+   * 
+   * @param x
+   *          the X position
+   * @param 
+   *          the Y position
+   */
   public Text setTopLeft(int x, int y)
   {
     this.x = x;
     this.y = y;
     return this;
   }
+  /**
+   * Adds text to the window
+   * <div><b>Example:</b> {@code  text.addTo(panel)}</div>
+   * 
+   * @param panel
+   *          the ProgramWindow or panel
+   */
   public void addTo(TurtlePanel panel)
   {
     panel.addPaintable(this);

src/org/teachingkidsprogramming/section07events/DeepDive07Events.java

@@ -21,7 +21,7 @@ public class DeepDive07Events
   //  Step 4: Consider at least one thing you just learned
   //  Step 5: Advance to the next method
   //  Do not change anything except the blank (___)
-  //
+  //  HINT: If you are stuck, look at the JavaDoc
   @Test
   public void twoTortoises() throws Exception
   {