component/bt : cleanup the function warning in doxygen

This commit is contained in:
Tian Hao
2016-12-01 20:55:08 +08:00
parent df419fd862
commit d925b96daf
5 changed files with 15 additions and 161 deletions

View File

@@ -254,8 +254,6 @@ typedef union {
} esp_ble_gap_cb_param_t;
/**
* @function esp_ble_gap_register_callback
*
* @brief This function is called to occur gap event, such as scan result
*
* @param[in] callback: callback function
@@ -269,8 +267,6 @@ esp_err_t esp_ble_gap_register_callback(esp_profile_cb_t callback);
/**
* @function esp_ble_gap_config_adv_data
*
* @brief This function is called to override the BTA default ADV parameters.
*
* @param[in] adv_data: Pointer to User defined ADV data structure. This
@@ -287,11 +283,9 @@ esp_err_t esp_ble_gap_config_adv_data (esp_ble_adv_data_t *adv_data);
/**
* @function esp_ble_gap_set_scan_params
*
* @brief This function is called to set scan parameters
*
* @param[in] esp_ble_scan_params: Pointer to User defined scan_params data structure. This
* @param[in] scan_params: Pointer to User defined scan_params data structure. This
* memory space can not be freed until callback of set_scan_params
*
* @return
@@ -303,8 +297,6 @@ esp_err_t esp_ble_gap_set_scan_params(esp_ble_scan_params_t *scan_params);
/**
* @function esp_ble_gap_start_scanning
*
* @brief This procedure keep the device scanning the peer device which advertising on the air
*
* @param[in] duration: Keeping the scanning time, the unit is second.
@@ -318,10 +310,7 @@ esp_err_t esp_ble_gap_start_scanning(uint32_t duration);
/**
* @function esp_ble_gap_stop_scanning
*
* @brief This function call to stop the device scanning the peer device which advertising on the air
* @param void
* @return
* - ESP_OK : success
* - other : failed
@@ -330,12 +319,10 @@ esp_err_t esp_ble_gap_start_scanning(uint32_t duration);
esp_err_t esp_ble_gap_stop_scanning(void);
/**
* @function esp_ble_gap_start_advertising
*
* @brief This function is called to start advertising.
*
* @param[in] esp_ble_adv_params_all_t: pointer to User defined adv_params data structure.
*
* @param[in] adv_params: pointer to User defined adv_params data structure.
* @return
* - ESP_OK : success
* - other : failed
@@ -346,12 +333,8 @@ esp_err_t esp_ble_gap_start_advertising (esp_ble_adv_params_t *adv_params);
/**
* @function esp_gap_ble_stop_advertising
*
* @brief This function is called to stop advertising.
*
* @param None
*
* @return
* - ESP_OK : success
* - other : failed
@@ -362,11 +345,9 @@ esp_err_t esp_ble_gap_stop_advertising(void);
/**
* @function esp_ble_update_conn_params
*
* @brief Update connection parameters, can only be used when connection is up.
*
* @param[in] param - connection update parameters
* @param[in] params - connection update parameters
*
* @return
* - ESP_OK : success
@@ -377,8 +358,6 @@ esp_err_t esp_ble_gap_update_conn_params(esp_ble_conn_update_params_t *params);
/**
* @function esp_ble_gap_set_pkt_data_len
*
* @brief This function is to set maximum LE data packet size
*
* @return
@@ -391,8 +370,6 @@ esp_err_t esp_ble_gap_set_pkt_data_len(esp_bd_addr_t remote_device, uint16_t tx_
/**
* @function esp_ble_gap_set_rand_addr
*
* @brief This function set the random address for the application
*
* @param[in] rand_addr: the random address which should be setting
@@ -407,8 +384,6 @@ esp_err_t esp_ble_gap_set_rand_addr(esp_bd_addr_t rand_addr);
/**
* @function esp_ble_gap_config_local_privacy
*
* @brief Enable/disable privacy on the local device
*
* @param[in] privacy_enable - enable/disable privacy on remote device.
@@ -422,8 +397,6 @@ esp_err_t esp_ble_gap_config_local_privacy (bool privacy_enable);
/**
* @function esp_ble_gap_set_device_name
*
* @brief Set device name to the local device
*
* @param[in] name - device name.
@@ -437,8 +410,6 @@ esp_err_t esp_ble_gap_set_device_name(const char *name);
/**
* @function esp_ble_resolve_adv_data
*
* @brief This function is called to get ADV data for a specific type.
*
* @param[in] adv_data - pointer of ADV data which to be resolved
@@ -448,6 +419,6 @@ esp_err_t esp_ble_gap_set_device_name(const char *name);
* @return pointer of ADV data
*
*/
uint8_t *esp_ble_resolve_adv_data(uint8_t *adv_data, uint8_t type, uint8_t *p_length);
uint8_t *esp_ble_resolve_adv_data(uint8_t *adv_data, uint8_t type, uint8_t *length);
#endif /* __ESP_GAP_BLE_API_H__ */