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 # http://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_crypto_types.h \
  29     ../components/esp32/include/esp_smartconfig.h \
  30     ## Bluetooth - API Reference
  31     ## Controller && VHCI
  32     ../components/bt/include/bt.h \
  33     ## Bluetooth COMMON
  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 \
  38     ## Bluetooth LE
  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 \
  45     ## Bluetooth Classic
  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 \
  50     ##
  51     ## Ethernet - API Reference
  52     ##
  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 \
  57     ##
  58     ## Peripherals - API Reference
  59     ##
  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     ##
  79     ## Protocols - API Reference
  80     ##
  81     ../components/mdns/include/mdns.h \
  82     ##
  83     ## Storage - API Reference
  84     ##
  85     ## SPI Flash and Partition APIs
  86     ../components/spi_flash/include/esp_spi_flash.h \
  87     ../components/spi_flash/include/esp_partition.h \
  88     ../components/bootloader_support/include/esp_flash_encrypt.h \
  89     ## SD/MMC Card Host
  90     ## NOTE: for three lines below header_file.inc is not used
  91     ../components/sdmmc/include/sdmmc_cmd.h \
  92     ../components/driver/include/driver/sdmmc_host.h \
  93     ../components/driver/include/driver/sdmmc_types.h \
  94     ../components/driver/include/driver/sdspi_host.h \
  95     ## Non-Volatile Storage
  96     ../components/nvs_flash/include/nvs.h \
  97     ../components/nvs_flash/include/nvs_flash.h \
  98     ## Virtual Filesystem
  99     ../components/vfs/include/esp_vfs.h \
 100     ../components/vfs/include/esp_vfs_dev.h \
 101     ## FAT Filesystem
 102     ## NOTE: for two lines below header_file.inc is not used
 103     ../components/fatfs/src/esp_vfs_fat.h \
 104     ../components/fatfs/src/diskio.h \
 105     ## Wear Levelling
 106     ../components/wear_levelling/include/wear_levelling.h \
 107     ##
 108     ## System - API Reference
 109     ##
 110     ## Memory Allocation    #
 111     ../components/heap/include/esp_heap_caps.h \
 112     ../components/heap/include/multi_heap.h \
 113     ## Interrupt Allocation
 114     ../components/esp32/include/esp_intr_alloc.h \
 115     ## Watchdogs
 116     ## NOTE: for two lines below header_file.inc is not used
 117     ../components/esp32/include/esp_int_wdt.h \
 118     ../components/esp32/include/esp_task_wdt.h \
 119     ## Over The Air Updates (OTA)
 120     ../components/app_update/include/esp_ota_ops.h \
 121     ## Deep Sleep
 122     ## NOTE: for line below header_file.inc is not used
 123     ../components/esp32/include/esp_deep_sleep.h \
 124     ## Logging
 125     ../components/log/include/esp_log.h \
 126     ## Base MAC address
 127     ## NOTE: for line below header_file.inc is not used
 128     ../components/esp32/include/esp_system.h \
 129     ##
 130     ## ULP Coprocessor - API Guides
 131     ##
 132     ## NOTE: for line below header_file.inc is not used
 133     ../components/ulp/include/esp32/ulp.h \
 134     ##
 135     ## Application Level Tracing - API Reference
 136     ##
 137     ../components/app_trace/include/esp_app_trace.h
 138
 139
 140 ## Get warnings for functions that have no documentation for their parameters or return value
 141 ##
 142 WARN_NO_PARAMDOC = YES
 143
 144 ## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
 145 ##
 146 ENABLE_PREPROCESSING   = YES
 147 MACRO_EXPANSION        = YES
 148 EXPAND_ONLY_PREDEF     = YES
 149 PREDEFINED             = __attribute__(x)=
 150
 151 ## Do not complain about not having dot
 152 ##
 153 HAVE_DOT = NO
 154
 155 ## Generate XML that is required for Breathe
 156 ##
 157 GENERATE_XML    = YES
 158 XML_OUTPUT      = xml
 159
 160 GENERATE_HTML   = NO
 161 HAVE_DOT        = NO
 162 GENERATE_LATEX  = NO
 163 GENERATE_MAN    = YES
 164 GENERATE_RTF    = NO
 165
 166 ## Skip distracting progress messages
 167 ##
 168 QUIET = YES
 169 ## Log warnings in a file for further review
 170 ##
 171 WARN_LOGFILE = "doxygen-warning-log.txt"
 172