Doxyfile.in 2.6 KB

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