Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
OVMS3-idf/docs/Doxyfile

219 lines
8 KiB
Text
Raw Normal View History

Doxygen configuration clean up
2016-11-16 19:27:55 +00:00
# This is Doxygen configuration file
#
# Doxygen provides over 260 configuration statements
esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load
2017-03-22 03:07:37 +00:00
# To make this file easier to follow,
Doxygen configuration clean up
2016-11-16 19:27:55 +00:00
# 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:
Mass replacement of http with https urls, fixed broken urls
2017-09-05 19:58:31 +00:00
# https://www.stack.nl/~dimitri/doxygen/manual/config.html
Doxygen configuration clean up
2016-11-16 19:27:55 +00:00
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst
2016-10-26 19:08:36 +00:00
PROJECT_NAME = "ESP32 Programming Guide"
API samples - Logging library - Virtual file system component
2016-10-29 21:00:30 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## The 'INPUT' statement below is used as input by script 'gen-df-input.py'
## to automatically generate API reference list files heder_file.inc
esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load
2017-03-22 03:07:37 +00:00
## These files are placed in '_inc' directory
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## and used to include in API reference documentation
INPUT = \
##
## Wi-Fi - API Reference
##
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/esp32/include/esp_wifi.h \
../../components/esp32/include/esp_wifi_types.h \
../../components/esp32/include/esp_smartconfig.h \
../../components/esp32/include/esp_now.h \
add mesh feature
2018-02-27 10:22:20 +00:00
## Mesh - API Reference
../../components/esp32/include/esp_mesh.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Bluetooth - API Reference
## Controller && VHCI
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/bt/include/bt.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Bluetooth COMMON
## Issue with __attribute__
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../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 \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Bluetooth LE
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/bt/bluedroid/api/include/esp_gap_ble_api.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Issue with __attribute__
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../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 \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Bluetooth Classic
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/bt/bluedroid/api/include/esp_gap_bt_api.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Issue with __attribute__
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/bt/bluedroid/api/include/esp_a2dp_api.h \
../../components/bt/bluedroid/api/include/esp_avrc_api.h \
../../components/bt/bluedroid/api/include/esp_spp_api.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
##
## Ethernet - API Reference
##
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../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 \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
##
## Peripherals - API Reference
##
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../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 \
../../components/esp_adc_cal/include/esp_adc_cal.h \
../../components/soc/esp32/include/soc/adc_channel.h \
../../components/soc/esp32/include/soc/dac_channel.h \
../../components/soc/esp32/include/soc/touch_channel.h \
../../components/soc/esp32/include/soc/uart_channel.h \
../../components/soc/esp32/include/soc/rtc_gpio_channel.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
##
## Protocols - API Reference
##
Resolved Issues
2018-02-14 09:45:50 +00:00
## ESP-TLS
../../components/esp-tls/esp_tls.h \
## mDNS
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/mdns/include/mdns.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
##
## Storage - API Reference
##
## SPI Flash and Partition APIs
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/spi_flash/include/esp_spi_flash.h \
../../components/spi_flash/include/esp_partition.h \
../../components/bootloader_support/include/esp_flash_encrypt.h \
Add SPIFFS Component to IDF
2017-09-07 14:37:59 +00:00
## SPIFFS
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/spiffs/include/esp_spiffs.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## SD/MMC Card Host
## NOTE: for three lines below header_file.inc is not used
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../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 \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Non-Volatile Storage
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/nvs_flash/include/nvs.h \
../../components/nvs_flash/include/nvs_flash.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Virtual Filesystem
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/vfs/include/esp_vfs.h \
../../components/vfs/include/esp_vfs_dev.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## FAT Filesystem
## NOTE: for two lines below header_file.inc is not used
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/fatfs/src/esp_vfs_fat.h \
../../components/fatfs/src/diskio.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Wear Levelling
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/wear_levelling/include/wear_levelling.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
##
## System - API Reference
##
## Memory Allocation #
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/heap/include/esp_heap_caps.h \
../../components/heap/include/esp_heap_trace.h \
../../components/heap/include/esp_heap_caps_init.h \
../../components/heap/include/multi_heap.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Interrupt Allocation
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/esp32/include/esp_intr_alloc.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Watchdogs
## NOTE: for two lines below header_file.inc is not used
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/esp32/include/esp_int_wdt.h \
../../components/esp32/include/esp_task_wdt.h \
docs/Added documentation about esp32 hooks This commit adds documentation about the esp32 Idle and Tick Hooks
2017-10-17 10:57:31 +00:00
## Hooks
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/esp32/include/esp_freertos_hooks.h \
docs/ipc documentation This commit updates doxygen comments in the IPC header files and adds an rst docs page.
2017-11-22 07:16:29 +00:00
## Inter-Processor Call
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/esp32/include/esp_ipc.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Over The Air Updates (OTA)
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/app_update/include/esp_ota_ops.h \
sleep: add light sleep, factor out APIs common for deep/light sleep
2017-04-21 04:32:50 +00:00
## Sleep
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## NOTE: for line below header_file.inc is not used
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/esp32/include/esp_sleep.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Logging
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/log/include/esp_log.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Base MAC address
## NOTE: for line below header_file.inc is not used
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/esp32/include/esp_system.h \
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
##
## ULP Coprocessor - API Guides
##
## NOTE: for line below header_file.inc is not used
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/ulp/include/esp32/ulp.h \
esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load
2017-03-22 03:07:37 +00:00
##
## Application Level Tracing - API Reference
##
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/app_trace/include/esp_app_trace.h \
docs: add power management API reference
2017-10-09 06:38:41 +00:00
### Power management
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/esp32/include/esp_pm.h \
../../components/esp32/include/esp32/pm.h \
esp_timer: add documentation, expose profiling option in Kconfig
2017-11-24 10:51:37 +00:00
### esp_timer, High Resolution Timer
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/esp32/include/esp_timer.h \
pthread: Allow configuration of priority and stacksize The expected usage is: esp_pthread_set_cfg(cfg); pthread_create() If the inherit flag is set, then all subsequent threads forked by this thread will also inherit this configuration. This avoids having to change/prefix this for each and every pthread_create() call.
2018-02-25 09:26:04 +00:00
### ESP Pthread parameters
../../components/pthread/include/esp_pthread.h \
docs: add FreeRTOS API docs - Use `code` tags instead of a mix of `<pre></pre>` and `@verbatim .. @endverbatim` - Remove manually added function prototypes from comment blocks - Remove of grouping (`\defgroup`) — some extra work is needed to make groups compatible with the way we auto-generate API reference from Doxygen XML files. It's pretty easy to add the grouping directives back if/when we implement support for Doxygen groups in the later stages of documentation build process. - Hide private APIs under `@cond .. @endcond` - Convert some comments into Doxygen-compatible ones - Fix various documentation issues: missing documentation for some parameters, mismatch between parameter names in comment block and in function prototype. - Add doxygen comments for functions which didn't have them (thread local storage). - Add [out] param tags where necessary - Redefine `xTaskCreate` and `xTaskCreateStatic` as inline functions instead of macros.
2017-12-01 04:50:45 +00:00
###
### FreeRTOS
###
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 21:12:13 +00:00
../../components/freertos/include/freertos/task.h \
../../components/freertos/include/freertos/queue.h \
../../components/freertos/include/freertos/semphr.h \
../../components/freertos/include/freertos/timers.h \
../../components/freertos/include/freertos/event_groups.h \
../../components/freertos/include/freertos/ringbuf.h
docs: add FreeRTOS API docs - Use `code` tags instead of a mix of `<pre></pre>` and `@verbatim .. @endverbatim` - Remove manually added function prototypes from comment blocks - Remove of grouping (`\defgroup`) — some extra work is needed to make groups compatible with the way we auto-generate API reference from Doxygen XML files. It's pretty easy to add the grouping directives back if/when we implement support for Doxygen groups in the later stages of documentation build process. - Hide private APIs under `@cond .. @endcond` - Convert some comments into Doxygen-compatible ones - Fix various documentation issues: missing documentation for some parameters, mismatch between parameter names in comment block and in function prototype. - Add doxygen comments for functions which didn't have them (thread local storage). - Add [out] param tags where necessary - Redefine `xTaskCreate` and `xTaskCreateStatic` as inline functions instead of macros.
2017-12-01 04:50:45 +00:00
add wear_levelling component and example
2017-04-10 14:06:35 +00:00
API samples - Logging library - Virtual file system component
2016-10-29 21:00:30 +00:00
esp32: SEGGER SystemView Tracing Support Implements support for system level traces compatible with SEGGER SystemView tool on top of ESP32 application tracing module. That kind of traces can help to analyse program's behaviour. SystemView can show timeline of tasks/ISRs execution, context switches, statistics related to the CPUs' load distribution etc. Also this commit adds useful feature to ESP32 application tracing module: - Trace data buffering is implemented to handle temporary peaks of events load
2017-03-22 03:07:37 +00:00
## Get warnings for functions that have no documentation for their parameters or return value
Doxygen configuration clean up
2016-11-16 19:27:55 +00:00
##
WARN_NO_PARAMDOC = YES
API samples - Logging library - Virtual file system component
2016-10-29 21:00:30 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
##
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
docs: add FreeRTOS API docs - Use `code` tags instead of a mix of `<pre></pre>` and `@verbatim .. @endverbatim` - Remove manually added function prototypes from comment blocks - Remove of grouping (`\defgroup`) — some extra work is needed to make groups compatible with the way we auto-generate API reference from Doxygen XML files. It's pretty easy to add the grouping directives back if/when we implement support for Doxygen groups in the later stages of documentation build process. - Hide private APIs under `@cond .. @endcond` - Convert some comments into Doxygen-compatible ones - Fix various documentation issues: missing documentation for some parameters, mismatch between parameter names in comment block and in function prototype. - Add doxygen comments for functions which didn't have them (thread local storage). - Add [out] param tags where necessary - Redefine `xTaskCreate` and `xTaskCreateStatic` as inline functions instead of macros.
2017-12-01 04:50:45 +00:00
PREDEFINED = \
__attribute__(x)= \
IRAM_ATTR= \
configSUPPORT_DYNAMIC_ALLOCATION=1 \
configSUPPORT_STATIC_ALLOCATION=1 \
configQUEUE_REGISTRY_SIZE=1 \
configUSE_RECURSIVE_MUTEXES=1 \
configTHREAD_LOCAL_STORAGE_DELETE_CALLBACKS=1 \
configNUM_THREAD_LOCAL_STORAGE_POINTERS=1 \
configUSE_APPLICATION_TASK_TAG=1
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
Doxygen configuration clean up
2016-11-16 19:27:55 +00:00
## Do not complain about not having dot
##
HAVE_DOT = NO
API samples - Logging library - Virtual file system component
2016-10-29 21:00:30 +00:00
Doxygen configuration clean up
2016-11-16 19:27:55 +00:00
## Generate XML that is required for Breathe
##
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
GENERATE_XML = YES
XML_OUTPUT = xml
API samples - Logging library - Virtual file system component
2016-10-29 21:00:30 +00:00
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
GENERATE_HTML = NO
HAVE_DOT = NO
GENERATE_LATEX = NO
GENERATE_MAN = YES
GENERATE_RTF = NO
API samples - Logging library - Virtual file system component
2016-10-29 21:00:30 +00:00
Doxygen configuration clean up
2016-11-16 19:27:55 +00:00
## Skip distracting progress messages
##
QUIET = YES
## Log warnings in a file for further review
##
API samples - Logging library - Virtual file system component
2016-10-29 21:00:30 +00:00
WARN_LOGFILE = "doxygen-warning-log.txt"
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130.
2017-05-02 08:36:01 +00:00
Reference in a new issue Copy permalink