X-Git-Url: https://oss.titaniummirror.com/gitweb/?p=tinyos-2.x.git;a=blobdiff_plain;f=tos%2Flib%2Fmac%2Ftkn154%2Finterfaces%2Fpublic%2FIEEE154Frame.nc;h=1f3184c56285b3c586fa43798dbc420d3e6cb7ee;hp=01d59541c4e7858bce2a6fc89ca5f8898369aa25;hb=e9bfab607e051bae6afb47b44892ce37541d1b44;hpb=adf1de6c009d13b7b52e68535c63b28f59c97400 diff --git a/tos/lib/mac/tkn154/interfaces/public/IEEE154Frame.nc b/tos/lib/mac/tkn154/interfaces/public/IEEE154Frame.nc index 01d59541..1f3184c5 100644 --- a/tos/lib/mac/tkn154/interfaces/public/IEEE154Frame.nc +++ b/tos/lib/mac/tkn154/interfaces/public/IEEE154Frame.nc @@ -33,6 +33,10 @@ * ======================================================================== */ +/** + * The IEEE154Frame interface allows to access the content of a IEEE 802.15.4 + * frame. + */ #include #include @@ -115,10 +119,10 @@ interface IEEE154Frame /** * Sets the addressing fields in the MAC header of a frame. The source * PAN identifier and the source address will be set automatically, their - * values depend on the SrcAddrMode parameter: if - * SrcAddrMode is a short or extended address, then - * the current PIB attributes macShortAddress or - * aExtendedAddress and macPANId are used. + * values depend on the SrcAddrMode parameter: if + * SrcAddrMode is a short or extended address, then + * the current PIB attributes macShortAddress or + * aExtendedAddress and macPANId are used. * * @param frame the frame * @param srcAddrMode the source addressing mode @@ -157,7 +161,7 @@ interface IEEE154Frame /** * Returns the point in time when the frame was received. If - * isTimestampValid()<\code> returns FALSE then the + * isTimestampValid() returns FALSE then the * timestamp is not valid and must be ignored. * * @param frame the frame @@ -192,7 +196,7 @@ interface IEEE154Frame * Returns the type of the frame * BEACON=0, DATA=1, ACK=2, COMMAND=3. * - * Note: For beacon frames one can use the IEEE154BeaconFrame<\code> + * Note: For beacon frames one can use the IEEE154BeaconFrame * interface to inspect additional fields of the frame. * * @param frame the frame @@ -233,8 +237,8 @@ interface IEEE154Frame * received while in promiscuous mode, because then no filtering * (except CRC check) was applied. Note: if this command returns * FALSE, then all other commands in this interface (except - * wasPromiscuousModeEnabled()) and the - * IEEE154BeaconFrame interface return undefined values! + * wasPromiscuousModeEnabled()) and the + * IEEE154BeaconFrame interface return undefined values! * * @param frame the frame * @return TRUE if frame has a standard compliant header,