File: Doxyfile.in

package info (click to toggle)
pico-sdk 2.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 26,552 kB
  • sloc: ansic: 146,841; asm: 13,423; python: 2,417; cpp: 2,171; yacc: 381; lex: 270; makefile: 32; sh: 13; javascript: 13
file content (68 lines) | stat: -rw-r--r-- 2,794 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
PROJECT_NAME            = "Raspberry Pi Pico SDK"
PROJECT_BRIEF           = "Raspberry Pi Pico SDK documentation"
PROJECT_NUMBER          = @PICO_SDK_VERSION_STRING@ @PICO_DOXYGEN_TAG@

#STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@
STRIP_FROM_PATH         = @DOXY_INPUT_DIRS@
#                         @PROJECT_BINARY_DIR@
#INPUT                  = @doxy_main_page@ \
#                         @PROJECT_SOURCE_DIR@ \
#                         @PROJECT_BINARY_DIR@

FILE_PATTERNS          = *.h \
                         *.cpp \
                         *.c \
                         *.S \
                         *.s \
                         *.md

USE_MDFILE_AS_MAINPAGE = @PROJECT_SOURCE_DIR@/docs/mainpage.md
LAYOUT_FILE = @PROJECT_BINARY_DIR@/docs/DoxygenLayout.xml
HTML_FOOTER = @PROJECT_SOURCE_DIR@/docs/footer.html
HTML_HEADER = @PROJECT_SOURCE_DIR@/docs/header.html

OPTIMIZE_OUTPUT_FOR_C = YES
# HTML_EXTRA_STYLESHEET = @PROJECT_SOURCE_DIR@/docs/customdoxygen.css
HTML_EXTRA_STYLESHEET  = @PROJECT_SOURCE_DIR@/docs/normalise.css @PROJECT_SOURCE_DIR@/docs/main.css @PROJECT_SOURCE_DIR@/docs/styles.css
HTML_EXTRA_FILES       = @PROJECT_SOURCE_DIR@/docs/logo-mobile.svg @PROJECT_SOURCE_DIR@/docs/logo.svg @PROJECT_SOURCE_DIR@/docs/search.svg \
                         @PROJECT_SOURCE_DIR@/docs/main.js @PROJECT_SOURCE_DIR@/docs/pico.jpg @PROJECT_SOURCE_DIR@/docs/rp2040.png
GENERATE_TREEVIEW      = YES # This is needed as it wraps the content area in an HTML tag that we need to use
HTML_COLORSTYLE_HUE = 350
HTML_COLORSTYLE_SAT = 200
HTML_COLORSTYLE_GAMMA = 150
GENERATE_LATEX = NO
GENERATE_XML = YES
GROUP_GRAPHS = NO

ALIASES += tag=@internal
ALIASES += end=@internal

OUTPUT_DIRECTORY       = @DOXY_OUTPUT_DIR@
INPUT                  = ./docs/index.h @DOXY_INPUT_DIRS@ ./docs/

#EXCLUDE               = @DOXY_EXCLUDE_DIRS@ @PROJECT_SOURCE_DIR@/src/rp2040
EXCLUDE                = @DOXY_EXCLUDE_DIRS@
RECURSIVE              = YES
EXAMPLE_PATH           = @PICO_EXAMPLES_PATH@

# This is needed as we have a number of static inline functions that need to be documented.
EXTRACT_STATIC         = YES

EXTRACT_ALL            = NO
ALWAYS_DETAILED_SEC    = NO
#REPEAT_BRIEF          = NO

ENABLE_PREPROCESSING   = YES
# Need these next options to ensure that functions with modifiers do not confuse the Doxygen parser.
# And any further function modifiers here.
MACRO_EXPANSION        = YES

PREDEFINED             = __not_in_flash_func(x)= \
                         __time_critical_func(x)= \
                         __not_in_flash(x)= \
                         __no_inline_not_in_flash(x)= \
                         __attribute__(x)= \
                         DOXYGEN_GENERATION= \
                         @DOXY_PREDEFINED@

ENABLED_SECTIONS       = @DOXY_ENABLED_SECTIONS@