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

[tinyos-2.x.git] / tos / lib / mac / tkn154 / interfaces / public / IEEE154TxBeaconPayload.nc

diff --git a/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc b/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc
index 4415ee60373e2955ca6f08468874d03ba8766738..bc42d77ca442c739af38b2431580b2ca064559e4 100644 (file)
--- a/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc
+++ b/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc
@@ -42,28 +42,28 @@ interface IEEE154TxBeaconPayload
    * Sets the beacon payload portion for all subsequently transmitted beacons.
    * This command replaces the MLME-SET command for the PIB attribute values
    * 0x45 (macBeaconPayload) and 0x46 (macBeaconPayloadLength). The
-   * <code>setBeaconPayloadDone()<\code> event will be signalled when the 
-   * beacon payload has been set -- until then <code>beaconPayload<\code> must 
+   * <tt>setBeaconPayloadDone()<\tt> event will be signalled when the 
+   * beacon payload has been set -- until then <tt>beaconPayload<\tt> must 
    * not be modified.
    *
    * @param beaconPayload   the new beacon payload
    * @param length          the length of the new beacon payload (in byte)
    *
    * @return EBUSY if another transaction is pending, ESIZE if length is too big, 
-   * SUCCESS otherwise (and only then the <code>setBeaconPayloadDone<\code> event 
+   * SUCCESS otherwise (and only then the <tt>setBeaconPayloadDone<\tt> event 
    * will be signalled)
    */
  command error_t setBeaconPayload(void *beaconPayload, uint8_t length);
 
   /**
-   * Signalled in response to a <code>setBeaconPayload()<\code> request.
+   * Signalled in response to a <tt>setBeaconPayload()<\tt> request.
    * Indicates that the beacon payload has been copied and returns the
    * ownership of the buffer to the next higher layer. 
    * 
-   * @param beaconPayload   the <code>beaconPayload<\code> passed in the 
-   *                        <code>setBeaconPayload()<\code> command
-   * @param length          the <code>length<\code> passed in the 
-   *                        <code>setBeaconPayload()<\code> command
+   * @param beaconPayload   the <tt>beaconPayload<\tt> passed in the 
+   *                        <tt>setBeaconPayload()<\tt> command
+   * @param length          the <tt>length<\tt> passed in the 
+   *                        <tt>setBeaconPayload()<\tt> command
    */
  event void setBeaconPayloadDone(void *beaconPayload, uint8_t length);
 
@@ -84,9 +84,9 @@ interface IEEE154TxBeaconPayload
   /**
    * Replaces (overwrites) a portion of the current beacon payload. Whenever
    * possible, to minimize overhead, the next higher layer should prefer this
-   * command over the <code>setBeaconPayload()<\code> command.  The
-   * <code>modifyBeaconPayloadDone()<\code> event will be signalled when the 
-   * beacon payload has been updated -- until then <code>buffer<\code> must 
+   * command over the <tt>setBeaconPayload()<\tt> command.  The
+   * <tt>modifyBeaconPayloadDone()<\tt> event will be signalled when the 
+   * beacon payload has been updated -- until then <tt>buffer<\tt> must 
    * not be modified.
    *
    * @param offset      offset into the current beacon payload
@@ -94,21 +94,21 @@ interface IEEE154TxBeaconPayload
    * @param length      the length of the buffer
    *
    * @return EBUSY if another transaction is pending, ESIZE if offset+length is too big, 
-   * SUCCESS otherwise (and only then the <code>modifyBeaconPayloadDone<\code> event 
+   * SUCCESS otherwise (and only then the <tt>modifyBeaconPayloadDone<\tt> event 
    * will be signalled)
    */
  command error_t modifyBeaconPayload(uint8_t offset, void *buffer, uint8_t bufferLength);
 
   /**
-   * Signalled in response to a <code>modifyBeaconPayload()<\code> request.
+   * Signalled in response to a <tt>modifyBeaconPayload()<\tt> request.
    * Indicates that the beacon payload has been updated. 
    * 
-   * @param offset        the <code>offset<\code> passed in the 
-   *                      <code>modifyBeaconPayload()<\code> command
-   * @param buffer        the <code>buffer<\code> passed in the 
-   *                      <code>modifyBeaconPayload()<\code> command
-   * @param bufferLength  the <code>bufferLength<\code> passed in the 
-   *                      <code>modifyBeaconPayload()<\code> command
+   * @param offset        the <tt>offset<\tt> passed in the 
+   *                      <tt>modifyBeaconPayload()<\tt> command
+   * @param buffer        the <tt>buffer<\tt> passed in the 
+   *                      <tt>modifyBeaconPayload()<\tt> command
+   * @param bufferLength  the <tt>bufferLength<\tt> passed in the 
+   *                      <tt>modifyBeaconPayload()<\tt> command
    */
  event void modifyBeaconPayloadDone(uint8_t offset, void *buffer, uint8_t bufferLength);
 
@@ -117,7 +117,7 @@ interface IEEE154TxBeaconPayload
    * time to update the beacon payload (if desired).
    *
    * The usual policy is that (1) this event is signalled before every beacon
-   * transmission, and (2) that a subsequent call to <code>setPayload<\code>
+   * transmission, and (2) that a subsequent call to <tt>setPayload<\tt>
    * will update the beacon payload portion of this beacon.  However, 
    * because of tight timing constraints in beacon-enabled mode neither can be
    * guaranteed!
@@ -126,7 +126,7 @@ interface IEEE154TxBeaconPayload
 
   /** 
    * Indicates that a beacon frame has been transmitted (the 
-   * <code>getBeaconPayload<\code> command can be used to inspect the
+   * <tt>getBeaconPayload<\tt> command can be used to inspect the
    * beacon payload).
    */
  event void beaconTransmitted();