updating comment header for waitForEvent()

master
Rohit Grover 2014-06-10 09:26:32 +01:00
parent efa48841c5
commit b9bb38f054
1 changed files with 5 additions and 1 deletions

View File

@ -145,7 +145,11 @@ public:
ble_error_t updateCharacteristicValue(uint16_t handle, const uint8_t* value, uint16_t size, bool localOnly = false);
/**
* Yield control to the BLE stack or to other tasks waiting for events.
* Yield control to the BLE stack or to other tasks waiting for events. This
* is a sleep function which will return when there is an application
* specific interrupt, but the MCU might wake up several times before
* returning (to service the stack). Note: The use of this API is not always
* interchangeable with the MCU's WFE() instruction.
*/
void waitForEvent(void);