added documentation to ProgramWindow

Author: lynnlangit

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

@@ -38,6 +38,13 @@ public ProgramWindow(String title)
     getFrame().getContentPane().add(this);
     ProgramWindow.createStandardFrame(getFrame());
   }
+  /**
+   * Adds a button instance to a window 
+   * <p><b>Example:</b> {@code programWindow.addButton(myButton)}</p>
+   *
+   * @param button
+   *     A button instance
+   */
   public void addButton(JButton button)
   {
     this.add(button);
@@ -76,14 +83,35 @@ public void removePaintable()
     additional.clear();
     repaint();
   }
+  /**
+   * Adds a right mouse click listener instance to a window 
+   * <p><b>Example:</b> {@code programWindow.addMouseRightClickListener(myRightClickListener)}</p>
+   *
+   * @param listener
+   *     A listener instance
+   */
   public void addMouseRightClickListener(MouseRightClickListener listener)
   {
     addMouseListener(new RightClickMouseAdapter(listener));
   }
+  /**
+   * Adds a left mouse click listener instance to a window 
+   * <p><b>Example:</b> {@code programWindow.addMouseLeftClickListener(myLeftClickListener)}</p>
+   *
+   * @param listener
+   *     A listener instance
+   */
   public void addMouseLeftClickListener(MouseLeftClickListener listener)
   {
     addMouseListener(new LeftClickMouseAdapter(listener));
   }
+  /**
+   * Adds a background image to a window 
+   * <p><b>Example:</b> {@code programWindow.setBackgroundImage("http://www.coolpicture.com/sunshine.jpg")}</p>
+   *
+   * @param URL
+   *     A URL path to an image
+   */
   public void setBackgroundImage(String url)
   {
     addPaintable(new ImageBackground(url));

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

@@ -97,7 +97,7 @@ public static void setPenWidth(Number width)
    * Gives you access to the window the
    * Tortoise is moving on so you can do things like change it's color. <br>
    * <b>Example:</b> {@code  TurtlePanel panel = Tortoise.getBackgroundWindow()}
-   * @return the window that the Tortoise is moving on
+   * @return the (program) window that the Tortoise is moving on
    */
   public static TurtlePanel getBackgroundWindow()
   {