Wang Xinglu / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependencies:   nRF51822

Dependents:   LinkNode_LIS3DH

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 335:dea9e14b7ddc, committed 2015-04-15

Comitter:
rgrover1
Date:
Wed Apr 15 09:05:10 2015 +0100
Parent:
334:6bc1223306b9
Child:
336:896e159d3af6
Commit message:
Synchronized with git rev 38a2037d
Author: Rohit Grover
add a comment block for disconnect()

Changed in this revision

public/BLEDevice.h Show annotated file Show diff for this revision Revisions of this file 
--- 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. */