Merge branch 'docs/organize_header_files_bluetooth_controller' into '…

…master' docs: organize header files of Bluetooth Controller See merge request espressif/esp-idf!24848
espressif · Sep 8, 2023 · 58775f8 · 58775f8
2 parents c8f17b1 + c09595a
commit 58775f8
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 1 deletion.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -8,6 +8,10 @@ Check :example:`bluetooth/hci` folder in ESP-IDF examples, which contains the fo
 
 * This is a Bluetooth® Low Energy (Bluetooth LE) advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for Bluetooth Low Energy 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
 -------------
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		INPUT += \
		$(PROJECT_PATH)/components/bt/include/$(IDF_TARGET)/include/esp_bt.h \