YUFEI JIANG / BLE_API_Tiny_BLE

BLE_API_Tiny_BLE

Dependents:   CSSE4011_BLE_IMU

Fork of BLE_API by Bluetooth Low Energy

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. */