浏览代码

Merge branch 'doc/update_doc_of_esp_bt_gap_set_cod' into 'master'

bt: Optimized the document for GAP API: esp_bt_gap_set_cod

Closes IDFGH-8668

See merge request espressif/esp-idf!22887
Wang Meng Yang 2 年之前
父节点
当前提交
70a355dbc1
共有 1 个文件被更改,包括 3 次插入1 次删除
  1. 3 1
      components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h

+ 3 - 1
components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h

@@ -576,7 +576,9 @@ esp_err_t esp_bt_gap_config_eir_data(esp_bt_eir_data_t *eir_data);
 /**
  * @brief           This function is called to set class of device.
  *                  The structure esp_bt_gap_cb_t will be called with ESP_BT_GAP_SET_COD_EVT after set COD ends.
- *                  Some profile have special restrictions on class of device, changes may cause these profile do not work.
+ *                  This function should be called after Bluetooth profiles are initialized, otherwise the user configured
+ *                  class of device can be overwritten.
+ *                  Some profiles have special restrictions on class of device, and changes may make these profiles unable to work.
  *
  * @param[in]       cod - class of device
  * @param[in]       mode - setting mode