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/http_server/include/http_server.h \
 101     ##
 102     ## Storage - API Reference
 103     ##
 104     ## SPI Flash and Partition APIs
 105     ../../components/spi_flash/include/esp_spi_flash.h \
 106     ../../components/spi_flash/include/esp_partition.h \
 107     ../../components/bootloader_support/include/esp_flash_encrypt.h \
 108     ## SPIFFS
 109     ../../components/spiffs/include/esp_spiffs.h \
 110     ## SD/MMC Card Host
 111     ../../components/sdmmc/include/sdmmc_cmd.h \
 112     ../../components/driver/include/driver/sdmmc_host.h \
 113     ../../components/driver/include/driver/sdmmc_types.h \
 114     ../../components/driver/include/driver/sdspi_host.h \
 115     ## SDIO slave
 116     ../../components/driver/include/driver/sdio_slave.h \
 117     ## Non-Volatile Storage
 118     ../../components/nvs_flash/include/nvs.h \
 119     ../../components/nvs_flash/include/nvs_flash.h \
 120     ## Virtual Filesystem
 121     ../../components/vfs/include/esp_vfs.h \
 122     ../../components/vfs/include/esp_vfs_dev.h \
 123     ## FAT Filesystem
 124     ## NOTE: for two lines below header_file.inc is not used
 125     ../../components/fatfs/src/esp_vfs_fat.h \
 126     ../../components/fatfs/src/diskio.h \
 127     ## Wear Levelling
 128     ../../components/wear_levelling/include/wear_levelling.h \
 129     ##
 130     ## System - API Reference
 131     ##
 132     ## Memory Allocation    #
 133     ../../components/heap/include/esp_heap_caps.h \
 134     ../../components/heap/include/esp_heap_trace.h \
 135     ../../components/heap/include/esp_heap_caps_init.h \
 136     ../../components/heap/include/multi_heap.h \
 137     ## Interrupt Allocation
 138     ../../components/esp32/include/esp_intr_alloc.h \
 139     ## Watchdogs
 140     ## NOTE: for two lines below header_file.inc is not used
 141     ../../components/esp32/include/esp_int_wdt.h \
 142     ../../components/esp32/include/esp_task_wdt.h \
 143     ## Hooks
 144     ../../components/esp32/include/esp_freertos_hooks.h \
 145     ## Inter-Processor Call
 146     ../../components/esp32/include/esp_ipc.h \
 147     ## Over The Air Updates (OTA)
 148     ../../components/app_update/include/esp_ota_ops.h \
 149     ## ESP HTTPS OTA
 150     ../../components/esp_https_ota/include/esp_https_ota.h \
 151     ## Sleep
 152     ../../components/esp32/include/esp_sleep.h \
 153     ## Logging
 154     ../../components/log/include/esp_log.h \
 155     ## Base MAC address
 156     ## NOTE: for line below header_file.inc is not used
 157     ../../components/esp32/include/esp_system.h \
 158     ##
 159     ## ULP Coprocessor - API Guides
 160     ##
 161     ## NOTE: for line below header_file.inc is not used
 162     ../../components/ulp/include/esp32/ulp.h \
 163     ##
 164     ## Application Level Tracing - API Reference
 165     ##
 166     ../../components/app_trace/include/esp_app_trace.h \
 167     ### Power management
 168     ../../components/esp32/include/esp_pm.h \
 169     ../../components/esp32/include/esp32/pm.h \
 170     ### esp_timer, High Resolution Timer
 171     ../../components/esp32/include/esp_timer.h \
 172     ### ESP Pthread parameters
 173     ../../components/pthread/include/esp_pthread.h \
 174     ###
 175     ### FreeRTOS
 176     ###
 177     ../../components/freertos/include/freertos/task.h \
 178     ../../components/freertos/include/freertos/queue.h \
 179     ../../components/freertos/include/freertos/semphr.h \
 180     ../../components/freertos/include/freertos/timers.h \
 181     ../../components/freertos/include/freertos/event_groups.h \
 182     ### Ringbuffer
 183     ../../components/esp_ringbuf/include/freertos/ringbuf.h \
 184     ### Helper functions for error codes
 185     ../../components/esp32/include/esp_err.h \
 186     ### System APIs
 187     ../../components/esp32/include/esp_system.h
 188
 189
 190
 191 ## Get warnings for functions that have no documentation for their parameters or return value
 192 ##
 193 WARN_NO_PARAMDOC = YES
 194
 195 ## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
 196 ##
 197 ENABLE_PREPROCESSING   = YES
 198 MACRO_EXPANSION        = YES
 199 EXPAND_ONLY_PREDEF     = YES
 200 PREDEFINED             = \
 201     __attribute__(x)= \
 202     IRAM_ATTR= \
 203     configSUPPORT_DYNAMIC_ALLOCATION=1 \
 204     configSUPPORT_STATIC_ALLOCATION=1 \
 205     configQUEUE_REGISTRY_SIZE=1 \
 206     configUSE_RECURSIVE_MUTEXES=1 \
 207     configTHREAD_LOCAL_STORAGE_DELETE_CALLBACKS=1 \
 208     configNUM_THREAD_LOCAL_STORAGE_POINTERS=1 \
 209     configUSE_APPLICATION_TASK_TAG=1 \
 210     configTASKLIST_INCLUDE_COREID=1
 211
 212 ## Do not complain about not having dot
 213 ##
 214 HAVE_DOT = NO
 215
 216 ## Generate XML that is required for Breathe
 217 ##
 218 GENERATE_XML    = YES
 219 XML_OUTPUT      = xml
 220
 221 GENERATE_HTML   = NO
 222 HAVE_DOT        = NO
 223 GENERATE_LATEX  = NO
 224 GENERATE_MAN    = YES
 225 GENERATE_RTF    = NO
 226
 227 ## Skip distracting progress messages
 228 ##
 229 QUIET = YES
 230 ## Log warnings in a file for further review
 231 ##
 232 WARN_LOGFILE = "doxygen-warning-log.txt"
 233