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
31 OPTIMIZE_OUTPUT_FOR_C = YES
32 OPTIMIZE_OUTPUT_JAVA = NO
33 OPTIMIZE_FOR_FORTRAN = NO
34 OPTIMIZE_OUTPUT_VHDL = NO
36 MARKDOWN_SUPPORT = YES
37 AUTOLINK_SUPPORT = YES
38 BUILTIN_STL_SUPPORT = NO
41 IDL_PROPERTY_SUPPORT = YES
42 DISTRIBUTE_GROUP_DOC = NO
44 INLINE_GROUPED_CLASSES = NO
45 INLINE_SIMPLE_STRUCTS = NO
46 TYPEDEF_HIDES_STRUCT = YES
48 #---------------------------------------------------------------------------
49 # Build related configuration options
50 #---------------------------------------------------------------------------
55 EXTRACT_LOCAL_CLASSES = YES
56 EXTRACT_LOCAL_METHODS = NO
57 EXTRACT_ANON_NSPACES = NO
58 HIDE_UNDOC_MEMBERS = NO
59 HIDE_UNDOC_CLASSES = NO
60 HIDE_FRIEND_COMPOUNDS = NO
61 HIDE_IN_BODY_DOCS = NO
63 CASE_SENSE_NAMES = YES
65 SHOW_INCLUDE_FILES = NO
66 FORCE_LOCAL_INCLUDES = NO
70 SORT_MEMBERS_CTORS_1ST = NO
72 SORT_BY_SCOPE_NAME = NO
73 STRICT_PROTO_MATCHING = NO
74 GENERATE_TODOLIST = NO
75 GENERATE_TESTLIST = NO
77 GENERATE_DEPRECATEDLIST= YES
79 MAX_INITIALIZER_LINES = 30
86 #---------------------------------------------------------------------------
87 # configuration options related to warning and progress messages
88 #---------------------------------------------------------------------------
91 WARN_IF_UNDOCUMENTED = YES
92 WARN_IF_DOC_ERROR = YES
94 WARN_FORMAT = "$file:$line: $text"
96 #---------------------------------------------------------------------------
97 # configuration options related to the input files
98 #---------------------------------------------------------------------------
99 INPUT_ENCODING = UTF-8
103 EXCLUDE_SYMLINKS = NO
108 EXAMPLE_RECURSIVE = NO
112 FILTER_SOURCE_FILES = NO
113 FILTER_SOURCE_PATTERNS =
114 USE_MDFILE_AS_MAINPAGE =
115 #---------------------------------------------------------------------------
116 # configuration options related to source browsing
117 #---------------------------------------------------------------------------
120 STRIP_CODE_COMMENTS = YES
121 REFERENCED_BY_RELATION = NO
122 REFERENCES_RELATION = NO
123 REFERENCES_LINK_SOURCE = YES
125 VERBATIM_HEADERS = NO
126 #---------------------------------------------------------------------------
127 # configuration options related to the alphabetical class index
128 #---------------------------------------------------------------------------
129 ALPHABETICAL_INDEX = NO
130 COLS_IN_ALPHA_INDEX = 5
132 #---------------------------------------------------------------------------
133 # configuration options related to the HTML output
134 #---------------------------------------------------------------------------
137 HTML_FILE_EXTENSION = .html
141 HTML_EXTRA_STYLESHEET =
143 HTML_COLORSTYLE_HUE = 220
144 HTML_COLORSTYLE_SAT = 100
145 HTML_COLORSTYLE_GAMMA = 80
147 HTML_DYNAMIC_SECTIONS = NO
148 HTML_INDEX_NUM_ENTRIES = 100
150 DOCSET_FEEDNAME = "Doxygen generated docs"
151 DOCSET_BUNDLE_ID = org.doxygen.Project
152 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
153 DOCSET_PUBLISHER_NAME = Publisher
154 GENERATE_HTMLHELP = NO
163 QHP_NAMESPACE = org.doxygen.Project
164 QHP_VIRTUAL_FOLDER = doc
165 QHP_CUST_FILTER_NAME =
166 QHP_CUST_FILTER_ATTRS =
167 QHP_SECT_FILTER_ATTRS =
169 GENERATE_ECLIPSEHELP = NO
170 ECLIPSE_DOC_ID = org.doxygen.Project
172 GENERATE_TREEVIEW = NO
173 ENUM_VALUES_PER_LINE = 4
175 EXT_LINKS_IN_WINDOW = NO
176 FORMULA_FONTSIZE = 10
177 FORMULA_TRANSPARENT = YES
179 MATHJAX_FORMAT = HTML-CSS
180 MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest
184 SERVER_BASED_SEARCH = NO
187 SEARCHDATA_FILE = searchdata.xml
189 EXTRA_SEARCH_MAPPINGS =
190 #---------------------------------------------------------------------------
191 # configuration options related to the LaTeX output
192 #---------------------------------------------------------------------------
195 LATEX_CMD_NAME = latex
196 MAKEINDEX_CMD_NAME = makeindex
206 LATEX_HIDE_INDICES = NO
207 LATEX_SOURCE_CODE = NO
208 LATEX_BIB_STYLE = plain
209 #---------------------------------------------------------------------------
210 # configuration options related to the RTF output
211 #---------------------------------------------------------------------------
216 RTF_STYLESHEET_FILE =
217 RTF_EXTENSIONS_FILE =
218 #---------------------------------------------------------------------------
219 # configuration options related to the man page output
220 #---------------------------------------------------------------------------
225 #---------------------------------------------------------------------------
226 # configuration options related to the XML output
227 #---------------------------------------------------------------------------
230 XML_PROGRAMLISTING = YES
231 #---------------------------------------------------------------------------
232 # configuration options related to the DOCBOOK output
233 #---------------------------------------------------------------------------
234 GENERATE_DOCBOOK = NO
235 DOCBOOK_OUTPUT = docbook
236 #---------------------------------------------------------------------------
237 # configuration options for the AutoGen Definitions output
238 #---------------------------------------------------------------------------
239 GENERATE_AUTOGEN_DEF = NO
240 #---------------------------------------------------------------------------
241 # configuration options related to the Perl module output
242 #---------------------------------------------------------------------------
243 GENERATE_PERLMOD = NO
246 PERLMOD_MAKEVAR_PREFIX =
247 #---------------------------------------------------------------------------
248 # Configuration options related to the preprocessor
249 #---------------------------------------------------------------------------
250 ENABLE_PREPROCESSING = YES
252 EXPAND_ONLY_PREDEF = NO
255 INCLUDE_FILE_PATTERNS =
256 PREDEFINED = __DOXYGEN__
258 SKIP_FUNCTION_MACROS = YES
259 #---------------------------------------------------------------------------
260 # Configuration::additions related to external references
261 #---------------------------------------------------------------------------
267 PERL_PATH = /usr/bin/perl
268 #---------------------------------------------------------------------------
269 # Configuration options related to the dot tool
270 #---------------------------------------------------------------------------
273 HIDE_UNDOC_RELATIONS = YES
276 DOT_FONTNAME = Helvetica
280 COLLABORATION_GRAPH = YES
283 UML_LIMIT_NUM_FIELDS = 10
284 TEMPLATE_RELATIONS = NO
286 INCLUDED_BY_GRAPH = NO
289 GRAPHICAL_HIERARCHY = NO
291 DOT_IMAGE_FORMAT = png
296 DOT_GRAPH_MAX_NODES = 50
297 MAX_DOT_GRAPH_DEPTH = 0
299 DOT_MULTI_TARGETS = YES