From 2c661df09df2426443a875bb4029c7fb8c787107 Mon Sep 17 00:00:00 2001 From: "Michael (XIAO Xufeng)" Date: Sat, 6 Feb 2021 20:52:28 +0800 Subject: [PATCH] docs: reorder the sequence of headers This can makes the public headers more obvious --- docs/doxygen/Doxyfile_common | 51 +++++++++++++++++------------------ docs/doxygen/Doxyfile_esp32 | 14 +++++----- docs/doxygen/Doxyfile_esp32s2 | 14 +++++----- 3 files changed, 39 insertions(+), 40 deletions(-) diff --git a/docs/doxygen/Doxyfile_common b/docs/doxygen/Doxyfile_common index 07ecf79825..71866087e4 100644 --- a/docs/doxygen/Doxyfile_common +++ b/docs/doxygen/Doxyfile_common @@ -94,43 +94,42 @@ INPUT = \ ## ## Peripherals - API Reference ## - $(IDF_PATH)/components/driver/include/driver/dedic_gpio.h \ + $(IDF_PATH)/components/hal/include/hal/adc_types.h \ + $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \ + $(IDF_PATH)/components/driver/include/driver/adc_common.h \ + $(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/adc.h \ + $(IDF_PATH)/components/esp_adc_cal/include/esp_adc_cal.h \ + $(IDF_PATH)/components/hal/include/hal/dac_types.h \ + $(IDF_PATH)/components/driver/include/driver/dac_common.h \ + $(IDF_PATH)/components/hal/include/hal/gpio_types.h \ $(IDF_PATH)/components/driver/include/driver/gpio.h \ + $(IDF_PATH)/components/driver/include/driver/dedic_gpio.h \ + $(IDF_PATH)/components/hal/include/hal/rtc_io_types.h \ $(IDF_PATH)/components/driver/include/driver/rtc_io.h \ + $(IDF_PATH)/components/hal/include/hal/i2c_types.h \ $(IDF_PATH)/components/driver/include/driver/i2c.h \ + $(IDF_PATH)/components/hal/include/hal/i2s_types.h \ $(IDF_PATH)/components/driver/include/driver/i2s.h \ + $(IDF_PATH)/components/hal/include/hal/ledc_types.h \ $(IDF_PATH)/components/driver/include/driver/ledc.h \ + $(IDF_PATH)/components/hal/include/hal/rmt_types.h \ $(IDF_PATH)/components/driver/include/driver/rmt.h \ + $(IDF_PATH)/components/hal/include/hal/sigmadelta_types.h \ $(IDF_PATH)/components/driver/include/driver/sigmadelta.h \ + $(IDF_PATH)/components/hal/include/hal/spi_types.h \ $(IDF_PATH)/components/driver/include/driver/spi_common.h \ $(IDF_PATH)/components/driver/include/driver/spi_master.h \ $(IDF_PATH)/components/driver/include/driver/spi_slave.h \ $(IDF_PATH)/components/driver/include/driver/spi_slave_hd.h \ - $(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/adc.h \ - $(IDF_PATH)/components/driver/include/driver/timer.h \ - $(IDF_PATH)/components/driver/include/driver/touch_sensor_common.h \ - $(IDF_PATH)/components/driver/include/driver/twai.h \ - $(IDF_PATH)/components/driver/include/driver/adc_common.h \ - $(IDF_PATH)/components/driver/include/driver/dac_common.h \ - $(IDF_PATH)/components/driver/include/driver/uart.h \ - $(IDF_PATH)/components/esp_adc_cal/include/esp_adc_cal.h \ - $(IDF_PATH)/components/hal/include/hal/dma_types.h \ - $(IDF_PATH)/components/hal/include/hal/gpio_types.h \ - $(IDF_PATH)/components/hal/include/hal/uart_types.h \ - $(IDF_PATH)/components/hal/include/hal/rmt_types.h \ - $(IDF_PATH)/components/hal/include/hal/spi_types.h \ - $(IDF_PATH)/components/hal/include/hal/i2s_types.h \ - $(IDF_PATH)/components/hal/include/hal/rtc_io_types.h \ - $(IDF_PATH)/components/hal/include/hal/sigmadelta_types.h \ $(IDF_PATH)/components/hal/include/hal/timer_types.h \ - $(IDF_PATH)/components/hal/include/hal/ledc_types.h \ - $(IDF_PATH)/components/hal/include/hal/i2c_types.h \ - $(IDF_PATH)/components/hal/include/hal/dac_types.h \ - $(IDF_PATH)/components/hal/include/hal/adc_types.h \ - $(IDF_PATH)/components/hal/include/hal/twai_types.h \ + $(IDF_PATH)/components/driver/include/driver/timer.h \ $(IDF_PATH)/components/hal/include/hal/touch_sensor_types.h \ - $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \ + $(IDF_PATH)/components/driver/include/driver/touch_sensor_common.h \ + $(IDF_PATH)/components/hal/include/hal/twai_types.h \ + $(IDF_PATH)/components/driver/include/driver/twai.h \ + $(IDF_PATH)/components/hal/include/hal/uart_types.h \ $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \ + $(IDF_PATH)/components/driver/include/driver/uart.h \ ## esp_netif - API Reference $(IDF_PATH)/components/esp_netif/include/esp_netif.h \ $(IDF_PATH)/components/esp_netif/include/esp_netif_net_stack.h \ @@ -182,21 +181,21 @@ INPUT = \ ## Storage - API Reference ## ## SPI Flash and Partition APIs + $(IDF_PATH)/components/hal/include/hal/spi_flash_types.h \ $(IDF_PATH)/components/spi_flash/include/esp_flash_spi_init.h \ $(IDF_PATH)/components/spi_flash/include/esp_flash.h \ $(IDF_PATH)/components/spi_flash/include/esp_partition.h \ $(IDF_PATH)/components/bootloader_support/include/esp_flash_encrypt.h \ - $(IDF_PATH)/components/hal/include/hal/spi_flash_types.h \ ## SPIFFS $(IDF_PATH)/components/spiffs/include/esp_spiffs.h \ ## SD/MMC Card Host + $(IDF_PATH)/components/driver/include/driver/sdmmc_types.h \ $(IDF_PATH)/components/sdmmc/include/sdmmc_cmd.h \ $(IDF_PATH)/components/driver/include/driver/sdmmc_host.h \ - $(IDF_PATH)/components/driver/include/driver/sdmmc_types.h \ $(IDF_PATH)/components/driver/include/driver/sdspi_host.h \ ## SDIO slave - $(IDF_PATH)/components/driver/include/driver/sdio_slave.h \ $(IDF_PATH)/components/hal/include/hal/sdio_slave_types.h \ + $(IDF_PATH)/components/driver/include/driver/sdio_slave.h \ ## Non-Volatile Storage $(IDF_PATH)/components/nvs_flash/include/nvs.h \ $(IDF_PATH)/components/nvs_flash/include/nvs_flash.h \ diff --git a/docs/doxygen/Doxyfile_esp32 b/docs/doxygen/Doxyfile_esp32 index b9198e5a86..37d4a3a444 100644 --- a/docs/doxygen/Doxyfile_esp32 +++ b/docs/doxygen/Doxyfile_esp32 @@ -1,12 +1,12 @@ INPUT += \ - $(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/dac.h \ - $(IDF_PATH)/components/esp32/include/esp32/himem.h \ - $(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/touch_sensor.h \ $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \ - $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \ - $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \ - $(IDF_PATH)/components/driver/include/driver/mcpwm.h \ + $(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/dac.h \ $(IDF_PATH)/components/hal/include/hal/mcpwm_types.h \ - $(IDF_PATH)/components/driver/include/driver/pcnt.h \ + $(IDF_PATH)/components/driver/include/driver/mcpwm.h \ $(IDF_PATH)/components/hal/include/hal/pcnt_types.h \ + $(IDF_PATH)/components/driver/include/driver/pcnt.h \ + $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \ + $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \ + $(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/touch_sensor.h \ + $(IDF_PATH)/components/esp32/include/esp32/himem.h \ $(IDF_PATH)/components/ulp/include/$(IDF_TARGET)/ulp.h diff --git a/docs/doxygen/Doxyfile_esp32s2 b/docs/doxygen/Doxyfile_esp32s2 index 50cd9abbc0..4b4cbfbb0e 100644 --- a/docs/doxygen/Doxyfile_esp32s2 +++ b/docs/doxygen/Doxyfile_esp32s2 @@ -1,13 +1,13 @@ INPUT += \ - $(IDF_PATH)/components/driver/esp32s2/include/driver/temp_sensor.h \ + $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \ $(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/dac.h \ + $(IDF_PATH)/components/hal/include/hal/pcnt_types.h \ + $(IDF_PATH)/components/driver/include/driver/pcnt.h \ + $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \ + $(IDF_PATH)/components/driver/esp32s2/include/driver/temp_sensor.h \ + $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \ + $(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/touch_sensor.h \ $(IDF_PATH)/components/esp32s2/include/esp_hmac.h \ $(IDF_PATH)/components/esp32s2/include/esp_ds.h \ $(IDF_PATH)/components/ulp/include/esp32s2/ulp_riscv.h \ - $(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/touch_sensor.h \ - $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \ - $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \ - $(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \ - $(IDF_PATH)/components/driver/include/driver/pcnt.h \ - $(IDF_PATH)/components/hal/include/hal/pcnt_types.h \ $(IDF_PATH)/components/ulp/include/$(IDF_TARGET)/ulp.h