Doxyfile 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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. ## Get warnings for functions that have no documentation for their parameters or return value
  29. ##
  30. WARN_NO_PARAMDOC = YES
  31. ## Do not complain about not having dot
  32. ##
  33. HAVE_DOT = NO
  34. ## Generate XML that is required for Breathe
  35. ##
  36. GENERATE_XML = YES
  37. XML_OUTPUT = xml
  38. GENERATE_HTML = NO
  39. HAVE_DOT = NO
  40. GENERATE_LATEX = NO
  41. GENERATE_MAN = YES
  42. GENERATE_RTF = NO
  43. ## Skip distracting progress messages
  44. ##
  45. QUIET = YES
  46. ## Log warnings in a file for further review
  47. ##
  48. WARN_LOGFILE = "doxygen-warning-log.txt"