Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / tos / lib / mac / tkn154 / interfaces / public / IEEE154Frame.nc

diff --git a/tos/lib/mac/tkn154/interfaces/public/IEEE154Frame.nc b/tos/lib/mac/tkn154/interfaces/public/IEEE154Frame.nc
index 01d59541c4e7858bce2a6fc89ca5f8898369aa25..1f3184c56285b3c586fa43798dbc420d3e6cb7ee 100644 (file)
--- 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 <TKN154.h>
 #include <message.h>
@@ -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 <code>SrcAddrMode</code> parameter: if 
-   * <code>SrcAddrMode</code> is a short or extended address, then
-   * the current PIB attributes <code>macShortAddress</code> or 
-   * <code>aExtendedAddress</code> and <code>macPANId</code> are used.
+   * values depend on the <tt>SrcAddrMode</tt> parameter: if 
+   * <tt>SrcAddrMode</tt> is a short or extended address, then
+   * the current PIB attributes <tt>macShortAddress</tt> or 
+   * <tt>aExtendedAddress</tt> and <tt>macPANId</tt> 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 
-   * <code>isTimestampValid()<\code> returns FALSE then the 
+   * <tt>isTimestampValid()</tt> 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 <code>IEEE154BeaconFrame<\code>
+    * Note: For beacon frames one can use the <tt>IEEE154BeaconFrame</tt>
     * 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
-    * <code>wasPromiscuousModeEnabled()</code>) and the 
-    * <code>IEEE154BeaconFrame</code> interface return undefined values!
+    * <tt>wasPromiscuousModeEnabled()</tt>) and the 
+    * <tt>IEEE154BeaconFrame</tt> interface return undefined values!
     *
     * @param  frame   the frame
     * @return         TRUE if frame has a standard compliant header,