Merge TinyOS 2.1.1 into master.

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

diff --git a/tos/lib/mac/tkn154/interfaces/MLME/MLME_DISASSOCIATE.nc b/tos/lib/mac/tkn154/interfaces/MLME/MLME_DISASSOCIATE.nc
index 9602ba3d9660393e01dbc8b596feb248244e69f2..902b0f4e400e3a2204275334cbf8feeff0ca0b79 100644 (file)
--- a/tos/lib/mac/tkn154/interfaces/MLME/MLME_DISASSOCIATE.nc
+++ b/tos/lib/mac/tkn154/interfaces/MLME/MLME_DISASSOCIATE.nc
@@ -33,11 +33,16 @@
  * ========================================================================
  */
 
+/** 
+ * The MLME-SAP disassociation primitives define how a device can
+ * disassociate from a PAN. (IEEE 802.15.4-2006, Sect. 7.1.4)
+ */
+
 #include "TKN154.h"
 interface MLME_DISASSOCIATE {
 
   /**
-   * Request disassociation from a PAN.
+   * Requests disassociation from a PAN.
    * 
    * @param DeviceAddrMode The addressing mode of the device to which to send 
    *                       the disassociation notification command.
@@ -50,6 +55,7 @@ interface MLME_DISASSOCIATE {
    *                   indirectly
    * @param security   The security options (NULL means security is 
    *                   disabled)
+   *
    * @return       IEEE154_SUCCESS if the request succeeded and a confirm event
    *               will be signalled, an appropriate error code otherwise 
    *               (no confirm event will be signalled in this case)
@@ -65,7 +71,7 @@ interface MLME_DISASSOCIATE {
                         );
 
   /**
-   * Signals that a device has requested disassociation.
+   * Signals that a device has requested disassociation from this PAN.
    *
    * @param DeviceAddress the 64-bit address of the requesting device
    * @param DisassociateReason Reason for the disassociation
@@ -79,7 +85,7 @@ interface MLME_DISASSOCIATE {
                         );
 
   /**
-   * Confirmation of the disassociation attempt.
+   * Confirmsn a disassociation attempt.
    *
    * @param status The status of the disassociation attempt
    * @param DeviceAddrMode The addressing mode of the device that has either