OVMS3-idf/docs/Doxyfile
Wangjialin 842caaab21 driver(touch): fix bug and add more features
1. add sens_struct.h
2. add definition of RTCCNTL and RTCIO
3. modify touch pad examples
4. update example code.
5. add comments add option in menuconfig
6. fix issue that pad index 8 and 9 are mismatched
7. add touch_pad_read_filtered() api to get value filtered by iir filter
8. modify touch pad isr func
9. Make the items in perihperal.ld in the sequence of address
10. delete Kconfig for touch pad
11. add touchpad filter APIs to adjust the filter
12. add touch_pad into index.rst
13. add touch_pad in Doxyfile
14. add touch_pad.rst
2017-08-22 21:21:39 +08:00

172 lines
5.9 KiB
Plaintext

# 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
PROJECT_NAME = "ESP32 Programming Guide"
## The 'INPUT' statement below is used as input by script 'gen-df-input.py'
## to automatically generate API reference list files heder_file.inc
## These files are placed in '_inc' directory
## and used to include in API reference documentation
INPUT = \
##
## Wi-Fi - API Reference
##
../components/esp32/include/esp_wifi.h \
../components/esp32/include/esp_wifi_crypto_types.h \
../components/esp32/include/esp_smartconfig.h \
## Bluetooth - API Reference
## Controller && VHCI
../components/bt/include/bt.h \
## Bluetooth COMMON
## Issue with __attribute__
../components/bt/bluedroid/api/include/esp_bt_defs.h \
../components/bt/bluedroid/api/include/esp_bt_main.h \
../components/bt/bluedroid/api/include/esp_bt_device.h \
## Bluetooth LE
../components/bt/bluedroid/api/include/esp_gap_ble_api.h \
## Issue with __attribute__
../components/bt/bluedroid/api/include/esp_gatt_defs.h \
../components/bt/bluedroid/api/include/esp_gatts_api.h \
../components/bt/bluedroid/api/include/esp_gattc_api.h \
../components/bt/bluedroid/api/include/esp_blufi_api.h \
## Bluetooth Classic
../components/bt/bluedroid/api/include/esp_gap_bt_api.h \
## Issue with __attribute__
../components/bt/bluedroid/api/include/esp_a2dp_api.h \
../components/bt/bluedroid/api/include/esp_avrc_api.h \
##
## Ethernet - API Reference
##
../components/ethernet/include/esp_eth.h \
../components/ethernet/include/eth_phy/phy.h \
../components/ethernet/include/eth_phy/phy_tlk110.h \
../components/ethernet/include/eth_phy/phy_lan8720.h \
##
## Peripherals - API Reference
##
../components/driver/include/driver/adc.h \
../components/driver/include/driver/dac.h \
../components/driver/include/driver/gpio.h \
../components/driver/include/driver/rtc_io.h \
../components/driver/include/driver/i2c.h \
../components/driver/include/driver/i2s.h \
../components/driver/include/driver/ledc.h \
../components/driver/include/driver/mcpwm.h \
../components/driver/include/driver/pcnt.h \
../components/driver/include/driver/rmt.h \
../components/driver/include/driver/sigmadelta.h \
../components/driver/include/driver/spi_common.h \
../components/driver/include/driver/spi_master.h \
../components/driver/include/driver/spi_slave.h \
../components/driver/include/driver/timer.h \
../components/driver/include/driver/touch_pad.h \
../components/driver/include/driver/uart.h \
##
## Protocols - API Reference
##
../components/mdns/include/mdns.h \
##
## Storage - API Reference
##
## SPI Flash and Partition APIs
../components/spi_flash/include/esp_spi_flash.h \
../components/spi_flash/include/esp_partition.h \
../components/bootloader_support/include/esp_flash_encrypt.h \
## SD/MMC Card Host
## NOTE: for three lines below header_file.inc is not used
../components/sdmmc/include/sdmmc_cmd.h \
../components/driver/include/driver/sdmmc_host.h \
../components/driver/include/driver/sdmmc_types.h \
../components/driver/include/driver/sdspi_host.h \
## Non-Volatile Storage
../components/nvs_flash/include/nvs.h \
../components/nvs_flash/include/nvs_flash.h \
## Virtual Filesystem
../components/vfs/include/esp_vfs.h \
../components/vfs/include/esp_vfs_dev.h \
## FAT Filesystem
## NOTE: for two lines below header_file.inc is not used
../components/fatfs/src/esp_vfs_fat.h \
../components/fatfs/src/diskio.h \
## Wear Levelling
../components/wear_levelling/include/wear_levelling.h \
##
## System - API Reference
##
## Memory Allocation #
../components/heap/include/esp_heap_caps.h \
../components/heap/include/multi_heap.h \
## Interrupt Allocation
../components/esp32/include/esp_intr_alloc.h \
## Watchdogs
## NOTE: for two lines below header_file.inc is not used
../components/esp32/include/esp_int_wdt.h \
../components/esp32/include/esp_task_wdt.h \
## Over The Air Updates (OTA)
../components/app_update/include/esp_ota_ops.h \
## Deep Sleep
## NOTE: for line below header_file.inc is not used
../components/esp32/include/esp_deep_sleep.h \
## Logging
../components/log/include/esp_log.h \
## Base MAC address
## NOTE: for line below header_file.inc is not used
../components/esp32/include/esp_system.h \
##
## ULP Coprocessor - API Guides
##
## NOTE: for line below header_file.inc is not used
../components/ulp/include/esp32/ulp.h \
##
## Application Level Tracing - API Reference
##
../components/app_trace/include/esp_app_trace.h
## Get warnings for functions that have no documentation for their parameters or return value
##
WARN_NO_PARAMDOC = YES
## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
##
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = __attribute__(x)=
## Do not complain about not having dot
##
HAVE_DOT = NO
## Generate XML that is required for Breathe
##
GENERATE_XML = YES
XML_OUTPUT = xml
GENERATE_HTML = NO
HAVE_DOT = NO
GENERATE_LATEX = NO
GENERATE_MAN = YES
GENERATE_RTF = NO
## Skip distracting progress messages
##
QUIET = YES
## Log warnings in a file for further review
##
WARN_LOGFILE = "doxygen-warning-log.txt"