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