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
d8b2b9e77f
esp-idf/docs/doxygen/Doxyfile

357 lines
23 KiB
Plaintext
Raw Normal View History

docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
# This is Doxygen configuration file
#
# Doxygen provides over 260 configuration statements
# To make this file easier to follow,
# it contains only statements that are non-default
#
# NOTE:
# It is recommended not to change defaults unless specifically required
# Test any changes how they affect generated documentation
# Make sure that correct warnings are generated to flag issues with documented code
#
# For the complete list of configuration statements see:
# http://doxygen.nl/manual/config.html
PROJECT_NAME = "IDF Programming Guide"
## The 'INPUT' statement below is used as input by script 'gen-df-input.py'
## to automatically generate API reference list files heder_file.inc
## These files are placed in '_inc' directory
## and used to include in API reference documentation
INPUT = \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/app_trace/include/esp_app_trace.h \
$(PROJECT_PATH)/components/app_trace/include/esp_sysview_trace.h \
$(PROJECT_PATH)/components/app_update/include/esp_ota_ops.h \
$(PROJECT_PATH)/components/bootloader_support/include/bootloader_random.h \
$(PROJECT_PATH)/components/bootloader_support/include/esp_app_format.h \
$(PROJECT_PATH)/components/bootloader_support/include/esp_flash_encrypt.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/bt/common/api/include/api/esp_blufi_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_common_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_local_data_operation_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_low_power_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_networking_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_provisioning_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/core/include/esp_ble_mesh_proxy_api.h \
feat(ble_mesh): Support Bluetooth Mesh Protocol v1.1 (Preview)
2023-08-28 04:09:37 -04:00
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_agg_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_brc_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_cm_data_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_df_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_lcd_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_odp_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_prb_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_rpr_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_sar_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/core/include/esp_ble_mesh_srpl_model_api.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/esp_ble_mesh_defs.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_config_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_generic_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_health_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_lighting_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_sensor_model_api.h \
$(PROJECT_PATH)/components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_time_scene_model_api.h \
feat(ble_mesh): Support Bluetooth Mesh Protocol v1.1 (Preview)
2023-08-28 04:09:37 -04:00
$(PROJECT_PATH)/components/bt/esp_ble_mesh/v1.1/api/models/include/esp_ble_mesh_mbt_model_api.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_a2dp_api.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_avrc_api.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_bt_defs.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_bt_device.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_bt_main.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_gatt_defs.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_gatts_api.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h \
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_defs.h \
component/docs: enable generation of API-reference documents for Bluetooth HID device
2022-03-23 09:25:44 -04:00
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hidd_api.h \
component/docs: enable generation of API-reference documents for Bluetooth HID host
2022-03-25 06:20:37 -04:00
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hidh_api.h \
Added BT_L2CAP API reference document
2022-05-18 03:48:21 -04:00
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_l2cap_bt_api.h \
Added BT_SDP API reference document
2022-05-28 03:20:42 -04:00
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_sdp_api.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_spp_api.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \
$(PROJECT_PATH)/components/console/esp_console.h \
ana_cmpr: add programming guide
2023-03-13 00:34:53 -04:00
$(PROJECT_PATH)/components/driver/analog_comparator/include/driver/ana_cmpr.h \
feat(ana_cmpr): supported etm in analog comparator example
2023-07-30 22:43:54 -04:00
$(PROJECT_PATH)/components/driver/analog_comparator/include/driver/ana_cmpr_etm.h \
ana_cmpr: add programming guide
2023-03-13 00:34:53 -04:00
$(PROJECT_PATH)/components/driver/analog_comparator/include/driver/ana_cmpr_types.h \
driver: pack peripherals
2023-01-31 01:36:21 -05:00
$(PROJECT_PATH)/components/driver/dac/include/driver/dac_continuous.h \
$(PROJECT_PATH)/components/driver/dac/include/driver/dac_cosine.h \
$(PROJECT_PATH)/components/driver/dac/include/driver/dac_oneshot.h \
$(PROJECT_PATH)/components/driver/dac/include/driver/dac_types.h \
docs(i2c): Add new programming guide for new I2C driver
2023-11-07 05:41:26 -05:00
$(PROJECT_PATH)/components/driver/i2c/include/driver/i2c_master.h \
$(PROJECT_PATH)/components/driver/i2c/include/driver/i2c_slave.h \
$(PROJECT_PATH)/components/driver/i2c/include/driver/i2c_types.h \
driver: pack peripherals
2023-01-31 01:36:21 -05:00
$(PROJECT_PATH)/components/driver/gpio/include/driver/dedic_gpio.h \
$(PROJECT_PATH)/components/driver/gpio/include/driver/gpio.h \
$(PROJECT_PATH)/components/driver/gpio/include/driver/gpio_etm.h \
$(PROJECT_PATH)/components/driver/gpio/include/driver/gpio_filter.h \
feat(gpio): add a dump API to dump IO configurations Closes https://github.com/espressif/esp-idf/issues/12176
2023-09-22 05:36:51 -04:00
$(PROJECT_PATH)/components/driver/gpio/include/driver/lp_io.h \
driver: pack peripherals
2023-01-31 01:36:21 -05:00
$(PROJECT_PATH)/components/driver/gpio/include/driver/rtc_io.h \
$(PROJECT_PATH)/components/driver/gptimer/include/driver/gptimer.h \
$(PROJECT_PATH)/components/driver/gptimer/include/driver/gptimer_etm.h \
$(PROJECT_PATH)/components/driver/gptimer/include/driver/gptimer_types.h \
$(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_common.h \
$(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_pdm.h \
$(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_std.h \
$(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_tdm.h \
$(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_types.h \
$(PROJECT_PATH)/components/driver/ledc/include/driver/ledc.h \
$(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_cap.h \
$(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_cmpr.h \
docs(pcnt,mcpwm): document new features for esp32p4
2023-09-13 06:20:15 -04:00
$(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_etm.h \
driver: pack peripherals
2023-01-31 01:36:21 -05:00
$(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_fault.h \
$(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_gen.h \
$(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_oper.h \
$(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_sync.h \
$(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_timer.h \
$(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_types.h \
doc: initial parallel IO programming guide Also correct the GPIO information on esp32h2.
2023-02-22 00:29:31 -05:00
$(PROJECT_PATH)/components/driver/parlio/include/driver/parlio_tx.h \
$(PROJECT_PATH)/components/driver/parlio/include/driver/parlio_types.h \
driver: pack peripherals
2023-01-31 01:36:21 -05:00
$(PROJECT_PATH)/components/driver/pcnt/include/driver/pulse_cnt.h \
$(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_common.h \
$(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_encoder.h \
$(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_rx.h \
$(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_tx.h \
$(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_types.h \
$(PROJECT_PATH)/components/driver/sdio_slave/include/driver/sdio_slave.h \
$(PROJECT_PATH)/components/driver/sigma_delta/include/driver/sdm.h \
feat(sdmmc): supported sd2.0 on esp32p4
2023-08-29 07:50:27 -04:00
$(PROJECT_PATH)/components/driver/sdmmc/include/driver/sdmmc_default_configs.h \
driver: pack peripherals
2023-01-31 01:36:21 -05:00
$(PROJECT_PATH)/components/driver/sdmmc/include/driver/sdmmc_host.h \
$(PROJECT_PATH)/components/driver/sdmmc/include/driver/sdmmc_types.h \
$(PROJECT_PATH)/components/driver/spi/include/driver/sdspi_host.h \
$(PROJECT_PATH)/components/driver/spi/include/driver/spi_common.h \
$(PROJECT_PATH)/components/driver/spi/include/driver/spi_master.h \
$(PROJECT_PATH)/components/driver/spi/include/driver/spi_slave_hd.h \
$(PROJECT_PATH)/components/driver/spi/include/driver/spi_slave.h \
$(PROJECT_PATH)/components/driver/temperature_sensor/include/driver/temperature_sensor.h \
$(PROJECT_PATH)/components/driver/touch_sensor/include/driver/touch_sensor_common.h \
$(PROJECT_PATH)/components/driver/twai/include/driver/twai.h \
$(PROJECT_PATH)/components/driver/uart/include/driver/uart.h \
test: move 'driver/test/esp_serial_slave_link' to 'driver/test-apps/components' and make it be a component
2022-11-07 01:11:55 -05:00
$(PROJECT_PATH)/components/driver/test_apps/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_sdio.h \
$(PROJECT_PATH)/components/driver/test_apps/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_spi.h \
$(PROJECT_PATH)/components/driver/test_apps/components/esp_serial_slave_link/include/esp_serial_slave_link/essl.h \
efuse: Adds missing header
2022-08-01 09:19:38 -04:00
$(PROJECT_PATH)/components/efuse/$(IDF_TARGET)/include/esp_efuse_chip.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/efuse/include/esp_efuse.h \
esp_adc: new esp_adc component and adc drivers
2022-07-15 00:52:44 -04:00
$(PROJECT_PATH)/components/esp_adc/include/esp_adc/adc_cali_scheme.h \
$(PROJECT_PATH)/components/esp_adc/include/esp_adc/adc_cali.h \
$(PROJECT_PATH)/components/esp_adc/include/esp_adc/adc_continuous.h \
$(PROJECT_PATH)/components/esp_adc/include/esp_adc/adc_oneshot.h \
docs: Added migration guide for `app_update` - Deprecated functions and alternatives
2022-07-06 00:54:48 -04:00
$(PROJECT_PATH)/components/esp_app_format/include/esp_app_desc.h \
esp_bootloader_format: Adds bootloader description structure to read bootloader version from app Closes https://github.com/espressif/esp-idf/issues/8800 Closes https://github.com/espressif/esp-idf/issues/9132
2022-12-13 12:16:56 -05:00
$(PROJECT_PATH)/components/esp_bootloader_format/include/esp_bootloader_desc.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_common/include/esp_check.h \
$(PROJECT_PATH)/components/esp_common/include/esp_err.h \
$(PROJECT_PATH)/components/esp_common/include/esp_idf_version.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/esp_eth/include/esp_eth_com.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/esp_eth/include/esp_eth_driver.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/esp_eth/include/esp_eth_mac.h \
$(PROJECT_PATH)/components/esp_eth/include/esp_eth_netif_glue.h \
esp_eth: IEEE 802.3 PHY MII Management Interface functionality grouped to one common file
2022-05-13 06:03:56 -04:00
$(PROJECT_PATH)/components/esp_eth/include/esp_eth_phy_802_3.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/esp_eth/include/esp_eth_phy.h \
$(PROJECT_PATH)/components/esp_eth/include/esp_eth.h \
doc: update api reference for new rmt driver
2022-04-07 01:15:23 -04:00
$(PROJECT_PATH)/components/esp_event/include/esp_event_base.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/esp_event/include/esp_event.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_http_client/include/esp_http_client.h \
$(PROJECT_PATH)/components/esp_http_server/include/esp_http_server.h \
$(PROJECT_PATH)/components/esp_https_ota/include/esp_https_ota.h \
$(PROJECT_PATH)/components/esp_https_server/include/esp_https_server.h \
esp_clk_tree: Rename clk_tree_xxx to esp_clk_tree_xxx, add compilation warning to clk_tree.h
2023-04-23 03:49:59 -04:00
$(PROJECT_PATH)/components/esp_hw_support/include/esp_clk_tree.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_hw_support/include/esp_async_memcpy.h \
$(PROJECT_PATH)/components/esp_hw_support/include/esp_chip_info.h \
$(PROJECT_PATH)/components/esp_hw_support/include/esp_cpu.h \
$(PROJECT_PATH)/components/esp_hw_support/include/esp_crc.h \
doc: add api reference for etm driver
2022-09-20 02:23:15 -04:00
$(PROJECT_PATH)/components/esp_hw_support/include/esp_etm.h \
feat(cache): added cache msync doc
2023-09-27 01:08:28 -04:00
$(PROJECT_PATH)/components/esp_hw_support/include/esp_dma_utils.h \
docs: Fix Doxyfile after esp_ds.h is merged
2022-11-22 00:21:09 -05:00
$(PROJECT_PATH)/components/esp_hw_support/include/esp_ds.h \
docs: Update esp_hmac references from doxyfile
2022-10-03 10:25:17 -04:00
$(PROJECT_PATH)/components/esp_hw_support/include/esp_hmac.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_hw_support/include/esp_intr_alloc.h \
refactor(intr): add namespace for intr_cpu_id_t previously the intr_types.h doesn't have a namespace, it has the risk of introduing conflict in user's project.
2023-07-12 22:44:06 -04:00
$(PROJECT_PATH)/components/esp_hw_support/include/esp_intr_types.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_hw_support/include/esp_mac.h \
$(PROJECT_PATH)/components/esp_hw_support/include/esp_random.h \
$(PROJECT_PATH)/components/esp_hw_support/include/esp_sleep.h \
lcd: initial build of API docs
2021-09-25 10:23:10 -04:00
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_io.h \
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_ops.h \
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_rgb.h \
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_panel_vendor.h \
$(PROJECT_PATH)/components/esp_lcd/include/esp_lcd_types.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_local_ctrl/include/esp_local_ctrl.h \
doc: added memory management programming guides
2023-03-21 04:15:13 -04:00
$(PROJECT_PATH)/components/esp_mm/include/esp_mmu_map.h \
$(PROJECT_PATH)/components/esp_mm/include/esp_cache.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_netif/include/esp_netif_ip_addr.h \
$(PROJECT_PATH)/components/esp_netif/include/esp_netif_net_stack.h \
$(PROJECT_PATH)/components/esp_netif/include/esp_netif_types.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/esp_netif/include/esp_netif.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_netif/include/esp_vfs_l2tap.h \
esp_netif/lwip: Fix core-locking config * Fix thread safety issues in non-core locking * Add option to verify thread safety issues in lwip (core-lock assertion) * Make esp_sntp.h thread safe API * Fix sntp examples * Fix openthread libs Closes https://github.com/espressif/esp-idf/issues/9908 Closes https://github.com/espressif/esp-idf/issues/10502 Closes https://github.com/espressif/esp-idf/issues/10466
2022-10-27 13:07:07 -04:00
$(PROJECT_PATH)/components/esp_netif/include/esp_netif_sntp.h \
Storage: Partition APIs moved to the new component 'esp_partition' All the partition handling API functions and data-types were moved from the 'spi_flash' component to the new one named 'esp_partition'. See Storage 5.x migration guide for more details
2022-10-14 08:15:32 -04:00
$(PROJECT_PATH)/components/esp_partition/include/esp_partition.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_pm/include/esp_pm.h \
$(PROJECT_PATH)/components/esp_ringbuf/include/freertos/ringbuf.h \
$(PROJECT_PATH)/components/esp_rom/include/esp_rom_sys.h \
$(PROJECT_PATH)/components/esp_system/include/esp_expression_with_stack.h \
$(PROJECT_PATH)/components/esp_system/include/esp_freertos_hooks.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/esp_system/include/esp_ipc_isr.h \
$(PROJECT_PATH)/components/esp_system/include/esp_ipc.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_system/include/esp_system.h \
doc: add api reference for etm driver
2022-09-20 02:23:15 -04:00
$(PROJECT_PATH)/components/esp_system/include/esp_systick_etm.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_system/include/esp_task_wdt.h \
Docs: add CN translation for api-guides/performance/speed.rst
2023-05-19 06:38:22 -04:00
$(PROJECT_PATH)/components/esp_system/include/esp_task.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp_timer/include/esp_timer.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_mesh.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_now.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_smartconfig.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_default.h \
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi_types.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/esp_wifi/include/esp_wifi.h \
change(wifi): Add supplicant's public API header files to doc
2023-09-12 04:46:44 -04:00
$(PROJECT_PATH)/components/wpa_supplicant/esp_supplicant/include/esp_mbo.h \
$(PROJECT_PATH)/components/wpa_supplicant/esp_supplicant/include/esp_eap_client.h \
$(PROJECT_PATH)/components/wpa_supplicant/esp_supplicant/include/esp_rrm.h \
$(PROJECT_PATH)/components/wpa_supplicant/esp_supplicant/include/esp_wnm.h \
$(PROJECT_PATH)/components/wpa_supplicant/esp_supplicant/include/esp_wps.h \
esp_wifi: Add support for NAN Discovery and Datapath Update wifi lib with below - 1. Create NAN Discovery SM for beaconing & cluster formation 2. Create NAN interface for Tx/Rx of beacons & action frames 3. Add commands & events for NAN Services Publish/Subscribe/Followup 4. Add NAN Datapath definitions, Events, Peer structures 5. Support for forming and parsing of Datapath related attributes 6. Modules for NDP Req, Resp, Confirm, Term, Peer management 7. NAN Interface related additions in Datapath, Data Tx Q's In addition include below changes - 1. Add netif and driver support for NAN Interface 2. Add simple examples for Publisher-Subscriber usecases 3. Add an advanced console example that supports commands for NAN Discovery, Services & Datapath 4. Add wifi_apps for providing better NAN API's and Peer management Co-authored-by: Shyamal Khachane <shyamal.khachane@espressif.com>
2023-02-13 23:36:40 -05:00
$(PROJECT_PATH)/components/esp_wifi/wifi_apps/include/esp_nan.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/esp-tls/esp_tls_errors.h \
$(PROJECT_PATH)/components/esp-tls/esp_tls.h \
$(PROJECT_PATH)/components/fatfs/diskio/diskio_impl.h \
$(PROJECT_PATH)/components/fatfs/diskio/diskio_rawflash.h \
$(PROJECT_PATH)/components/fatfs/diskio/diskio_sdmmc.h \
$(PROJECT_PATH)/components/fatfs/diskio/diskio_wl.h \
$(PROJECT_PATH)/components/fatfs/vfs/esp_vfs_fat.h \
freertos: Add wrapper functions to create objects with capabilities This commit adds various ...WithCaps() functions to create FreeRTOS objects with specific memory capabilities.
2023-04-06 10:36:58 -04:00
$(PROJECT_PATH)/components/freertos/esp_additions/include/freertos/idf_additions.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/freertos/FreeRTOS-Kernel/include/freertos/event_groups.h \
$(PROJECT_PATH)/components/freertos/FreeRTOS-Kernel/include/freertos/message_buffer.h \
$(PROJECT_PATH)/components/freertos/FreeRTOS-Kernel/include/freertos/queue.h \
$(PROJECT_PATH)/components/freertos/FreeRTOS-Kernel/include/freertos/semphr.h \
$(PROJECT_PATH)/components/freertos/FreeRTOS-Kernel/include/freertos/stream_buffer.h \
$(PROJECT_PATH)/components/freertos/FreeRTOS-Kernel/include/freertos/task.h \
$(PROJECT_PATH)/components/freertos/FreeRTOS-Kernel/include/freertos/timers.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/hal/include/hal/adc_types.h \
dac: optimize the dma stratege
2022-10-10 07:17:22 -04:00
$(PROJECT_PATH)/components/hal/include/hal/dac_types.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/hal/include/hal/esp_flash_err.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/hal/include/hal/gpio_types.h \
$(PROJECT_PATH)/components/hal/include/hal/i2c_types.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/hal/include/hal/i2s_types.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/hal/include/hal/lcd_types.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/hal/include/hal/ledc_types.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/hal/include/hal/mcpwm_types.h \
doc: initial parallel IO programming guide Also correct the GPIO information on esp32h2.
2023-02-22 00:29:31 -05:00
$(PROJECT_PATH)/components/hal/include/hal/parlio_types.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/hal/include/hal/pcnt_types.h \
$(PROJECT_PATH)/components/hal/include/hal/rmt_types.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/hal/include/hal/rtc_io_types.h \
$(PROJECT_PATH)/components/hal/include/hal/sdio_slave_types.h \
doc: update sdm api reference
2022-06-22 04:29:35 -04:00
$(PROJECT_PATH)/components/hal/include/hal/sdm_types.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/hal/include/hal/spi_flash_types.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/hal/include/hal/spi_types.h \
$(PROJECT_PATH)/components/hal/include/hal/timer_types.h \
$(PROJECT_PATH)/components/hal/include/hal/touch_sensor_types.h \
$(PROJECT_PATH)/components/hal/include/hal/twai_types.h \
$(PROJECT_PATH)/components/hal/include/hal/uart_types.h \
all: Apply new version logic (major * 100 + minor)
2022-03-17 09:58:15 -04:00
$(PROJECT_PATH)/components/hal/include/hal/efuse_hal.h \
doc: update api reference for new rmt driver
2022-04-07 01:15:23 -04:00
$(PROJECT_PATH)/components/heap/include/esp_heap_caps_init.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/heap/include/esp_heap_caps.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/heap/include/esp_heap_trace.h \
$(PROJECT_PATH)/components/heap/include/multi_heap.h \
doc: update api reference for new rmt driver
2022-04-07 01:15:23 -04:00
$(PROJECT_PATH)/components/ieee802154/include/esp_ieee802154_types.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/ieee802154/include/esp_ieee802154.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/log/include/esp_log.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/lwip/include/apps/esp_sntp.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/lwip/include/apps/ping/ping_sock.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/mbedtls/esp_crt_bundle/include/esp_crt_bundle.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/mqtt/esp-mqtt/include/mqtt_client.h \
doc: update api reference for new rmt driver
2022-04-07 01:15:23 -04:00
$(PROJECT_PATH)/components/nvs_flash/include/nvs_flash.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/nvs_flash/include/nvs.h \
docs: Update `nvs_flash` docs for the HMAC-based NVS encr-keys protection scheme - Also updated the `nvs_partition_generator` and `mass_mfg` tools documentation
2023-04-18 08:39:38 -04:00
$(PROJECT_PATH)/components/nvs_sec_provider/include/nvs_sec_provider.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/openthread/include/esp_openthread_border_router.h \
$(PROJECT_PATH)/components/openthread/include/esp_openthread_lock.h \
$(PROJECT_PATH)/components/openthread/include/esp_openthread_netif_glue.h \
$(PROJECT_PATH)/components/openthread/include/esp_openthread_types.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/openthread/include/esp_openthread.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/protocomm/include/common/protocomm.h \
$(PROJECT_PATH)/components/protocomm/include/security/protocomm_security.h \
$(PROJECT_PATH)/components/protocomm/include/security/protocomm_security0.h \
$(PROJECT_PATH)/components/protocomm/include/security/protocomm_security1.h \
$(PROJECT_PATH)/components/protocomm/include/transports/protocomm_ble.h \
$(PROJECT_PATH)/components/protocomm/include/transports/protocomm_console.h \
$(PROJECT_PATH)/components/protocomm/include/transports/protocomm_httpd.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/pthread/include/esp_pthread.h \
$(PROJECT_PATH)/components/sdmmc/include/sdmmc_cmd.h \
$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \
clk_tree: prework of introducing clk subsystem control 1. Clean up clk usage in IDF, replace rtc_clk_xtal/apb_freq_get with upper level API esp_clk_xtal/apb_freq 2. Fix small errors and wrong comments related to clock 3. Add clk_tree_defs.h to provide an unified clock id for each chip Modify the NGed drivers to adopt new clock ids
2022-03-25 06:41:25 -04:00
$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \
refactor(gpio): per-target gpio number definition
2023-07-02 23:51:12 -04:00
$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/gpio_num.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/soc_caps.h \
$(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
doc: update api reference for new rmt driver
2022-04-07 01:15:23 -04:00
$(PROJECT_PATH)/components/spi_flash/include/esp_flash_spi_init.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/spi_flash/include/esp_flash.h \
spi_flash: Modify documentations
2022-06-27 03:21:42 -04:00
$(PROJECT_PATH)/components/spi_flash/include/spi_flash_mmap.h \
docs: provided translation for storage.rst and system.rst and updated a typo for memory-types.rst
2023-06-08 04:12:01 -04:00
$(PROJECT_PATH)/components/spi_flash/include/esp_spi_flash_counters.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/spiffs/include/esp_spiffs.h \
$(PROJECT_PATH)/components/vfs/include/esp_vfs_dev.h \
$(PROJECT_PATH)/components/vfs/include/esp_vfs_eventfd.h \
$(PROJECT_PATH)/components/vfs/include/esp_vfs_semihost.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/vfs/include/esp_vfs.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
$(PROJECT_PATH)/components/wear_levelling/include/wear_levelling.h \
docs: fix broken references to misc API functions and types.
2022-03-24 02:57:51 -04:00
$(PROJECT_PATH)/components/wifi_provisioning/include/wifi_provisioning/manager.h \
$(PROJECT_PATH)/components/wifi_provisioning/include/wifi_provisioning/scheme_ble.h \
$(PROJECT_PATH)/components/wifi_provisioning/include/wifi_provisioning/scheme_console.h \
$(PROJECT_PATH)/components/wifi_provisioning/include/wifi_provisioning/scheme_softap.h \
$(PROJECT_PATH)/components/wifi_provisioning/include/wifi_provisioning/wifi_config.h \
$(PROJECT_PATH)/components/wifi_provisioning/include/wifi_provisioning/wifi_scan.h \
docs: cleanup target specific doxygen files Move all headers that can be common to the common Doxyfile. Reduces copy-paste potential for errors when adding new targets.
2022-10-18 01:04:45 -04:00
$(PROJECT_PATH)/components/wpa_supplicant/esp_supplicant/include/esp_dpp.h \
esp_wifi: Add support for NAN Discovery and Datapath Update wifi lib with below - 1. Create NAN Discovery SM for beaconing & cluster formation 2. Create NAN interface for Tx/Rx of beacons & action frames 3. Add commands & events for NAN Services Publish/Subscribe/Followup 4. Add NAN Datapath definitions, Events, Peer structures 5. Support for forming and parsing of Datapath related attributes 6. Modules for NDP Req, Resp, Confirm, Term, Peer management 7. NAN Interface related additions in Datapath, Data Tx Q's In addition include below changes - 1. Add netif and driver support for NAN Interface 2. Add simple examples for Publisher-Subscriber usecases 3. Add an advanced console example that supports commands for NAN Discovery, Services & Datapath 4. Add wifi_apps for providing better NAN API's and Peer management Co-authored-by: Shyamal Khachane <shyamal.khachane@espressif.com>
2023-02-13 23:36:40 -05:00
$(PROJECT_PATH)/components/wpa_supplicant/esp_supplicant/include/esp_supplicant_utils.h \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
## Target specific headers are in seperate Doxyfile files
@INCLUDE = $(PROJECT_PATH)/docs/doxygen/Doxyfile_$(IDF_TARGET)
## Get warnings for functions that have no documentation for their parameters or return value
##
WARN_NO_PARAMDOC = YES
## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
##
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = \
$(ENV_DOXYGEN_DEFINES) \
docs: define __DOXYGEN__ for doxygen builds Some docs depended on __DOXYGEN__ but this was never defined anywhere.
2021-10-25 01:48:33 -04:00
__DOXYGEN__=1 \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
__attribute__(x)= \
C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT Closes https://github.com/espressif/esp-idf/issues/9938
2022-10-13 00:01:27 -04:00
_Static_assert()= \
ESP_STATIC_ASSERT()= \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
IDF_DEPRECATED(X)= \
IRAM_ATTR= \
esp_hw_support: Add esp_cpu.h abstraction and API This commit updates the esp_cpu.h API. The new API presents a new abstraction of the CPU where CPU presents the following interfaces: - CPU Control (to stall/unstall/reset the CPU) - CPU Registers (to read registers commonly used in SW such as SP, PC) - CPU Interrupts (to inquire/allocate/control the CPUs 32 interrupts) - Memory Port (to configure the CPU's memory bus for memory protection) - Debugging (to configure/control the CPU's debugging port) Note: Also added FORCE_INLINE_ATTR to the DoxyFile in order to pass doc builds for esp_cpu.h
2022-06-07 02:46:23 -04:00
FORCE_INLINE_ATTR= \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
configSUPPORT_DYNAMIC_ALLOCATION=1 \
configSUPPORT_STATIC_ALLOCATION=1 \
configQUEUE_REGISTRY_SIZE=1 \
change(freertos/idf): Update FreeRTOS documentation build This commit does the following: - Update doxygen comments in FreeRTOS headers to remove unsupported doxygen labels and internal functions - Fixed existing doxygen warnings in FreeRTOS headers
2023-10-08 14:57:38 -04:00
configUSE_MUTEXES=1 \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
configUSE_RECURSIVE_MUTEXES=1 \
configTHREAD_LOCAL_STORAGE_DELETE_CALLBACKS=1 \
configNUM_THREAD_LOCAL_STORAGE_POINTERS=1 \
configUSE_APPLICATION_TASK_TAG=1 \
configTASKLIST_INCLUDE_COREID=1 \
change(freertos/idf): Update FreeRTOS documentation build This commit does the following: - Update doxygen comments in FreeRTOS headers to remove unsupported doxygen labels and internal functions - Fixed existing doxygen warnings in FreeRTOS headers
2023-10-08 14:57:38 -04:00
configUSE_SB_COMPLETED_CALLBACK=1 \
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-03-31 23:54:56 -04:00
PRIVILEGED_FUNCTION= \
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
"ESP_EVENT_DECLARE_BASE(x)=extern esp_event_base_t x"
## Do not complain about not having dot
##
HAVE_DOT = NO
## Generate XML that is required for Breathe
##
GENERATE_XML = YES
XML_OUTPUT = xml
GENERATE_HTML = NO
HAVE_DOT = NO
GENERATE_LATEX = NO
GENERATE_MAN = YES
GENERATE_RTF = NO
## Skip distracting progress messages
##
QUIET = YES
freertos: added doxygen section tags for conditional documentation Added DOC_EXCLUDE_SECTION section tag to conditionally remove sections from FreeRTOS source files which we don't want in IDF API docs. Added DOC_SINGLE_GROUP section tag to enable a flat document for FreeRTOS and removing groups. With these conditional tags, we can upstream FreeRTOS files without affecting the upstream documentation. Signed-off-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
2021-10-07 07:43:26 -04:00
## Enable Section Tags for conditional documentation
##
docs: fix all doxygen warnings Doxygen warnings would previously not result in a failed pipeline. Fixed this as well as all current warnings.
2022-05-11 03:52:09 -04:00
ENABLED_SECTIONS += DOC_EXCLUDE_HEADER_SECTION ## To conditionally remove doc sections from IDF source files without affecting documentation in upstream files.
ENABLED_SECTIONS += DOC_SINGLE_GROUP ## To conditionally remove groups from the documentation and create a 'flat' document without affecting documentation in upstream files.
Reference in New Issue Copy Permalink