1 # This is Doxygen configuration file
3 # Doxygen provides over 260 configuration statements
4 # To make this file easier to follow,
5 # it contains only statements that are non-default
8 # It is recommended not to change defaults unless specifically required
9 # Test any changes how they affect generated documentation
10 # Make sure that correct warnings are generated to flag issues with documented code
12 # For the complete list of configuration statements see:
13 # https://www.stack.nl/~dimitri/doxygen/manual/config.html
16 PROJECT_NAME = "ESP32 Programming Guide"
18 ## The 'INPUT' statement below is used as input by script 'gen-df-input.py'
19 ## to automatically generate API reference list files heder_file.inc
20 ## These files are placed in '_inc' directory
21 ## and used to include in API reference documentation
25 ## Wi-Fi - API Reference
27 ../components/esp32/include/esp_wifi.h \
28 ../components/esp32/include/esp_wifi_crypto_types.h \
29 ../components/esp32/include/esp_smartconfig.h \
30 ## Bluetooth - API Reference
32 ../components/bt/include/bt.h \
34 ## Issue with __attribute__
35 ../components/bt/bluedroid/api/include/esp_bt_defs.h \
36 ../components/bt/bluedroid/api/include/esp_bt_main.h \
37 ../components/bt/bluedroid/api/include/esp_bt_device.h \
39 ../components/bt/bluedroid/api/include/esp_gap_ble_api.h \
40 ## Issue with __attribute__
41 ../components/bt/bluedroid/api/include/esp_gatt_defs.h \
42 ../components/bt/bluedroid/api/include/esp_gatts_api.h \
43 ../components/bt/bluedroid/api/include/esp_gattc_api.h \
44 ../components/bt/bluedroid/api/include/esp_blufi_api.h \
46 ../components/bt/bluedroid/api/include/esp_gap_bt_api.h \
47 ## Issue with __attribute__
48 ../components/bt/bluedroid/api/include/esp_a2dp_api.h \
49 ../components/bt/bluedroid/api/include/esp_avrc_api.h \
51 ## Ethernet - API Reference
53 ../components/ethernet/include/esp_eth.h \
54 ../components/ethernet/include/eth_phy/phy.h \
55 ../components/ethernet/include/eth_phy/phy_tlk110.h \
56 ../components/ethernet/include/eth_phy/phy_lan8720.h \
58 ## Peripherals - API Reference
60 ../components/driver/include/driver/adc.h \
61 ../components/driver/include/driver/dac.h \
62 ../components/driver/include/driver/gpio.h \
63 ../components/driver/include/driver/rtc_io.h \
64 ../components/driver/include/driver/i2c.h \
65 ../components/driver/include/driver/i2s.h \
66 ../components/driver/include/driver/ledc.h \
67 ../components/driver/include/driver/mcpwm.h \
68 ../components/driver/include/driver/pcnt.h \
69 ../components/driver/include/driver/rmt.h \
70 ../components/driver/include/driver/sigmadelta.h \
71 ../components/driver/include/driver/spi_common.h \
72 ../components/driver/include/driver/spi_master.h \
73 ../components/driver/include/driver/spi_slave.h \
74 ../components/driver/include/driver/timer.h \
75 ../components/driver/include/driver/touch_pad.h \
76 ../components/driver/include/driver/uart.h \
77 ../components/esp_adc_cal/include/esp_adc_cal.h \
78 ../components/soc/esp32/include/soc/adc_channel.h \
79 ../components/soc/esp32/include/soc/dac_channel.h \
80 ../components/soc/esp32/include/soc/touch_channel.h \
81 ../components/soc/esp32/include/soc/uart_channel.h \
82 ../components/soc/esp32/include/soc/rtc_gpio_channel.h \
84 ## Protocols - API Reference
86 ../components/mdns/include/mdns.h \
88 ## Storage - API Reference
90 ## SPI Flash and Partition APIs
91 ../components/spi_flash/include/esp_spi_flash.h \
92 ../components/spi_flash/include/esp_partition.h \
93 ../components/bootloader_support/include/esp_flash_encrypt.h \
95 ../components/spiffs/include/esp_spiffs.h \
97 ## NOTE: for three lines below header_file.inc is not used
98 ../components/sdmmc/include/sdmmc_cmd.h \
99 ../components/driver/include/driver/sdmmc_host.h \
100 ../components/driver/include/driver/sdmmc_types.h \
101 ../components/driver/include/driver/sdspi_host.h \
102 ## Non-Volatile Storage
103 ../components/nvs_flash/include/nvs.h \
104 ../components/nvs_flash/include/nvs_flash.h \
105 ## Virtual Filesystem
106 ../components/vfs/include/esp_vfs.h \
107 ../components/vfs/include/esp_vfs_dev.h \
109 ## NOTE: for two lines below header_file.inc is not used
110 ../components/fatfs/src/esp_vfs_fat.h \
111 ../components/fatfs/src/diskio.h \
113 ../components/wear_levelling/include/wear_levelling.h \
115 ## System - API Reference
117 ## Memory Allocation #
118 ../components/heap/include/esp_heap_caps.h \
119 ../components/heap/include/esp_heap_trace.h \
120 ../components/heap/include/esp_heap_caps_init.h \
121 ../components/heap/include/multi_heap.h \
122 ## Interrupt Allocation
123 ../components/esp32/include/esp_intr_alloc.h \
125 ## NOTE: for two lines below header_file.inc is not used
126 ../components/esp32/include/esp_int_wdt.h \
127 ../components/esp32/include/esp_task_wdt.h \
128 ## Over The Air Updates (OTA)
129 ../components/app_update/include/esp_ota_ops.h \
131 ## NOTE: for line below header_file.inc is not used
132 ../components/esp32/include/esp_sleep.h \
134 ../components/log/include/esp_log.h \
136 ## NOTE: for line below header_file.inc is not used
137 ../components/esp32/include/esp_system.h \
139 ## ULP Coprocessor - API Guides
141 ## NOTE: for line below header_file.inc is not used
142 ../components/ulp/include/esp32/ulp.h \
144 ## Application Level Tracing - API Reference
146 ../components/app_trace/include/esp_app_trace.h
149 ## Get warnings for functions that have no documentation for their parameters or return value
151 WARN_NO_PARAMDOC = YES
153 ## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
155 ENABLE_PREPROCESSING = YES
156 MACRO_EXPANSION = YES
157 EXPAND_ONLY_PREDEF = YES
158 PREDEFINED = __attribute__(x)=
160 ## Do not complain about not having dot
164 ## Generate XML that is required for Breathe
175 ## Skip distracting progress messages
178 ## Log warnings in a file for further review
180 WARN_LOGFILE = "doxygen-warning-log.txt"