docs(ble/bluedroid): Optimize doc for registering BLE callback functions

2024-07-10 14:58:34 +08:00
parent 3cb2d9c3c6
commit d84ccadf90
5 changed files with 10 additions and 4 deletions
@@ -1593,6 +1593,8 @@ typedef void (* esp_gap_ble_cb_t)(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_p
 *
 * @param[in]       callback: callback function
 *
+ * @note            Avoid performing time-consuming operations within the callback functions.
+ *
 * @return
 *                  - ESP_OK : success
 *                  - other  : failed
@@ -266,6 +266,8 @@ typedef void (* esp_gattc_cb_t)(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_
 *
 * @param[in]       callback : pointer to the application callback function.
 *
+ * @note            Avoid performing time-consuming operations within the callback functions.
+ *
 * @return
 *                  - ESP_OK: success
 *                  - other: failed
@@ -289,6 +289,8 @@ typedef void (* esp_gatts_cb_t)(esp_gatts_cb_event_t event, esp_gatt_if_t gatts_
 * @brief           This function is called to register application callbacks
 *                  with BTA GATTS module.
 *
+ * @note            Avoid performing time-consuming operations within the callback functions.
+ *
 * @return
 *                  - ESP_OK : success
 *                  - other  : failed