esp-idf/docs/doxygen/Doxyfile_common

266 lines
15 KiB
Plaintext
Raw Normal View History

2016-11-16 14:27:55 -05:00
# This is Doxygen configuration file
#
# Doxygen provides over 260 configuration statements
# To make this file easier to follow,
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:
# http://doxygen.nl/manual/config.html
2016-11-16 14:27:55 -05:00
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 = \
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 \
$(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 \
$(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 \
$(IDF_PATH)/components/bt/include/esp32/include/esp_bt.h \
$(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_blufi_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 \
$(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 \
$(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 \
$(IDF_PATH)/components/driver/include/driver/gpio.h \
$(IDF_PATH)/components/driver/include/driver/dedic_gpio.h \
$(IDF_PATH)/components/hal/include/hal/rtc_io_types.h \
$(IDF_PATH)/components/driver/include/driver/rtc_io.h \
$(IDF_PATH)/components/hal/include/hal/i2c_types.h \
$(IDF_PATH)/components/driver/include/driver/i2c.h \
$(IDF_PATH)/components/hal/include/hal/i2s_types.h \
$(IDF_PATH)/components/driver/include/driver/i2s.h \
$(IDF_PATH)/components/hal/include/hal/ledc_types.h \
$(IDF_PATH)/components/driver/include/driver/ledc.h \
$(IDF_PATH)/components/hal/include/hal/rmt_types.h \
$(IDF_PATH)/components/driver/include/driver/rmt.h \
$(IDF_PATH)/components/hal/include/hal/sigmadelta_types.h \
$(IDF_PATH)/components/driver/include/driver/sigmadelta.h \
$(IDF_PATH)/components/hal/include/hal/spi_types.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 \
$(IDF_PATH)/components/driver/include/driver/spi_slave_hd.h \
$(IDF_PATH)/components/hal/include/hal/timer_types.h \
$(IDF_PATH)/components/driver/include/driver/timer.h \
$(IDF_PATH)/components/hal/include/hal/touch_sensor_types.h \
$(IDF_PATH)/components/driver/include/driver/touch_sensor_common.h \
$(IDF_PATH)/components/hal/include/hal/twai_types.h \
$(IDF_PATH)/components/driver/include/driver/twai.h \
$(IDF_PATH)/components/hal/include/hal/uart_types.h \
$(IDF_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \
$(IDF_PATH)/components/driver/include/driver/uart.h \
$(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 \
$(IDF_PATH)/components/lwip/include/apps/esp_sntp.h \
$(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 \
$(IDF_PATH)/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_spi.h \
$(IDF_PATH)/components/mbedtls/esp_crt_bundle/include/esp_crt_bundle.h \
$(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 \
$(IDF_PATH)/components/hal/include/hal/spi_flash_types.h \
$(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/bootloader_support/include/bootloader_random.h \
$(IDF_PATH)/components/spiffs/include/esp_spiffs.h \
$(IDF_PATH)/components/driver/include/driver/sdmmc_types.h \
$(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 \
$(IDF_PATH)/components/hal/include/hal/sdio_slave_types.h \
$(IDF_PATH)/components/driver/include/driver/sdio_slave.h \
$(IDF_PATH)/components/nvs_flash/include/nvs.h \
$(IDF_PATH)/components/nvs_flash/include/nvs_flash.h \
$(IDF_PATH)/components/openthread/include/esp_openthread.h \
$(IDF_PATH)/components/openthread/include/esp_openthread_lock.h \
$(IDF_PATH)/components/openthread/include/esp_openthread_types.h \
$(IDF_PATH)/components/openthread/include/openthread-core-esp32x-config.h \
$(IDF_PATH)/components/vfs/include/esp_vfs.h \
$(IDF_PATH)/components/vfs/include/esp_vfs_dev.h \
2021-03-08 03:29:22 -05:00
$(IDF_PATH)/components/vfs/include/esp_vfs_eventfd.h \
$(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 \
$(IDF_PATH)/components/console/esp_console.h \
$(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 \
2021-03-10 08:39:29 -05:00
$(IDF_PATH)/components/esp_hw_support/include/esp_intr_alloc.h \
$(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 \
$(IDF_PATH)/components/esp_ipc/include/esp_ipc.h \
$(IDF_PATH)/components/esp_system/include/esp_expression_with_stack.h \
$(IDF_PATH)/components/app_update/include/esp_ota_ops.h \
$(IDF_PATH)/components/esp_https_ota/include/esp_https_ota.h \
$(IDF_PATH)/components/esp_hw_support/include/esp_async_memcpy.h \
$(IDF_PATH)/components/esp_hw_support/include/esp_random.h \
$(IDF_PATH)/components/esp_hw_support/include/esp_sleep.h \
$(IDF_PATH)/components/log/include/esp_log.h \
$(IDF_PATH)/components/esp_rom/include/esp_rom_sys.h \
$(IDF_PATH)/components/esp_system/include/esp_system.h \
$(IDF_PATH)/components/esp_common/include/esp_idf_version.h \
2020-08-18 05:51:32 -04:00
$(IDF_PATH)/components/ulp/include/ulp_common.h \
$(IDF_PATH)/components/app_trace/include/esp_app_trace.h \
$(IDF_PATH)/components/app_trace/include/esp_sysview_trace.h \
$(IDF_PATH)/components/esp_pm/include/esp_pm.h \
$(IDF_PATH)/components/esp_pm/include/$(IDF_TARGET)/pm.h \
$(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 \
$(IDF_PATH)/components/esp_ringbuf/include/freertos/ringbuf.h \
$(IDF_PATH)/components/esp_common/include/esp_err.h \
$(IDF_PATH)/components/esp_common/include/esp_check.h \
$(IDF_PATH)/components/esp_system/include/esp_system.h \
$(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 \
$(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
2020-10-28 21:57:09 -04:00
## Target specific headers are in seperate Doxyfile files
@INCLUDE = $(IDF_PATH)/docs/doxygen/Doxyfile_$(IDF_TARGET)
## Get warnings for functions that have no documentation for their parameters or return value
2016-11-16 14:27:55 -05:00
##
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) \
__attribute__(x)= \
_Static_assert()= \
IDF_DEPRECATED(X)= \
IRAM_ATTR= \
configSUPPORT_DYNAMIC_ALLOCATION=1 \
configSUPPORT_STATIC_ALLOCATION=1 \
configQUEUE_REGISTRY_SIZE=1 \
configUSE_RECURSIVE_MUTEXES=1 \
configTHREAD_LOCAL_STORAGE_DELETE_CALLBACKS=1 \
configNUM_THREAD_LOCAL_STORAGE_POINTERS=1 \
configUSE_APPLICATION_TASK_TAG=1 \
2018-11-21 02:56:06 -05:00
configTASKLIST_INCLUDE_COREID=1 \
"ESP_EVENT_DECLARE_BASE(x)=extern esp_event_base_t x"
2016-11-16 14:27:55 -05:00
## Do not complain about not having dot
##
HAVE_DOT = NO
2016-11-16 14:27:55 -05:00
## 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
2016-11-16 14:27:55 -05:00
## Skip distracting progress messages
##
QUIET = YES