Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / tos / lib / mac / tkn154 / interfaces / private / RadioOff.nc

diff --git a/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc b/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc
index 24317842876f3fac0055f126c285827b5df3dfdf..1a110723172970dae0c4424213704bb8b6211afc 100644 (file)
--- a/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc
+++ b/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc
@@ -35,16 +35,14 @@
 
 interface RadioOff
 {
-
   /** 
-   * Switches the radio off and changes the radio state to RADIO_OFF. This
-   * command will succeed only if the current state of the radio is either
-   * TX_LOADED, RX_PREPARED or RECEIVING.
+   * Disables the transceiver and changes the radio state to RADIO_OFF. This
+   * command will succeed only if the current state of the radio is RECEIVING.
    *
-   * @return EALREADY if radio is already switched off <br> FAIL if radio the
-   * current radio state is neither TX_LOADED, RX_PREPARED nor RECEIVING <br>
-   * SUCCESS if the command was accepted and the <tt>offDone()</tt> event will
-   * be signalled.
+   * @return SUCCESS if the command was accepted and the <tt>offDone()</tt>
+   * event will be signalled; EALREADY if the radio is already switched off,
+   * i.e. in state RADIO_OFF; FAIL if the radio was not switched of because 
+   * the current state is not RECEIVING.
    */
   async command error_t off();
 
@@ -54,6 +52,10 @@ interface RadioOff
    **/  
   async event void offDone();
 
- /** @return TRUE if the radio is in the state RADIO_OFF, FALSE otherwise */
-  async command bool isOff();
+  /** 
+   * Tells whether the radio is in state RADIO_OFF.
+   *
+   * @return TRUE if the radio is in the state RADIO_OFF, FALSE otherwise 
+   */
+  async command bool isOff(); 
 }