From d925b96daf496230bf6e68fdcf22ed770345d79e Mon Sep 17 00:00:00 2001 From: Tian Hao Date: Thu, 1 Dec 2016 20:55:08 +0800 Subject: [PATCH] component/bt : cleanup the function warning in doxygen --- .../bt/bluedroid/api/include/esp_blufi_api.h | 10 +-- .../bt/bluedroid/api/include/esp_bt_main.h | 8 --- .../bluedroid/api/include/esp_gap_ble_api.h | 39 ++--------- .../bt/bluedroid/api/include/esp_gattc_api.h | 70 ++----------------- .../bt/bluedroid/api/include/esp_gatts_api.h | 49 +------------ 5 files changed, 15 insertions(+), 161 deletions(-) diff --git a/components/bt/bluedroid/api/include/esp_blufi_api.h b/components/bt/bluedroid/api/include/esp_blufi_api.h index 92b88e0e28..b8ba382d0e 100644 --- a/components/bt/bluedroid/api/include/esp_blufi_api.h +++ b/components/bt/bluedroid/api/include/esp_blufi_api.h @@ -73,8 +73,6 @@ typedef union { } esp_blufi_cb_param_t; /** - * - * @function esp_blufi_register_callback * * @brief This function is called to receive blufi callback event * @@ -86,8 +84,6 @@ typedef union { esp_err_t esp_blufi_register_callback(esp_profile_cb_t callback); /** - * - * @function esp_blufi_send_config_state * * @brief This function is called to send config state to phone * @@ -99,8 +95,6 @@ esp_err_t esp_blufi_register_callback(esp_profile_cb_t callback); esp_err_t esp_blufi_send_config_state(esp_blufi_config_state_t state); /** - * - * @function esp_blufi_profile_init * * @brief This function is called to initialize blufi_profile * @@ -109,9 +103,7 @@ esp_err_t esp_blufi_send_config_state(esp_blufi_config_state_t state); */ esp_err_t esp_blufi_profile_init(void); -/* - * - * @function esp_blufi_profile_deinit +/** * * @brief This function is called to de-initialize blufi_profile * diff --git a/components/bt/bluedroid/api/include/esp_bt_main.h b/components/bt/bluedroid/api/include/esp_bt_main.h index 76b0a77998..2bb7b8977b 100644 --- a/components/bt/bluedroid/api/include/esp_bt_main.h +++ b/components/bt/bluedroid/api/include/esp_bt_main.h @@ -19,8 +19,6 @@ #include "esp_err.h" /** - * @function esp_enable_bluetooth - * * @brief Enable bluetooth, must after esp_init_bluetooth() * * @return @@ -30,8 +28,6 @@ esp_err_t esp_enable_bluetooth(void); /** - * @function esp_disable_bluetooth - * * @brief Disable bluetooth, must prior to esp_deinit_bluetooth() * * @return @@ -41,8 +37,6 @@ esp_err_t esp_enable_bluetooth(void); esp_err_t esp_disable_bluetooth(void); /** - * @function esp_init_bluetooth - * * @brief Init and alloc the resource for bluetooth, must be prior to every bluetooth stuff * * @return @@ -52,8 +46,6 @@ esp_err_t esp_disable_bluetooth(void); esp_err_t esp_init_bluetooth(void); /** - * @function esp_deinit_bluetooth - * * @brief Deinit and free the resource for bluetooth, must be after every bluetooth stuff * * @return diff --git a/components/bt/bluedroid/api/include/esp_gap_ble_api.h b/components/bt/bluedroid/api/include/esp_gap_ble_api.h index 242d74f0fe..29ffbe38ff 100644 --- a/components/bt/bluedroid/api/include/esp_gap_ble_api.h +++ b/components/bt/bluedroid/api/include/esp_gap_ble_api.h @@ -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__ */ diff --git a/components/bt/bluedroid/api/include/esp_gattc_api.h b/components/bt/bluedroid/api/include/esp_gattc_api.h index 0199f97bf5..4cf5113eb1 100755 --- a/components/bt/bluedroid/api/include/esp_gattc_api.h +++ b/components/bt/bluedroid/api/include/esp_gattc_api.h @@ -246,9 +246,6 @@ typedef union { /** - * - * @function esp_ble_gattc_app_register_callback - * * @brief This function is called to register application callbacks * with GATTC module. * @@ -263,9 +260,6 @@ esp_err_t esp_ble_gattc_register_callback(esp_profile_cb_t callback); /** - * - * @function esp_ble_gattc_app_register - * * @brief This function is called to register application callbacks * with GATTC module. * @@ -280,9 +274,6 @@ esp_err_t esp_ble_gattc_app_register(uint16_t app_id); /** - * - * @function esp_ble_gattc_app_unregister - * * @brief This function is called to unregister an application * from GATTC module. * @@ -297,9 +288,6 @@ esp_err_t esp_ble_gattc_app_unregister(esp_gatt_if_t gatt_if); /** - * - * @function esp_ble_gattc_conn - * * @brief Open a direct connection or add a background auto connection * * @param[in] gatt_if: application identity. @@ -315,9 +303,6 @@ esp_err_t esp_ble_gattc_open(esp_gatt_if_t gatt_if, esp_bd_addr_t remote_bda, bo /** - * - * @function esp_ble_gattc_close - * * @brief Close a connection to a GATT server. * * @param[in] conn_id: connection ID to be closed. @@ -327,31 +312,25 @@ esp_err_t esp_ble_gattc_open(esp_gatt_if_t gatt_if, esp_bd_addr_t remote_bda, bo * - other: failed * */ -esp_err_t esp_ble_gattc_close (uint16_t conn_id); +esp_err_t esp_ble_gattc_close(uint16_t conn_id); /** - * - * @function esp_ble_gattc_config_mtu - * * @brief Configure the MTU size in the GATT channel. This can be done * only once per connection. * * @param[in] conn_id: connection ID. - * mtu: desired MTU size to use. + * @param[in] mtu: desired MTU size to use. * * @return * - ESP_OK: success * - other: failed * */ -esp_err_t esp_ble_gattc_config_mtu (uint16_t conn_id, uint16_t mtu); +esp_err_t esp_ble_gattc_config_mtu(uint16_t conn_id, uint16_t mtu); /** - * - * @function esp_ble_gattc_search_service - * * @brief This function is called to request a GATT service discovery * on a GATT server. This function report service search result * by a callback event, and followed by a service search complete @@ -370,9 +349,6 @@ esp_err_t esp_ble_gattc_search_service(uint16_t conn_id, esp_bt_uuid_t *filter_u /** - * - * @function esp_ble_gattc_get_characteristic - * * @brief This function is called to find the first characteristic of the * service on the given server. * @@ -392,9 +368,6 @@ esp_err_t esp_ble_gattc_get_characteristic(uint16_t conn_id, /** - * - * @function esp_ble_gattc_get_descriptor - * * @brief This function is called to find the descriptor of the * service on the given server. * @@ -415,9 +388,6 @@ esp_err_t esp_ble_gattc_get_descriptor(uint16_t conn_id, /** - * - * @function esp_ble_gattc_get_include_service - * * @brief This function is called to find the first characteristic of the * service on the given server. * @@ -435,9 +405,6 @@ esp_err_t esp_ble_gattc_get_included_service(uint16_t conn_id, /** - * - * @function esp_ble_gattc_read_char - * * @brief This function is called to read a service's characteristics of * the given characteriistic ID * @@ -458,13 +425,11 @@ esp_err_t esp_ble_gattc_read_char (uint16_t conn_id, /** - * - * @function esp_ble_gattc_read_char_descr - * * @brief This function is called to read a characteristics descriptor. * * @param[in] conn_id : connection ID. * @param[in] srvc_id : service ID. + * @param[in] char_id : characteristic ID to read. * @param[in] descr_id : characteristic descriptor ID to read. * @param[in] auth_req : authenticate request type * @@ -481,9 +446,6 @@ esp_err_t esp_ble_gattc_read_char_descr (uint16_t conn_id, /** - * - * @function esp_ble_gattc_write_char - * * @brief This function is called to write characteristic value. * * @param[in] conn_id : connection ID. @@ -494,7 +456,6 @@ esp_err_t esp_ble_gattc_read_char_descr (uint16_t conn_id, * @param[in] write_type : the type of attribute write operation. * @param[in] auth_req : authentication request. * - * * @return * - ESP_OK: success * - other: failed @@ -510,9 +471,6 @@ esp_err_t esp_ble_gattc_write_char( uint16_t conn_id, /** - * - * @function esp_ble_gattc_write_char_descr - * * @brief This function is called to write characteristic descriptor value. * * @param[in] conn_id : connection ID @@ -524,7 +482,6 @@ esp_err_t esp_ble_gattc_write_char( uint16_t conn_id, * @param[in] write_type : the type of attribute write operation. * @param[in] auth_req : authentication request. * - * * @return * - ESP_OK: success * - other: failed @@ -541,12 +498,10 @@ esp_err_t esp_ble_gattc_write_char_descr (uint16_t conn_id, /** - * - * @function esp_ble_gattc_prepare_write - * * @brief This function is called to prepare write a characteristic value. * * @param[in] conn_id : connection ID. + * @param[in] srvc_id : service ID. * @param[in] char_id : GATT characteristic ID of the service. * @param[in] offset : offset of the write value. * @param[in] value_len: length of the value to be written. @@ -567,9 +522,6 @@ esp_err_t esp_ble_gattc_prepare_write(uint16_t conn_id, esp_gatt_auth_req_t auth_req); /** - * - * @function esp_ble_gattc_execute_write - * * @brief This function is called to execute write a prepare write sequence. * * @param[in] conn_id : connection ID. @@ -584,17 +536,13 @@ esp_err_t esp_ble_gattc_execute_write (uint16_t conn_id, bool is_execute); /** - * - * @function esp_ble_gattc_register_for_notify - * * @brief This function is called to register for notification of a service. * * @param[in] gatt_if : gatt interface id. - * @param[in] bda : target GATT server. + * @param[in] server_bda : target GATT server. * @param[in] srvc_id : pointer to GATT service ID. * @param[in] char_id : pointer to GATT characteristic ID. * - * * @return * - ESP_OK: registration succeeds * - other: failed @@ -607,17 +555,13 @@ esp_gatt_status_t esp_ble_gattc_register_for_notify (esp_gatt_if_t gatt_if, /** - * - * @function esp_ble_gattc_unregister_ntf - * * @brief This function is called to de-register for notification of a service. * * @param[in] gatt_if : gatt interface id. - * @param[in] bda : target GATT server. + * @param[in] server_bda : target GATT server. * @param[in] srvc_id : pointer to GATT service ID. * @param[in] char_id : pointer to GATT characteristic ID. * - * * @return * - ESP_OK: unregister succeeds * - other: failed diff --git a/components/bt/bluedroid/api/include/esp_gatts_api.h b/components/bt/bluedroid/api/include/esp_gatts_api.h index fe99e159d9..3d858d5b7e 100644 --- a/components/bt/bluedroid/api/include/esp_gatts_api.h +++ b/components/bt/bluedroid/api/include/esp_gatts_api.h @@ -239,13 +239,9 @@ typedef union { } esp_ble_gatts_cb_param_t; /** - * - * @function esp_ble_gatts_register_callback - * * @brief This function is called to register application callbacks * with BTA GATTS module. * - * * @return * - ESP_OK : success * - other : failed @@ -256,12 +252,8 @@ esp_err_t esp_ble_gatts_register_callback(esp_profile_cb_t callback); /** - * - * @function esp_ble_gatts_app_register - * * @brief This function is called to register application identifier * - * * @return * - ESP_OK : success * - other : failed @@ -272,9 +264,6 @@ esp_err_t esp_ble_gatts_app_register(uint16_t app_id); /** - * - * @function esp_ble_gatts_app_unregister - * * @brief unregister with GATT Server. * * @param[in] gatt_if: gatt interface id. @@ -288,9 +277,6 @@ esp_err_t esp_ble_gatts_app_unregister(esp_gatt_if_t gatt_if); /** - * - * @function esp_ble_gatts_create_service - * * @brief Create a service. When service creation is done, a callback * event BTA_GATTS_CREATE_SRVC_EVT is called to report status * and service ID to the profile. The service ID obtained in @@ -312,9 +298,6 @@ esp_err_t esp_ble_gatts_create_service(esp_gatt_if_t gatt_if, /** - * - * @function esp_ble_gatts_add_included_service - * * @brief This function is called to add an included service. After included * service is included, a callback event BTA_GATTS_ADD_INCL_SRVC_EVT * is reported the included service ID. @@ -333,9 +316,6 @@ esp_err_t esp_ble_gatts_add_included_service(uint16_t service_handle, uint16_t i /** - * - * @function esp_ble_gatts_add_char - * * @brief This function is called to add a characteristic into a service. * * @param[in] service_handle: service handle to which this included service is to @@ -354,9 +334,6 @@ esp_err_t esp_ble_gatts_add_char(uint16_t service_handle, esp_bt_uuid_t *char_ /** - * - * @function esp_ble_gatts_add_char_descr - * * @brief This function is called to add characteristic descriptor. When * it's done, a callback event BTA_GATTS_ADD_DESCR_EVT is called * to report the status and an ID number for this descriptor. @@ -378,13 +355,10 @@ esp_err_t esp_ble_gatts_add_char_descr (uint16_t service_handle, /** - * - * @function esp_ble_gatts_delete_service - * * @brief This function is called to delete a service. When this is done, * a callback event BTA_GATTS_DELETE_EVT is report with the status. * - * @param[in] service_handled: service_handle to be deleted. + * @param[in] service_handle: service_handle to be deleted. * * @return * - ESP_OK : success @@ -396,13 +370,9 @@ esp_err_t esp_ble_gatts_delete_service(uint16_t service_handle); /** - * - * @function esp_ble_gatts_start_service - * * @brief This function is called to start a service. * * @param[in] service_handle: the service handle to be started. - * @param[in] sup_transport: supported transport. * * @return * - ESP_OK : success @@ -414,9 +384,6 @@ esp_err_t esp_ble_gatts_start_service(uint16_t service_handle); /** - * - * @function esp_ble_gatts_stop_service - * * @brief This function is called to stop a service. * * @param[in] service_handle - service to be topped. @@ -431,13 +398,10 @@ esp_err_t esp_ble_gatts_stop_service(uint16_t service_handle); /** - * - * @function esp_ble_gatts_send_indicate - * * @brief This function is called to read a characteristics descriptor. * * @param[in] conn_id - connection id to indicate. - * @param[in] attribute_handle - attribute handle to indicate. + * @param[in] attr_handle - attribute handle to indicate. * @param[in] value_len - indicate value length. * @param[in] value: value to indicate. * @param[in] need_confirm - if this indication expects a confirmation or not. @@ -452,9 +416,6 @@ esp_err_t esp_ble_gatts_send_indicate(uint16_t conn_id, uint16_t attr_handle, /** - * - * @function esp_ble_gatts_send_rsp - * * @brief This function is called to send a response to a request. * * @param[in] conn_id - connection identifier. @@ -472,9 +433,6 @@ esp_err_t esp_ble_gatts_send_response(uint16_t conn_id, uint32_t trans_id, /** - * - * @function esp_ble_gatts_open - * * @brief Open a direct open connection or add a background auto connection * * @param[in] gatt_if: application ID. @@ -489,9 +447,6 @@ esp_err_t esp_ble_gatts_send_response(uint16_t conn_id, uint32_t trans_id, esp_err_t esp_ble_gatts_open(esp_gatt_if_t gatt_if, esp_bd_addr_t remote_bda, bool is_direct); /** - * - * @function esp_ble_gatts_close - * * @brief Close a connection a remote device. * * @param[in] conn_id: connection ID to be closed. -- 2.40.0