X-Git-Url: https://oss.titaniummirror.com/gitweb/?a=blobdiff_plain;f=tos%2Flib%2Fmac%2Ftkn154%2Finterfaces%2Fprivate%2FRadioRx.nc;h=597ab758c8184c2b0f09a9efb9590b62b106915f;hb=82c215ff867ea7ef4fa748fb72b686c32ffb25e1;hp=e548e20f08e5f077028b0583f0b472f3228b720f;hpb=afb6da3df34fdebb6843598761ef4de5eb0186f6;p=tinyos-2.x.git
diff --git a/tos/lib/mac/tkn154/interfaces/private/RadioRx.nc b/tos/lib/mac/tkn154/interfaces/private/RadioRx.nc
index e548e20f..597ab758 100644
--- a/tos/lib/mac/tkn154/interfaces/private/RadioRx.nc
+++ b/tos/lib/mac/tkn154/interfaces/private/RadioRx.nc
@@ -35,7 +35,6 @@
#include "TKN154_platform.h"
interface RadioRx
{
-
/**
* Prepares the radio for receive mode. This command will fail, if the radio
* is not in the state RADIO_OFF. The actual receive operation will be
@@ -55,13 +54,15 @@ interface RadioRx
**/
async event void prepareDone();
- /** @return TRUE if the radio is in the state RX_PREPARED, FALSE otherwise */
+ /**
+ * Tells whether the radio is in state RX_PREPARED.
+ * @return TRUE if the radio is in the state RX_PREPARED, FALSE otherwise
+ */
async command bool isPrepared();
/**
* Switches the radio to receive mode at time t0 + dt. If
- * t0 is NULL, then the callee interprets t0 as the current
- * time.
+ * t0 is NULL, then the callee interprets t0 as now.
*
* @param t0 Reference time for receive operation (NULL means now)
*
@@ -73,7 +74,10 @@ interface RadioRx
*/
async command error_t receive(ieee154_reftime_t *t0, uint32_t dt);
- /** @return TRUE if the radio is in the state RECEIVING, FALSE otherwise */
+ /**
+ * Tells whether the radio is in state RECEIVING.
+ * @return TRUE if the radio is in the state RECEIVING, FALSE otherwise
+ */
async command bool isReceiving();
/**