added documentation to new Sound class and cleaned

Author: lynnlangit

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

@@ -30,6 +30,11 @@ public enum TKPSound {
     LosingPower, Malfunction, Pizza, RunAway, SheerIgnorance, SoBeIt, StrangePerson, Stubborn, Yahoo, Yay
   }
   private String soundFilename = null;
+  /**
+   * Sets a sound that you can play through your speakers. 
+   * Use a TKPSound (there is a list)<br>
+   * <b>Example:</b> {@code  Sound.setSound(TKPSound.Ahem)}
+   */
   public synchronized void setSound(TKPSound mySound)
   {
     String sound = "soundFiles/" + mySound + ".wav";
@@ -43,8 +48,9 @@ public synchronized void setSound(TKPSound mySound)
     this.soundFilename = this.soundFilename.replace("file:", "");
   }
   /**
-   * Plays a sound through your speakers. Use a '.wav' file<br>
-   * <b>Example:</b> {@code  Sound.playSound("mySound.wav")}
+   * Plays a TKPSound through your speakers. 
+   * You must first set the TKPSound <br>
+   * <b>Example:</b> {@code  Sound.playSound()}
    */
   public synchronized void playSound()
   {

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

@@ -322,6 +322,10 @@ 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>
+   */
   public static void drawTortoise()
   {
     Tortoise.show();

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

@@ -245,6 +245,13 @@ public TurtlePanel getBackgroundWindow()
   {
     return (TurtlePanel) getPanel();
   }
+  /**
+   * Sets the animal
+   * <p><b>Example:</b> {@code myTurtle.setAnimal(Animals.spider)}</p>
+   *
+   * @param animal
+   *     The type of animal that appears on your window
+   */
   public void setAnimal(Animals animal)
   {
     refreshPanel();
@@ -326,7 +333,7 @@ public boolean isDead()
     return this.animal == Animals.ExplodedTurtle;
   }
   /**
-   * Current types are: ExplodedTurtle, Turtle, Spider
+   * Current types are: ExplodedTurtle, Turtle, Spider, Unicorn
    */
   public enum Animals {
     ExplodedTurtle, Turtle, Spider, Unicorn

src/main/java/org/teachingkidsprogramming/recipes/completed/section00demos/RecipeForTestingVirtualProctor.java

@@ -22,7 +22,7 @@ public static void main(String[] args) throws Exception
       Tortoise.move(75);
       Tortoise.turn(360 / sides);
       Sound s = new Sound();
-      s.setSound(Sound.TKPSound.SoBeIt);
+      s.setSound(Sound.TKPSound.BrainIsGone);
       s.playSound();
     }
     VirtualProctor.setClassName("TKPHouseAtHome");

src/main/java/org/teachingkidsprogramming/recipes/completed/section06modelviewcontroller/ExceptionalAdLibsVariation.java

@@ -2,12 +2,10 @@
 
 import org.teachingextensions.logo.utils.EventUtils.MessageBox;
 
-//***********this recipe is in development - watch for updates!**************
 public class ExceptionalAdLibsVariation
 {
   public static void main(String[] args)
   {
-    //  Ask the user to enter an adverb, save it as currentAdverb --#2
     String adverb = MessageBox.askForTextInput("What is the adverb?");
     if (adverb.isEmpty())
     {
@@ -20,7 +18,6 @@ else if (adverb.matches("[\\d]*"))
       return;
     }
     String currentAdverb = adverb;
-    //  Ask the user to enter a verb ending in '-ed', save it as currentEdVerb --#4
     String edverb = MessageBox.askForTextInput("What is the -ed verb?");
     if (edverb.isEmpty())
     {
@@ -33,7 +30,6 @@ else if (edverb.matches("[\\d]*"))
       return;
     }
     String currentEdVerb = edverb;
-    //  Ask the user to enter a body part, save it as currentBodyPart --#6
     String bodyPart = MessageBox.askForTextInput("What is the body part?");
     if (bodyPart.isEmpty())
     {
@@ -46,15 +42,10 @@ else if (bodyPart.matches("[\\d]*"))
       return;
     }
     String currentBodyPart = bodyPart;
-    //  Set the value of the currentStory to the word "Today " --#1.2
     String currentStory = "Today ";
-    //  Add the words "I woke " + currentAdverb + ". " to the currentStory --#3
     currentStory = currentStory + "I woke " + currentAdverb + ". ";
-    //  Add the words '"Then I " + currentEdVerb + " " to the currentStory --#5
     currentStory = currentStory + "Then I " + currentEdVerb + " ";
-    //  Add the words "my " + currentBodyPart + ". " to the current story --#7
     currentStory = currentStory + "my " + currentBodyPart + ". ";
-    //  Show the currentStory in a message box as a message --#1.1
     MessageBox.showMessage(currentStory);
   }
 }

src/main/java/org/teachingkidsprogramming/recipes/completed/section06modelviewcontroller/OneFishTwoFish.java

@@ -3,7 +3,7 @@
 import java.util.Iterator;
 import java.util.Scanner;
 
-//**In Development**//
+//*************This Lesson is In Development*****************************//
 public class OneFishTwoFish
 {
   private static Scanner scanner;
@@ -13,7 +13,6 @@ public static void main(String[] args)
     int fish = -10;
     howManyFish(fish);
   }
-  //
   public static void makeAString()
   {
     final String input = "1 fish 2 fish red fish blue fish,black fish,blue fish,old fish,new fish ";