adding documentation

Author: lynnlangit

src/org/teachingextensions/logo/ColorWheel.java

@@ -25,7 +25,6 @@ public class ColorWheel
   private static Wheel<Color> wheel = new Wheel<Color>();
   /**
    * This method adds a color to the ColorWheel. <br/>
-   * <b>Example:</b> {@code  ColorWheel.addColor(Colors.Reds.Red);} <br/>
    * <b>Example:</b> {@code  ColorWheel.addColor(PenColors.Reds.Red);}
    * @param color
    *          the color to add to the wheel
@@ -36,7 +35,7 @@ public static void addColor(Color color)
   }
   /**
    * This method returns the next color of the ColorWheel. <br/>
-   * <b>Example:</b> {@code  Color penColor = ColorWheel.getNextColor();}
+   * <b>Example:</b> {@code  Color color = ColorWheel.getNextColor();}
    * 
    * @return the next color of the ColorWheel
    */
@@ -46,7 +45,7 @@ public static Color getNextColor()
   }
   /**
    * This method returns the a random color from the options on the ColorWheel. <br/>
-   * <b>Example:</b> {@code  Color penColor = ColorWheel.getNextColor();}
+   * <b>Example:</b> {@code  Color color = ColorWheel.getNextColor();}
    * 
    * @return A random color from the ColorWheel
    */

src/org/teachingextensions/logo/MultiTurtlePanel.java

@@ -17,6 +17,10 @@
 import org.teachingextensions.logo.Turtle.Animals;
 import org.teachingextensions.windows.ProgramWindow;
 
+/**
+ *  Use this window when you want to put more than one turtle on the same window
+ */
+@SuppressWarnings("serial")
 public class MultiTurtlePanel extends TurtlePanel
 {
   private List<Turtle> turtles;
@@ -26,11 +30,30 @@ public MultiTurtlePanel()
   {
     turtles = new ArrayList<Turtle>();
   }
+  /**
+   * Adds a turtle instance to a window
+   * <div><b>Example:</b> {@code  multiTurtlePanel.addTurtle(myTurtle)} </div>
+   * 
+   * @param turtle
+   *            A turtle instance 
+   */
   public void addTurtle(Turtle turtle)
   {
     this.turtles.add(turtle);
     turtle.setPanel(this);
   }
+  /**
+   * Shows a window that can hold more than one turtle
+   * <div><b>Example:</b> {@code  multiTurtlePanel.showPanel( )} </div>
+   * 
+   */
+  public void showPanel()
+  {
+    JFrame frame = new JFrame("So Many Turtles");
+    frame.getContentPane().add(this);
+    ProgramWindow.createStandardFrame(frame);
+    this.repaint();
+  }
   @Override
   public void paint(Graphics g)
   {
@@ -100,13 +123,6 @@ public void setCursor(int cursor)
   {
     this.setCursor(Cursor.getPredefinedCursor(cursor));
   }
-  public void showPanel()
-  {
-    JFrame frame = new JFrame("So Many Turtles");
-    frame.getContentPane().add(this);
-    ProgramWindow.createStandardFrame(frame);
-    this.repaint();
-  }
   public void ___()
   {
     // blank for the DeepDive

src/org/teachingextensions/logo/Turtle.java

@@ -20,7 +20,7 @@
 public class Turtle
 {
   /**
-   * Current types are: Turtle, Spider
+   * Current types are: ExplodedTurtle, Turtle, Spider
    */
   public enum Animals {
     ExplodedTurtle, Turtle, Spider

src/org/teachingextensions/logo/TurtlePanel.java

@@ -14,6 +14,7 @@
 import org.teachingextensions.logo.Turtle.Animals;
 import org.teachingextensions.windows.ProgramWindow;
 
+@SuppressWarnings("serial")
 public class TurtlePanel extends ProgramWindow
 {
   private Turtle  turtle;

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

@@ -5,13 +5,13 @@
 
 import javax.swing.JPanel;
 
-import org.teachingextensions.logo.Colors;
 import org.teachingextensions.logo.Paintable;
+import org.teachingextensions.logo.PenColors;
 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
+ * The Circle allows you to draw circles on the window
  */
 public class Circle implements Paintable
 {
@@ -62,7 +62,7 @@ public void addTo(ProgramWindow panel)
   @Override
   public void paint(Graphics2D g, JPanel caller)
   {
-    Color color2 = Colors.getTransparentVersion(mainColor, percentTransparent);
+    Color color2 = PenColors.getTransparentVersion(mainColor, percentTransparent);
     g.setColor(color2);
     g.fillOval(x - radius, y - radius, radius * 2, radius * 2);
   }

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

@@ -5,8 +5,8 @@
 
 import javax.swing.JPanel;
 
-import org.teachingextensions.logo.Colors;
 import org.teachingextensions.logo.Paintable;
+import org.teachingextensions.logo.PenColors;
 import org.teachingextensions.windows.ProgramWindow;
 
 public class Oval implements Paintable
@@ -33,7 +33,7 @@ public void addTo(ProgramWindow panel)
   @Override
   public void paint(Graphics2D g, JPanel caller)
   {
-    Color color2 = Colors.getTransparentVersion(mainColor, percentTransparent);
+    Color color2 = PenColors.getTransparentVersion(mainColor, percentTransparent);
     g.setColor(color2);
     //need to incorporate radius, x, y
     g.drawOval(x + 320, y - 20, radius + 250, radius + 140);

src/org/teachingextensions/utils/Viewer.java

@@ -9,6 +9,13 @@
 
 public class Viewer
 {
+  /**
+   * Uses a RTF Viewer to display the results of a model (or text)
+   * <div><b>Example:</b> {@code  viewer.displayRtfFile(text)} </div>
+   * 
+   * @param text
+   *            A model created from a String (text) 
+   */
   public static void displayRtfFile(String text)
   {
     try

src/org/teachingextensions/utils/VirtualProctor.java

@@ -45,6 +45,13 @@ public static void resetName()
         file.delete();
       }
     }
+    /**
+     * Allows you to set the displayed username in Virtual Proctor
+     * <div><b>Example:</b> {@code  virtualProctor.setName(name)} </div>
+     * 
+     * @param name
+     *            A name that is displayed for the user in the Virtual Proctor client 
+     */
     public static void setName(String name)
     {
       if (StringUtils.isEmpty(name)) { return; }

src/org/teachingextensions/windows/ProgramWindow.java

@@ -21,6 +21,7 @@
  * <img src="http://ftpmirror.your.org/pub/wikimedia/images/wikibooks/de/2/2c/JPanel_Add_JButton_PAGE_END.JPG" align="left" >
  * Program Window allows you to change the color of the background and more...
  */
+@SuppressWarnings({"serial", "deprecation"})
 public class ProgramWindow extends JPanel
 {
   private ArrayList<Paintable> additional = new ArrayList<Paintable>();