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/esp32/include/esp_wifi.h \
  28     ../../components/esp32/include/esp_wifi_types.h \
  29     ../../components/esp32/include/esp_smartconfig.h \
  30     ../../components/esp32/include/esp_now.h \
  31     ## Mesh - API Reference
  32     ../../components/esp32/include/esp_mesh.h \
  33     ## Bluetooth - API Reference
  34     ## Controller && VHCI
  35     ../../components/bt/include/esp_bt.h \
  36     ## Bluetooth COMMON
  37     ## Issue with __attribute__
  38     ../../components/bt/bluedroid/api/include/api/esp_bt_defs.h \
  39     ../../components/bt/bluedroid/api/include/api/esp_bt_main.h \
  40     ../../components/bt/bluedroid/api/include/api/esp_bt_device.h \
  41     ## Bluetooth LE
  42     ../../components/bt/bluedroid/api/include/api/esp_gap_ble_api.h \
  43     ## Issue with __attribute__
  44     ../../components/bt/bluedroid/api/include/api/esp_gatt_defs.h \
  45     ../../components/bt/bluedroid/api/include/api/esp_gatts_api.h \
  46     ../../components/bt/bluedroid/api/include/api/esp_gattc_api.h \
  47     ../../components/bt/bluedroid/api/include/api/esp_blufi_api.h \
  48     ## Bluetooth Classic
  49     ../../components/bt/bluedroid/api/include/api/esp_gap_bt_api.h \
  50     ## Issue with __attribute__
  51     ../../components/bt/bluedroid/api/include/api/esp_a2dp_api.h \
  52     ../../components/bt/bluedroid/api/include/api/esp_avrc_api.h \
  53     ../../components/bt/bluedroid/api/include/api/esp_spp_api.h \
  54     ../../components/bt/bluedroid/api/include/api/esp_hf_defs.h \
  55     ../../components/bt/bluedroid/api/include/api/esp_hf_client_api.h \
  56     ##
  57     ## Ethernet - API Reference
  58     ##
  59     ../../components/ethernet/include/esp_eth.h \
  60     ../../components/ethernet/include/eth_phy/phy.h \
  61     ../../components/ethernet/include/eth_phy/phy_tlk110.h \
  62     ../../components/ethernet/include/eth_phy/phy_lan8720.h \
  63     ##
  64     ## Peripherals - API Reference
  65     ##
  66     ../../components/driver/include/driver/adc.h \
  67     ../../components/driver/include/driver/can.h \
  68     ../../components/driver/include/driver/dac.h \
  69     ../../components/driver/include/driver/gpio.h \
  70     ../../components/driver/include/driver/rtc_io.h \
  71     ../../components/driver/include/driver/i2c.h \
  72     ../../components/driver/include/driver/i2s.h \
  73     ../../components/driver/include/driver/ledc.h \
  74     ../../components/driver/include/driver/mcpwm.h \
  75     ../../components/driver/include/driver/pcnt.h \
  76     ../../components/driver/include/driver/rmt.h \
  77     ../../components/driver/include/driver/sigmadelta.h \
  78     ../../components/driver/include/driver/spi_common.h \
  79     ../../components/driver/include/driver/spi_master.h \
  80     ../../components/driver/include/driver/spi_slave.h \
  81     ../../components/driver/include/driver/timer.h \
  82     ../../components/driver/include/driver/touch_pad.h \
  83     ../../components/driver/include/driver/uart.h \
  84     ../../components/esp_adc_cal/include/esp_adc_cal.h \
  85     ../../components/soc/esp32/include/soc/adc_channel.h \
  86     ../../components/soc/esp32/include/soc/dac_channel.h \
  87     ../../components/soc/esp32/include/soc/touch_channel.h \
  88     ../../components/soc/esp32/include/soc/uart_channel.h \
  89     ../../components/soc/esp32/include/soc/rtc_gpio_channel.h \
  90     ##
  91     ## Protocols - API Reference
  92     ##
  93     ## ESP-TLS
  94     ../../components/esp-tls/esp_tls.h \
  95     ## MQTT
  96     ../../components/mqtt/esp-mqtt/include/mqtt_client.h \
  97     ## mDNS
  98     ../../components/mdns/include/mdns.h \
  99     ../../components/esp_http_client/include/esp_http_client.h \
 100     ../../components/esp_http_server/include/esp_http_server.h \
 101     ##
 102     ## Provisioning - API Reference
 103     ##
 104     ## Protocol Communication
 105     ../../components/protocomm/include/common/protocomm.h \
 106     ../../components/protocomm/include/security/protocomm_security.h \
 107     ../../components/protocomm/include/security/protocomm_security0.h \
 108     ../../components/protocomm/include/security/protocomm_security1.h \
 109     ../../components/protocomm/include/transports/protocomm_ble.h \
 110     ../../components/protocomm/include/transports/protocomm_console.h \
 111     ../../components/protocomm/include/transports/protocomm_httpd.h \
 112     ## WiFi Provisioning
 113     ../../components/wifi_provisioning/include/wifi_provisioning/wifi_config.h \
 114     ##
 115     ## Storage - API Reference
 116     ##
 117     ## SPI Flash and Partition APIs
 118     ../../components/spi_flash/include/esp_spi_flash.h \
 119     ../../components/spi_flash/include/esp_partition.h \
 120     ../../components/bootloader_support/include/esp_flash_encrypt.h \
 121     ## SPIFFS
 122     ../../components/spiffs/include/esp_spiffs.h \
 123     ## SD/MMC Card Host
 124     ../../components/sdmmc/include/sdmmc_cmd.h \
 125     ../../components/driver/include/driver/sdmmc_host.h \
 126     ../../components/driver/include/driver/sdmmc_types.h \
 127     ../../components/driver/include/driver/sdspi_host.h \
 128     ## SDIO slave
 129     ../../components/driver/include/driver/sdio_slave.h \
 130     ## Non-Volatile Storage
 131     ../../components/nvs_flash/include/nvs.h \
 132     ../../components/nvs_flash/include/nvs_flash.h \
 133     ## Virtual Filesystem
 134     ../../components/vfs/include/esp_vfs.h \
 135     ../../components/vfs/include/esp_vfs_dev.h \
 136     ## FAT Filesystem
 137     ## NOTE: for two lines below header_file.inc is not used
 138     ../../components/fatfs/src/esp_vfs_fat.h \
 139     ../../components/fatfs/src/diskio.h \
 140     ## Wear Levelling
 141     ../../components/wear_levelling/include/wear_levelling.h \
 142     ##
 143     ## System - API Reference
 144     ##
 145     ## Memory Allocation    #
 146     ../../components/heap/include/esp_heap_caps.h \
 147     ../../components/heap/include/esp_heap_trace.h \
 148     ../../components/heap/include/esp_heap_caps_init.h \
 149     ../../components/heap/include/multi_heap.h \
 150     ## Himem
 151     ../../components/esp32/include/esp_himem.h \
 152     ## Interrupt Allocation
 153     ../../components/esp32/include/esp_intr_alloc.h \
 154     ## Watchdogs
 155     ## NOTE: for two lines below header_file.inc is not used
 156     ../../components/esp32/include/esp_int_wdt.h \
 157     ../../components/esp32/include/esp_task_wdt.h \
 158     ## Hooks
 159     ../../components/esp32/include/esp_freertos_hooks.h \
 160     ## Inter-Processor Call
 161     ../../components/esp32/include/esp_ipc.h \
 162     ## Over The Air Updates (OTA)
 163     ../../components/app_update/include/esp_ota_ops.h \
 164     ## ESP HTTPS OTA
 165     ../../components/esp_https_ota/include/esp_https_ota.h \
 166     ## Sleep
 167     ../../components/esp32/include/esp_sleep.h \
 168     ## Logging
 169     ../../components/log/include/esp_log.h \
 170     ## Base MAC address
 171     ## NOTE: for line below header_file.inc is not used
 172     ../../components/esp32/include/esp_system.h \
 173     ##
 174     ## ULP Coprocessor - API Guides
 175     ##
 176     ## NOTE: for line below header_file.inc is not used
 177     ../../components/ulp/include/esp32/ulp.h \
 178     ##
 179     ## Application Level Tracing - API Reference
 180     ##
 181     ../../components/app_trace/include/esp_app_trace.h \
 182     ### Power management
 183     ../../components/esp32/include/esp_pm.h \
 184     ../../components/esp32/include/esp32/pm.h \
 185     ### esp_timer, High Resolution Timer
 186     ../../components/esp32/include/esp_timer.h \
 187     ### esp_event, Event Loop Library
 188     ../../components/esp_event/include/esp_event.h \
 189     ../../components/esp_event/include/esp_event_base.h \
 190     ### ESP Pthread parameters
 191     ../../components/pthread/include/esp_pthread.h \
 192     ###
 193     ### FreeRTOS
 194     ###
 195     ../../components/freertos/include/freertos/task.h \
 196     ../../components/freertos/include/freertos/queue.h \
 197     ../../components/freertos/include/freertos/semphr.h \
 198     ../../components/freertos/include/freertos/timers.h \
 199     ../../components/freertos/include/freertos/event_groups.h \
 200     ### Ringbuffer
 201     ../../components/esp_ringbuf/include/freertos/ringbuf.h \
 202     ### Helper functions for error codes
 203     ../../components/esp32/include/esp_err.h \
 204     ### System APIs
 205     ../../components/esp32/include/esp_system.h \
 206     ### Modbus controller component header file
 207     ../../components/freemodbus/modbus_controller/mbcontroller.h
 208
 209 ## Get warnings for functions that have no documentation for their parameters or return value
 210 ##
 211 WARN_NO_PARAMDOC = YES
 212
 213 ## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
 214 ##
 215 ENABLE_PREPROCESSING   = YES
 216 MACRO_EXPANSION        = YES
 217 EXPAND_ONLY_PREDEF     = YES
 218 PREDEFINED             = \
 219     __attribute__(x)= \
 220     IRAM_ATTR= \
 221     configSUPPORT_DYNAMIC_ALLOCATION=1 \
 222     configSUPPORT_STATIC_ALLOCATION=1 \
 223     configQUEUE_REGISTRY_SIZE=1 \
 224     configUSE_RECURSIVE_MUTEXES=1 \
 225     configTHREAD_LOCAL_STORAGE_DELETE_CALLBACKS=1 \
 226     configNUM_THREAD_LOCAL_STORAGE_POINTERS=1 \
 227     configUSE_APPLICATION_TASK_TAG=1 \
 228     configTASKLIST_INCLUDE_COREID=1
 229
 230 ## Do not complain about not having dot
 231 ##
 232 HAVE_DOT = NO
 233
 234 ## Generate XML that is required for Breathe
 235 ##
 236 GENERATE_XML    = YES
 237 XML_OUTPUT      = xml
 238
 239 GENERATE_HTML   = NO
 240 HAVE_DOT        = NO
 241 GENERATE_LATEX  = NO
 242 GENERATE_MAN    = YES
 243 GENERATE_RTF    = NO
 244
 245 ## Skip distracting progress messages
 246 ##
 247 QUIET = YES
 248 ## Log warnings in a file for further review
 249 ##
 250 WARN_LOGFILE = "doxygen-warning-log.txt"
 251