From 639e3c681d0730950b0f1ad7dbf00f14fb58ab6e Mon Sep 17 00:00:00 2001 From: Rohit Grover Date: Thu, 21 May 2015 11:01:59 +0100 Subject: [PATCH] add a comment header for BLEDevice::connect() --- public/BLEDevice.h | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/public/BLEDevice.h b/public/BLEDevice.h index 14e7633..a87f8ea 100644 --- a/public/BLEDevice.h +++ b/public/BLEDevice.h @@ -320,10 +320,18 @@ public: ble_error_t stopScan(void); /** - * [connect description] - * @param peerAddr [description] - * @param peerAddrType [description] - * @return [description] + * Create a connection (GAP Link Establishment). + * @param peerAddr + * 48-bit address, LSB format. + * @param peerAddrType + * Address type of the peer. + * @param connectionParams + * Connection parameters. + * @param scanParams + * Paramters to be used while scanning for the peer. + * @return BLE_ERROR_NONE if connection establishment procedure is started + * successfully. The onConnection callback (if set) will be invoked upon + * a connection event. */ ble_error_t connect(const Gap::Address_t peerAddr, Gap::AddressType_t peerAddrType = Gap::ADDR_TYPE_RANDOM_STATIC,