alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
5a23447452
esp-idf/docs/Doxyfile

345 lines
16 KiB
Plaintext
Raw Normal View History

Doxygen configuration clean up
2016-11-16 14:27:55 -05: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-21 23:07:37 -04:00
# To make this file easier to follow,
Doxygen configuration clean up
2016-11-16 14:27:55 -05: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:
docs: Fix broken URLs & permanent redirects
2020-03-22 19:27:51 -04:00
# http://doxygen.nl/manual/config.html
Doxygen configuration clean up
2016-11-16 14:27:55 -05:00
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst
2016-10-26 15:08:36 -04:00
PROJECT_NAME = "ESP32 Programming Guide"
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04: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 04:36:01 -04: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-21 23:07:37 -04: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 04:36:01 -04:00
## and used to include in API reference documentation
INPUT = \
##
## Wi-Fi - API Reference
##
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_wifi/include/esp_wifi.h \
$(IDF_PATH)/components/esp_wifi/include/esp_wifi_types.h \
$(IDF_PATH)/components/esp_wifi/include/esp_smartconfig.h \
$(IDF_PATH)/components/esp_wifi/include/esp_now.h \
$(IDF_PATH)/components/esp_wifi/include/esp_wifi_default.h \
add mesh feature
2018-02-27 05:22:20 -05:00
## Mesh - API Reference
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_wifi/include/esp_mesh.h \
docs: add event handling API guide
2018-11-21 02:56:06 -05:00
## Event loop - API Reference
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_event/include/esp_event.h \
$(IDF_PATH)/components/esp_event/include/esp_event_base.h \
$(IDF_PATH)/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 04:36:01 -04:00
## Bluetooth - API Reference
## Controller && VHCI
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 04:36:01 -04:00
## Bluetooth COMMON
## Issue with __attribute__
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_bt_defs.h \
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_bt_main.h \
$(IDF_PATH)/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 04:36:01 -04:00
## Bluetooth LE
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 04:36:01 -04:00
## Issue with __attribute__
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h \
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_gatts_api.h \
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h \
$(IDF_PATH)/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 04:36:01 -04:00
## Bluetooth Classic
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 04:36:01 -04:00
## Issue with __attribute__
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_a2dp_api.h \
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_avrc_api.h \
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_spp_api.h \
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_defs.h \
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h \
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h \
Port NimBLE Host Stack on ESP-IDF
2019-06-24 21:03:58 -04:00
## NimBLE related Bluetooth APIs
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \
ble_mesh: add Doxyfile for core apis & model apis
2019-06-27 23:13:18 -04:00
## ESP BLE Mesh APIs
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_common_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_local_data_operation_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_low_power_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_networking_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_provisioning_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_proxy_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_config_model_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_generic_model_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_health_model_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_lighting_model_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_sensor_model_api.h \
$(IDF_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_time_scene_model_api.h \
$(IDF_PATH)/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 04:36:01 -04:00
##
## Ethernet - API Reference
##
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_eth/include/esp_eth.h \
$(IDF_PATH)/components/esp_eth/include/esp_eth_com.h \
$(IDF_PATH)/components/esp_eth/include/esp_eth_mac.h \
$(IDF_PATH)/components/esp_eth/include/esp_eth_phy.h \
$(IDF_PATH)/components/esp_eth/include/esp_eth_netif_glue.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 04:36:01 -04:00
##
## Peripherals - API Reference
##
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/driver/include/driver/dac.h \
$(IDF_PATH)/components/driver/include/driver/gpio.h \
$(IDF_PATH)/components/driver/include/driver/rtc_io.h \
$(IDF_PATH)/components/driver/include/driver/i2c.h \
$(IDF_PATH)/components/driver/include/driver/i2s.h \
$(IDF_PATH)/components/driver/include/driver/ledc.h \
$(IDF_PATH)/components/driver/include/driver/mcpwm.h \
$(IDF_PATH)/components/soc/include/hal/mcpwm_types.h \
$(IDF_PATH)/components/driver/include/driver/pcnt.h \
$(IDF_PATH)/components/driver/include/driver/rmt.h \
$(IDF_PATH)/components/driver/include/driver/sigmadelta.h \
$(IDF_PATH)/components/driver/include/driver/spi_common.h \
$(IDF_PATH)/components/driver/include/driver/spi_master.h \
$(IDF_PATH)/components/driver/include/driver/spi_slave.h \
driver(adc/dac): fix adc dac driver for esp32s2 1. update register file about adc; 2. fix adc driver; 3. add UT for adc/dac; See merge request espressif/esp-idf!7776
2020-02-25 09:19:48 -05:00
$(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/adc.h \
$(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/touch_sensor.h \
$(IDF_PATH)/components/driver/esp32s2/include/driver/temp_sensor.h \
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/driver/include/driver/timer.h \
doc: updated peripherals api-reference for s2
2019-12-12 22:49:10 -05:00
$(IDF_PATH)/components/driver/include/driver/touch_sensor_common.h \
TWAI: Add ESP32-S2 support This commit adds TWAI driver support for the ESP32-S2. The following features were added: - Expanded BRP support - Expanded CLKOUT Divider Support - Updated example READMEs
2020-03-11 12:45:02 -04:00
$(IDF_PATH)/components/driver/include/driver/twai.h \
driver(adc/dac): fix adc dac driver for esp32s2 1. update register file about adc; 2. fix adc driver; 3. add UT for adc/dac; See merge request espressif/esp-idf!7776
2020-02-25 09:19:48 -05:00
$(IDF_PATH)/components/driver/include/driver/adc_common.h \
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/driver/include/driver/uart.h \
$(IDF_PATH)/components/esp_adc_cal/include/esp_adc_cal.h \
Doc: S2 HMAC documentation
2020-04-15 02:06:10 -04:00
$(IDF_PATH)/components/esp32s2/include/esp_hmac.h \
Doc: DS documentation for S2
2020-04-23 01:52:33 -04:00
$(IDF_PATH)/components/esp32s2/include/esp_ds.h \
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/soc/include/hal/rmt_types.h \
$(IDF_PATH)/components/soc/include/hal/spi_types.h \
$(IDF_PATH)/components/soc/include/hal/pcnt_types.h \
$(IDF_PATH)/components/soc/include/hal/i2s_types.h \
$(IDF_PATH)/components/soc/include/hal/rtc_io_types.h \
$(IDF_PATH)/components/soc/include/hal/sigmadelta_types.h \
$(IDF_PATH)/components/soc/include/hal/timer_types.h \
$(IDF_PATH)/components/soc/include/hal/ledc_types.h \
$(IDF_PATH)/components/soc/include/hal/i2c_types.h \
$(IDF_PATH)/components/soc/include/hal/dac_types.h \
$(IDF_PATH)/components/soc/include/hal/adc_types.h \
$(IDF_PATH)/components/soc/include/hal/gpio_types.h \
$(IDF_PATH)/components/soc/include/hal/uart_types.h \
TWAI: Add ESP32-S2 support This commit adds TWAI driver support for the ESP32-S2. The following features were added: - Expanded BRP support - Expanded CLKOUT Divider Support - Updated example READMEs
2020-03-11 12:45:02 -04:00
$(IDF_PATH)/components/soc/include/hal/twai_types.h \
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/soc/include/hal/touch_sensor_types.h \
soc: separate abstraction, description and implementation
2020-01-07 23:50:03 -05:00
$(IDF_PATH)/components/soc/soc/esp32/include/soc/adc_channel.h \
$(IDF_PATH)/components/soc/soc/esp32/include/soc/dac_channel.h \
$(IDF_PATH)/components/soc/soc/esp32/include/soc/touch_sensor_channel.h \
$(IDF_PATH)/components/soc/soc/esp32/include/soc/uart_channel.h \
$(IDF_PATH)/components/soc/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 03:24:56 -04:00
## esp_netif - API Reference
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_netif/include/esp_netif.h \
$(IDF_PATH)/components/esp_netif/include/esp_netif_net_stack.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 04:36:01 -04:00
##
## Protocols - API Reference
##
Resolved Issues
2018-02-14 04:45:50 -05:00
## ESP-TLS
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 10:59:03 -04:00
## MQTT
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/mqtt/esp-mqtt/include/mqtt_client.h \
doc: add api reference for icmp_echo
2019-10-18 03:07:11 -04:00
## ICMP-ECHO
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/lwip/include/apps/ping/ping_sock.h \
docs: Add System time chapter and for sntp a description about using CONFIG_LWIP_SNTP_UPDATE_DELAY option Closes: https://github.com/espressif/esp-idf/issues/4386 Closes: IDFGH-2237 Closes: IDF-1199
2019-11-25 02:03:38 -05:00
## SNTP
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/lwip/include/apps/sntp/sntp.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 06:57:41 -04:00
## mDNS
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/mdns/include/mdns.h \
$(IDF_PATH)/components/esp_http_client/include/esp_http_client.h \
$(IDF_PATH)/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-25 15:33:55 -04:00
## HTTP / HTTPS Server
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_http_server/include/esp_http_server.h \
$(IDF_PATH)/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-25 15:33:55 -04:00
## ESP Local Ctrl
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_local_ctrl/include/esp_local_ctrl.h \
essl: new component to communicate with esp serial slave devices
2019-09-28 06:14:24 -04:00
## ESP Serial Slave Link
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_serial_slave_link/include/esp_serial_slave_link/essl.h \
$(IDF_PATH)/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_sdio.h \
Add ESP certificate bundle feature Adds the ESP certificate bundle feature that enables users to bundle a root certificate bundle together with their application. Default bundle includes all Mozilla root certificates Closes IDF-296
2019-09-29 06:04:34 -04:00
## ESP Certificate Bundle
$(IDF_PATH)/components/mbedtls/esp_crt_bundle/include/esp_crt_bundle.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 04:36:01 -04: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 10:44:46 -04:00
## Provisioning - API Reference
##
## Protocol Communication
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/protocomm/include/common/protocomm.h \
$(IDF_PATH)/components/protocomm/include/security/protocomm_security.h \
$(IDF_PATH)/components/protocomm/include/security/protocomm_security0.h \
$(IDF_PATH)/components/protocomm/include/security/protocomm_security1.h \
$(IDF_PATH)/components/protocomm/include/transports/protocomm_ble.h \
$(IDF_PATH)/components/protocomm/include/transports/protocomm_console.h \
$(IDF_PATH)/components/protocomm/include/transports/protocomm_httpd.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 10:44:46 -04:00
## WiFi Provisioning
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/wifi_provisioning/include/wifi_provisioning/manager.h \
$(IDF_PATH)/components/wifi_provisioning/include/wifi_provisioning/scheme_ble.h \
$(IDF_PATH)/components/wifi_provisioning/include/wifi_provisioning/scheme_softap.h \
$(IDF_PATH)/components/wifi_provisioning/include/wifi_provisioning/scheme_console.h \
$(IDF_PATH)/components/wifi_provisioning/include/wifi_provisioning/wifi_config.h \
$(IDF_PATH)/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 10:44:46 -04: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 04:36:01 -04:00
## Storage - API Reference
##
## SPI Flash and Partition APIs
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/spi_flash/include/esp_flash_spi_init.h \
$(IDF_PATH)/components/spi_flash/include/esp_flash.h \
$(IDF_PATH)/components/spi_flash/include/esp_partition.h \
$(IDF_PATH)/components/bootloader_support/include/esp_flash_encrypt.h \
$(IDF_PATH)/components/soc/include/hal/spi_flash_types.h \
Add SPIFFS Component to IDF
2017-09-07 10:37:59 -04:00
## SPIFFS
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 04:36:01 -04:00
## SD/MMC Card Host
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/sdmmc/include/sdmmc_cmd.h \
$(IDF_PATH)/components/driver/include/driver/sdmmc_host.h \
$(IDF_PATH)/components/driver/include/driver/sdmmc_types.h \
$(IDF_PATH)/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 06:57:41 -04:00
## SDIO slave
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/driver/include/driver/sdio_slave.h \
$(IDF_PATH)/components/soc/include/hal/sdio_slave_types.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 04:36:01 -04:00
## Non-Volatile Storage
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/nvs_flash/include/nvs.h \
$(IDF_PATH)/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 04:36:01 -04:00
## Virtual Filesystem
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/vfs/include/esp_vfs.h \
$(IDF_PATH)/components/vfs/include/esp_vfs_dev.h \
$(IDF_PATH)/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 04:36:01 -04:00
## FAT Filesystem
## NOTE: for two lines below header_file.inc is not used
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/fatfs/vfs/esp_vfs_fat.h \
$(IDF_PATH)/components/fatfs/diskio/diskio_impl.h \
$(IDF_PATH)/components/fatfs/diskio/diskio_sdmmc.h \
$(IDF_PATH)/components/fatfs/diskio/diskio_wl.h \
$(IDF_PATH)/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 04:36:01 -04:00
## Wear Levelling
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 04:36:01 -04:00
##
## System - API Reference
##
console: simplify examples 1. simplify console examples 2. add "quit" command 3. support console command overwrite 4. add API reference
2020-02-03 05:01:04 -05:00
## ESP Console
$(IDF_PATH)/components/console/esp_console.h \
## Memory Allocation
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/heap/include/esp_heap_caps.h \
$(IDF_PATH)/components/heap/include/esp_heap_trace.h \
$(IDF_PATH)/components/heap/include/esp_heap_caps_init.h \
$(IDF_PATH)/components/heap/include/multi_heap.h \
Spiram: Add option to reserve MMU banks; add himem API to make use of those banks
2018-06-28 23:05:36 -04:00
## Himem
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 04:36:01 -04:00
## Interrupt Allocation
doc: Include paths for chip specific headers now depend on target Input for Doxygen now depend on idf_target for some paths, updated path name generated in run_doxygen.py to show the target dependent path.
2019-12-12 21:48:21 -05:00
$(IDF_PATH)/components/$(IDF_TARGET)/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 04:36:01 -04:00
## Watchdogs
## NOTE: for two lines below header_file.inc is not used
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_common/include/esp_int_wdt.h \
$(IDF_PATH)/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 06:57:31 -04:00
## Hooks
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 02:16:29 -05:00
## Inter-Processor Call
esp_ipc: Move to new component This commit moves esp_ipc into a separate component.
2020-04-27 02:29:54 -04:00
$(IDF_PATH)/components/esp_ipc/include/esp_ipc.h \
docs: added esp-expression-with-stack on documentation
2019-11-22 12:28:15 -05:00
## Call Function with External stack
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_common/include/esp_expression_with_stack.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 04:36:01 -04:00
## Over The Air Updates (OTA)
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/app_update/include/esp_ota_ops.h \
esp_https_ota: Add support for HTTPS based ota feature
2018-07-12 08:15:44 -04:00
## ESP HTTPS OTA
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_https_ota/include/esp_https_ota.h \
sleep: add light sleep, factor out APIs common for deep/light sleep
2017-04-21 00:32:50 -04:00
## Sleep
doc: Include paths for chip specific headers now depend on target Input for Doxygen now depend on idf_target for some paths, updated path name generated in run_doxygen.py to show the target dependent path.
2019-12-12 21:48:21 -05:00
$(IDF_PATH)/components/$(IDF_TARGET)/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 04:36:01 -04:00
## Logging
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 04:36:01 -04:00
## Base MAC address
## NOTE: for line below header_file.inc is not used
docs: update docs with panic handler changes
2020-02-02 10:25:39 -05:00
$(IDF_PATH)/components/esp_system/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 00:40:12 -04:00
## IDF version
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 04:36:01 -04:00
##
## ULP Coprocessor - API Guides
##
## NOTE: for line below header_file.inc is not used
doc: Include paths for chip specific headers now depend on target Input for Doxygen now depend on idf_target for some paths, updated path name generated in run_doxygen.py to show the target dependent path.
2019-12-12 21:48:21 -05:00
$(IDF_PATH)/components/ulp/include/$(IDF_TARGET)/ulp.h \
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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-21 23:07:37 -04:00
##
## Application Level Tracing - API Reference
##
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/app_trace/include/esp_app_trace.h \
$(IDF_PATH)/components/app_trace/include/esp_sysview_trace.h \
docs: add power management API reference
2017-10-09 02:38:41 -04:00
### Power management
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_common/include/esp_pm.h \
doc: Include paths for chip specific headers now depend on target Input for Doxygen now depend on idf_target for some paths, updated path name generated in run_doxygen.py to show the target dependent path.
2019-12-12 21:48:21 -05:00
$(IDF_PATH)/components/$(IDF_TARGET)/include/$(IDF_TARGET)/pm.h \
esp_timer: add documentation, expose profiling option in Kconfig
2017-11-24 05:51:37 -05:00
### esp_timer, High Resolution Timer
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_timer/include/esp_timer.h \
event: Implement event loop library
2018-10-26 01:14:19 -04:00
### esp_event, Event Loop Library
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_event/include/esp_event.h \
$(IDF_PATH)/components/esp_event/include/esp_event_base.h \
docs: Add efuse
2018-11-18 22:41:26 -05:00
### eFuse Manager
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/efuse/include/esp_efuse.h \
docs: Add description
2019-04-29 00:31:50 -04:00
### App Image Format
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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 04:26:04 -05:00
### ESP Pthread parameters
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/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-11-30 23:50:45 -05:00
###
### FreeRTOS
###
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/freertos/include/freertos/task.h \
$(IDF_PATH)/components/freertos/include/freertos/queue.h \
$(IDF_PATH)/components/freertos/include/freertos/semphr.h \
$(IDF_PATH)/components/freertos/include/freertos/timers.h \
$(IDF_PATH)/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 06:29:01 -04:00
### Ringbuffer
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_ringbuf/include/freertos/ringbuf.h \
docs: add error codes reference
2018-06-13 04:07:26 -04:00
### Helper functions for error codes
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/esp_common/include/esp_err.h \
docs: add API reference section for esp_system.h
2018-07-30 09:19:20 -04:00
### System APIs
docs: update docs with panic handler changes
2020-02-02 10:25:39 -05:00
$(IDF_PATH)/components/esp_system/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 11:45:41 -04:00
### Modbus controller component header file
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/freemodbus/common/include/esp_modbus_common.h \
$(IDF_PATH)/components/freemodbus/common/include/esp_modbus_slave.h \
$(IDF_PATH)/components/freemodbus/common/include/esp_modbus_master.h \
Performance monitor component. The component contains APIs, example and documentation.
2019-04-04 04:06:22 -04:00
### Performance Monitor component header file
docs: add new top-level docs builder that builds docs for a single chip
2019-11-12 22:46:16 -05:00
$(IDF_PATH)/components/perfmon/include/xtensa_perfmon_access.h \
$(IDF_PATH)/components/perfmon/include/xtensa_perfmon_apis.h \
$(IDF_PATH)/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 09:51:27 -04:00
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04: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-21 23:07:37 -04:00
## Get warnings for functions that have no documentation for their parameters or return value
Doxygen configuration clean up
2016-11-16 14:27:55 -05:00
##
WARN_NO_PARAMDOC = YES
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04: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 04:36:01 -04: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-11-30 23:50:45 -05:00
PREDEFINED = \
docs: Move Doxygen build to a Sphinx extension, load sdkconfig & soc caps headers
2019-11-12 05:42:03 -05:00
$(ENV_DOXYGEN_DEFINES) \
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-11-30 23:50:45 -05:00
__attribute__(x)= \
docs: Clear _Static_assert related warnings Unclear why defining _Static_assert(x, y) in PREDEFINED list doesn't match anything, but defining _Static_assert() does match.
2019-12-10 00:59:15 -05:00
_Static_assert()= \
ci: Add IDF_DEPRECATED macro for things we only deprecate in our CI passes
2019-04-17 02:31:07 -04: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-11-30 23:50:45 -05: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 03:25:59 -04:00
configUSE_APPLICATION_TASK_TAG=1 \
docs: add event handling API guide
2018-11-21 02:56:06 -05: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 04:36:01 -04:00
Doxygen configuration clean up
2016-11-16 14:27:55 -05:00
## Do not complain about not having dot
##
HAVE_DOT = NO
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04:00
Doxygen configuration clean up
2016-11-16 14:27:55 -05: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 04:36:01 -04:00
GENERATE_XML = YES
XML_OUTPUT = xml
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04: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 04:36:01 -04: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 17:00:30 -04:00
Doxygen configuration clean up
2016-11-16 14:27:55 -05:00
## Skip distracting progress messages
##
QUIET = YES
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 04:36:01 -04:00
Reference in New Issue Copy Permalink