From d42ed7d5da04bb6e0a62d4008f0b232ac6240435 Mon Sep 17 00:00:00 2001
From: fros4943 <fros4943>
Date: Tue, 12 Feb 2008 15:31:22 +0000
Subject: [PATCH] fixed some javadoc warnings

---
 tools/cooja/java/se/sics/cooja/GUI.java         | 17 +++++++----------
 tools/cooja/java/se/sics/cooja/Simulation.java  |  4 ++--
 .../se/sics/cooja/plugins/Visualizer2D.java     |  6 +++---
 .../java/se/sics/cooja/radiomediums/UDGM.java   |  5 +++--
 4 files changed, 15 insertions(+), 17 deletions(-)

diff --git a/tools/cooja/java/se/sics/cooja/GUI.java b/tools/cooja/java/se/sics/cooja/GUI.java
index a06bbfc99..cdcb2f378 100644
--- a/tools/cooja/java/se/sics/cooja/GUI.java
+++ b/tools/cooja/java/se/sics/cooja/GUI.java
@@ -24,7 +24,7 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
- * $Id: GUI.java,v 1.69 2008/02/12 15:20:56 fros4943 Exp $
+ * $Id: GUI.java,v 1.70 2008/02/12 15:31:22 fros4943 Exp $
  */
 
 package se.sics.cooja;
@@ -295,22 +295,22 @@ public class GUI {
   /**
    * Add mote highlight observer.
    *
-   * @see #deleteTickObserver(Observer)
+   * @see #deleteMoteHighlightObserver(Observer)
    * @param newObserver
    *          New observer
    */
-  public void addMoteHighligtObserver(Observer newObserver) {
+  public void addMoteHighlightObserver(Observer newObserver) {
     moteHighlightObservable.addObserver(newObserver);
   }
 
   /**
    * Delete an mote highlight observer.
    *
-   * @see #addTickObserver(Observer)
+   * @see #addMoteHighlightObserver(Observer)
    * @param observer
    *          Observer to delete
    */
-  public void deleteMoteHighligtObserver(Observer observer) {
+  public void deleteMoteHighlightObserver(Observer observer) {
     moteHighlightObservable.deleteObserver(observer);
   }
 
@@ -1382,11 +1382,8 @@ public class GUI {
    * files were not parsed correctly.
    *
    * Any registered temporary plugins will be saved and reregistered.
-   *
-   * @return True if external configuration files were found and parsed OK
    */
-  public void reparseProjectConfig()
-  throws ParseProjectsException {
+  public void reparseProjectConfig() throws ParseProjectsException {
     // Backup temporary plugins
     Vector<Class<? extends Plugin>> oldTempPlugins = (Vector<Class<? extends Plugin>>) pluginClassesTemporary
         .clone();
@@ -3571,7 +3568,7 @@ public class GUI {
    * listeners will be notified. An example application of mote highlightinh is
    * a simulator visualizer that highlights the mote.
    *
-   * @see #addMoteHighligtObserver(Observer)
+   * @see #addMoteHighlightObserver(Observer)
    * @param m
    *          Mote to highlight
    */
diff --git a/tools/cooja/java/se/sics/cooja/Simulation.java b/tools/cooja/java/se/sics/cooja/Simulation.java
index aff6f3c04..5dd709e59 100644
--- a/tools/cooja/java/se/sics/cooja/Simulation.java
+++ b/tools/cooja/java/se/sics/cooja/Simulation.java
@@ -24,7 +24,7 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
- * $Id: Simulation.java,v 1.19 2008/02/12 15:03:43 fros4943 Exp $
+ * $Id: Simulation.java,v 1.20 2008/02/12 15:31:22 fros4943 Exp $
  */
 
 package se.sics.cooja;
@@ -315,7 +315,7 @@ public class Simulation extends Observable implements Runnable {
   }
 
   /**
-   * @param nrTickLists Maximum mote startup delay
+   * @param maxMoteStartupDelay Maximum mote startup delay
    */
   public void setDelayedMoteStartupTime(int maxMoteStartupDelay) {
     this.maxMoteStartupDelay = Math.max(0, maxMoteStartupDelay);
diff --git a/tools/cooja/java/se/sics/cooja/plugins/Visualizer2D.java b/tools/cooja/java/se/sics/cooja/plugins/Visualizer2D.java
index 604155138..1350a6ca9 100644
--- a/tools/cooja/java/se/sics/cooja/plugins/Visualizer2D.java
+++ b/tools/cooja/java/se/sics/cooja/plugins/Visualizer2D.java
@@ -26,7 +26,7 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $Id: Visualizer2D.java,v 1.12 2008/02/12 15:11:40 fros4943 Exp $
+ * $Id: Visualizer2D.java,v 1.13 2008/02/12 15:31:22 fros4943 Exp $
  */
 
 package se.sics.cooja.plugins;
@@ -186,7 +186,7 @@ public abstract class Visualizer2D extends VisPlugin {
     simObserver.update(null, null);
 
     // Detect mote highligts
-    myGUI.addMoteHighligtObserver(moteHighligtObserver = new Observer() {
+    myGUI.addMoteHighlightObserver(moteHighligtObserver = new Observer() {
       public void update(Observable obs, Object obj) {
         if (!(obj instanceof Mote)) {
           return;
@@ -614,7 +614,7 @@ public abstract class Visualizer2D extends VisPlugin {
 
   public void closePlugin() {
     if (moteHighligtObserver != null) {
-      myGUI.deleteMoteHighligtObserver(moteHighligtObserver);
+      myGUI.deleteMoteHighlightObserver(moteHighligtObserver);
     }
 
     if (simObserver != null) {
diff --git a/tools/cooja/java/se/sics/cooja/radiomediums/UDGM.java b/tools/cooja/java/se/sics/cooja/radiomediums/UDGM.java
index 23847998c..3889b92fd 100644
--- a/tools/cooja/java/se/sics/cooja/radiomediums/UDGM.java
+++ b/tools/cooja/java/se/sics/cooja/radiomediums/UDGM.java
@@ -26,7 +26,7 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $Id: UDGM.java,v 1.12 2007/12/13 07:59:35 fros4943 Exp $
+ * $Id: UDGM.java,v 1.13 2008/02/12 15:31:22 fros4943 Exp $
  */
 
 package se.sics.cooja.radiomediums;
@@ -59,7 +59,8 @@ import se.sics.cooja.plugins.Visualizer2D;
  * The radio output power indicator (0-100) is used in a very simple way; the
  * total transmission (and interfering) range is multiplied with [power_ind]%.
  *
- * @see #SS_OK
+ * @see #SS_OK_BEST
+ * @see #SS_OK_WORST
  * @see #SS_NOISE
  * @see #SS_NOTHING
  *