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
2025-11-26 20:53:11 +00:00 · 2021-04-09 11:57:03 +08:00
parent 7154866e80
commit 0633ee3e18
8 changed files with 30 additions and 123 deletions
--- a/docs/doxygen/Doxyfile_common
+++ b/docs/doxygen/Doxyfile_common
@@ -21,7 +21,6 @@ PROJECT_NAME = "IDF Programming Guide"
 ## and used to include in API reference documentation

 INPUT = \
-    ## TinyUSB
    $(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 \
@@ -29,47 +28,32 @@ INPUT = \
    $(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 \
-    ##
-    ## Wi-Fi - API Reference
-    ##
    $(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 \
-    ## Mesh - API Reference
    $(IDF_PATH)/components/esp_wifi/include/esp_mesh.h \
-    ## Event loop - API Reference
    $(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 \
-    ## Bluetooth - API Reference
-    ## Controller && VHCI
    $(IDF_PATH)/components/bt/include/esp32/include/esp_bt.h \
-    ## Bluetooth COMMON
-    ## Issue with __attribute__
    $(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 \
-    ## Bluetooth LE
    $(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h \
-    ## Issue with __attribute__
    $(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 \
-    ## Bluetooth Classic
    $(IDF_PATH)/components/bt/host/bluedroid/api/include/api/esp_gap_bt_api.h \
-    ## Issue with __attribute__
    $(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 \
-    ## NimBLE related Bluetooth APIs
    $(IDF_PATH)/components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \
-    ## ESP BLE Mesh APIs
    $(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 \
@@ -83,17 +67,11 @@ INPUT = \
    $(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 \
-    ##
-    ## Ethernet - API Reference
-    ##
    $(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 \
-    ##
-    ## Peripherals - API Reference
-    ##
    $(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 \
@@ -130,39 +108,22 @@ INPUT = \
    $(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 \
-    ## esp_netif - API Reference
    $(IDF_PATH)/components/esp_netif/include/esp_netif.h \
    $(IDF_PATH)/components/esp_netif/include/esp_netif_net_stack.h \
-    ##
-    ## Protocols - API Reference
-    ##
-    ## ESP-TLS
    $(IDF_PATH)/components/esp-tls/esp_tls.h \
-    ## MQTT
    $(IDF_PATH)/components/mqtt/esp-mqtt/include/mqtt_client.h \
-    ## ICMP-ECHO
    $(IDF_PATH)/components/lwip/include/apps/ping/ping_sock.h \
-    ## SNTP
    $(IDF_PATH)/components/lwip/include/apps/esp_sntp.h \
-    ## mDNS
    $(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 \
-    ## HTTP / HTTPS Server
    $(IDF_PATH)/components/esp_http_server/include/esp_http_server.h \
    $(IDF_PATH)/components/esp_https_server/include/esp_https_server.h \
-    ## ESP Local Ctrl
    $(IDF_PATH)/components/esp_local_ctrl/include/esp_local_ctrl.h \
-    ## ESP Serial Slave Link
    $(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 \
-    ## ESP Certificate Bundle
    $(IDF_PATH)/components/mbedtls/esp_crt_bundle/include/esp_crt_bundle.h \
-    ##
-    ## Provisioning - API Reference
-    ##
-    ## Protocol Communication
    $(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 \
@@ -170,119 +131,70 @@ INPUT = \
    $(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 \
-    ## WiFi Provisioning
    $(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 \
-    ##
-    ## Storage - API Reference
-    ##
-    ## SPI Flash and Partition APIs
    $(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 \
-    ## SPIFFS
    $(IDF_PATH)/components/spiffs/include/esp_spiffs.h \
-    ## SD/MMC Card Host
    $(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 \
-    ## SDIO slave
    $(IDF_PATH)/components/hal/include/hal/sdio_slave_types.h \
    $(IDF_PATH)/components/driver/include/driver/sdio_slave.h \
-    ## Non-Volatile Storage
    $(IDF_PATH)/components/nvs_flash/include/nvs.h \
    $(IDF_PATH)/components/nvs_flash/include/nvs_flash.h \
-    ## OpenThread
    $(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 \
-    ## Virtual Filesystem
    $(IDF_PATH)/components/vfs/include/esp_vfs.h \
    $(IDF_PATH)/components/vfs/include/esp_vfs_dev.h \
    $(IDF_PATH)/components/vfs/include/esp_vfs_semihost.h \
-    ## FAT Filesystem
-    ## NOTE: for two lines below header_file.inc is not used
    $(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 \
-    ## Wear Levelling
    $(IDF_PATH)/components/wear_levelling/include/wear_levelling.h \
-    ##
-    ## System - API Reference
-    ##
-    ## ESP Console
    $(IDF_PATH)/components/console/esp_console.h \
-    ## Memory Allocation
    $(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 \
-    ## Interrupt Allocation
    $(IDF_PATH)/components/esp_hw_support/include/esp_intr_alloc.h \
-    ## Watchdogs
-    ## NOTE: for two lines below header_file.inc is not used
    $(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 \
-    ## Hooks
    $(IDF_PATH)/components/esp_system/include/esp_freertos_hooks.h \
-    ## Inter-Processor Call
    $(IDF_PATH)/components/esp_ipc/include/esp_ipc.h \
-    ## Call Function with External stack
    $(IDF_PATH)/components/esp_system/include/esp_expression_with_stack.h \
-    ## Over The Air Updates (OTA)
    $(IDF_PATH)/components/app_update/include/esp_ota_ops.h \
-    ## ESP HTTPS OTA
    $(IDF_PATH)/components/esp_https_ota/include/esp_https_ota.h \
-    ## Sleep
    $(IDF_PATH)/components/esp_hw_support/include/esp_sleep.h \
-    ## Async memory copy
    $(IDF_PATH)/components/esp_hw_support/include/esp_async_memcpy.h \
-    ## Logging
    $(IDF_PATH)/components/log/include/esp_log.h \
    $(IDF_PATH)/components/esp_rom/include/esp_rom_sys.h \
-    ## Base MAC address
-    ## NOTE: for line below header_file.inc is not used
    $(IDF_PATH)/components/esp_system/include/esp_system.h \
-    ## IDF version
    $(IDF_PATH)/components/esp_common/include/esp_idf_version.h \
-    ##
-    ## ULP Coprocessor - API Guides
-    ##
-    ## NOTE: for line below header_file.inc is not used
    $(IDF_PATH)/components/ulp/include/ulp_common.h \
-    ##
-    ## Application Level Tracing - API Reference
-    ##
    $(IDF_PATH)/components/app_trace/include/esp_app_trace.h \
    $(IDF_PATH)/components/app_trace/include/esp_sysview_trace.h \
-    ### Power management
    $(IDF_PATH)/components/esp_pm/include/esp_pm.h \
    $(IDF_PATH)/components/esp_pm/include/$(IDF_TARGET)/pm.h \
-    ### esp_timer, High Resolution Timer
    $(IDF_PATH)/components/esp_timer/include/esp_timer.h \
-    ### esp_event, Event Loop Library
    $(IDF_PATH)/components/esp_event/include/esp_event.h \
    $(IDF_PATH)/components/esp_event/include/esp_event_base.h \
-    ### eFuse Manager
    $(IDF_PATH)/components/efuse/include/esp_efuse.h \
-    ### App Image Format
    $(IDF_PATH)/components/bootloader_support/include/esp_app_format.h \
-    ### ESP Pthread parameters
    $(IDF_PATH)/components/pthread/include/esp_pthread.h \
-    ###
-    ### FreeRTOS
-    ###
    $(IDF_PATH)/components/freertos/include/freertos/task.h \
    $(IDF_PATH)/components/freertos/include/freertos/queue.h \
    $(IDF_PATH)/components/freertos/include/freertos/semphr.h \
@@ -290,22 +202,16 @@ INPUT = \
    $(IDF_PATH)/components/freertos/include/freertos/event_groups.h \
    $(IDF_PATH)/components/freertos/include/freertos/stream_buffer.h \
    $(IDF_PATH)/components/freertos/include/freertos/message_buffer.h \
-    ### Ringbuffer
    $(IDF_PATH)/components/esp_ringbuf/include/freertos/ringbuf.h \
-    ### Helper functions for error codes
    $(IDF_PATH)/components/esp_common/include/esp_err.h \
-    ### Check macros
    $(IDF_PATH)/components/esp_common/include/esp_check.h \
-    ### System APIs
    $(IDF_PATH)/components/esp_system/include/esp_system.h \
-    ### Modbus controller component header file
    $(IDF_PATH)/components/freemodbus/common/include/esp_modbus_common.h \
    $(IDF_PATH)/components/freemodbus/common/include/esp_modbus_slave.h \
    $(IDF_PATH)/components/freemodbus/common/include/esp_modbus_master.h \
-     ### Performance Monitor component header file
-     $(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
+    $(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


 ## Target specific headers are in seperate Doxyfile files