X-Git-Url: https://oss.titaniummirror.com/gitweb/?a=blobdiff_plain;f=tos%2Flib%2Fmac%2Ftkn154%2Finterfaces%2Fprivate%2FRadioOff.nc;h=3405932cf50b0b308e7a5b21a0bfd478c37e3369;hb=82c215ff867ea7ef4fa748fb72b686c32ffb25e1;hp=24317842876f3fac0055f126c285827b5df3dfdf;hpb=afb6da3df34fdebb6843598761ef4de5eb0186f6;p=tinyos-2.x.git
diff --git a/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc b/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc
index 24317842..3405932c 100644
--- a/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc
+++ b/tos/lib/mac/tkn154/interfaces/private/RadioOff.nc
@@ -37,14 +37,14 @@ interface RadioOff
{
/**
- * Switches the radio off and changes the radio state to RADIO_OFF. This
+ * Disables the transceiver 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.
*
- * @return EALREADY if radio is already switched off
FAIL if radio the
- * current radio state is neither TX_LOADED, RX_PREPARED nor RECEIVING
- * SUCCESS if the command was accepted and the offDone() event will
- * be signalled.
+ * @return SUCCESS if the command was accepted and the offDone()
+ * event will be signalled; EALREADY if radio is already switched off; FAIL
+ * if the current radio state is neither TX_LOADED, RX_PREPARED nor
+ * RECEIVING.
*/
async command error_t off();
@@ -54,6 +54,9 @@ 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();
}