3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING = UTF-8
7 @INCLUDE = "doc/config.dox"
11 OUTPUT_DIRECTORY = doc/_build
13 OUTPUT_LANGUAGE = English
14 BRIEF_MEMBER_DESC = YES
17 ALWAYS_DETAILED_SEC = NO
18 INLINE_INHERITED_MEMB = NO
23 JAVADOC_AUTOBRIEF = YES
25 MULTILINE_CPP_IS_BRIEF = NO
27 SEPARATE_MEMBER_PAGES = NO
30 OPTIMIZE_OUTPUT_FOR_C = YES
31 OPTIMIZE_OUTPUT_JAVA = NO
32 OPTIMIZE_FOR_FORTRAN = NO
33 OPTIMIZE_OUTPUT_VHDL = NO
35 MARKDOWN_SUPPORT = YES
36 AUTOLINK_SUPPORT = YES
37 BUILTIN_STL_SUPPORT = NO
40 IDL_PROPERTY_SUPPORT = YES
41 DISTRIBUTE_GROUP_DOC = NO
43 INLINE_GROUPED_CLASSES = NO
44 INLINE_SIMPLE_STRUCTS = NO
45 TYPEDEF_HIDES_STRUCT = YES
47 #---------------------------------------------------------------------------
48 # Build related configuration options
49 #---------------------------------------------------------------------------
54 EXTRACT_LOCAL_CLASSES = YES
55 EXTRACT_LOCAL_METHODS = NO
56 EXTRACT_ANON_NSPACES = NO
57 HIDE_UNDOC_MEMBERS = NO
58 HIDE_UNDOC_CLASSES = NO
59 HIDE_FRIEND_COMPOUNDS = NO
60 HIDE_IN_BODY_DOCS = NO
62 CASE_SENSE_NAMES = YES
64 SHOW_INCLUDE_FILES = NO
65 FORCE_LOCAL_INCLUDES = NO
69 SORT_MEMBERS_CTORS_1ST = NO
71 SORT_BY_SCOPE_NAME = NO
72 STRICT_PROTO_MATCHING = NO
73 GENERATE_TODOLIST = NO
74 GENERATE_TESTLIST = NO
76 GENERATE_DEPRECATEDLIST= YES
78 MAX_INITIALIZER_LINES = 30
85 #---------------------------------------------------------------------------
86 # configuration options related to warning and progress messages
87 #---------------------------------------------------------------------------
90 WARN_IF_UNDOCUMENTED = YES
91 WARN_IF_DOC_ERROR = YES
93 WARN_FORMAT = "$file:$line: $text"
95 #---------------------------------------------------------------------------
96 # configuration options related to the input files
97 #---------------------------------------------------------------------------
98 INPUT_ENCODING = UTF-8
102 EXCLUDE_SYMLINKS = NO
107 EXAMPLE_RECURSIVE = NO
111 FILTER_SOURCE_FILES = NO
112 FILTER_SOURCE_PATTERNS =
113 USE_MDFILE_AS_MAINPAGE =
114 #---------------------------------------------------------------------------
115 # configuration options related to source browsing
116 #---------------------------------------------------------------------------
119 STRIP_CODE_COMMENTS = YES
120 REFERENCED_BY_RELATION = NO
121 REFERENCES_RELATION = NO
122 REFERENCES_LINK_SOURCE = YES
124 VERBATIM_HEADERS = NO
125 #---------------------------------------------------------------------------
126 # configuration options related to the alphabetical class index
127 #---------------------------------------------------------------------------
128 ALPHABETICAL_INDEX = NO
129 COLS_IN_ALPHA_INDEX = 5
131 #---------------------------------------------------------------------------
132 # configuration options related to the HTML output
133 #---------------------------------------------------------------------------
136 HTML_FILE_EXTENSION = .html
140 HTML_EXTRA_STYLESHEET =
142 HTML_COLORSTYLE_HUE = 220
143 HTML_COLORSTYLE_SAT = 100
144 HTML_COLORSTYLE_GAMMA = 80
146 HTML_DYNAMIC_SECTIONS = NO
147 HTML_INDEX_NUM_ENTRIES = 100
149 DOCSET_FEEDNAME = "Doxygen generated docs"
150 DOCSET_BUNDLE_ID = org.doxygen.Project
151 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
152 DOCSET_PUBLISHER_NAME = Publisher
153 GENERATE_HTMLHELP = NO
162 QHP_NAMESPACE = org.doxygen.Project
163 QHP_VIRTUAL_FOLDER = doc
164 QHP_CUST_FILTER_NAME =
165 QHP_CUST_FILTER_ATTRS =
166 QHP_SECT_FILTER_ATTRS =
168 GENERATE_ECLIPSEHELP = NO
169 ECLIPSE_DOC_ID = org.doxygen.Project
171 GENERATE_TREEVIEW = NO
172 ENUM_VALUES_PER_LINE = 4
174 EXT_LINKS_IN_WINDOW = NO
175 FORMULA_FONTSIZE = 10
176 FORMULA_TRANSPARENT = YES
178 MATHJAX_FORMAT = HTML-CSS
179 MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest
183 SERVER_BASED_SEARCH = NO
186 SEARCHDATA_FILE = searchdata.xml
188 EXTRA_SEARCH_MAPPINGS =
189 #---------------------------------------------------------------------------
190 # configuration options related to the LaTeX output
191 #---------------------------------------------------------------------------
194 LATEX_CMD_NAME = latex
195 MAKEINDEX_CMD_NAME = makeindex
205 LATEX_HIDE_INDICES = NO
206 LATEX_SOURCE_CODE = NO
207 LATEX_BIB_STYLE = plain
208 #---------------------------------------------------------------------------
209 # configuration options related to the RTF output
210 #---------------------------------------------------------------------------
215 RTF_STYLESHEET_FILE =
216 RTF_EXTENSIONS_FILE =
217 #---------------------------------------------------------------------------
218 # configuration options related to the man page output
219 #---------------------------------------------------------------------------
224 #---------------------------------------------------------------------------
225 # configuration options related to the XML output
226 #---------------------------------------------------------------------------
229 XML_PROGRAMLISTING = YES
230 #---------------------------------------------------------------------------
231 # configuration options related to the DOCBOOK output
232 #---------------------------------------------------------------------------
233 GENERATE_DOCBOOK = NO
234 DOCBOOK_OUTPUT = docbook
235 #---------------------------------------------------------------------------
236 # configuration options for the AutoGen Definitions output
237 #---------------------------------------------------------------------------
238 GENERATE_AUTOGEN_DEF = NO
239 #---------------------------------------------------------------------------
240 # configuration options related to the Perl module output
241 #---------------------------------------------------------------------------
242 GENERATE_PERLMOD = NO
245 PERLMOD_MAKEVAR_PREFIX =
246 #---------------------------------------------------------------------------
247 # Configuration options related to the preprocessor
248 #---------------------------------------------------------------------------
249 ENABLE_PREPROCESSING = YES
251 EXPAND_ONLY_PREDEF = NO
254 INCLUDE_FILE_PATTERNS =
255 PREDEFINED = __DOXYGEN__
257 SKIP_FUNCTION_MACROS = YES
258 #---------------------------------------------------------------------------
259 # Configuration::additions related to external references
260 #---------------------------------------------------------------------------
266 #---------------------------------------------------------------------------
267 # Configuration options related to the dot tool
268 #---------------------------------------------------------------------------
270 HIDE_UNDOC_RELATIONS = YES
273 DOT_FONTNAME = Helvetica
277 COLLABORATION_GRAPH = YES
280 UML_LIMIT_NUM_FIELDS = 10
281 TEMPLATE_RELATIONS = NO
283 INCLUDED_BY_GRAPH = NO
286 GRAPHICAL_HIERARCHY = NO
288 DOT_IMAGE_FORMAT = png
293 DOT_GRAPH_MAX_NODES = 50
294 MAX_DOT_GRAPH_DEPTH = 0
296 DOT_MULTI_TARGETS = YES