Bluetooth Low Energy / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more

Diff: public/BLEDevice.h

Revision:
335:dea9e14b7ddc
Parent:
334:6bc1223306b9
Child:
336:896e159d3af6
diff -r 6bc1223306b9 -r dea9e14b7ddc public/BLEDevice.h
--- a/public/BLEDevice.h	Wed Apr 15 09:05:10 2015 +0100
+++ b/public/BLEDevice.h	Wed Apr 15 09:05:10 2015 +0100
@@ -219,6 +219,14 @@
      */
     ble_error_t stopAdvertising(void);
 
+    /**
+     * This call initiates the disconnection procedure, and its completion will
+     * be communicated to the application with an invocation of the
+     * onDisconnection callback.
+     *
+     * @param  reason
+     *           The reason for disconnection to be sent back to the peer.
+     */
     ble_error_t disconnect(Gap::DisconnectionReason_t reason);
 
     /* APIs to set GAP callbacks. */