Skip to content

Commit 3cbe391

Browse files
committed
BLE: Update BLE.h comments.
* processEvents: Remove reference to mbed OS 3. * Clarify documentation of waitForEvent.
1 parent 25ad0f3 commit 3cbe391

File tree

1 file changed

+8
-8
lines changed
  • features/FEATURE_BLE/ble

1 file changed

+8
-8
lines changed

features/FEATURE_BLE/ble/BLE.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class BLEInstanceBase;
6868
* Next, the signal handling/process mechanism should be set up. By design,
6969
* Mbed BLE does not impose to the user an event handling/processing mechanism;
7070
* however, it exposes APIs, which allows an application to compose its own:
71-
* - onEventsToProcess(), whichs register a callback that
71+
* - onEventsToProcess(), whichs register a callback that
7272
* the BLE subsystem will call when there is an event ready to be processed.
7373
* - processEvents(), which processes all the events present in the BLE subsystem.
7474
*
@@ -215,9 +215,7 @@ class BLE
215215
* Process ALL pending events living in the BLE stack and return once all
216216
* events have been consumed.
217217
*
218-
* @note: this function is automatically called by the OS on mbed OS 3
219-
* however it shall be explicitly called by user code on mbed OS classic and
220-
* mbed OS 2.
218+
* @see onEventsToProcess()
221219
*/
222220
void processEvents();
223221

@@ -424,10 +422,12 @@ class BLE
424422
BLE(InstanceID_t instanceID = DEFAULT_INSTANCE);
425423

426424
/**
427-
* Yield control to the BLE stack or to other tasks waiting for events. This
428-
* is a sleep function that returns when there is an application-specific
429-
* interrupt, but the MCU might wake up several times before returning (to
430-
* service the stack). This is not always interchangeable with WFE().
425+
* Yield control to the BLE stack or to other tasks waiting for events.
426+
*
427+
* This is a sleep function that returns when there is an application-specific
428+
* interrupt. This is not interchangeable with WFE() considering that the
429+
* MCU might wake up several times to service the stack before returning
430+
* control to the caller.
431431
*
432432
* @deprecated This function block the CPU prefer to use the pair
433433
* onEventsToProcess() and processEvents().

0 commit comments

Comments
 (0)