Modify the comments and delete the unused API

Author: sgbihu

libraries/CurieBLE/src/BLEAttribute.h

@@ -42,6 +42,16 @@ class BLEAttribute {
      * @return const char* string representation of the Attribute
      */
     const char* uuid(void) const;
+    
+    /**
+     * @brief   Get the UUID raw data
+     *
+     * @param   none
+     *
+     * @return  struct bt_uuid*     The pointer of UUID
+     *
+     * @note  none
+     */
     struct bt_uuid *uuid(void);
 
 protected:
@@ -60,15 +70,15 @@ class BLEAttribute {
     BLEAttribute(const char* uuid, enum BLEAttributeType type);
 
     BLEAttributeType type(void) const;
-    bt_uuid btUuid(void) const;
     uint16_t handle(void);
     void setHandle(uint16_t handle);
 
     static unsigned char numAttributes(void);
     // The below APIs are for central device to discover the
     virtual void discover(struct bt_gatt_discover_params *params) = 0;
     virtual void discover(const struct bt_gatt_attr *attr,
-			              struct bt_gatt_discover_params *params) = 0;
+                          struct bt_gatt_discover_params *params) = 0;
+    
     /**
      * @brief   Get attribute's discover state
      *

libraries/CurieBLE/src/BLECentralRole.cpp

@@ -245,8 +245,8 @@ void BLECentralRole::handleParamUpdated(struct bt_conn *conn,
 {
     if (_event_handlers[BLEUpdateParam])
     {
-        // Fix me Add parameter proc
         BLEPeripheralHelper *temp = peripheral(conn);
+        temp->setConnParames(interval, interval, latency, timeout);
         _event_handlers[BLEUpdateParam](*temp);
     }
 }

libraries/CurieBLE/src/BLEHelper.cpp

@@ -16,29 +16,7 @@ BLEHelper::BLEHelper()
 
 BLEHelper::~BLEHelper()
 {
-    #if 0
-    if (NULL != _conn)
-    {
-        bt_conn_unref(_conn);
-    }
-    #endif
-}
-
-#if 0
-void BLEHelper::setConn(struct bt_conn *conn)
-{
-    if (conn == _conn)
-    {
-        return;
-    }
-    
-    if (NULL != _conn)
-    {
-        bt_conn_unref(_conn);
-    }
-    _conn = conn;
 }
-#endif
 
 BLEHelper::operator bool() const 
 {

libraries/CurieBLE/src/BLEHelper.h

@@ -31,12 +31,21 @@ class BLEHelper {
         virtual bool connected(void) = 0;
 
         /**
-         * Get the address of the Central in string form
+         * Get the address of the BLE in string format
          *
-         * @return const char* address of the Central in string form
+         * @return const char* address of the BLE in string format
          */
         const char* address(void) const;
 
+        /**
+         * @brief   Get the address of the BLE in raw format
+         *
+         * @param   none
+         *
+         * @return  const bt_addr_le_t *    address of the BLE in raw format
+         *
+         * @note  none
+         */
         const bt_addr_le_t *bt_le_address(void) const;
         /**
          * Disconnect the central if it is connected
@@ -69,9 +78,8 @@ class BLEHelper {
         virtual ~BLEHelper();
 
     private:
-        bt_addr_le_t   _address;
-        //struct bt_conn *_conn;
-        struct bt_le_conn_param _conn_params;
+        bt_addr_le_t   _address; /// BT low energy address
+        struct bt_le_conn_param _conn_params; /// Connection parameter
 };
 
 #endif

libraries/CurieBLE/src/BLEPeripheralHelper.h

@@ -55,11 +55,41 @@ class BLEPeripheralHelper : public BLEHelper {
          */
         BleStatus addAttribute(BLEAttribute& attribute);
 
+        /**
+         * @brief   Get BLEAttribute by subscribe parameter
+         *
+         * @param   params              Subscribe parameter
+         *
+         * @return  BLEAttribute *      NULL - Not found
+         *                              Not NULL - The BLEAttribute object
+         *
+         * @note  none
+         */
         BLEAttribute *attribute(struct bt_gatt_subscribe_params *params);
+        
+        /**
+         * @brief   Get BLEAttribute by characteristic handle
+         *
+         * @param   handle              The characteristic handle
+         *
+         * @return  BLEAttribute *      NULL - Not found
+         *                              Not NULL - The BLEAttribute object
+         *
+         * @note  none
+         */
         BLEAttribute *attribute(uint16_t handle);
 
         /**
-         * For central to discover the profile
+         * @brief   Discover the BLE peripheral profile for central
+         *
+         * @param   none
+         *
+         * @return  none
+         *
+         * @note  This function only for the central device.
+         *
+         * @note  The central deivce didn't know the connected BLE's profile.
+         *         Need send discover request to search the attribute in the BLE peripheral
          */
         void discover();
 
@@ -76,13 +106,51 @@ class BLEPeripheralHelper : public BLEHelper {
          */
         uint8_t discover(const struct bt_gatt_attr *attr);
 
-        // For peripheral to register the tree
+        /**
+         * @brief   For peripheral to register the profile tree
+         *
+         * @param   none
+         *
+         * @return  int         0 - success
+         *                      other - error code
+         *
+         * @note  none
+         */
         int registerProfile();
+        
+        /**
+         * @brief   Process the link lost event
+         *
+         * @param   none
+         *
+         * @return  none
+         *
+         * @note  none
+         */
         void linkLost(void);
 
-        // Get value handle.
-        // 0 is invalid
+        /**
+         * @brief   Get the characteristic value handle
+         *
+         * @param   attr    Attribute object 
+         *
+         * @return  uint16_t    The value hander of attribute
+         *                       0 is invalid
+         *
+         * @note  Only for central mode
+         */
         uint16_t valueHandle(BLEAttribute *attr);
+        
+        /**
+         * @brief   Get characteristic configuration descriptor value handle
+         *
+         * @param   attr    Attribute object 
+         *
+         * @return  uint16_t    The value hander of attribute
+         *                       0 is invalid
+         *
+         * @note  Only for central mode
+         */
         uint16_t cccdHandle(BLEAttribute *attr);
 
     protected:

libraries/CurieBLE/src/BLEPeripheralRole.cpp

@@ -281,7 +281,10 @@ void BLEPeripheralRole::handleParamUpdated(struct bt_conn *conn,
     pr_info(LOG_MODULE_BLE, "Parameter updated\r\n\tConn: %p\r\n\tinterval: %d\r\n\tlatency: %d\r\n\ttimeout: %d", 
                         conn, interval, latency, timeout);
     if (_event_handlers[BLEUpdateParam])
+    {
+        _central.setConnParames(interval, interval, latency, timeout);
         _event_handlers[BLEUpdateParam](_central);
+    }
 }
 
 

libraries/CurieBLE/src/BLEProfile.h

@@ -56,7 +56,7 @@ class BLEProfile{
     /**
      * @brief   Get BLEAttribute by subscribe parameter
      *
-     * @param   struct bt_gatt_subscribe_params *       Subscribe parameter
+     * @param   params              Subscribe parameter
      *
      * @return  BLEAttribute *      NULL - Not found
      *                              Not NULL - The BLEAttribute object
@@ -68,7 +68,7 @@ class BLEProfile{
     /**
      * @brief   Get BLEAttribute by characteristic handle
      *
-     * @param   uint16_t       The characteristic handle
+     * @param   handle              The characteristic handle
      *
      * @return  BLEAttribute *      NULL - Not found
      *                              Not NULL - The BLEAttribute object
@@ -120,7 +120,7 @@ class BLEProfile{
     /**
      * @brief   Get the characteristic value handle
      *
-     * @param   none
+     * @param   attr            Attribute object 
      *
      * @return  uint16_t        The value handle
      *                           0 is invalid handle
@@ -132,7 +132,7 @@ class BLEProfile{
     /**
      * @brief   Get characteristic configuration descriptor value handle
      *
-     * @param   none
+     * @param   attr            Attribute object 
      *
      * @return  uint16_t        The value handle
      *                           0 is invalid handle