From 778c14e9e361af62e7e11c1ca54491b1023eb2d0 Mon Sep 17 00:00:00 2001 From: fros4943 Date: Wed, 3 Feb 2010 15:49:24 +0000 Subject: [PATCH] javadoc update --- tools/cooja/java/se/sics/cooja/CoreComm.java | 12 +++++------- tools/cooja/java/se/sics/cooja/GUI.java | 6 +++--- tools/cooja/java/se/sics/cooja/RadioMedium.java | 7 +++---- tools/cooja/java/se/sics/cooja/Simulation.java | 4 ++-- .../cooja/contikimote/interfaces/ContikiRS232.java | 4 ++-- .../se/sics/cooja/dialogs/ConfigurationWizard.java | 4 ++-- .../cooja/java/se/sics/cooja/interfaces/Battery.java | 3 +-- .../cooja/java/se/sics/cooja/plugins/Visualizer.java | 6 +++--- .../java/se/sics/cooja/plugins/VisualizerSkin.java | 5 +++-- .../sics/cooja/plugins/skins/UDGMVisualizerSkin.java | 4 ++-- .../cooja/java/se/sics/cooja/radiomediums/UDGM.java | 6 +++--- 11 files changed, 29 insertions(+), 32 deletions(-) diff --git a/tools/cooja/java/se/sics/cooja/CoreComm.java b/tools/cooja/java/se/sics/cooja/CoreComm.java index 06fe29052..f1e987229 100644 --- a/tools/cooja/java/se/sics/cooja/CoreComm.java +++ b/tools/cooja/java/se/sics/cooja/CoreComm.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: CoreComm.java,v 1.14 2009/03/10 21:05:00 fros4943 Exp $ + * $Id: CoreComm.java,v 1.15 2010/02/03 15:49:25 fros4943 Exp $ */ package se.sics.cooja; @@ -279,15 +279,13 @@ public abstract class CoreComm { /** * Loads given Java class file from disk. * - * @param classFile - * Java class (without extension) + * @param className Java class name * @return Loaded class - * @throws MoteTypeCreationException - * If error occurs + * @throws MoteTypeCreationException If error occurs */ - public static Class loadClassFile(String className) + public static Class loadClassFile(String className) throws MoteTypeCreationException { - Class loadedClass = null; + Class loadedClass = null; try { ClassLoader urlClassLoader = new URLClassLoader( new URL[] { new File(".").toURI().toURL() }, diff --git a/tools/cooja/java/se/sics/cooja/GUI.java b/tools/cooja/java/se/sics/cooja/GUI.java index 171805881..abd706975 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.158 2010/01/20 13:27:02 fros4943 Exp $ + * $Id: GUI.java,v 1.159 2010/02/03 15:49:25 fros4943 Exp $ */ package se.sics.cooja; @@ -2334,7 +2334,7 @@ public class GUI extends Observable { * Reloading a simulation may include recompiling Contiki. * * @param autoStart Start executing simulation when loaded - * @param newSeed Change simulation seed + * @param randomSeed Simulation's next random seed */ public void reloadCurrentSimulation(final boolean autoStart, final long randomSeed) { if (getSimulation() == null) { @@ -2437,7 +2437,7 @@ public class GUI extends Observable { * Reloading a simulation may include recompiling Contiki. * The same random seed is used. * - * @see #reloadCurrentSimulation(boolean, boolean) + * @see #reloadCurrentSimulation(boolean, long) * @param autoStart Start executing simulation when loaded */ public void reloadCurrentSimulation(boolean autoStart) { diff --git a/tools/cooja/java/se/sics/cooja/RadioMedium.java b/tools/cooja/java/se/sics/cooja/RadioMedium.java index 311eabc8b..5a30ed2f9 100644 --- a/tools/cooja/java/se/sics/cooja/RadioMedium.java +++ b/tools/cooja/java/se/sics/cooja/RadioMedium.java @@ -26,7 +26,7 @@ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * - * $Id: RadioMedium.java,v 1.8 2009/11/25 15:26:35 fros4943 Exp $ + * $Id: RadioMedium.java,v 1.9 2010/02/03 15:49:25 fros4943 Exp $ */ package se.sics.cooja; @@ -100,10 +100,9 @@ public abstract class RadioMedium { /** * Adds an observer which is notified each time a radio connection has finished. * - * @see #getLastTickConnections() + * @see #getLastConnection() * @see #deleteRadioMediumObserver(Observer) - * @param observer - * New observer + * @param observer New observer */ public abstract void addRadioMediumObserver(Observer observer); diff --git a/tools/cooja/java/se/sics/cooja/Simulation.java b/tools/cooja/java/se/sics/cooja/Simulation.java index b9c7d8f3a..927749693 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.60 2010/02/03 15:33:36 fros4943 Exp $ + * $Id: Simulation.java,v 1.61 2010/02/03 15:49:25 fros4943 Exp $ */ package se.sics.cooja; @@ -948,7 +948,7 @@ public class Simulation extends Observable implements Runnable { * Returns current simulation time rounded to milliseconds. * * @see #getSimulationTime() - * @return + * @return Time rounded to milliseconds */ public long getSimulationTimeMillis() { return currentSimulationTime / MILLISECOND; diff --git a/tools/cooja/java/se/sics/cooja/contikimote/interfaces/ContikiRS232.java b/tools/cooja/java/se/sics/cooja/contikimote/interfaces/ContikiRS232.java index 268e6cf9a..3f5ef983a 100644 --- a/tools/cooja/java/se/sics/cooja/contikimote/interfaces/ContikiRS232.java +++ b/tools/cooja/java/se/sics/cooja/contikimote/interfaces/ContikiRS232.java @@ -26,7 +26,7 @@ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * - * $Id: ContikiRS232.java,v 1.12 2010/02/03 09:27:24 fros4943 Exp $ + * $Id: ContikiRS232.java,v 1.13 2010/02/03 15:49:25 fros4943 Exp $ */ package se.sics.cooja.contikimote.interfaces; @@ -60,7 +60,7 @@ import se.sics.cooja.interfaces.PolledAfterActiveTicks; * * This observable notifies observers when a serial message is sent from the mote. * - * @see #getSerialMessages() + * @see #getLastLogMessage() * * @author Fredrik Osterlind */ diff --git a/tools/cooja/java/se/sics/cooja/dialogs/ConfigurationWizard.java b/tools/cooja/java/se/sics/cooja/dialogs/ConfigurationWizard.java index 1c62b9a93..3ac493153 100644 --- a/tools/cooja/java/se/sics/cooja/dialogs/ConfigurationWizard.java +++ b/tools/cooja/java/se/sics/cooja/dialogs/ConfigurationWizard.java @@ -26,7 +26,7 @@ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * - * $Id: ConfigurationWizard.java,v 1.6 2010/02/03 09:58:07 fros4943 Exp $ + * $Id: ConfigurationWizard.java,v 1.7 2010/02/03 15:49:24 fros4943 Exp $ */ package se.sics.cooja.dialogs; @@ -668,7 +668,7 @@ public class ConfigurationWizard extends JDialog { testOutput.addMessage("### Loading Java library class: se/sics/cooja/corecomm/" + javaLibraryName); Class javaLibraryClass = null; try { - javaLibraryClass = CoreComm.loadClassFile(javaLibraryName); + javaLibraryClass = (Class) CoreComm.loadClassFile(javaLibraryName); } catch (MoteTypeCreationException e) { e.printStackTrace(errorStream); testOutput.addMessage("### Error: " + e.getMessage(), MessageList.ERROR); diff --git a/tools/cooja/java/se/sics/cooja/interfaces/Battery.java b/tools/cooja/java/se/sics/cooja/interfaces/Battery.java index e24ad4224..4b5961802 100644 --- a/tools/cooja/java/se/sics/cooja/interfaces/Battery.java +++ b/tools/cooja/java/se/sics/cooja/interfaces/Battery.java @@ -26,7 +26,7 @@ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * - * $Id: Battery.java,v 1.11 2009/11/13 08:52:26 fros4943 Exp $ + * $Id: Battery.java,v 1.12 2010/02/03 15:49:24 fros4943 Exp $ */ package se.sics.cooja.interfaces; @@ -49,7 +49,6 @@ import se.sics.cooja.MoteInterface; * The current code does not monitor the energy consumption of simulated motes. * * @see MoteInterface - * @see MoteInterface#energyConsumption() * * @author Fredrik Osterlind */ diff --git a/tools/cooja/java/se/sics/cooja/plugins/Visualizer.java b/tools/cooja/java/se/sics/cooja/plugins/Visualizer.java index d9fd5393d..0bfe3ae56 100644 --- a/tools/cooja/java/se/sics/cooja/plugins/Visualizer.java +++ b/tools/cooja/java/se/sics/cooja/plugins/Visualizer.java @@ -26,7 +26,7 @@ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * - * $Id: Visualizer.java,v 1.12 2010/01/13 12:29:10 nifi Exp $ + * $Id: Visualizer.java,v 1.13 2010/02/03 15:49:24 fros4943 Exp $ */ package se.sics.cooja.plugins; @@ -112,8 +112,8 @@ import se.sics.cooja.plugins.skins.UDGMVisualizerSkin; * * Observes the simulation and all mote positions. * - * @see #registerMoteMenuAction(MoteMenuAction) - * @see #registerSimulationMenuAction(SimulationMenuAction) + * @see #registerMoteMenuAction(Class) + * @see #registerSimulationMenuAction(Class) * @see #registerVisualizerSkin(Class) * @see UDGMVisualizerSkin * @author Fredrik Osterlind diff --git a/tools/cooja/java/se/sics/cooja/plugins/VisualizerSkin.java b/tools/cooja/java/se/sics/cooja/plugins/VisualizerSkin.java index ca23243e9..3515a99c5 100644 --- a/tools/cooja/java/se/sics/cooja/plugins/VisualizerSkin.java +++ b/tools/cooja/java/se/sics/cooja/plugins/VisualizerSkin.java @@ -26,7 +26,7 @@ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * - * $Id: VisualizerSkin.java,v 1.3 2009/08/27 13:57:42 fros4943 Exp $ + * $Id: VisualizerSkin.java,v 1.4 2010/02/03 15:49:24 fros4943 Exp $ */ package se.sics.cooja.plugins; @@ -52,7 +52,8 @@ public interface VisualizerSkin { * @param sim Simulation * @param visualizer Visualizer plugin * - * @see #paintSkin(Graphics) + * @see #paintBeforeMotes(Graphics) + * @see #paintAfterMotes(Graphics) * @see #setInactive() */ public void setActive(Simulation sim, Visualizer visualizer); diff --git a/tools/cooja/java/se/sics/cooja/plugins/skins/UDGMVisualizerSkin.java b/tools/cooja/java/se/sics/cooja/plugins/skins/UDGMVisualizerSkin.java index 948740075..1d4744888 100644 --- a/tools/cooja/java/se/sics/cooja/plugins/skins/UDGMVisualizerSkin.java +++ b/tools/cooja/java/se/sics/cooja/plugins/skins/UDGMVisualizerSkin.java @@ -26,7 +26,7 @@ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * - * $Id: UDGMVisualizerSkin.java,v 1.9 2009/10/27 10:14:58 fros4943 Exp $ + * $Id: UDGMVisualizerSkin.java,v 1.10 2010/02/03 15:49:25 fros4943 Exp $ */ package se.sics.cooja.plugins.skins; @@ -65,7 +65,7 @@ import se.sics.cooja.radiomediums.UDGM; * success ratio. * * To also see radio traffic, this skin can be combined with {@link - * TrafficVisualizerSkin()}. + * TrafficVisualizerSkin}. * * @see TrafficVisualizerSkin * @see UDGM diff --git a/tools/cooja/java/se/sics/cooja/radiomediums/UDGM.java b/tools/cooja/java/se/sics/cooja/radiomediums/UDGM.java index 53fa3ff56..b77720ca8 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.29 2009/12/07 11:03:19 fros4943 Exp $ + * $Id: UDGM.java,v 1.30 2010/02/03 15:49:25 fros4943 Exp $ */ package se.sics.cooja.radiomediums; @@ -45,7 +45,6 @@ import se.sics.cooja.Mote; import se.sics.cooja.RadioConnection; import se.sics.cooja.Simulation; import se.sics.cooja.SimEventCentral.MoteCountListener; -import se.sics.cooja.contikimote.interfaces.ContikiRadio; import se.sics.cooja.interfaces.Position; import se.sics.cooja.interfaces.Radio; import se.sics.cooja.plugins.Visualizer; @@ -77,7 +76,8 @@ import se.sics.cooja.radiomediums.DirectedGraphMedium.DestinationRadio; * @see #SS_WEAK * @see #SS_NOTHING * - * @see DirectedGraphMedium, UDGMVisualizerSkin + * @see DirectedGraphMedium + * @see UDGMVisualizerSkin * @author Fredrik Osterlind */ @ClassDescription("Unit Disk Graph Medium (UDGM)")