javadoc bugs

This commit is contained in:
fros4943 2008-03-18 16:55:44 +00:00
parent 0c0d313506
commit dab209d74f
3 changed files with 15 additions and 20 deletions

View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * 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; 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) */ /* 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 * @param coojaPacket COOJA radio packet
* @return CC2420 packet * @return CC2420 radio packet
*/ */
public static CC2420RadioPacket fromCoojaToCC24240(RadioPacket coojaPacket) { public static CC2420RadioPacket fromCoojaToCC24240(RadioPacket coojaPacket) {
return new CC2420RadioPacket(coojaPacket.getPacketData()); 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 cc2420RadioPacket CC24240 radio packet
* @param cc24240DataLength CC24240 data length * @return COOJA radio packet
* @return
*/ */
public static COOJARadioPacket fromCC2420ToCooja(CC2420RadioPacket cc2420RadioPacket) { public static COOJARadioPacket fromCC2420ToCooja(CC2420RadioPacket cc2420RadioPacket) {
return new COOJARadioPacket(cc2420RadioPacket.getPacketData()); return new COOJARadioPacket(cc2420RadioPacket.getPacketData());

View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * 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; package se.sics.cooja.mspmote.interfaces;
@ -46,8 +46,8 @@ public class CRCCoder {
* Updates given accumulated CRC16 checksum with given byte. * Updates given accumulated CRC16 checksum with given byte.
* *
* @param b Byte to be added to CRC * @param b Byte to be added to CRC
* @param crc Accumulated CRC that is to be updated * @param acc Accumulated CRC that is to be updated
* @return * @return New accumulated CRC
*/ */
public static short crc16Add(byte b, short acc) { public static short crc16Add(byte b, short acc) {
acc ^= 0xff & b; acc ^= 0xff & b;

View file

@ -26,7 +26,7 @@
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE. * 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; package se.sics.cooja.mspmote.interfaces;
@ -156,10 +156,8 @@ public class TR1001RadioPacketConverter {
* - Read length header * - Read length header
* - Remove both length header and CRC footer * - Remove both length header and CRC footer
* *
* @param tr1001Data * @param tr1001Bytes TR1001 bytes
* TR1001 packet data * @param tr1001DataLength TR1001 specified packet length
* @param tr1001DataLength
* TR1001 packet data length
* @return COOJA radio packet * @return COOJA radio packet
*/ */
public static RadioPacket fromTR1001ToCooja(TR1001RadioByte[] tr1001Bytes, int tr1001DataLength) { 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 * Adds another another byte to the accumulated conversion from TR1001
* to Cooja. * to Cooja.
* *
* @see #accumulatedConversionIsOk() * @param tr1001Byte New TR1001 packet data byte
* @param b * @return True if conversion finished (either successful of failed)
* Byte
* @return True if conversion finished (either successful of failed).
*/ */
public boolean fromTR1001ToCoojaAccumulated(TR1001RadioByte tr1001Byte) { public boolean fromTR1001ToCoojaAccumulated(TR1001RadioByte tr1001Byte) {
byte b = tr1001Byte.getByte(); byte b = tr1001Byte.getByte();