change(doxyfile): move soc files to target specific doxygen

soc files relies on target variable, which not correct while there are multiple versions for one target
2025-08-08 04:02:27 +00:00 · 2024-02-20 18:37:38 +08:00
parent 319e30ac38
commit 45a094367d
15 changed files with 65 additions and 15 deletions
--- a/docs/doxygen/Doxyfile
+++ b/docs/doxygen/Doxyfile
@@ -288,11 +288,6 @@ INPUT = \
    $(PROJECT_PATH)/components/protocomm/include/crypto/srp6a/esp_srp.h \
    $(PROJECT_PATH)/components/pthread/include/esp_pthread.h \
    $(PROJECT_PATH)/components/sdmmc/include/sdmmc_cmd.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
-    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
    $(PROJECT_PATH)/components/spi_flash/include/esp_flash_spi_init.h \
    $(PROJECT_PATH)/components/spi_flash/include/esp_flash.h \
    $(PROJECT_PATH)/components/spi_flash/include/spi_flash_mmap.h \
--- a/docs/doxygen/Doxyfile_esp32
+++ b/docs/doxygen/Doxyfile_esp32
@@ -1,8 +1,13 @@
 INPUT += \
         $(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \
         $(PROJECT_PATH)/components/esp_psram/include/esp32/himem.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
         $(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 \
--- a/docs/doxygen/Doxyfile_esp32c2
+++ b/docs/doxygen/Doxyfile_esp32c2
@@ -2,3 +2,8 @@ INPUT += \
    $(PROJECT_PATH)/components/bt/include/esp32c2/include/esp_bt.h \
    $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
    $(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
--- a/docs/doxygen/Doxyfile_esp32c3
+++ b/docs/doxygen/Doxyfile_esp32c3
@@ -2,3 +2,8 @@ INPUT += \
    $(PROJECT_PATH)/components/bt/include/esp32c3/include/esp_bt.h \
    $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
    $(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
--- a/docs/doxygen/Doxyfile_esp32c5
+++ b/docs/doxygen/Doxyfile_esp32c5
@@ -1 +1,7 @@
+# TODO: IDF-9197 Use beta3 in doc temprory
 INPUT += \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/soc_caps.h \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/adc_channel.h \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/clk_tree_defs.h \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/gpio_num.h \
+		$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/beta3/include/soc/uart_channel.h \
--- a/docs/doxygen/Doxyfile_esp32c6
+++ b/docs/doxygen/Doxyfile_esp32c6
@@ -13,3 +13,8 @@ INPUT += \
    $(PROJECT_PATH)/components/ulp/ulp_common/include/ulp_common.h \
    $(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_he_types.h \
    $(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_he.h \
+	$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
--- a/docs/doxygen/Doxyfile_esp32h2
+++ b/docs/doxygen/Doxyfile_esp32h2
@@ -3,3 +3,8 @@ INPUT += \
    $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \
    $(PROJECT_PATH)/components/esp_phy/include/esp_phy_cert_test.h \
    $(PROJECT_PATH)/components/esp_coex/include/esp_coex_i154.h \
+	$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
--- a/docs/doxygen/Doxyfile_esp32p4
+++ b/docs/doxygen/Doxyfile_esp32p4
@@ -15,3 +15,8 @@ INPUT += \
    $(PROJECT_PATH)/components/hal/include/hal/jpeg_types.h \
    $(PROJECT_PATH)/components/esp_driver_jpeg/include/driver/jpeg_decode.h \
    $(PROJECT_PATH)/components/esp_driver_jpeg/include/driver/jpeg_types.h \
+	$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+    $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
--- a/docs/doxygen/Doxyfile_esp32s2
+++ b/docs/doxygen/Doxyfile_esp32s2
@@ -1,7 +1,12 @@
 INPUT += \
         $(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \
+		 $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
         $(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 \
--- a/docs/doxygen/Doxyfile_esp32s3
+++ b/docs/doxygen/Doxyfile_esp32s3
@@ -1,7 +1,12 @@
 INPUT += \
         $(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \
         $(PROJECT_PATH)/components/esp_lcd/rgb/include/esp_lcd_panel_rgb.h \
+		 $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \
+         $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_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/touch_element/include/touch_element/touch_button.h \