Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / tos / lib / mac / tkn154 / interfaces / MLME / MLME_BEACON_NOTIFY.nc

diff --git a/tos/lib/mac/tkn154/interfaces/MLME/MLME_BEACON_NOTIFY.nc b/tos/lib/mac/tkn154/interfaces/MLME/MLME_BEACON_NOTIFY.nc
index c7e81d940b0c1c6389c9e41ff734dc97f50a80e1..e014b56d19db650427ab5e6acabaf6b9ca86e487 100644 (file)
--- a/tos/lib/mac/tkn154/interfaces/MLME/MLME_BEACON_NOTIFY.nc
+++ b/tos/lib/mac/tkn154/interfaces/MLME/MLME_BEACON_NOTIFY.nc
@@ -33,21 +33,29 @@
  * ========================================================================
  */
 
+/** 
+ * The MLME-SAP beacon notification primitive defines how a device may be
+ * notified when a beacon is received during normal operating conditions. 
+ * (IEEE 802.15.4-2006, Sect. 7.1.5)
+ */
+
 #include "TKN154.h"
 #include <message.h>
+
 interface MLME_BEACON_NOTIFY {
 
   /**
-   * A beacon frame has been received. This event is signalled only if 
-   * either the PIB attribute macAutoRequest is set to FALSE or the 
-   * beacon payload is not empty.
+   * A beacon frame has been received. This event is signalled only if
+   * either the PIB attribute <tt>macAutoRequest</tt> is set to FALSE
+   * or the beacon payload is not empty.
    *
-   * The beacon parameters can be accessed through the 
-   * <code>IEEE154BeaconFrame<\code> interface. The 
-   * <code>IEEE154Frame<\code> interface can be used to
-   * inspect the addressing fields in the MAC header.
+   * The beacon parameters can be accessed through the
+   * <tt>IEEE154BeaconFrame</tt> interface. The <tt>IEEE154Frame</tt>
+   * interface can be used to inspect the addressing fields in the MAC
+   * header.
    *
    * @param beacon The beacon frame
+   *
    * @return A frame buffer for the stack to use for the next received frame
    */
   event message_t* indication ( message_t *beaconFrame );