From dab209d74f1b77ac6a5931bd45fde01bbd0a2b88 Mon Sep 17 00:00:00 2001
From: fros4943 <fros4943>
Date: Tue, 18 Mar 2008 16:55:44 +0000
Subject: [PATCH] javadoc bugs

---
 .../interfaces/CC2420RadioPacketConverter.java    | 15 +++++++--------
 .../sics/cooja/mspmote/interfaces/CRCCoder.java   |  6 +++---
 .../interfaces/TR1001RadioPacketConverter.java    | 14 +++++---------
 3 files changed, 15 insertions(+), 20 deletions(-)

diff --git a/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/CC2420RadioPacketConverter.java b/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/CC2420RadioPacketConverter.java
index 7c737042b..716ffc7c7 100644
--- a/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/CC2420RadioPacketConverter.java
+++ b/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/CC2420RadioPacketConverter.java
@@ -26,7 +26,7 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $Id: CC2420RadioPacketConverter.java,v 1.1 2008/03/18 13:34:29 fros4943 Exp $
+ * $Id: CC2420RadioPacketConverter.java,v 1.2 2008/03/18 16:55:44 fros4943 Exp $
  */
 
 package se.sics.cooja.mspmote.interfaces;
@@ -48,21 +48,20 @@ public class CC2420RadioPacketConverter {
   /* CC2420/802.15.4 packet: PREAMBLE(4) _ SYNCH(2) _ LENGTH(1) _ PAYLOAD(<27) _ CRCFOOTER(2) */
 
   /**
-   * Converts radio packet data from COOJA to CC2420.
+   * Converts a COOJA radio packet to a CC2420 radio packet.
    *
-   * @param coojaPacket COOJA packet
-   * @return CC2420 packet
+   * @param coojaPacket COOJA radio packet
+   * @return CC2420 radio packet
    */
   public static CC2420RadioPacket fromCoojaToCC24240(RadioPacket coojaPacket) {
     return new CC2420RadioPacket(coojaPacket.getPacketData());
   }
 
   /**
-   * Converts radio packet data from CC24240 to COOJA.
+   * Converts a CC2420 radio packet to a COOJA radio packet.
    *
-   * @param cc24240Data CC24240 data
-   * @param cc24240DataLength CC24240 data length
-   * @return
+   * @param cc2420RadioPacket CC24240 radio packet
+   * @return COOJA radio packet
    */
   public static COOJARadioPacket fromCC2420ToCooja(CC2420RadioPacket cc2420RadioPacket) {
     return new COOJARadioPacket(cc2420RadioPacket.getPacketData());
diff --git a/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/CRCCoder.java b/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/CRCCoder.java
index ab1758da4..33b6f0ca0 100644
--- a/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/CRCCoder.java
+++ b/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/CRCCoder.java
@@ -26,7 +26,7 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $Id: CRCCoder.java,v 1.1 2008/02/07 14:54:16 fros4943 Exp $
+ * $Id: CRCCoder.java,v 1.2 2008/03/18 16:55:44 fros4943 Exp $
  */
 
 package se.sics.cooja.mspmote.interfaces;
@@ -46,8 +46,8 @@ public class CRCCoder {
    * Updates given accumulated CRC16 checksum with given byte.
    *
    * @param b Byte to be added to CRC
-   * @param crc Accumulated CRC that is to be updated
-   * @return
+   * @param acc Accumulated CRC that is to be updated
+   * @return New accumulated CRC
    */
   public static short crc16Add(byte b, short acc) {
     acc ^= 0xff & b;
diff --git a/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/TR1001RadioPacketConverter.java b/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/TR1001RadioPacketConverter.java
index 8b13bf732..99d03142a 100644
--- a/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/TR1001RadioPacketConverter.java
+++ b/tools/cooja/apps/mspsim/src/se/sics/cooja/mspmote/interfaces/TR1001RadioPacketConverter.java
@@ -26,7 +26,7 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $Id: TR1001RadioPacketConverter.java,v 1.2 2008/03/18 13:13:56 fros4943 Exp $
+ * $Id: TR1001RadioPacketConverter.java,v 1.3 2008/03/18 16:55:44 fros4943 Exp $
  */
 
 package se.sics.cooja.mspmote.interfaces;
@@ -156,10 +156,8 @@ public class TR1001RadioPacketConverter {
    * - Read length header
    * - Remove both length header and CRC footer
    *
-   * @param tr1001Data
-   *          TR1001 packet data
-   * @param tr1001DataLength
-   *          TR1001 packet data length
+   * @param tr1001Bytes TR1001 bytes
+   * @param tr1001DataLength TR1001 specified packet length
    * @return COOJA radio packet
    */
   public static RadioPacket fromTR1001ToCooja(TR1001RadioByte[] tr1001Bytes, int tr1001DataLength) {
@@ -238,10 +236,8 @@ public class TR1001RadioPacketConverter {
    * Adds another another byte to the accumulated conversion from TR1001
    * to Cooja.
    *
-   * @see #accumulatedConversionIsOk()
-   * @param b
-   *          Byte
-   * @return True if conversion finished (either successful of failed).
+   * @param tr1001Byte New TR1001 packet data byte
+   * @return True if conversion finished (either successful of failed)
    */
   public boolean fromTR1001ToCoojaAccumulated(TR1001RadioByte tr1001Byte) {
     byte b = tr1001Byte.getByte();