2016-11-16 14:27:55 -05:00
|
|
|
# This is Doxygen configuration file
|
|
|
|
|
#
|
|
|
|
|
# Doxygen provides over 260 configuration statements
|
|
|
|
|
# To make this file easier to follow,
|
|
|
|
|
# it contains only statements that are non-default
|
|
|
|
|
#
|
|
|
|
|
# NOTE:
|
|
|
|
|
# It is recommended not to change defaults unless specifically required
|
|
|
|
|
# Test any changes how they affect generated documentation
|
|
|
|
|
# Make sure that correct warnings are generated to flag issues with documented code
|
|
|
|
|
#
|
|
|
|
|
# For the complete list of configuration statements see:
|
|
|
|
|
# http://www.stack.nl/~dimitri/doxygen/manual/config.html
|
|
|
|
|
|
|
|
|
|
|
2016-10-26 15:08:36 -04:00
|
|
|
PROJECT_NAME = "ESP32 Programming Guide"
|
2016-10-29 17:00:30 -04:00
|
|
|
|
2016-11-16 08:33:04 -05:00
|
|
|
INPUT = ../components/esp32/include/esp_wifi.h \
|
|
|
|
|
../components/driver/include/driver \
|
|
|
|
|
../components/bt/include \
|
2016-12-01 07:20:22 -05:00
|
|
|
../components/bt/bluedroid/api/include \
|
2016-11-16 08:33:04 -05:00
|
|
|
../components/nvs_flash/include \
|
|
|
|
|
../components/log/include \
|
|
|
|
|
../components/vfs/include \
|
2016-11-17 07:21:12 -05:00
|
|
|
../components/spi_flash/include \
|
|
|
|
|
../components/esp32/include/esp_int_wdt.h \
|
2016-11-28 00:53:03 -05:00
|
|
|
../components/esp32/include/esp_task_wdt.h \
|
2016-11-08 04:45:17 -05:00
|
|
|
../components/app_update/include/esp_ota_ops.h \
|
2016-11-29 09:10:31 -05:00
|
|
|
../components/ethernet/include/esp_eth.h \
|
2016-11-25 04:33:51 -05:00
|
|
|
../components/ulp/include/esp32/ulp.h \
|
2016-12-13 04:01:10 -05:00
|
|
|
../components/esp32/include/esp_intr_alloc.h \
|
|
|
|
|
../components/esp32/include/esp_heap_alloc_caps.h \
|
2016-12-11 21:00:24 -05:00
|
|
|
../components/freertos/include/freertos/heap_regions.h \
|
2016-12-16 01:26:52 -05:00
|
|
|
../components/esp32/include/esp_smartconfig.h \
|
2017-01-08 15:09:09 -05:00
|
|
|
../components/esp32/include/esp_deep_sleep.h \
|
|
|
|
|
../components/sdmmc/include/sdmmc_cmd.h \
|
|
|
|
|
../components/fatfs/src/esp_vfs_fat.h \
|
2017-01-06 05:06:43 -05:00
|
|
|
../components/fatfs/src/diskio.h \
|
2017-01-04 11:54:07 -05:00
|
|
|
../components/esp32/include/esp_core_dump.h \
|
2017-02-13 20:48:28 -05:00
|
|
|
../components/mdns/include/mdns.h \
|
2017-04-10 10:06:35 -04:00
|
|
|
../components/bootloader_support/include/esp_flash_encrypt.h \
|
|
|
|
|
../components/wear_levelling/include/wear_levelling.h
|
|
|
|
|
|
2016-10-29 17:00:30 -04:00
|
|
|
|
2016-11-16 14:27:55 -05:00
|
|
|
## Get warnings for functions that have no documentation for their parameters or return value
|
|
|
|
|
##
|
|
|
|
|
WARN_NO_PARAMDOC = YES
|
2016-10-29 17:00:30 -04:00
|
|
|
|
2016-11-16 14:27:55 -05:00
|
|
|
## Do not complain about not having dot
|
|
|
|
|
##
|
|
|
|
|
HAVE_DOT = NO
|
2016-10-29 17:00:30 -04:00
|
|
|
|
2016-11-16 14:27:55 -05:00
|
|
|
## Generate XML that is required for Breathe
|
|
|
|
|
##
|
|
|
|
|
GENERATE_XML = YES
|
|
|
|
|
XML_OUTPUT = xml
|
2016-10-29 17:00:30 -04:00
|
|
|
|
|
|
|
|
GENERATE_HTML = NO
|
|
|
|
|
HAVE_DOT = NO
|
|
|
|
|
GENERATE_LATEX = NO
|
2016-11-15 12:35:09 -05:00
|
|
|
GENERATE_MAN = YES
|
2016-10-29 17:00:30 -04:00
|
|
|
GENERATE_RTF = NO
|
|
|
|
|
|
2016-11-16 14:27:55 -05:00
|
|
|
## Skip distracting progress messages
|
|
|
|
|
##
|
|
|
|
|
QUIET = YES
|
|
|
|
|
## Log warnings in a file for further review
|
|
|
|
|
##
|
2016-10-29 17:00:30 -04:00
|
|
|
WARN_LOGFILE = "doxygen-warning-log.txt"
|
