Doxyfile.in 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. PROJECT_NAME = "Pico SDK"
  2. PROJECT_NUMBER = @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@
  3. #STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@
  4. STRIP_FROM_PATH = @DOXY_INPUT_DIRS@
  5. # @PROJECT_BINARY_DIR@
  6. #INPUT = @doxy_main_page@ \
  7. # @PROJECT_SOURCE_DIR@ \
  8. # @PROJECT_BINARY_DIR@
  9. FILE_PATTERNS = *.h \
  10. *.cpp \
  11. *.c \
  12. *.S \
  13. *.s \
  14. *.md
  15. USE_MDFILE_AS_MAINPAGE = @PROJECT_SOURCE_DIR@/docs/mainpage.md
  16. LAYOUT_FILE = @PROJECT_SOURCE_DIR@/docs/DoxygenLayout.xml
  17. HTML_FOOTER = @PROJECT_SOURCE_DIR@/docs/footer.html
  18. HTML_HEADER = @PROJECT_SOURCE_DIR@/docs/header.html
  19. PROJECT_BRIEF = "Pico SDK documentation"
  20. PROJECT_NUMBER = 1.0
  21. OPTIMIZE_OUTPUT_FOR_C = YES
  22. # HTML_EXTRA_STYLESHEET = @PROJECT_SOURCE_DIR@/docs/customdoxygen.css
  23. HTML_EXTRA_STYLESHEET = @PROJECT_SOURCE_DIR@/docs/normalise.css @PROJECT_SOURCE_DIR@/docs/main.css @PROJECT_SOURCE_DIR@/docs/styles.css
  24. HTML_EXTRA_FILES = @PROJECT_SOURCE_DIR@/docs/logo-mobile.svg @PROJECT_SOURCE_DIR@/docs/logo.svg @PROJECT_SOURCE_DIR@/docs/search.svg \
  25. @PROJECT_SOURCE_DIR@/docs/main.js @PROJECT_SOURCE_DIR@/docs/pico.jpg @PROJECT_SOURCE_DIR@/docs/rp2040.png
  26. GENERATE_TREEVIEW = YES # This is needed as it wraps the content area in an HTML tag that we need to use
  27. HTML_COLORSTYLE_HUE = 350
  28. HTML_COLORSTYLE_SAT = 200
  29. HTML_COLORSTYLE_GAMMA = 150
  30. GENERATE_LATEX = NO
  31. GENERATE_XML = YES
  32. GROUP_GRAPHS = NO
  33. ALIASES += tag=@internal
  34. ALIASES += end=@internal
  35. OUTPUT_DIRECTORY = @DOXY_OUTPUT_DIR@
  36. INPUT = @PROJECT_SOURCE_DIR@/docs/index.h @DOXY_INPUT_DIRS@ @PROJECT_SOURCE_DIR@/docs/
  37. #EXCLUDE = @DOXY_EXCLUDE_DIRS@ @PROJECT_SOURCE_DIR@/src/rp2040
  38. EXCLUDE = @DOXY_EXCLUDE_DIRS@
  39. RECURSIVE = YES
  40. EXAMPLE_PATH = @PICO_EXAMPLES_PATH@
  41. # This is needed as we have a number of static inline functions that need to be documented.
  42. EXTRACT_STATIC = YES
  43. EXTRACT_ALL = NO
  44. ALWAYS_DETAILED_SEC = NO
  45. #REPEAT_BRIEF = NO
  46. # Need these next options to ensure that functions with modifiers do not confuse the Doxygen parser.
  47. # And any further function modifiers here.
  48. MACRO_EXPANSION = YES
  49. PREDEFINED = __not_in_flash_func(x) \
  50. __time_critical_func(x) \
  51. __not_in_flash(x)= \
  52. __no_inline_not_in_flash(x)= \
  53. __attribute__(x)=