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