Doxyfile 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. # This is Doxygen configuration file
  2. #
  3. # Doxygen provides over 260 configuration statements
  4. # To make this file easier to follow,
  5. # it contains only statements that are non-default
  6. #
  7. # NOTE:
  8. # It is recommended not to change defaults unless specifically required
  9. # Test any changes how they affect generated documentation
  10. # Make sure that correct warnings are generated to flag issues with documented code
  11. #
  12. # For the complete list of configuration statements see:
  13. # http://www.stack.nl/~dimitri/doxygen/manual/config.html
  14. PROJECT_NAME = "ESP32 Programming Guide"
  15. INPUT = ../components/esp32/include/esp_wifi.h \
  16. ../components/driver/include/driver \
  17. ../components/bt/include \
  18. ../components/bt/bluedroid/api/include \
  19. ../components/nvs_flash/include \
  20. ../components/log/include \
  21. ../components/vfs/include \
  22. ../components/spi_flash/include \
  23. ../components/esp32/include/esp_int_wdt.h \
  24. ../components/esp32/include/esp_task_wdt.h \
  25. ../components/app_update/include/esp_ota_ops.h \
  26. ../components/ethernet/include/esp_eth.h \
  27. ../components/ulp/include/esp32/ulp.h \
  28. ../components/esp32/include/esp_intr_alloc.h \
  29. ../components/esp32/include/esp_heap_alloc_caps.h \
  30. ../components/freertos/include/freertos/heap_regions.h \
  31. ../components/esp32/include/esp_smartconfig.h \
  32. ../components/esp32/include/esp_deep_sleep.h \
  33. ../components/sdmmc/include/sdmmc_cmd.h \
  34. ../components/fatfs/src/esp_vfs_fat.h \
  35. ../components/fatfs/src/diskio.h \
  36. ../components/esp32/include/esp_core_dump.h \
  37. ../components/mdns/include/mdns.h \
  38. ../components/bootloader_support/include/esp_flash_encrypt.h
  39. ## Get warnings for functions that have no documentation for their parameters or return value
  40. ##
  41. WARN_NO_PARAMDOC = YES
  42. ## Do not complain about not having dot
  43. ##
  44. HAVE_DOT = NO
  45. ## Generate XML that is required for Breathe
  46. ##
  47. GENERATE_XML = YES
  48. XML_OUTPUT = xml
  49. GENERATE_HTML = NO
  50. HAVE_DOT = NO
  51. GENERATE_LATEX = NO
  52. GENERATE_MAN = YES
  53. GENERATE_RTF = NO
  54. ## Skip distracting progress messages
  55. ##
  56. QUIET = YES
  57. ## Log warnings in a file for further review
  58. ##
  59. WARN_LOGFILE = "doxygen-warning-log.txt"