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