espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-11-04 09:01:40 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
e62b831867f49550a03ee02afa3b8d06b80b8585
esp-idf/docs/Doxyfile

316 lines
14 KiB
Plaintext
Raw Normal View History

Doxygen configuration clean up
2016-11-16 20:27:55 +01: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 06:07:37 +03:00
# To make this file easier to follow,
Doxygen configuration clean up
2016-11-16 20:27:55 +01: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 21:58:31 +02:00
# https://www.stack.nl/~dimitri/doxygen/manual/config.html
Doxygen configuration clean up
2016-11-16 20:27:55 +01:00
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst
2016-10-26 21:08:36 +02:00
PROJECT_NAME = "ESP32 Programming Guide"
API samples - Logging library - Virtual file system component
2016-10-29 23:00:30 +02: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 10:36:01 +02: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 06:07:37 +03: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 10:36:01 +02:00
## and used to include in API reference documentation
INPUT = \
##
## Wi-Fi - API Reference
##
derive esp_wifi from esp32 component
2019-03-22 14:21:15 +08:00
../../components/esp_wifi/include/esp_wifi.h \
../../components/esp_wifi/include/esp_wifi_types.h \
../../components/esp_wifi/include/esp_smartconfig.h \
../../components/esp_wifi/include/esp_now.h \
add mesh feature
2018-02-27 18:22:20 +08:00
## Mesh - API Reference
derive esp_wifi from esp32 component
2019-03-22 14:21:15 +08:00
../../components/esp_wifi/include/esp_mesh.h \
docs: add event handling API guide
2018-11-21 15:56:06 +08:00
## Event loop - API Reference
../../components/esp_event/include/esp_event.h \
../../components/esp_event/include/esp_event_base.h \
../../components/esp_event/include/esp_event_legacy.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 10:36:01 +02:00
## Bluetooth - API Reference
## Controller && VHCI
component/bt : modify header files to avoid conflict 1. add the L1 include path with a prefix, such like osi/list.h, stack/a2d_api.h and etc. 2. modify component, only bluedroid/api/include/api is export to another component and application, other include path just for bluedroid used 3. put bluedroid/include into common/include/common, so the root directory of bluedroid have no include path. 4. modify doxygen to use esp_bt.h and redirect to component/bt/bluedroid/api/include/api/ fix compile
2018-04-08 12:10:50 +08:00
../../components/bt/include/esp_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 10:36:01 +02:00
## Bluetooth COMMON
## Issue with __attribute__
Bluetooth component refactoring
2019-06-30 16:39:00 +08:00
../../components/bt/host/bluedroid/api/include/api/esp_bt_defs.h \
../../components/bt/host/bluedroid/api/include/api/esp_bt_main.h \
../../components/bt/host/bluedroid/api/include/api/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 10:36:01 +02:00
## Bluetooth LE
Bluetooth component refactoring
2019-06-30 16:39:00 +08:00
../../components/bt/host/bluedroid/api/include/api/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 10:36:01 +02:00
## Issue with __attribute__
Bluetooth component refactoring
2019-06-30 16:39:00 +08:00
../../components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h \
../../components/bt/host/bluedroid/api/include/api/esp_gatts_api.h \
../../components/bt/host/bluedroid/api/include/api/esp_gattc_api.h \
../../components/bt/host/bluedroid/api/include/api/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 10:36:01 +02:00
## Bluetooth Classic
Bluetooth component refactoring
2019-06-30 16:39:00 +08:00
../../components/bt/host/bluedroid/api/include/api/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 10:36:01 +02:00
## Issue with __attribute__
Bluetooth component refactoring
2019-06-30 16:39:00 +08:00
../../components/bt/host/bluedroid/api/include/api/esp_a2dp_api.h \
../../components/bt/host/bluedroid/api/include/api/esp_avrc_api.h \
../../components/bt/host/bluedroid/api/include/api/esp_spp_api.h \
../../components/bt/host/bluedroid/api/include/api/esp_hf_defs.h \
../../components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h \
Port NimBLE Host Stack on ESP-IDF
2019-06-25 09:03:58 +08:00
## NimBLE related Bluetooth APIs
Bluetooth component refactoring
2019-06-30 16:39:00 +08:00
../../components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \
ble_mesh: add Doxyfile for core apis & model apis
2019-06-28 11:13:18 +08:00
## ESP BLE Mesh APIs
../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_common_api.h \
../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_local_data_operation_api.h \
../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_low_power_api.h \
../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_networking_api.h \
../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_provisioning_api.h \
../../components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_proxy_api.h \
../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_config_model_api.h \
../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_generic_model_api.h \
../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_health_model_api.h \
../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_lighting_model_api.h \
../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_sensor_model_api.h \
../../components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_time_scene_model_api.h \
../../components/bt/esp_ble_mesh/api/esp_ble_mesh_defs.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 10:36:01 +02:00
##
## Ethernet - API Reference
##
add esp_eth component
2019-04-10 16:24:50 +08:00
../../components/esp_eth/include/esp_eth.h \
../../components/esp_eth/include/esp_eth_com.h \
../../components/esp_eth/include/esp_eth_mac.h \
../../components/esp_eth/include/esp_eth_phy.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 10:36:01 +02: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 22:12:13 +01:00
../../components/driver/include/driver/adc.h \
CAN Driver The following commit contains the first version of the ESP32 CAN Driver. closes #544
2017-12-18 20:32:29 +08:00
../../components/driver/include/driver/can.h \
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 22:12:13 +01:00
../../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 \
add Comment for touchpad
2019-06-20 16:13:47 +08:00
../../components/driver/esp32s2beta/include/temp_sensor.h \
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 22:12:13 +01:00
../../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 \
rmt: add HAL layer
2019-11-19 16:10:02 +08:00
../../components/soc/include/hal/rmt_types.h \
spi: multichip support move hardcoded numbers, etc. into soc files. create headers for shared types which needs to be documented. (MINOR CHANGE)
2019-06-13 14:12:54 +08:00
../../components/soc/include/hal/spi_types.h \
refactor(pcnt): add hal pcnt driver
2019-07-15 14:44:15 +08:00
../../components/soc/include/hal/pcnt_types.h \
refactor(i2s): add hal i2s driver
2019-07-15 14:44:15 +08:00
../../components/soc/include/hal/i2s_types.h \
rtcio: add hal for driver
2019-07-25 23:11:31 +08:00
../../components/soc/include/hal/rtc_io_types.h \
refactor(sigmadelta): add hal sigmadelta driver
2019-07-15 14:44:15 +08:00
../../components/soc/include/hal/sigmadelta_types.h \
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 22:12:13 +01:00
../../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 \
rtcio: add hal for driver
2019-07-25 23:11:31 +08:00
../../components/soc/esp32/include/soc/rtc_io_channel.h \
esp_netif: documentation udpated and grouped the esp-netif API structure. Updated rst documenentation and diagram of esp-netif cooperation with other components.
2019-09-12 09:24:56 +02:00
## esp_netif - API Reference
../../components/esp_netif/include/esp_netif.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 10:36:01 +02:00
##
## Protocols - API Reference
##
Resolved Issues
2018-02-14 15:15:50 +05:30
## ESP-TLS
../../components/esp-tls/esp_tls.h \
MQTT: Integrate esp-mqtt library into idf added docs and tests for mqtt library, small fixes (removed warnings, option for custom outbox, websocket bug fixed for longer transports). refactored to use common tcp_transport component, support for CMake build system. Closes #2108
2018-07-24 16:59:03 +02:00
## MQTT
../../components/mqtt/esp-mqtt/include/mqtt_client.h \
doc: add api reference for icmp_echo
2019-10-18 15:07:11 +08:00
## ICMP-ECHO
../../components/lwip/include/apps/ping/ping_sock.h \
Http Server : Add a simple light weight HTTP Server Component. Also add examples, docs and test apps for the HTTP Server.
2018-07-03 16:27:41 +05:30
## mDNS
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 22:12:13 +01:00
../../components/mdns/include/mdns.h \
Add esp_http_client Add error handling for http client set ssid password correct with Example_WIFI test, and clear password before free Fixed the CI failure due to HTTP errror names
2017-11-14 10:16:20 +07:00
../../components/esp_http_client/include/esp_http_client.h \
esp_websocket_client: Add websocket client component Closes https://github.com/espressif/esp-idf/issues/2829
2019-06-20 15:37:40 +08:00
../../components/esp_websocket_client/include/esp_websocket_client.h \
ESP Local Control Feature Added List of changes: * New component esp_local_ctrl added * Example added under examples/protocols/esp_local_ctrl * Documentation added under protocols/esp_local_ctrl * Demo client side app esp_local_ctrl.py added under examples/protocols/esp_local_ctrl/scripts * protocomm_ble : protocomm_ble_config_t given struct name for allowing forward declaration * esp_prov/transport_softap renamed to transport_http * transport_http module supports verification of server certificate * transport_http module performs name resolution before connection
2019-06-26 01:03:55 +05:30
## HTTP / HTTPS Server
HTTP Server Docs : Replace http_server with esp_http_server
2018-10-24 15:25:04 +05:30
../../components/esp_http_server/include/esp_http_server.h \
esp_https_server : Docs and API references fixed
2018-11-01 18:24:19 +05:30
../../components/esp_https_server/include/esp_https_server.h \
ESP Local Control Feature Added List of changes: * New component esp_local_ctrl added * Example added under examples/protocols/esp_local_ctrl * Documentation added under protocols/esp_local_ctrl * Demo client side app esp_local_ctrl.py added under examples/protocols/esp_local_ctrl/scripts * protocomm_ble : protocomm_ble_config_t given struct name for allowing forward declaration * esp_prov/transport_softap renamed to transport_http * transport_http module supports verification of server certificate * transport_http module performs name resolution before connection
2019-06-26 01:03:55 +05:30
## ESP Local Ctrl
../../components/esp_local_ctrl/include/esp_local_ctrl.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 10:36:01 +02:00
##
Docs : Added Provisioning and Protocomm related docs Co-Authored-By: Amey Inamdar <amey@espressif.com> Co-Authored-By: Anurag Kar <anurag.kar@espressif.com>
2018-09-23 20:14:46 +05:30
## Provisioning - API Reference
##
## Protocol Communication
../../components/protocomm/include/common/protocomm.h \
../../components/protocomm/include/security/protocomm_security.h \
../../components/protocomm/include/security/protocomm_security0.h \
../../components/protocomm/include/security/protocomm_security1.h \
../../components/protocomm/include/transports/protocomm_ble.h \
../../components/protocomm/include/transports/protocomm_console.h \
../../components/protocomm/include/transports/protocomm_httpd.h \
## WiFi Provisioning
wifi_provisioning : Docs updated with information about new provisioning manager
2019-04-21 20:23:31 +05:30
../../components/wifi_provisioning/include/wifi_provisioning/manager.h \
../../components/wifi_provisioning/include/wifi_provisioning/scheme_ble.h \
../../components/wifi_provisioning/include/wifi_provisioning/scheme_softap.h \
../../components/wifi_provisioning/include/wifi_provisioning/scheme_console.h \
Docs : Added Provisioning and Protocomm related docs Co-Authored-By: Amey Inamdar <amey@espressif.com> Co-Authored-By: Anurag Kar <anurag.kar@espressif.com>
2018-09-23 20:14:46 +05:30
../../components/wifi_provisioning/include/wifi_provisioning/wifi_config.h \
wifi_provisioning : Added Wi-Fi Scan list feature to Provisioning Manager List of changes in components/wifi_provisioning: * Manager version is now v1.1 * .proto files and protocomm handler added for sending Wi-Fi scan command and receiving scan results * Implemented handlers for wifi_scan protocomm endpoint * Update manager context data structure to hold scan state and results * scheme_softap now runs Wi-Fi in APSTA mode * Wi-Fi is started in AP mode when provisioning is started. This is necessary for scan list to work * Docs updates with information about new wifi_scan endpoint List of changes in tools/esp_prov: * Added functions for sending and receiving protobuf messages compatible with wifi_scan protocomm endpoint * Added feature to display/refresh scan results and accept user selection at runtime * New functions: * get_version() : only returns the protocol version string * has_capability() : check is a capability is present according to proto-ver response * wifi_scan feature is provided only if the `wifi_scan` capability is present Other changes: * Replace recursive mutex with plain mutex * assert on return value of mutex give / take calls * replace all calls with macros ACQUIRE_LOCK and RELEASE_LOCK * some checks added in scanning related private APIs * free and nullify scanning context and state if service is stopped while ongoing scan
2019-04-23 12:18:28 +05:30
../../components/wifi_provisioning/include/wifi_provisioning/wifi_scan.h \
Docs : Added Provisioning and Protocomm related docs Co-Authored-By: Amey Inamdar <amey@espressif.com> Co-Authored-By: Anurag Kar <anurag.kar@espressif.com>
2018-09-23 20:14:46 +05:30
##
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 10:36:01 +02:00
## Storage - API Reference
##
## SPI Flash and Partition APIs
esp_flash: add initialization interface for SPI devices
2019-06-24 12:56:39 +08:00
../../components/spi_flash/include/esp_flash_spi_init.h \
esp_flash: update the document to the latest API
2019-06-19 20:35:55 +08:00
../../components/spi_flash/include/esp_flash.h \
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 22:12:13 +01:00
../../components/spi_flash/include/esp_partition.h \
../../components/bootloader_support/include/esp_flash_encrypt.h \
esp_flash: update the document to the latest API
2019-06-19 20:35:55 +08:00
../../components/soc/include/hal/spi_flash_types.h \
Add SPIFFS Component to IDF
2017-09-07 17:37:59 +03: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 22:12:13 +01: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 10:36:01 +02:00
## SD/MMC Card Host
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 22:12:13 +01: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 \
Http Server : Add a simple light weight HTTP Server Component. Also add examples, docs and test apps for the HTTP Server.
2018-07-03 16:27:41 +05:30
## SDIO slave
doc(sdio_slave): documentation for SDIO slave driver
2017-12-04 20:05:09 +08:00
../../components/driver/include/driver/sdio_slave.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 10:36:01 +02: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 22:12:13 +01: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 10:36:01 +02: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 22:12:13 +01:00
../../components/vfs/include/esp_vfs.h \
../../components/vfs/include/esp_vfs_dev.h \
vfs: Adds semihosting VFS driver
2019-02-19 22:50:18 +03:00
../../components/vfs/include/esp_vfs_semihost.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 10:36:01 +02:00
## FAT Filesystem
## NOTE: for two lines below header_file.inc is not used
fatfs: separate IDF-specific files from the original FatFS code This is a breaking change: applications which used diskio.h to call ff_diskio_register, will now need to include diskio_impl.h. Including diskio.h will include the original diskio.h header from FatFS library.
2019-06-20 00:07:51 +08:00
../../components/fatfs/vfs/esp_vfs_fat.h \
../../components/fatfs/diskio/diskio_impl.h \
../../components/fatfs/diskio/diskio_sdmmc.h \
../../components/fatfs/diskio/diskio_wl.h \
../../components/fatfs/diskio/diskio_rawflash.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 10:36:01 +02: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 22:12:13 +01: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 10:36:01 +02: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 22:12:13 +01: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 \
Spiram: Add option to reserve MMU banks; add himem API to make use of those banks
2018-06-29 11:05:36 +08:00
## Himem
move esp32 chip specific includes to esp32/xxx.h
2019-03-18 15:46:15 +08:00
../../components/esp32/include/esp32/himem.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 10:36:01 +02: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 22:12:13 +01: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 10:36:01 +02:00
## Watchdogs
## NOTE: for two lines below header_file.inc is not used
move common include files from esp32 into esp_common
2019-03-15 17:44:27 +08:00
../../components/esp_common/include/esp_int_wdt.h \
../../components/esp_common/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 18:57:31 +08:00
## Hooks
misc adjustment of esp32 component
2019-03-26 16:30:43 +08:00
../../components/esp_common/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 15:16:29 +08:00
## Inter-Processor Call
misc adjustment of esp32 component
2019-03-26 16:30:43 +08:00
../../components/esp_common/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 10:36:01 +02: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 22:12:13 +01:00
../../components/app_update/include/esp_ota_ops.h \
esp_https_ota: Add support for HTTPS based ota feature
2018-07-12 17:45:44 +05:30
## ESP HTTPS OTA
../../components/esp_https_ota/include/esp_https_ota.h \
sleep: add light sleep, factor out APIs common for deep/light sleep
2017-04-21 12:32:50 +08:00
## Sleep
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 22:12:13 +01: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 10:36:01 +02: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 22:12:13 +01: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 10:36:01 +02:00
## Base MAC address
## NOTE: for line below header_file.inc is not used
move common include files from esp32 into esp_common
2019-03-15 17:44:27 +08:00
../../components/esp_common/include/esp_system.h \
esp_common: add version definitions in code and build system Closes https://github.com/espressif/esp-idf/issues/2482 Closes IDF-253
2019-03-22 12:40:12 +08:00
## IDF version
../../components/esp_common/include/esp_idf_version.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 10:36:01 +02: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 22:12:13 +01:00
../../components/ulp/include/esp32/ulp.h \
ulp: Add header for common ULP definitions Fixes problems with duplicate error codes in the two chip-specific ulp headers
2019-09-16 14:14:54 +10:00
../../components/ulp/include/ulp_common.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 06:07:37 +03: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 22:12:13 +01:00
../../components/app_trace/include/esp_app_trace.h \
docs: Adds host-based heap tracing description
2018-12-12 18:57:55 +03:00
../../components/app_trace/include/esp_sysview_trace.h \
docs: add power management API reference
2017-10-09 14:38:41 +08:00
### Power management
move common include files from esp32 into esp_common
2019-03-15 17:44:27 +08:00
../../components/esp_common/include/esp_pm.h \
Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version
2018-02-03 22:12:13 +01:00
../../components/esp32/include/esp32/pm.h \
esp_timer: add documentation, expose profiling option in Kconfig
2017-11-24 18:51:37 +08:00
### esp_timer, High Resolution Timer
move common include files from esp32 into esp_common
2019-03-15 17:44:27 +08:00
../../components/esp_common/include/esp_timer.h \
event: Implement event loop library
2018-10-26 13:14:19 +08:00
### esp_event, Event Loop Library
../../components/esp_event/include/esp_event.h \
../../components/esp_event/include/esp_event_base.h \
docs: Add efuse
2018-11-19 11:41:26 +08:00
### eFuse Manager
../../components/efuse/include/esp_efuse.h \
docs: Add description
2019-04-29 12:31:50 +08:00
### App Image Format
../../components/bootloader_support/include/esp_app_format.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 14:56:04 +05:30
### 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 12:50:45 +08: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 22:12:13 +01: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 \
esp_ringbuf: move ringbuf to seperate component Signed-off-by: Mahavir Jain <mahavir@espressif.com>
2018-08-30 15:59:01 +05:30
### Ringbuffer
../../components/esp_ringbuf/include/freertos/ringbuf.h \
docs: add error codes reference
2018-06-13 16:07:26 +08:00
### Helper functions for error codes
move common include files from esp32 into esp_common
2019-03-15 17:44:27 +08:00
../../components/esp_common/include/esp_err.h \
docs: add API reference section for esp_system.h
2018-07-30 16:19:20 +03:00
### System APIs
move common include files from esp32 into esp_common
2019-03-15 17:44:27 +08:00
../../components/esp_common/include/esp_system.h \
examples: freemodbus port slave basic implementation This example adds functionality to support basic communication in RS485 networks using Modbus protocol. This example uses FreeModbus stack and regular UART driver API to communicate in RS485 half duplex mode. Added initial support of modbus controller pure C api to access device parameters over Modbus transport. Move freemodbus stack and port files into components folder Move the modbus_controller interface into components idf folder Source files updated after review. Add modbus interface documentation docs/en/api-reference/protocols/modbus.rst porttimer.c: fix bug with timer1 selected in the Kconfig Add support of cmake system (added cmake files) Closes https://github.com/espressif/esp-idf/issues/858
2018-06-28 17:45:41 +02:00
### Modbus controller component header file
freemodbus: Fix bug with incorrect coils read mask Contains two different component folders per each implementation (serial_master and serial_slave) with concrete ports. Added common public api for master and slave and common interface for master and slave implementation. Add support of cmake system (added cmake files). Added sdkconfig.defaults files for slave and master modbus examples. Updated make file and KConfig for freemodbus component Update according to review and fix doxygen warnings Fix Doxyfile to pass documentation build Update headers and change interface file names as per review comments Merge branch feature/freemodbus_move_rs485_mode_control Update after review: The stack modbus folder updated to support master and slave ports together and moved into freemodbus/modbus Stack and port files updated to remove duplicated simbols Make file, KConfig and CMakeLists.txt updated to compile master and slave stacks, common interface and concrete implementations of ports Stack callback functions execute callbacks using interface pointer from concrete port implementation User can instantiate any of concrete port using common API (only one concrete port at a time) and it does not require to select port by KConfig Port pins and mode configuration moved into example files from port files to allow user select pins and port mode (customer request) Changes tested using pymodbus, ModbusPoll and communication between two boards Updated DoxyFile according to public include path Fix maximum instance size for slave (merge from master of customer issue) Fix critical section issue TW#28622 (change spin lock based critical section to semaphore) Move serial port files into component port folder for master and slave accordingly Fix example issue showed in the log when IO slave is not configured correctly Fix conflicts while merging from origin/master Fix errors handling in modbus controller interface + some final corrections according to review Update maximum allowed number of slaves in the network segment Fix bug with incorrect coils read mask Closes https://github.com/espressif/esp-idf/issues/858
2018-10-19 15:51:27 +02:00
../../components/freemodbus/common/include/esp_modbus_common.h \
../../components/freemodbus/common/include/esp_modbus_slave.h \
Performance monitor component. The component contains APIs, example and documentation.
2019-04-04 11:06:22 +03:00
../../components/freemodbus/common/include/esp_modbus_master.h \
### Performance Monitor component header file
../../components/perfmon/include/xtensa_perfmon_access.h \
../../components/perfmon/include/xtensa_perfmon_apis.h \
../../components/perfmon/include/xtensa_perfmon_masks.h
freemodbus: Fix bug with incorrect coils read mask Contains two different component folders per each implementation (serial_master and serial_slave) with concrete ports. Added common public api for master and slave and common interface for master and slave implementation. Add support of cmake system (added cmake files). Added sdkconfig.defaults files for slave and master modbus examples. Updated make file and KConfig for freemodbus component Update according to review and fix doxygen warnings Fix Doxyfile to pass documentation build Update headers and change interface file names as per review comments Merge branch feature/freemodbus_move_rs485_mode_control Update after review: The stack modbus folder updated to support master and slave ports together and moved into freemodbus/modbus Stack and port files updated to remove duplicated simbols Make file, KConfig and CMakeLists.txt updated to compile master and slave stacks, common interface and concrete implementations of ports Stack callback functions execute callbacks using interface pointer from concrete port implementation User can instantiate any of concrete port using common API (only one concrete port at a time) and it does not require to select port by KConfig Port pins and mode configuration moved into example files from port files to allow user select pins and port mode (customer request) Changes tested using pymodbus, ModbusPoll and communication between two boards Updated DoxyFile according to public include path Fix maximum instance size for slave (merge from master of customer issue) Fix critical section issue TW#28622 (change spin lock based critical section to semaphore) Move serial port files into component port folder for master and slave accordingly Fix example issue showed in the log when IO slave is not configured correctly Fix conflicts while merging from origin/master Fix errors handling in modbus controller interface + some final corrections according to review Update maximum allowed number of slaves in the network segment Fix bug with incorrect coils read mask Closes https://github.com/espressif/esp-idf/issues/858
2018-10-19 15:51:27 +02:00
API samples - Logging library - Virtual file system component
2016-10-29 23:00:30 +02: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 06:07:37 +03:00
## Get warnings for functions that have no documentation for their parameters or return value
Doxygen configuration clean up
2016-11-16 20:27:55 +01:00
##
WARN_NO_PARAMDOC = YES
API samples - Logging library - Virtual file system component
2016-10-29 23:00:30 +02: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 10:36:01 +02: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 12:50:45 +08:00
PREDEFINED = \
__attribute__(x)= \
ci: Add IDF_DEPRECATED macro for things we only deprecate in our CI passes
2019-04-17 16:31:07 +10:00
IDF_DEPRECATED(X)= \
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 12:50:45 +08:00
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 \
freertos: add configTASKLIST_INCLUDE_COREID
2018-07-09 15:25:59 +08:00
configUSE_APPLICATION_TASK_TAG=1 \
docs: add event handling API guide
2018-11-21 15:56:06 +08:00
configTASKLIST_INCLUDE_COREID=1 \
"ESP_EVENT_DECLARE_BASE(x)=extern esp_event_base_t x"
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 10:36:01 +02:00
Doxygen configuration clean up
2016-11-16 20:27:55 +01:00
## Do not complain about not having dot
##
HAVE_DOT = NO
API samples - Logging library - Virtual file system component
2016-10-29 23:00:30 +02:00
Doxygen configuration clean up
2016-11-16 20:27:55 +01: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 10:36:01 +02:00
GENERATE_XML = YES
XML_OUTPUT = xml
API samples - Logging library - Virtual file system component
2016-10-29 23:00:30 +02: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 10:36:01 +02: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 23:00:30 +02:00
Doxygen configuration clean up
2016-11-16 20:27:55 +01: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 23:00:30 +02: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 10:36:01 +02:00
Reference in New Issue Copy Permalink