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
5eb098393b
esp-idf/docs/doxygen/Doxyfile_common

271 lines
15 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
docs: change some header path to use IDF_TARGET Some header path were using hardcoded esp32 paths, when they should be target dependent.
2020-10-28 06:38:51 -04:00
PROJECT_NAME = "IDF 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 = \
docs: tinyusb documentation
2020-08-18 05:51:32 -04:00
$(IDF_PATH)/components/tinyusb/additions/include/tinyusb.h \
$(IDF_PATH)/components/tinyusb/additions/include/tinyusb_types.h \
$(IDF_PATH)/components/tinyusb/additions/include/tusb_cdc_acm.h \
$(IDF_PATH)/components/tinyusb/additions/include/tusb_config.h \
$(IDF_PATH)/components/tinyusb/additions/include/tusb_console.h \
$(IDF_PATH)/components/tinyusb/additions/include/tusb_tasks.h \
$(IDF_PATH)/components/tinyusb/additions/include/vfs_tinyusb.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/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 \
$(IDF_PATH)/components/esp_wifi/include/esp_mesh.h \
docs: Separate Doc on WiFi security, added DPP Doc 1. Add new Doc on WiFi security 2. Add DPP related Doc under WiFi 3. Add Supplicant public headers in Doxyfile
2021-01-21 01:08:56 -05:00
$(IDF_PATH)/components/wpa_supplicant/esp_supplicant/include/esp_dpp.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/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 \
component/bt: add BLE v5.0 feature for bluedroid host
2020-07-09 08:58:13 -04:00
$(IDF_PATH)/components/bt/include/esp32/include/esp_bt.h \
Add support of NimBLE host to Blufi Merges https://github.com/espressif/esp-idf/pull/6904
2021-03-31 00:51:48 -04:00
$(IDF_PATH)/components/bt/common/api/include/api/esp_blufi_api.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/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 \
$(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h \
$(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_gap_bt_api.h \
$(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 \
$(IDF_PATH)/components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \
$(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 \
hal/emac_hal: refactord emac_hal
2021-05-07 05:38:36 -04:00
$(IDF_PATH)/components/hal/include/hal/eth_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/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: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/adc_types.h \
$(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
$(IDF_PATH)/components/driver/include/driver/adc_common.h \
$(IDF_PATH)/components/driver/$(IDF_TARGET)/include/driver/adc.h \
$(IDF_PATH)/components/esp_adc_cal/include/esp_adc_cal.h \
$(IDF_PATH)/components/hal/include/hal/dac_types.h \
$(IDF_PATH)/components/driver/include/driver/dac_common.h \
$(IDF_PATH)/components/hal/include/hal/gpio_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/driver/include/driver/gpio.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/driver/include/driver/dedic_gpio.h \
$(IDF_PATH)/components/hal/include/hal/rtc_io_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/driver/include/driver/rtc_io.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/i2c_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/driver/include/driver/i2c.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/i2s_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/driver/include/driver/i2s.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/ledc_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/driver/include/driver/ledc.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/rmt_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/driver/include/driver/rmt.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/sigmadelta_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/driver/include/driver/sigmadelta.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/spi_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/driver/include/driver/spi_common.h \
$(IDF_PATH)/components/driver/include/driver/spi_master.h \
$(IDF_PATH)/components/driver/include/driver/spi_slave.h \
spi_slave_hd: new driver for spi slave in half duplex mode
2020-04-29 04:20:40 -04:00
$(IDF_PATH)/components/driver/include/driver/spi_slave_hd.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/timer_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/driver/include/driver/timer.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/touch_sensor_types.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 \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/twai_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/driver/include/driver/twai.h \
hal: extract hal component from soc component
2020-08-08 08:15:27 -04:00
$(IDF_PATH)/components/hal/include/hal/uart_types.h \
docs: change some header path to use IDF_TARGET Some header path were using hardcoded esp32 paths, when they should be target dependent.
2020-10-28 06:38:51 -04:00
$(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/driver/include/driver/uart.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/esp_netif/include/esp_netif.h \
$(IDF_PATH)/components/esp_netif/include/esp_netif_net_stack.h \
$(IDF_PATH)/components/esp-tls/esp_tls.h \
$(IDF_PATH)/components/mqtt/esp-mqtt/include/mqtt_client.h \
$(IDF_PATH)/components/lwip/include/apps/ping/ping_sock.h \
lwip: Moved default SNTP API to esp_sntp.h and make sntp.h in port folders of lwip component obsoleted
2021-01-12 21:28:34 -05:00
$(IDF_PATH)/components/lwip/include/apps/esp_sntp.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/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 \
$(IDF_PATH)/components/esp_http_server/include/esp_http_server.h \
$(IDF_PATH)/components/esp_https_server/include/esp_https_server.h \
$(IDF_PATH)/components/esp_local_ctrl/include/esp_local_ctrl.h \
$(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 \
spi_slave_hd: new driver for spi slave in half duplex mode
2020-04-29 04:20:40 -04:00
$(IDF_PATH)/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_spi.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
$(IDF_PATH)/components/mbedtls/esp_crt_bundle/include/esp_crt_bundle.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/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 \
$(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: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/hal/include/hal/spi_flash_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/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 \
docs: Add random number generation to the API Reference System section
2021-05-10 21:40:38 -04:00
$(IDF_PATH)/components/bootloader_support/include/bootloader_random.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/spiffs/include/esp_spiffs.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/driver/include/driver/sdmmc_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/sdmmc/include/sdmmc_cmd.h \
$(IDF_PATH)/components/driver/include/driver/sdmmc_host.h \
$(IDF_PATH)/components/driver/include/driver/sdspi_host.h \
hal: extract hal component from soc component
2020-08-08 08:15:27 -04:00
$(IDF_PATH)/components/hal/include/hal/sdio_slave_types.h \
docs: reorder the sequence of headers This can makes the public headers more obvious
2021-02-06 07:52:28 -05:00
$(IDF_PATH)/components/driver/include/driver/sdio_slave.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/nvs_flash/include/nvs.h \
$(IDF_PATH)/components/nvs_flash/include/nvs_flash.h \
OpenThread: add OpenThread and porting * Adds the OpenThread submodule. * Adds porting on ESP32. * Adds the OpenThread cli example.
2021-04-02 02:49:49 -04:00
$(IDF_PATH)/components/openthread/include/esp_openthread.h \
docs: add OpenThread docs
2021-07-22 23:57:40 -04:00
$(IDF_PATH)/components/openthread/include/esp_openthread_border_router.h \
OpenThread: add OpenThread and porting * Adds the OpenThread submodule. * Adds porting on ESP32. * Adds the OpenThread cli example.
2021-04-02 02:49:49 -04:00
$(IDF_PATH)/components/openthread/include/esp_openthread_lock.h \
docs: add OpenThread docs
2021-07-22 23:57:40 -04:00
$(IDF_PATH)/components/openthread/include/esp_openthread_netif_glue.h \
OpenThread: add OpenThread and porting * Adds the OpenThread submodule. * Adds porting on ESP32. * Adds the OpenThread cli example.
2021-04-02 02:49:49 -04:00
$(IDF_PATH)/components/openthread/include/esp_openthread_types.h \
$(IDF_PATH)/components/openthread/include/openthread-core-esp32x-config.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/vfs/include/esp_vfs.h \
$(IDF_PATH)/components/vfs/include/esp_vfs_dev.h \
vfs: add doc links
2021-03-08 03:29:22 -05:00
$(IDF_PATH)/components/vfs/include/esp_vfs_eventfd.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/vfs/include/esp_vfs_semihost.h \
$(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 \
$(IDF_PATH)/components/wear_levelling/include/wear_levelling.h \
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
$(IDF_PATH)/components/console/esp_console.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/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 \
esp_system: move intr_alloc
2021-03-10 08:39:29 -05:00
$(IDF_PATH)/components/esp_hw_support/include/esp_intr_alloc.h \
docs, ci: update docs and ci with movements from esp_common
2021-01-20 02:17:38 -05:00
$(IDF_PATH)/components/esp_system/include/esp_int_wdt.h \
$(IDF_PATH)/components/esp_system/include/esp_task_wdt.h \
$(IDF_PATH)/components/esp_hw_support/include/esp_crc.h \
$(IDF_PATH)/components/esp_system/include/esp_freertos_hooks.h \
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, ci: update docs and ci with movements from esp_common
2021-01-20 02:17:38 -05:00
$(IDF_PATH)/components/esp_system/include/esp_expression_with_stack.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/app_update/include/esp_ota_ops.h \
$(IDF_PATH)/components/esp_https_ota/include/esp_https_ota.h \
esp_system: move asysnc memcpy to esp_hw_support
2021-03-10 08:32:47 -05:00
$(IDF_PATH)/components/esp_hw_support/include/esp_async_memcpy.h \
docs: Add random number generation to the API Reference System section
2021-05-10 21:40:38 -04:00
$(IDF_PATH)/components/esp_hw_support/include/esp_random.h \
$(IDF_PATH)/components/esp_hw_support/include/esp_sleep.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/log/include/esp_log.h \
docs: Add esp_rom_printf to API Reference
2020-09-02 07:57:39 -04:00
$(IDF_PATH)/components/esp_rom/include/esp_rom_sys.h \
docs: update docs with panic handler changes
2020-02-02 10:25:39 -05:00
$(IDF_PATH)/components/esp_system/include/esp_system.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/esp_common/include/esp_idf_version.h \
docs: tinyusb documentation
2020-08-18 05:51:32 -04:00
$(IDF_PATH)/components/ulp/include/ulp_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/app_trace/include/esp_app_trace.h \
$(IDF_PATH)/components/app_trace/include/esp_sysview_trace.h \
esp32, esp32s2: create esp_pm component
2020-07-21 05:15:19 -04:00
$(IDF_PATH)/components/esp_pm/include/esp_pm.h \
$(IDF_PATH)/components/esp_pm/include/$(IDF_TARGET)/pm.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/esp_timer/include/esp_timer.h \
$(IDF_PATH)/components/esp_event/include/esp_event.h \
$(IDF_PATH)/components/esp_event/include/esp_event_base.h \
$(IDF_PATH)/components/efuse/include/esp_efuse.h \
$(IDF_PATH)/components/bootloader_support/include/esp_app_format.h \
$(IDF_PATH)/components/pthread/include/esp_pthread.h \
$(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 \
freertos: merged freertos 10 kernel files into IDF freertos/port: update the port files and split into xtensa and riscv ports freertos: separated cpu files from rest of the kernel sources freertos/port_xtensa: separated private include files into a folder freertos/tasks: added task create pinned to core function do not break current IDF API freertos/tasks: mimiced task create pinned function into tasks.c to do not break the IDF API. freertos: freertos component now compiling freertos: freertos component now building freertos: moved critical sections outside from FR kernel section to portable section portmacro_xtensa: add void indentifier on functions that take no arguments freertos: fix critical sections implementation to match with their function prototype freertos: add cmake changes of freertos into make freertos: remove portDONT_DISCARD attribute from switch context function, it was breaking the docs building. freertos: fix conflicitng types of vApplicationSleep function license: update the license of freertos freertos: Doxygen comments refactored to render them correctly on docs freertos: added new functions of freertos into the documentation freertos: added message buffers and stream buffers to documentation sysview: update freertos system view to the compatible with version 10 freertos: fixed event group documentation rendering freertos: update static task structure to match the actual tcb size freertos: removed backported test functions freertos/smp: brought SMP code to FreeRTOS 10 port freertos/portmacro: added missing crosscore interrupt for yielding tasks freertos: replaced soft-critical sections with hard-critical sections used by SMP freertos: placed muxes inside of kernel objects freertos: replaced original FR critical sections with SMP enabled spinlocks critical sections freertos: moved xtensa port files to a separated folder freertos: added multiple instance of global variables required to SMP freertos: added SMP modifications on specific tasks module functions freertos: added TLS deletion function to task module freertos/tls: initialize TLS deletion callback to avoid crashing when calling task delete freertos: modified vTaskDelete to do not erase current task that runs on other core freertos: reverted taskhandle and timerhandle as void* type freertos: fixed de-referencing void pointer to get run time counter freertos: fix system view trace enter macro arguments freertos: Replaced soft critical sections with spinlocks on event_groups freertos: fixed tick function to avoid calling tick hooks twice freertos: Nofity give checking per CPU if schedule is suspended freertos: added mpu release on TCB deletion freertos: Added SMP changes when deleting a TCB on idle task freertos/license: update freertos license in COPYRIGHT.rst freertos: unicore configurations can use task create pinned to core, it will be always pinned to core 0 freertos/portmacro: added cpu_hal_get_core_id() function instead of inline assembly freertos/xtensa: update xtensa specific files used in master branch newlib/locks: revert the preemption checking in lock acquisition and release ref_clock: fix initial state of ref_clock interrupt handler freertos: added missing critical sections and yielding checkings freertos: remove magic numbers in vTaskDelete freertos: added missing critical section in prvIsQueueEmpty
2019-11-28 13:27:47 -05:00
$(IDF_PATH)/components/freertos/include/freertos/stream_buffer.h \
$(IDF_PATH)/components/freertos/include/freertos/message_buffer.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/esp_ringbuf/include/freertos/ringbuf.h \
$(IDF_PATH)/components/esp_common/include/esp_err.h \
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
$(IDF_PATH)/components/esp_common/include/esp_check.h \
docs: update docs with panic handler changes
2020-02-02 10:25:39 -05:00
$(IDF_PATH)/components/esp_system/include/esp_system.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/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 \
docs: fix doxygen compile warnings for doxygen 1.9.1 Newer versions of doxygen will give warnings for comments in INPUT lists Delete all comment lines to fix these warnings, our folder structure stil gives an OK overview of what we are including
2021-04-08 23:57:03 -04:00
$(IDF_PATH)/components/perfmon/include/xtensa_perfmon_access.h \
$(IDF_PATH)/components/perfmon/include/xtensa_perfmon_apis.h \
ieee802154: add IEEE 802.15.4 component
2021-07-09 00:04:15 -04:00
$(IDF_PATH)/components/perfmon/include/xtensa_perfmon_masks.h \
$(IDF_PATH)/components/ieee802154/include/esp_ieee802154.h \
$(IDF_PATH)/components/ieee802154/include/esp_ieee802154_types.h
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04:00
Docs: Add C3 support to build_docs
2020-10-28 21:57:09 -04:00
## Target specific headers are in seperate Doxyfile files
@INCLUDE = $(IDF_PATH)/docs/doxygen/Doxyfile_$(IDF_TARGET)
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
Reference in New Issue Copy Permalink