granicus.if.org Git - esp-idf/blob - docs/Doxyfile

   1 # This is Doxygen configuration file
   2 #
   3 # Doxygen provides over 260 configuration statements
   4 # To make this file easier to follow,
   5 # it contains only statements that are non-default
   6 #
   7 # NOTE:
   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
  11 #
  12 # For the complete list of configuration statements see:
  13 # https://www.stack.nl/~dimitri/doxygen/manual/config.html
  14
  15
  16 PROJECT_NAME = "ESP32 Programming Guide"
  17
  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
  22
  23 INPUT = \
  24     ##
  25     ## Wi-Fi - API Reference
  26     ##
  27     ../../components/esp_wifi/include/esp_wifi.h \
  28     ../../components/esp_wifi/include/esp_wifi_types.h \
  29     ../../components/esp_wifi/include/esp_smartconfig.h \
  30     ../../components/esp_wifi/include/esp_now.h \
  31     ## Mesh - API Reference
  32     ../../components/esp_wifi/include/esp_mesh.h \
  33     ## Event loop - API Reference
  34     ../../components/esp_event/include/esp_event.h \
  35     ../../components/esp_event/include/esp_event_base.h \
  36     ../../components/esp_event/include/esp_event_legacy.h \
  37     ## Bluetooth - API Reference
  38     ## Controller && VHCI
  39     ../../components/bt/include/esp_bt.h \
  40     ## Bluetooth COMMON
  41     ## Issue with __attribute__
  42     ../../components/bt/host/bluedroid/api/include/api/esp_bt_defs.h \
  43     ../../components/bt/host/bluedroid/api/include/api/esp_bt_main.h \
  44     ../../components/bt/host/bluedroid/api/include/api/esp_bt_device.h \
  45     ## Bluetooth LE
  46     ../../components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h \
  47     ## Issue with __attribute__
  48     ../../components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h \
  49     ../../components/bt/host/bluedroid/api/include/api/esp_gatts_api.h \
  50     ../../components/bt/host/bluedroid/api/include/api/esp_gattc_api.h \
  51     ../../components/bt/host/bluedroid/api/include/api/esp_blufi_api.h \
  52     ## Bluetooth Classic
  53     ../../components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h \
  54     ## Issue with __attribute__
  55     ../../components/bt/host/bluedroid/api/include/api/esp_a2dp_api.h \
  56     ../../components/bt/host/bluedroid/api/include/api/esp_avrc_api.h \
  57     ../../components/bt/host/bluedroid/api/include/api/esp_spp_api.h \
  58     ../../components/bt/host/bluedroid/api/include/api/esp_hf_defs.h \
  59     ../../components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h \
  60     ## NimBLE related Bluetooth APIs
  61     ../../components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \
  62     ## ESP BLE Mesh APIs
  63     ../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_common_api.h \
  64     ../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_local_data_operation_api.h \
  65     ../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_low_power_api.h \
  66     ../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_networking_api.h \
  67     ../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_provisioning_api.h \
  68     ../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_proxy_api.h \
  69     ../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_config_model_api.h \
  70     ../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_generic_model_api.h \
  71     ../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_health_model_api.h \
  72     ../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_lighting_model_api.h \
  73     ../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_sensor_model_api.h \
  74     ../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_time_scene_model_api.h \
  75     ../../components/bt/esp_ble_mesh/api/esp_ble_mesh_defs.h \
  76     ##
  77     ## Ethernet - API Reference
  78     ##
  79     ../../components/esp_eth/include/esp_eth.h \
  80     ../../components/esp_eth/include/esp_eth_com.h \
  81     ../../components/esp_eth/include/esp_eth_mac.h \
  82     ../../components/esp_eth/include/esp_eth_phy.h \
  83     ##
  84     ## Peripherals - API Reference
  85     ##
  86     ../../components/driver/include/driver/adc.h \
  87     ../../components/driver/include/driver/can.h \
  88     ../../components/driver/include/driver/dac.h \
  89     ../../components/driver/include/driver/gpio.h \
  90     ../../components/driver/include/driver/rtc_io.h \
  91     ../../components/driver/include/driver/i2c.h \
  92     ../../components/driver/include/driver/i2s.h \
  93     ../../components/driver/include/driver/ledc.h \
  94     ../../components/driver/include/driver/mcpwm.h \
  95     ../../components/driver/include/driver/pcnt.h \
  96     ../../components/driver/include/driver/rmt.h \
  97     ../../components/driver/include/driver/sigmadelta.h \
  98     ../../components/driver/include/driver/spi_common.h \
  99     ../../components/driver/include/driver/spi_master.h \
 100     ../../components/driver/include/driver/spi_slave.h \
 101     ../../components/driver/include/driver/timer.h \
 102     ../../components/driver/include/driver/touch_pad.h \
 103     ../../components/driver/include/driver/uart.h \
 104     ../../components/esp_adc_cal/include/esp_adc_cal.h \
 105     ../../components/soc/include/hal/spi_types.h \
 106     ../../components/soc/esp32/include/soc/adc_channel.h \
 107     ../../components/soc/esp32/include/soc/dac_channel.h \
 108     ../../components/soc/esp32/include/soc/touch_channel.h \
 109     ../../components/soc/esp32/include/soc/uart_channel.h \
 110     ../../components/soc/esp32/include/soc/rtc_gpio_channel.h \
 111     ## tcpip_adapter - API Reference
 112     ../../components/tcpip_adapter/include/tcpip_adapter.h \
 113     ##
 114     ## Protocols - API Reference
 115     ##
 116     ## ESP-TLS
 117     ../../components/esp-tls/esp_tls.h \
 118     ## MQTT
 119     ../../components/mqtt/esp-mqtt/include/mqtt_client.h \
 120     ## mDNS
 121     ../../components/mdns/include/mdns.h \
 122     ../../components/esp_http_client/include/esp_http_client.h \
 123     ../../components/esp_websocket_client/include/esp_websocket_client.h \
 124     ## HTTP / HTTPS Server
 125     ../../components/esp_http_server/include/esp_http_server.h \
 126     ../../components/esp_https_server/include/esp_https_server.h \
 127     ## ESP Local Ctrl
 128     ../../components/esp_local_ctrl/include/esp_local_ctrl.h \
 129     ##
 130     ## Provisioning - API Reference
 131     ##
 132     ## Protocol Communication
 133     ../../components/protocomm/include/common/protocomm.h \
 134     ../../components/protocomm/include/security/protocomm_security.h \
 135     ../../components/protocomm/include/security/protocomm_security0.h \
 136     ../../components/protocomm/include/security/protocomm_security1.h \
 137     ../../components/protocomm/include/transports/protocomm_ble.h \
 138     ../../components/protocomm/include/transports/protocomm_console.h \
 139     ../../components/protocomm/include/transports/protocomm_httpd.h \
 140     ## WiFi Provisioning
 141     ../../components/wifi_provisioning/include/wifi_provisioning/manager.h \
 142     ../../components/wifi_provisioning/include/wifi_provisioning/scheme_ble.h \
 143     ../../components/wifi_provisioning/include/wifi_provisioning/scheme_softap.h \
 144     ../../components/wifi_provisioning/include/wifi_provisioning/scheme_console.h \
 145     ../../components/wifi_provisioning/include/wifi_provisioning/wifi_config.h \
 146     ../../components/wifi_provisioning/include/wifi_provisioning/wifi_scan.h \
 147     ##
 148     ## Storage - API Reference
 149     ##
 150     ## SPI Flash and Partition APIs
 151     ../../components/spi_flash/include/esp_flash_spi_init.h \
 152     ../../components/spi_flash/include/esp_flash.h \
 153     ../../components/spi_flash/include/esp_partition.h \
 154     ../../components/bootloader_support/include/esp_flash_encrypt.h \
 155     ../../components/soc/include/hal/spi_flash_types.h \
 156     ## SPIFFS
 157     ../../components/spiffs/include/esp_spiffs.h \
 158     ## SD/MMC Card Host
 159     ../../components/sdmmc/include/sdmmc_cmd.h \
 160     ../../components/driver/include/driver/sdmmc_host.h \
 161     ../../components/driver/include/driver/sdmmc_types.h \
 162     ../../components/driver/include/driver/sdspi_host.h \
 163     ## SDIO slave
 164     ../../components/driver/include/driver/sdio_slave.h \
 165     ## Non-Volatile Storage
 166     ../../components/nvs_flash/include/nvs.h \
 167     ../../components/nvs_flash/include/nvs_flash.h \
 168     ## Virtual Filesystem
 169     ../../components/vfs/include/esp_vfs.h \
 170     ../../components/vfs/include/esp_vfs_dev.h \
 171     ../../components/vfs/include/esp_vfs_semihost.h \
 172     ## FAT Filesystem
 173     ## NOTE: for two lines below header_file.inc is not used
 174     ../../components/fatfs/vfs/esp_vfs_fat.h \
 175     ../../components/fatfs/diskio/diskio_impl.h \
 176     ../../components/fatfs/diskio/diskio_sdmmc.h \
 177     ../../components/fatfs/diskio/diskio_wl.h \
 178     ../../components/fatfs/diskio/diskio_rawflash.h \
 179     ## Wear Levelling
 180     ../../components/wear_levelling/include/wear_levelling.h \
 181     ##
 182     ## System - API Reference
 183     ##
 184     ## Memory Allocation    #
 185     ../../components/heap/include/esp_heap_caps.h \
 186     ../../components/heap/include/esp_heap_trace.h \
 187     ../../components/heap/include/esp_heap_caps_init.h \
 188     ../../components/heap/include/multi_heap.h \
 189     ## Himem
 190     ../../components/esp32/include/esp32/himem.h \
 191     ## Interrupt Allocation
 192     ../../components/esp32/include/esp_intr_alloc.h \
 193     ## Watchdogs
 194     ## NOTE: for two lines below header_file.inc is not used
 195     ../../components/esp_common/include/esp_int_wdt.h \
 196     ../../components/esp_common/include/esp_task_wdt.h \
 197     ## Hooks
 198     ../../components/esp_common/include/esp_freertos_hooks.h \
 199     ## Inter-Processor Call
 200     ../../components/esp_common/include/esp_ipc.h \
 201     ## Over The Air Updates (OTA)
 202     ../../components/app_update/include/esp_ota_ops.h \
 203     ## ESP HTTPS OTA
 204     ../../components/esp_https_ota/include/esp_https_ota.h \
 205     ## Sleep
 206     ../../components/esp32/include/esp_sleep.h \
 207     ## Logging
 208     ../../components/log/include/esp_log.h \
 209     ## Base MAC address
 210     ## NOTE: for line below header_file.inc is not used
 211     ../../components/esp_common/include/esp_system.h \
 212     ## IDF version
 213     ../../components/esp_common/include/esp_idf_version.h \
 214     ##
 215     ## ULP Coprocessor - API Guides
 216     ##
 217     ## NOTE: for line below header_file.inc is not used
 218     ../../components/ulp/include/esp32/ulp.h \
 219     ##
 220     ## Application Level Tracing - API Reference
 221     ##
 222     ../../components/app_trace/include/esp_app_trace.h \
 223     ../../components/app_trace/include/esp_sysview_trace.h \
 224     ### Power management
 225     ../../components/esp_common/include/esp_pm.h \
 226     ../../components/esp32/include/esp32/pm.h \
 227     ### esp_timer, High Resolution Timer
 228     ../../components/esp_common/include/esp_timer.h \
 229     ### esp_event, Event Loop Library
 230     ../../components/esp_event/include/esp_event.h \
 231     ../../components/esp_event/include/esp_event_base.h \
 232     ### eFuse Manager
 233     ../../components/efuse/include/esp_efuse.h \
 234     ### App Image Format
 235     ../../components/bootloader_support/include/esp_app_format.h \
 236     ### ESP Pthread parameters
 237     ../../components/pthread/include/esp_pthread.h \
 238     ###
 239     ### FreeRTOS
 240     ###
 241     ../../components/freertos/include/freertos/task.h \
 242     ../../components/freertos/include/freertos/queue.h \
 243     ../../components/freertos/include/freertos/semphr.h \
 244     ../../components/freertos/include/freertos/timers.h \
 245     ../../components/freertos/include/freertos/event_groups.h \
 246     ### Ringbuffer
 247     ../../components/esp_ringbuf/include/freertos/ringbuf.h \
 248     ### Helper functions for error codes
 249     ../../components/esp_common/include/esp_err.h \
 250     ### System APIs
 251     ../../components/esp_common/include/esp_system.h \
 252     ### Modbus controller component header file
 253     ../../components/freemodbus/common/include/esp_modbus_common.h \
 254     ../../components/freemodbus/common/include/esp_modbus_slave.h \
 255     ../../components/freemodbus/common/include/esp_modbus_master.h
 256
 257
 258 ## Get warnings for functions that have no documentation for their parameters or return value
 259 ##
 260 WARN_NO_PARAMDOC = YES
 261
 262 ## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
 263 ##
 264 ENABLE_PREPROCESSING   = YES
 265 MACRO_EXPANSION        = YES
 266 EXPAND_ONLY_PREDEF     = YES
 267 PREDEFINED             = \
 268     __attribute__(x)= \
 269     IDF_DEPRECATED(X)= \
 270     IRAM_ATTR= \
 271     configSUPPORT_DYNAMIC_ALLOCATION=1 \
 272     configSUPPORT_STATIC_ALLOCATION=1 \
 273     configQUEUE_REGISTRY_SIZE=1 \
 274     configUSE_RECURSIVE_MUTEXES=1 \
 275     configTHREAD_LOCAL_STORAGE_DELETE_CALLBACKS=1 \
 276     configNUM_THREAD_LOCAL_STORAGE_POINTERS=1 \
 277     configUSE_APPLICATION_TASK_TAG=1 \
 278     configTASKLIST_INCLUDE_COREID=1 \
 279     "ESP_EVENT_DECLARE_BASE(x)=extern esp_event_base_t x"
 280
 281 ## Do not complain about not having dot
 282 ##
 283 HAVE_DOT = NO
 284
 285 ## Generate XML that is required for Breathe
 286 ##
 287 GENERATE_XML    = YES
 288 XML_OUTPUT      = xml
 289
 290 GENERATE_HTML   = NO
 291 HAVE_DOT        = NO
 292 GENERATE_LATEX  = NO
 293 GENERATE_MAN    = YES
 294 GENERATE_RTF    = NO
 295
 296 ## Skip distracting progress messages
 297 ##
 298 QUIET = YES
 299 ## Log warnings in a file for further review
 300 ##
 301 WARN_LOGFILE = "doxygen-warning-log.txt"
 302