X-Git-Url: https://oss.titaniummirror.com/gitweb/?a=blobdiff_plain;f=tos%2Flib%2Fmac%2Ftkn154%2Finterfaces%2Fpublic%2FIEEE154TxBeaconPayload.nc;h=bc42d77ca442c739af38b2431580b2ca064559e4;hb=82c215ff867ea7ef4fa748fb72b686c32ffb25e1;hp=4415ee60373e2955ca6f08468874d03ba8766738;hpb=afb6da3df34fdebb6843598761ef4de5eb0186f6;p=tinyos-2.x.git diff --git a/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc b/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc index 4415ee60..bc42d77c 100644 --- 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 - * setBeaconPayloadDone()<\code> event will be signalled when the - * beacon payload has been set -- until then beaconPayload<\code> must + * setBeaconPayloadDone()<\tt> event will be signalled when the + * beacon payload has been set -- until then 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 setBeaconPayloadDone<\code> event + * SUCCESS otherwise (and only then the setBeaconPayloadDone<\tt> event * will be signalled) */ command error_t setBeaconPayload(void *beaconPayload, uint8_t length); /** - * Signalled in response to a setBeaconPayload()<\code> request. + * Signalled in response to a 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 beaconPayload<\code> passed in the - * setBeaconPayload()<\code> command - * @param length the length<\code> passed in the - * setBeaconPayload()<\code> command + * @param beaconPayload the beaconPayload<\tt> passed in the + * setBeaconPayload()<\tt> command + * @param length the length<\tt> passed in the + * 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 setBeaconPayload()<\code> command. The - * modifyBeaconPayloadDone()<\code> event will be signalled when the - * beacon payload has been updated -- until then buffer<\code> must + * command over the setBeaconPayload()<\tt> command. The + * modifyBeaconPayloadDone()<\tt> event will be signalled when the + * beacon payload has been updated -- until then 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 modifyBeaconPayloadDone<\code> event + * SUCCESS otherwise (and only then the modifyBeaconPayloadDone<\tt> event * will be signalled) */ command error_t modifyBeaconPayload(uint8_t offset, void *buffer, uint8_t bufferLength); /** - * Signalled in response to a modifyBeaconPayload()<\code> request. + * Signalled in response to a modifyBeaconPayload()<\tt> request. * Indicates that the beacon payload has been updated. * - * @param offset the offset<\code> passed in the - * modifyBeaconPayload()<\code> command - * @param buffer the buffer<\code> passed in the - * modifyBeaconPayload()<\code> command - * @param bufferLength the bufferLength<\code> passed in the - * modifyBeaconPayload()<\code> command + * @param offset the offset<\tt> passed in the + * modifyBeaconPayload()<\tt> command + * @param buffer the buffer<\tt> passed in the + * modifyBeaconPayload()<\tt> command + * @param bufferLength the bufferLength<\tt> passed in the + * 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 setPayload<\code> + * transmission, and (2) that a subsequent call to 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 - * getBeaconPayload<\code> command can be used to inspect the + * getBeaconPayload<\tt> command can be used to inspect the * beacon payload). */ event void beaconTransmitted();