alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-12-11 02:07:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

component/bt : cleanup the function comment as doxygen type

Browse Source
This commit is contained in:
Tian Hao
2016-12-01 18:58:54 +08:00
parent 281a9c2761
commit c6ec70b67b
7 changed files with 834 additions and 752 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
components/bt/bluedroid/api/include/esp_blufi_api.h
View File

@@ -27,16 +27,19 @@
#define ESP_BLUFI_EVENT_DEINIT_FINISH 1
#define ESP_BLUFI_EVENT_RECV_DATA 2
/// BLUFI config status
typedef enum {
ESP_BLUFI_CONFIG_OK = 0,
ESP_BLUFI_CONFIG_FAILED,
} esp_blufi_config_state_t;
/// BLUFI init status
typedef enum {
ESP_BLUFI_INIT_OK = 0,
ESP_BLUFI_INIT_FAILED = 0,
} esp_blufi_init_state_t;
/// BLUFI deinit status
typedef enum {
ESP_BLUFI_DEINIT_OK = 0,
ESP_BLUFI_DEINIT_FAILED = 0,
@@ -69,52 +72,52 @@ typedef union {
} recv_data; /*!< Blufi callback param of ESP_BLUFI_EVENT_RECV_DATA */
} esp_blufi_cb_param_t;
/*******************************************************************************
**
** @function esp_blufi_register_callback
**
** @brief This function is called to receive blufi callback event
**
** @param[in] callback: callback function
**
** @return ESP_OK - success, other - failed
**
*******************************************************************************/
/**
*
* @function esp_blufi_register_callback
*
* @brief This function is called to receive blufi callback event
*
* @param[in] callback: callback function
*
* @return ESP_OK - success, other - failed
*
*/
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
**
** @param[in] state: blufi config OK or not
**
** @return ESP_OK - success, other - failed
**
*******************************************************************************/
/**
*
* @function esp_blufi_send_config_state
*
* @brief This function is called to send config state to phone
*
* @param[in] state: blufi config OK or not
*
* @return ESP_OK - success, other - failed
*
*/
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
**
** @return ESP_OK - success, other - failed
**
*******************************************************************************/
/**
*
* @function esp_blufi_profile_init
*
* @brief This function is called to initialize blufi_profile
*
* @return ESP_OK - success, other - failed
*
*/
esp_err_t esp_blufi_profile_init(void);
/*******************************************************************************
**
** @function esp_blufi_profile_deinit
**
** @brief This function is called to de-initialize blufi_profile
**
** @return ESP_OK - success, other - failed
**
*******************************************************************************/
/*
*
* @function esp_blufi_profile_deinit
*
* @brief This function is called to de-initialize blufi_profile
*
* @return ESP_OK - success, other - failed
*
*/
esp_err_t esp_blufi_profile_deinit(void);