+ modified radio driver (PHY) interfaces: CSMA-CA algorithm is now pushed to radio...

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

diff --git a/tos/lib/mac/tkn154/interfaces/private/RadioRx.nc b/tos/lib/mac/tkn154/interfaces/private/RadioRx.nc
index e548e20f08e5f077028b0583f0b472f3228b720f..597ab758c8184c2b0f09a9efb9590b62b106915f 100644 (file)
--- 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 <tt>t0 + dt</tt>.  If
-   * <tt>t0</tt> is NULL, then the callee interprets <tt>t0</tt> as the current
-   * time. 
+   * <tt>t0</tt> is NULL, then the callee interprets <tt>t0</tt> 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();
 
   /**