Doxyfile
8643 bytes
1# Doxyfile 1.8.14
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for qmk_firmware (github.com/qmk/qmk_firmware)
5#
6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20DOXYFILE_ENCODING = UTF-8
21PROJECT_NAME = "QMK Firmware"
22PROJECT_NUMBER = https://github.com/qmk/qmk_firmware
23PROJECT_BRIEF = "Keyboard controller firmware for Atmel AVR and ARM USB families"
24OUTPUT_DIRECTORY = .build/docs/static/doxygen
25ALLOW_UNICODE_NAMES = NO
26OUTPUT_LANGUAGE = English
27BRIEF_MEMBER_DESC = YES
28REPEAT_BRIEF = YES
29ABBREVIATE_BRIEF = "The $name class" \
30 "The $name widget" \
31 "The $name file" \
32 is \
33 provides \
34 specifies \
35 contains \
36 represents \
37 a \
38 an \
39 the
40ALWAYS_DETAILED_SEC = NO
41INLINE_INHERITED_MEMB = NO
42FULL_PATH_NAMES = YES
43STRIP_FROM_PATH =
44STRIP_FROM_INC_PATH =
45SHORT_NAMES = NO
46JAVADOC_AUTOBRIEF = NO
47QT_AUTOBRIEF = NO
48MULTILINE_CPP_IS_BRIEF = NO
49INHERIT_DOCS = YES
50SEPARATE_MEMBER_PAGES = NO
51TAB_SIZE = 4
52ALIASES =
53TCL_SUBST =
54OPTIMIZE_OUTPUT_FOR_C = YES
55OPTIMIZE_OUTPUT_JAVA = NO
56OPTIMIZE_FOR_FORTRAN = NO
57OPTIMIZE_OUTPUT_VHDL = NO
58EXTENSION_MAPPING =
59MARKDOWN_SUPPORT = YES
60TOC_INCLUDE_HEADINGS = 2
61AUTOLINK_SUPPORT = YES
62BUILTIN_STL_SUPPORT = NO
63CPP_CLI_SUPPORT = NO
64SIP_SUPPORT = NO
65IDL_PROPERTY_SUPPORT = YES
66DISTRIBUTE_GROUP_DOC = NO
67GROUP_NESTED_COMPOUNDS = NO
68SUBGROUPING = YES
69INLINE_GROUPED_CLASSES = NO
70INLINE_SIMPLE_STRUCTS = NO
71TYPEDEF_HIDES_STRUCT = NO
72LOOKUP_CACHE_SIZE = 0
73
74#---------------------------------------------------------------------------
75# Build related configuration options
76#---------------------------------------------------------------------------
77
78EXTRACT_ALL = NO
79EXTRACT_PRIVATE = NO
80EXTRACT_PACKAGE = NO
81EXTRACT_STATIC = NO
82EXTRACT_LOCAL_CLASSES = YES
83EXTRACT_LOCAL_METHODS = NO
84EXTRACT_ANON_NSPACES = NO
85HIDE_UNDOC_MEMBERS = NO
86HIDE_UNDOC_CLASSES = NO
87HIDE_FRIEND_COMPOUNDS = NO
88HIDE_IN_BODY_DOCS = NO
89INTERNAL_DOCS = NO
90CASE_SENSE_NAMES = NO
91HIDE_SCOPE_NAMES = YES
92HIDE_COMPOUND_REFERENCE= NO
93SHOW_INCLUDE_FILES = YES
94SHOW_GROUPED_MEMB_INC = NO
95FORCE_LOCAL_INCLUDES = NO
96INLINE_INFO = YES
97SORT_MEMBER_DOCS = YES
98SORT_BRIEF_DOCS = NO
99SORT_MEMBERS_CTORS_1ST = NO
100SORT_GROUP_NAMES = NO
101SORT_BY_SCOPE_NAME = NO
102STRICT_PROTO_MATCHING = NO
103GENERATE_TODOLIST = YES
104GENERATE_TESTLIST = YES
105GENERATE_BUGLIST = YES
106GENERATE_DEPRECATEDLIST= YES
107ENABLED_SECTIONS =
108MAX_INITIALIZER_LINES = 30
109SHOW_USED_FILES = YES
110SHOW_FILES = YES
111SHOW_NAMESPACES = YES
112FILE_VERSION_FILTER =
113LAYOUT_FILE =
114CITE_BIB_FILES =
115
116#---------------------------------------------------------------------------
117# Configuration options related to warning and progress messages
118#---------------------------------------------------------------------------
119
120QUIET = NO
121WARNINGS = YES
122WARN_IF_UNDOCUMENTED = YES
123WARN_IF_DOC_ERROR = YES
124WARN_NO_PARAMDOC = NO
125WARN_AS_ERROR = NO
126WARN_FORMAT = "$file:$line: $text"
127WARN_LOGFILE =
128
129#---------------------------------------------------------------------------
130# Configuration options related to the input files
131#---------------------------------------------------------------------------
132
133INPUT = tmk_core quantum drivers
134INPUT_ENCODING = UTF-8
135FILE_PATTERNS = *.c \
136 *.cc \
137 *.cxx \
138 *.cpp \
139 *.c++ \
140 *.h \
141 *.hh \
142 *.hxx \
143 *.hpp \
144 *.h++
145RECURSIVE = YES
146EXCLUDE =
147EXCLUDE_SYMLINKS = NO
148EXCLUDE_PATTERNS =
149EXCLUDE_SYMBOLS =
150EXAMPLE_PATH =
151EXAMPLE_PATTERNS = *
152EXAMPLE_RECURSIVE = NO
153IMAGE_PATH =
154INPUT_FILTER =
155FILTER_PATTERNS =
156FILTER_SOURCE_FILES = NO
157FILTER_SOURCE_PATTERNS =
158USE_MDFILE_AS_MAINPAGE =
159
160#---------------------------------------------------------------------------
161# Configuration options related to source browsing
162#---------------------------------------------------------------------------
163
164SOURCE_BROWSER = YES
165INLINE_SOURCES = NO
166STRIP_CODE_COMMENTS = YES
167REFERENCED_BY_RELATION = NO
168REFERENCES_RELATION = NO
169REFERENCES_LINK_SOURCE = YES
170SOURCE_TOOLTIPS = YES
171USE_HTAGS = NO
172VERBATIM_HEADERS = YES
173
174#---------------------------------------------------------------------------
175# Configuration options related to the alphabetical class index
176#---------------------------------------------------------------------------
177
178ALPHABETICAL_INDEX = YES
179COLS_IN_ALPHA_INDEX = 5
180IGNORE_PREFIX =
181
182#---------------------------------------------------------------------------
183# Configuration options related to disabled outputs
184#---------------------------------------------------------------------------
185
186GENERATE_HTML = NO
187GENERATE_LATEX = NO
188GENERATE_RTF = NO
189GENERATE_MAN = NO
190GENERATE_DOCBOOK = NO
191GENERATE_AUTOGEN_DEF = NO
192GENERATE_PERLMOD = NO
193
194#---------------------------------------------------------------------------
195# Configuration options related to the XML output
196#---------------------------------------------------------------------------
197
198GENERATE_XML = YES
199XML_OUTPUT = xml
200XML_PROGRAMLISTING = YES
201
202#---------------------------------------------------------------------------
203# Configuration options related to the preprocessor
204#---------------------------------------------------------------------------
205
206ENABLE_PREPROCESSING = YES
207MACRO_EXPANSION = NO
208EXPAND_ONLY_PREDEF = NO
209SEARCH_INCLUDES = YES
210INCLUDE_PATH =
211INCLUDE_FILE_PATTERNS =
212PREDEFINED = __DOXYGEN__ PROGMEM
213EXPAND_AS_DEFINED =
214SKIP_FUNCTION_MACROS = YES
215
216#---------------------------------------------------------------------------
217# Configuration options related to external references
218#---------------------------------------------------------------------------
219
220TAGFILES =
221GENERATE_TAGFILE =
222ALLEXTERNALS = NO
223EXTERNAL_GROUPS = YES
224EXTERNAL_PAGES = YES
225PERL_PATH = /usr/bin/perl
226
227#---------------------------------------------------------------------------
228# Configuration options related to the dot tool
229#---------------------------------------------------------------------------
230
231CLASS_DIAGRAMS = YES
232MSCGEN_PATH =
233DIA_PATH =
234HIDE_UNDOC_RELATIONS = YES
235HAVE_DOT = NO
236DOT_NUM_THREADS = 0
237DOT_FONTNAME = Helvetica
238DOT_FONTSIZE = 10
239DOT_FONTPATH =
240CLASS_GRAPH = YES
241COLLABORATION_GRAPH = YES
242GROUP_GRAPHS = YES
243UML_LOOK = NO
244UML_LIMIT_NUM_FIELDS = 10
245TEMPLATE_RELATIONS = NO
246INCLUDE_GRAPH = YES
247INCLUDED_BY_GRAPH = YES
248CALL_GRAPH = NO
249CALLER_GRAPH = NO
250GRAPHICAL_HIERARCHY = YES
251DIRECTORY_GRAPH = YES
252DOT_IMAGE_FORMAT = png
253INTERACTIVE_SVG = NO
254DOT_PATH =
255DOTFILE_DIRS =
256MSCFILE_DIRS =
257DIAFILE_DIRS =
258PLANTUML_JAR_PATH =
259PLANTUML_CFG_FILE =
260PLANTUML_INCLUDE_PATH =
261DOT_GRAPH_MAX_NODES = 50
262MAX_DOT_GRAPH_DEPTH = 0
263DOT_TRANSPARENT = NO
264DOT_MULTI_TARGETS = NO
265GENERATE_LEGEND = YES
266DOT_CLEANUP = YES