From c09595a831ec7f5cf39ebdb50d328ef0ff1b746e Mon Sep 17 00:00:00 2001 From: Linda Date: Mon, 17 Jul 2023 17:29:07 +0800 Subject: [PATCH] docs: organize header files of Bluetooth Controller --- docs/doxygen/Doxyfile | 1 - docs/doxygen/Doxyfile_esp32 | 1 + docs/doxygen/Doxyfile_esp32c2 | 1 + docs/doxygen/Doxyfile_esp32c3 | 1 + docs/doxygen/Doxyfile_esp32c6 | 1 + docs/doxygen/Doxyfile_esp32h2 | 1 + docs/doxygen/Doxyfile_esp32s3 | 1 + docs/en/api-reference/bluetooth/controller_vhci.rst | 4 ++++ 8 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index caab376be43d..f5b15ab653eb 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -60,7 +60,6 @@ INPUT = \ $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_sdp_api.h \ $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_spp_api.h \ $(PROJECT_PATH)/components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \ - $(PROJECT_PATH)/components/bt/include/esp32/include/esp_bt.h \ $(PROJECT_PATH)/components/console/esp_console.h \ $(PROJECT_PATH)/components/driver/analog_comparator/include/driver/ana_cmpr.h \ $(PROJECT_PATH)/components/driver/analog_comparator/include/driver/ana_cmpr_types.h \ diff --git a/docs/doxygen/Doxyfile_esp32 b/docs/doxygen/Doxyfile_esp32 index b0ee24c591b8..ad3bfb1335d1 100644 --- a/docs/doxygen/Doxyfile_esp32 +++ b/docs/doxygen/Doxyfile_esp32 @@ -6,3 +6,4 @@ INPUT += \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \ $(PROJECT_PATH)/components/ulp/ulp_common/include/$(IDF_TARGET)/ulp_common_defs.h \ $(PROJECT_PATH)/components/ulp/ulp_fsm/include/$(IDF_TARGET)/ulp.h \ + $(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt.h \ diff --git a/docs/doxygen/Doxyfile_esp32c2 b/docs/doxygen/Doxyfile_esp32c2 index 910f295a01f7..131db78eb092 100644 --- a/docs/doxygen/Doxyfile_esp32c2 +++ b/docs/doxygen/Doxyfile_esp32c2 @@ -1 +1,2 @@ INPUT += \ + $(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt.h \ diff --git a/docs/doxygen/Doxyfile_esp32c3 b/docs/doxygen/Doxyfile_esp32c3 index 910f295a01f7..131db78eb092 100644 --- a/docs/doxygen/Doxyfile_esp32c3 +++ b/docs/doxygen/Doxyfile_esp32c3 @@ -1 +1,2 @@ INPUT += \ + $(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt.h \ diff --git a/docs/doxygen/Doxyfile_esp32c6 b/docs/doxygen/Doxyfile_esp32c6 index 910f295a01f7..131db78eb092 100644 --- a/docs/doxygen/Doxyfile_esp32c6 +++ b/docs/doxygen/Doxyfile_esp32c6 @@ -1 +1,2 @@ INPUT += \ + $(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt.h \ diff --git a/docs/doxygen/Doxyfile_esp32h2 b/docs/doxygen/Doxyfile_esp32h2 index 910f295a01f7..131db78eb092 100644 --- a/docs/doxygen/Doxyfile_esp32h2 +++ b/docs/doxygen/Doxyfile_esp32h2 @@ -1 +1,2 @@ INPUT += \ + $(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt.h \ diff --git a/docs/doxygen/Doxyfile_esp32s3 b/docs/doxygen/Doxyfile_esp32s3 index 6177ef00bed6..524ed2ca73fe 100644 --- a/docs/doxygen/Doxyfile_esp32s3 +++ b/docs/doxygen/Doxyfile_esp32s3 @@ -3,3 +3,4 @@ INPUT += \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \ $(PROJECT_PATH)/components/ulp/ulp_common/include/$(IDF_TARGET)/ulp_common_defs.h \ $(PROJECT_PATH)/components/ulp/ulp_fsm/include/$(IDF_TARGET)/ulp.h \ + $(PROJECT_PATH)/components/bt/include/esp32c3/include/esp_bt.h \ diff --git a/docs/en/api-reference/bluetooth/controller_vhci.rst b/docs/en/api-reference/bluetooth/controller_vhci.rst index 6fc65df49777..a5f52e410179 100644 --- a/docs/en/api-reference/bluetooth/controller_vhci.rst +++ b/docs/en/api-reference/bluetooth/controller_vhci.rst @@ -8,6 +8,10 @@ Check :example:`bluetooth/hci` folder in ESP-IDF examples, which contains the fo * This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising - :example:`bluetooth/hci/controller_vhci_ble_adv`. +.. only:: esp32s3 + + Please note that ESP32-S3 shares the same :component_file:`bt/include/esp32c3/include/esp_bt.h` and :component_file:`bt/controller/esp32c3/bt.c` files with ESP32-C3. + API Reference -------------