Debian Codegraph @

docs/Doxyfile

raw
1 #
2 # CI Hello World
3 #
4 # Copyright (C) 2017 Assured Information Security, Inc.
5 # Author: Rian Quinn <[email protected]>
6 #
7 # Permission is hereby granted, free of charge, to any person obtaining a copy
8 # of this software and associated documentation files (the "Software"), to deal
9 # in the Software without restriction, including without limitation the rights
10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 # copies of the Software, and to permit persons to whom the Software is
12 # furnished to do so, subject to the following conditions:
13 #
14 # The above copyright notice and this permission notice shall be included in all
15 # copies or substantial portions of the Software.
16 #
17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 # SOFTWARE.
24
25 #---------------------------------------------------------------------------
26 # Custom
27 #---------------------------------------------------------------------------
28
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
32 # title of most generated pages and in a few other places.
33 # The default value is: My Project.
34
35 PROJECT_NAME = "manif"
36
37 # Using the PROJECT_BRIEF tag one can provide an optional one line description
38 # for a project that appears at the top of each page and should give viewer a
39 # quick idea about the purpose of the project. Keep the description short.
40
41 PROJECT_BRIEF = "C++ API"
42
43 # The INPUT tag is used to specify the files and/or directories that contain
44 # documented source files. You may enter file names like myfile.cpp or
45 # directories like /usr/src/myproject. Separate the files or directories with
46 # spaces.
47 # Note: If this tag is empty the current directory is searched.
48
49 INPUT = "../include" "./pages/cpp"
50
51 #---------------------------------------------------------------------------
52 # Shared
53 #---------------------------------------------------------------------------
54
55 # This tag specifies the encoding used for all characters in the config file
56 # that follow. The default is UTF-8 which is also the encoding used for all text
57 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
58 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
59 # for the list of possible encodings.
60 # The default value is: UTF-8.
61
62 DOXYFILE_ENCODING = UTF-8
63
64 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
65 # could be handy for archiving the generated documentation or if some version
66 # control system is used.
67
68 PROJECT_NUMBER =
69
70 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
71 # the documentation. The maximum height of the logo should not exceed 55 pixels
72 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
73 # to the output directory.
74
75 PROJECT_LOGO =
76
77 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
78 # into which the generated documentation will be written. If a relative path is
79 # entered, it will be relative to the location where doxygen was started. If
80 # left blank the current directory will be used.
81
82 OUTPUT_DIRECTORY = "../docs"
83
84 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
85 # directories (in 2 levels) under the output directory of each output format and
86 # will distribute the generated files over these directories. Enabling this
87 # option can be useful when feeding doxygen a huge amount of source files, where
88 # putting all generated files in the same directory would otherwise causes
89 # performance problems for the file system.
90 # The default value is: NO.
91
92 CREATE_SUBDIRS = NO
93
94 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
95 # documentation generated by doxygen is written. Doxygen will use this
96 # information to generate all constant output in the proper language.
97 # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
98 # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
99 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
100 # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
101 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
102 # Turkish, Ukrainian and Vietnamese.
103 # The default value is: English.
104
105 OUTPUT_LANGUAGE = English
106
107 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
108 # descriptions after the members that are listed in the file and class
109 # documentation (similar to Javadoc). Set to NO to disable this.
110 # The default value is: YES.
111
112 BRIEF_MEMBER_DESC = YES
113
114 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
115 # description of a member or function before the detailed description
116 #
117 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
118 # brief descriptions will be completely suppressed.
119 # The default value is: YES.
120
121 REPEAT_BRIEF = YES
122
123 # This tag implements a quasi-intelligent brief description abbreviator that is
124 # used to form the text in various listings. Each string in this list, if found
125 # as the leading text of the brief description, will be stripped from the text
126 # and the result, after processing the whole list, is used as the annotated
127 # text. Otherwise, the brief description is used as-is. If left blank, the
128 # following values are used ($name is automatically replaced with the name of
129 # the entity):The $name class, The $name widget, The $name file, is, provides,
130 # specifies, contains, represents, a, an and the.
131
132 ABBREVIATE_BRIEF =
133
134 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
135 # doxygen will generate a detailed section even if there is only a brief
136 # description.
137 # The default value is: NO.
138
139 ALWAYS_DETAILED_SEC = NO
140
141 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
142 # inherited members of a class in the documentation of that class as if those
143 # members were ordinary class members. Constructors, destructors and assignment
144 # operators of the base classes will not be shown.
145 # The default value is: NO.
146
147 INLINE_INHERITED_MEMB = NO
148
149 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
150 # before files name in the file list and in the header files. If set to NO the
151 # shortest path that makes the file name unique will be used
152 # The default value is: YES.
153
154 FULL_PATH_NAMES = NO
155
156 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
157 # Stripping is only done if one of the specified strings matches the left-hand
158 # part of the path. The tag can be used to show relative paths in the file list.
159 # If left blank the directory from which doxygen is run is used as the path to
160 # strip.
161 #
162 # Note that you can specify absolute paths here, but also relative paths, which
163 # will be relative from the directory where doxygen is started.
164 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
165
166 STRIP_FROM_PATH =
167
168 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
169 # path mentioned in the documentation of a class, which tells the reader which
170 # header file to include in order to use a class. If left blank only the name of
171 # the header file containing the class definition is used. Otherwise one should
172 # specify the list of include paths that are normally passed to the compiler
173 # using the -I flag.
174
175 STRIP_FROM_INC_PATH =
176
177 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
178 # less readable) file names. This can be useful is your file systems doesn't
179 # support long names like on DOS, Mac, or CD-ROM.
180 # The default value is: NO.
181
182 SHORT_NAMES = NO
183
184 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
185 # first line (until the first dot) of a Javadoc-style comment as the brief
186 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
187 # style comments (thus requiring an explicit @brief command for a brief
188 # description.)
189 # The default value is: NO.
190
191 JAVADOC_AUTOBRIEF = NO
192
193 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
194 # line (until the first dot) of a Qt-style comment as the brief description. If
195 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
196 # requiring an explicit \brief command for a brief description.)
197 # The default value is: NO.
198
199 QT_AUTOBRIEF = NO
200
201 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
202 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
203 # a brief description. This used to be the default behavior. The new default is
204 # to treat a multi-line C++ comment block as a detailed description. Set this
205 # tag to YES if you prefer the old behavior instead.
206 #
207 # Note that setting this tag to YES also means that rational rose comments are
208 # not recognized any more.
209 # The default value is: NO.
210
211 MULTILINE_CPP_IS_BRIEF = NO
212
213 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
214 # documentation from any documented member that it re-implements.
215 # The default value is: YES.
216
217 INHERIT_DOCS = YES
218
219 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
220 # new page for each member. If set to NO, the documentation of a member will be
221 # part of the file/class/namespace that contains it.
222 # The default value is: NO.
223
224 SEPARATE_MEMBER_PAGES = NO
225
226 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
227 # uses this value to replace tabs by spaces in code fragments.
228 # Minimum value: 1, maximum value: 16, default value: 4.
229
230 TAB_SIZE = 2
231
232 # This tag can be used to specify a number of aliases that act as commands in
233 # the documentation. An alias has the form:
234 # name=value
235 # For example adding
236 # "sideeffect=@par Side Effects:\n"
237 # will allow you to put the command \sideeffect (or @sideeffect) in the
238 # documentation, which will result in a user-defined paragraph with heading
239 # "Side Effects:". You can put \n's in the value part of an alias to insert
240 # newlines.
241
242 ALIASES = expects="\pre expects:" ensures="\post ensures:"
243
244 # This tag can be used to specify a number of word-keyword mappings (TCL only).
245 # A mapping has the form "name=value". For example adding "class=itcl::class"
246 # will allow you to use the command class in the itcl::class meaning.
247
248 TCL_SUBST =
249
250 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
251 # only. Doxygen will then generate output that is more tailored for C. For
252 # instance, some of the names that are used will be different. The list of all
253 # members will be omitted, etc.
254 # The default value is: NO.
255
256 OPTIMIZE_OUTPUT_FOR_C = YES
257
258 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
259 # Python sources only. Doxygen will then generate output that is more tailored
260 # for that language. For instance, namespaces will be presented as packages,
261 # qualified scopes will look different, etc.
262 # The default value is: NO.
263
264 OPTIMIZE_OUTPUT_JAVA = NO
265
266 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
267 # sources. Doxygen will then generate output that is tailored for Fortran.
268 # The default value is: NO.
269
270 OPTIMIZE_FOR_FORTRAN = NO
271
272 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
273 # sources. Doxygen will then generate output that is tailored for VHDL.
274 # The default value is: NO.
275
276 OPTIMIZE_OUTPUT_VHDL = NO
277
278 # Doxygen selects the parser to use depending on the extension of the files it
279 # parses. With this tag you can assign which parser to use for a given
280 # extension. Doxygen has a built-in mapping, but you can override or extend it
281 # using this tag. The format is ext=language, where ext is a file extension, and
282 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
283 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
284 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
285 # (default is Fortran), use: inc=Fortran f=C.
286 #
287 # Note For files without extension you can use no_extension as a placeholder.
288 #
289 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
290 # the files are not read by doxygen.
291
292 EXTENSION_MAPPING =
293
294 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
295 # according to the Markdown format, which allows for more readable
296 # documentation. See http://daringfireball.net/projects/markdown/ for details.
297 # The output of markdown processing is further processed by doxygen, so you can
298 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
299 # case of backward compatibilities issues.
300 # The default value is: YES.
301
302 MARKDOWN_SUPPORT = YES
303
304 TOC_INCLUDE_HEADINGS = 4
305
306 # When enabled doxygen tries to link words that correspond to documented
307 # classes, or namespaces to their corresponding documentation. Such a link can
308 # be prevented in individual cases by by putting a % sign in front of the word
309 # or globally by setting AUTOLINK_SUPPORT to NO.
310 # The default value is: YES.
311
312 AUTOLINK_SUPPORT = YES
313
314 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
315 # to include (a tag file for) the STL sources as input, then you should set this
316 # tag to YES in order to let doxygen match functions declarations and
317 # definitions whose arguments contain STL classes (e.g. func(std::string);
318 # versus func(std::string) {}). This also make the inheritance and collaboration
319 # diagrams that involve STL classes more complete and accurate.
320 # The default value is: NO.
321
322 BUILTIN_STL_SUPPORT = NO
323
324 # If you use Microsoft's C++/CLI language, you should set this option to YES to
325 # enable parsing support.
326 # The default value is: NO.
327
328 CPP_CLI_SUPPORT = NO
329
330 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
331 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
332 # will parse them like normal C++ but will assume all classes use public instead
333 # of private inheritance when no explicit protection keyword is present.
334 # The default value is: NO.
335
336 SIP_SUPPORT = NO
337
338 # For Microsoft's IDL there are propget and propput attributes to indicate
339 # getter and setter methods for a property. Setting this option to YES will make
340 # doxygen to replace the get and set methods by a property in the documentation.
341 # This will only work if the methods are indeed getting or setting a simple
342 # type. If this is not the case, or you want to show the methods anyway, you
343 # should set this option to NO.
344 # The default value is: YES.
345
346 IDL_PROPERTY_SUPPORT = YES
347
348 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
349 # tag is set to YES, then doxygen will reuse the documentation of the first
350 # member in the group (if any) for the other members of the group. By default
351 # all members of a group must be documented explicitly.
352 # The default value is: NO.
353
354 DISTRIBUTE_GROUP_DOC = NO
355
356 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
357 # (for instance a group of public functions) to be put as a subgroup of that
358 # type (e.g. under the Public Functions section). Set it to NO to prevent
359 # subgrouping. Alternatively, this can be done per class using the
360 # \nosubgrouping command.
361 # The default value is: YES.
362
363 SUBGROUPING = YES
364
365 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
366 # are shown inside the group in which they are included (e.g. using \ingroup)
367 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
368 # and RTF).
369 #
370 # Note that this feature does not work in combination with
371 # SEPARATE_MEMBER_PAGES.
372 # The default value is: NO.
373
374 INLINE_GROUPED_CLASSES = NO
375
376 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
377 # with only public data fields or simple typedef fields will be shown inline in
378 # the documentation of the scope in which they are defined (i.e. file,
379 # namespace, or group documentation), provided this scope is documented. If set
380 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
381 # Man pages) or section (for LaTeX and RTF).
382 # The default value is: NO.
383
384 INLINE_SIMPLE_STRUCTS = NO
385
386 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
387 # enum is documented as struct, union, or enum with the name of the typedef. So
388 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
389 # with name TypeT. When disabled the typedef will appear as a member of a file,
390 # namespace, or class. And the struct will be named TypeS. This can typically be
391 # useful for C code in case the coding convention dictates that all compound
392 # types are typedef'ed and only the typedef is referenced, never the tag name.
393 # The default value is: NO.
394
395 TYPEDEF_HIDES_STRUCT = NO
396
397 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
398 # cache is used to resolve symbols given their name and scope. Since this can be
399 # an expensive process and often the same symbol appears multiple times in the
400 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
401 # doxygen will become slower. If the cache is too large, memory is wasted. The
402 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
403 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
404 # symbols. At the end of a run doxygen will report the cache usage and suggest
405 # the optimal cache size from a speed point of view.
406 # Minimum value: 0, maximum value: 9, default value: 0.
407
408 LOOKUP_CACHE_SIZE = 2
409
410 #---------------------------------------------------------------------------
411 # Build related configuration options
412 #---------------------------------------------------------------------------
413
414 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
415 # documentation are documented, even if no documentation was available. Private
416 # class members and static file members will be hidden unless the
417 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
418 # Note: This will also disable the warnings about undocumented members that are
419 # normally produced when WARNINGS is set to YES.
420 # The default value is: NO.
421
422 EXTRACT_ALL = NO
423
424 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
425 # be included in the documentation.
426 # The default value is: NO.
427
428 EXTRACT_PRIVATE = NO
429
430 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
431 # scope will be included in the documentation.
432 # The default value is: NO.
433
434 EXTRACT_PACKAGE = NO
435
436 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
437 # included in the documentation.
438 # The default value is: NO.
439
440 EXTRACT_STATIC = NO
441
442 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
443 # locally in source files will be included in the documentation. If set to NO
444 # only classes defined in header files are included. Does not have any effect
445 # for Java sources.
446 # The default value is: YES.
447
448 EXTRACT_LOCAL_CLASSES = NO
449
450 # This flag is only useful for Objective-C code. When set to YES local methods,
451 # which are defined in the implementation section but not in the interface are
452 # included in the documentation. If set to NO only methods in the interface are
453 # included.
454 # The default value is: NO.
455
456 EXTRACT_LOCAL_METHODS = NO
457
458 # If this flag is set to YES, the members of anonymous namespaces will be
459 # extracted and appear in the documentation as a namespace called
460 # 'anonymous_namespace{file}', where file will be replaced with the base name of
461 # the file that contains the anonymous namespace. By default anonymous namespace
462 # are hidden.
463 # The default value is: NO.
464
465 EXTRACT_ANON_NSPACES = NO
466
467 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
468 # undocumented members inside documented classes or files. If set to NO these
469 # members will be included in the various overviews, but no documentation
470 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
471 # The default value is: NO.
472
473 HIDE_UNDOC_MEMBERS = NO
474
475 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
476 # undocumented classes that are normally visible in the class hierarchy. If set
477 # to NO these classes will be included in the various overviews. This option has
478 # no effect if EXTRACT_ALL is enabled.
479 # The default value is: NO.
480
481 HIDE_UNDOC_CLASSES = NO
482
483 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
484 # (class|struct|union) declarations. If set to NO these declarations will be
485 # included in the documentation.
486 # The default value is: NO.
487
488 HIDE_FRIEND_COMPOUNDS = YES
489
490 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
491 # documentation blocks found inside the body of a function. If set to NO these
492 # blocks will be appended to the function's detailed documentation block.
493 # The default value is: NO.
494
495 HIDE_IN_BODY_DOCS = YES
496
497 # The INTERNAL_DOCS tag determines if documentation that is typed after a
498 # \internal command is included. If the tag is set to NO then the documentation
499 # will be excluded. Set it to YES to include the internal documentation.
500 # The default value is: NO.
501
502 INTERNAL_DOCS = NO
503
504 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
505 # names in lower-case letters. If set to YES upper-case letters are also
506 # allowed. This is useful if you have classes or files whose names only differ
507 # in case and if your file system supports case sensitive file names. Windows
508 # and Mac users are advised to set this option to NO.
509 # The default value is: system dependent.
510
511 CASE_SENSE_NAMES = NO
512
513 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
514 # their full class and namespace scopes in the documentation. If set to YES the
515 # scope will be hidden.
516 # The default value is: NO.
517
518 HIDE_SCOPE_NAMES = NO
519
520 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
521 # the files that are included by a file in the documentation of that file.
522 # The default value is: YES.
523
524 SHOW_INCLUDE_FILES = NO
525
526 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
527 # files with double quotes in the documentation rather than with sharp brackets.
528 # The default value is: NO.
529
530 FORCE_LOCAL_INCLUDES = NO
531
532 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
533 # documentation for inline members.
534 # The default value is: YES.
535
536 INLINE_INFO = YES
537
538 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
539 # (detailed) documentation of file and class members alphabetically by member
540 # name. If set to NO the members will appear in declaration order.
541 # The default value is: YES.
542
543 SORT_MEMBER_DOCS = NO
544
545 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
546 # descriptions of file, namespace and class members alphabetically by member
547 # name. If set to NO the members will appear in declaration order.
548 # The default value is: NO.
549
550 SORT_BRIEF_DOCS = NO
551
552 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
553 # (brief and detailed) documentation of class members so that constructors and
554 # destructors are listed first. If set to NO the constructors will appear in the
555 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
556 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
557 # member documentation.
558 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
559 # detailed member documentation.
560 # The default value is: NO.
561
562 SORT_MEMBERS_CTORS_1ST = YES
563
564 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
565 # of group names into alphabetical order. If set to NO the group names will
566 # appear in their defined order.
567 # The default value is: NO.
568
569 SORT_GROUP_NAMES = NO
570
571 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
572 # fully-qualified names, including namespaces. If set to NO, the class list will
573 # be sorted only by class name, not including the namespace part.
574 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
575 # Note: This option applies only to the class list, not to the alphabetical
576 # list.
577 # The default value is: NO.
578
579 SORT_BY_SCOPE_NAME = NO
580
581 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
582 # type resolution of all parameters of a function it will reject a match between
583 # the prototype and the implementation of a member function even if there is
584 # only one candidate or it is obvious which candidate to choose by doing a
585 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
586 # accept a match between prototype and implementation in such cases.
587 # The default value is: NO.
588
589 STRICT_PROTO_MATCHING = NO
590
591 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
592 # todo list. This list is created by putting \todo commands in the
593 # documentation.
594 # The default value is: YES.
595
596 GENERATE_TODOLIST = NO
597
598 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
599 # test list. This list is created by putting \test commands in the
600 # documentation.
601 # The default value is: YES.
602
603 GENERATE_TESTLIST = NO
604
605 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
606 # list. This list is created by putting \bug commands in the documentation.
607 # The default value is: YES.
608
609 GENERATE_BUGLIST = NO
610
611 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
612 # the deprecated list. This list is created by putting \deprecated commands in
613 # the documentation.
614 # The default value is: YES.
615
616 GENERATE_DEPRECATEDLIST= YES
617
618 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
619 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
620 # ... \endcond blocks.
621
622 ENABLED_SECTIONS =
623
624 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
625 # initial value of a variable or macro / define can have for it to appear in the
626 # documentation. If the initializer consists of more lines than specified here
627 # it will be hidden. Use a value of 0 to hide initializers completely. The
628 # appearance of the value of individual variables and macros / defines can be
629 # controlled using \showinitializer or \hideinitializer command in the
630 # documentation regardless of this setting.
631 # Minimum value: 0, maximum value: 10000, default value: 30.
632
633 MAX_INITIALIZER_LINES = 30
634
635 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
636 # the bottom of the documentation of classes and structs. If set to YES the list
637 # will mention the files that were used to generate the documentation.
638 # The default value is: YES.
639
640 SHOW_USED_FILES = YES
641
642 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
643 # will remove the Files entry from the Quick Index and from the Folder Tree View
644 # (if specified).
645 # The default value is: YES.
646
647 SHOW_FILES = YES
648
649 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
650 # page. This will remove the Namespaces entry from the Quick Index and from the
651 # Folder Tree View (if specified).
652 # The default value is: YES.
653
654 SHOW_NAMESPACES = YES
655
656 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
657 # doxygen should invoke to get the current version for each file (typically from
658 # the version control system). Doxygen will invoke the program by executing (via
659 # popen()) the command command input-file, where command is the value of the
660 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
661 # by doxygen. Whatever the program writes to standard output is used as the file
662 # version. For an example see the documentation.
663
664 FILE_VERSION_FILTER =
665
666 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
667 # by doxygen. The layout file controls the global structure of the generated
668 # output files in an output format independent way. To create the layout file
669 # that represents doxygen's defaults, run doxygen with the -l option. You can
670 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
671 # will be used as the name of the layout file.
672 #
673 # Note that if you run doxygen from a directory containing a file called
674 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
675 # tag is left empty.
676
677 LAYOUT_FILE =
678
679 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
680 # the reference definitions. This must be a list of .bib files. The .bib
681 # extension is automatically appended if omitted. This requires the bibtex tool
682 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
683 # For LaTeX the style of the bibliography can be controlled using
684 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
685 # search path. Do not use file names with spaces, bibtex cannot handle them. See
686 # also \cite for info how to create references.
687
688 CITE_BIB_FILES =
689
690 #---------------------------------------------------------------------------
691 # Configuration options related to warning and progress messages
692 #---------------------------------------------------------------------------
693
694 # The QUIET tag can be used to turn on/off the messages that are generated to
695 # standard output by doxygen. If QUIET is set to YES this implies that the
696 # messages are off.
697 # The default value is: NO.
698
699 QUIET = NO
700
701 # The WARNINGS tag can be used to turn on/off the warning messages that are
702 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
703 # this implies that the warnings are on.
704 #
705 # Tip: Turn warnings on while writing the documentation.
706 # The default value is: YES.
707
708 WARNINGS = YES
709
710 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
711 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
712 # will automatically be disabled.
713 # The default value is: YES.
714
715 WARN_IF_UNDOCUMENTED = YES
716
717 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
718 # potential errors in the documentation, such as not documenting some parameters
719 # in a documented function, or documenting parameters that don't exist or using
720 # markup commands wrongly.
721 # The default value is: YES.
722
723 WARN_IF_DOC_ERROR = YES
724
725 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
726 # are documented, but have no documentation for their parameters or return
727 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
728 # documentation, but not about the absence of documentation.
729 # The default value is: NO.
730
731 WARN_NO_PARAMDOC = YES
732
733 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
734 # can produce. The string should contain the $file, $line, and $text tags, which
735 # will be replaced by the file and line number from which the warning originated
736 # and the warning text. Optionally the format may contain $version, which will
737 # be replaced by the version of the file (if it could be obtained via
738 # FILE_VERSION_FILTER)
739 # The default value is: $file:$line: $text.
740
741 WARN_FORMAT = "FIX: $file:$line: $text"
742
743 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
744 # messages should be written. If left blank the output is written to standard
745 # error (stderr).
746
747 WARN_LOGFILE = doxygen_warnings.txt
748
749 #---------------------------------------------------------------------------
750 # Configuration options related to the input files
751 #---------------------------------------------------------------------------
752
753 # This tag can be used to specify the character encoding of the source files
754 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
755 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
756 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
757 # possible encodings.
758 # The default value is: UTF-8.
759
760 INPUT_ENCODING = UTF-8
761
762 # If the value of the INPUT tag contains directories, you can use the
763 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
764 # *.h) to filter out the source-files in the directories. If left blank the
765 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
766 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
767 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
768 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
769 # *.qsf, *.as and *.js.
770
771 FILE_PATTERNS = *.c *.cpp *.h *.hpp *.md
772
773 # The RECURSIVE tag can be used to specify whether or not subdirectories should
774 # be searched for input files as well.
775 # The default value is: NO.
776
777 RECURSIVE = YES
778
779 # The EXCLUDE tag can be used to specify files and/or directories that should be
780 # excluded from the INPUT source files. This way you can easily exclude a
781 # subdirectory from a directory tree whose root is specified with the INPUT tag.
782 #
783 # Note that relative paths are relative to the directory from which doxygen is
784 # run.
785
786 EXCLUDE =
787
788 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
789 # directories that are symbolic links (a Unix file system feature) are excluded
790 # from the input.
791 # The default value is: NO.
792
793 EXCLUDE_SYMLINKS = NO
794
795 # If the value of the INPUT tag contains directories, you can use the
796 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
797 # certain files from those directories.
798 #
799 # Note that the wildcards are matched against the file with absolute path, so to
800 # exclude all test directories for example use the pattern */test/*
801
802 EXCLUDE_PATTERNS =
803
804 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
805 # (namespaces, classes, functions, etc.) that should be excluded from the
806 # output. The symbol name can be a fully qualified name, a word, or if the
807 # wildcard * is used, a substring. Examples: ANamespace, AClass,
808 # AClass::ANamespace, ANamespace::*Test
809 #
810 # Note that the wildcards are matched against the file with absolute path, so to
811 # exclude all test directories use the pattern */test/*
812
813 EXCLUDE_SYMBOLS =
814
815 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
816 # that contain example code fragments that are included (see the \include
817 # command).
818
819 EXAMPLE_PATH =
820
821 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
822 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
823 # *.h) to filter out the source-files in the directories. If left blank all
824 # files are included.
825
826 EXAMPLE_PATTERNS =
827
828 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
829 # searched for input files to be used with the \include or \dontinclude commands
830 # irrespective of the value of the RECURSIVE tag.
831 # The default value is: NO.
832
833 EXAMPLE_RECURSIVE = NO
834
835 # The IMAGE_PATH tag can be used to specify one or more files or directories
836 # that contain images that are to be included in the documentation (see the
837 # \image command).
838
839 IMAGE_PATH = "./images"
840
841 # The INPUT_FILTER tag can be used to specify a program that doxygen should
842 # invoke to filter for each input file. Doxygen will invoke the filter program
843 # by executing (via popen()) the command:
844 #
845 # <filter> <input-file>
846 #
847 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
848 # name of an input file. Doxygen will then use the output that the filter
849 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
850 # will be ignored.
851 #
852 # Note that the filter must not add or remove lines; it is applied before the
853 # code is scanned, but not when the output code is generated. If lines are added
854 # or removed, the anchors will not be placed correctly.
855
856 INPUT_FILTER =
857
858 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
859 # basis. Doxygen will compare the file name with each pattern and apply the
860 # filter if there is a match. The filters are a list of the form: pattern=filter
861 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
862 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
863 # patterns match the file name, INPUT_FILTER is applied.
864
865 FILTER_PATTERNS =
866
867 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
868 # INPUT_FILTER ) will also be used to filter the input files that are used for
869 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
870 # The default value is: NO.
871
872 FILTER_SOURCE_FILES = NO
873
874 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
875 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
876 # it is also possible to disable source filtering for a specific pattern using
877 # *.ext= (so without naming a filter).
878 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
879
880 FILTER_SOURCE_PATTERNS =
881
882 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
883 # is part of the input, its contents will be placed on the main page
884 # (index.html). This can be useful if you have a project on for instance GitHub
885 # and want to reuse the introduction page also for the doxygen output.
886
887 USE_MDFILE_AS_MAINPAGE =
888
889 #---------------------------------------------------------------------------
890 # Configuration options related to source browsing
891 #---------------------------------------------------------------------------
892
893 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
894 # generated. Documented entities will be cross-referenced with these sources.
895 #
896 # Note: To get rid of all source code in the generated output, make sure that
897 # also VERBATIM_HEADERS is set to NO.
898 # The default value is: NO.
899
900 SOURCE_BROWSER = YES
901
902 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
903 # classes and enums directly into the documentation.
904 # The default value is: NO.
905
906 INLINE_SOURCES = NO
907
908 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
909 # special comment blocks from generated source code fragments. Normal C, C++ and
910 # Fortran comments will always remain visible.
911 # The default value is: YES.
912
913 STRIP_CODE_COMMENTS = YES
914
915 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
916 # function all documented functions referencing it will be listed.
917 # The default value is: NO.
918
919 REFERENCED_BY_RELATION = NO
920
921 # If the REFERENCES_RELATION tag is set to YES then for each documented function
922 # all documented entities called/used by that function will be listed.
923 # The default value is: NO.
924
925 REFERENCES_RELATION = NO
926
927 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
928 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
929 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
930 # link to the documentation.
931 # The default value is: YES.
932
933 REFERENCES_LINK_SOURCE = YES
934
935 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
936 # source code will show a tooltip with additional information such as prototype,
937 # brief description and links to the definition and documentation. Since this
938 # will make the HTML file larger and loading of large files a bit slower, you
939 # can opt to disable this feature.
940 # The default value is: YES.
941 # This tag requires that the tag SOURCE_BROWSER is set to YES.
942
943 SOURCE_TOOLTIPS = YES
944
945 # If the USE_HTAGS tag is set to YES then the references to source code will
946 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
947 # source browser. The htags tool is part of GNU's global source tagging system
948 # (see http://www.gnu.org/software/global/global.html). You will need version
949 # 4.8.6 or higher.
950 #
951 # To use it do the following:
952 # - Install the latest version of global
953 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
954 # - Make sure the INPUT points to the root of the source tree
955 # - Run doxygen as normal
956 #
957 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
958 # tools must be available from the command line (i.e. in the search path).
959 #
960 # The result: instead of the source browser generated by doxygen, the links to
961 # source code will now point to the output of htags.
962 # The default value is: NO.
963 # This tag requires that the tag SOURCE_BROWSER is set to YES.
964
965 USE_HTAGS = NO
966
967 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
968 # verbatim copy of the header file for each class for which an include is
969 # specified. Set to NO to disable this.
970 # See also: Section \class.
971 # The default value is: YES.
972
973 VERBATIM_HEADERS = YES
974
975 #---------------------------------------------------------------------------
976 # Configuration options related to the alphabetical class index
977 #---------------------------------------------------------------------------
978
979 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
980 # compounds will be generated. Enable this if the project contains a lot of
981 # classes, structs, unions or interfaces.
982 # The default value is: YES.
983
984 ALPHABETICAL_INDEX = YES
985
986 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
987 # which the alphabetical index list will be split.
988 # Minimum value: 1, maximum value: 20, default value: 5.
989 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
990
991 COLS_IN_ALPHA_INDEX = 5
992
993 # In case all classes in a project start with a common prefix, all classes will
994 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
995 # can be used to specify a prefix (or a list of prefixes) that should be ignored
996 # while generating the index headers.
997 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
998
999 IGNORE_PREFIX =
1000
1001 #---------------------------------------------------------------------------
1002 # Configuration options related to the HTML output
1003 #---------------------------------------------------------------------------
1004
1005 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1006 # The default value is: YES.
1007
1008 GENERATE_HTML = YES
1009
1010 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1011 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1012 # it.
1013 # The default directory is: html.
1014 # This tag requires that the tag GENERATE_HTML is set to YES.
1015
1016 HTML_OUTPUT = html
1017
1018 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1019 # generated HTML page (for example: .htm, .php, .asp).
1020 # The default value is: .html.
1021 # This tag requires that the tag GENERATE_HTML is set to YES.
1022
1023 HTML_FILE_EXTENSION = .html
1024
1025 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1026 # each generated HTML page. If the tag is left blank doxygen will generate a
1027 # standard header.
1028 #
1029 # To get valid HTML the header file that includes any scripts and style sheets
1030 # that doxygen needs, which is dependent on the configuration options used (e.g.
1031 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1032 # default header using
1033 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1034 # YourConfigFile
1035 # and then modify the file new_header.html. See also section "Doxygen usage"
1036 # for information on how to generate the default header that doxygen normally
1037 # uses.
1038 # Note: The header is subject to change so you typically have to regenerate the
1039 # default header when upgrading to a newer version of doxygen. For a description
1040 # of the possible markers and block names see the documentation.
1041 # This tag requires that the tag GENERATE_HTML is set to YES.
1042
1043 HTML_HEADER =
1044
1045 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1046 # generated HTML page. If the tag is left blank doxygen will generate a standard
1047 # footer. See HTML_HEADER for more information on how to generate a default
1048 # footer and what special commands can be used inside the footer. See also
1049 # section "Doxygen usage" for information on how to generate the default footer
1050 # that doxygen normally uses.
1051 # This tag requires that the tag GENERATE_HTML is set to YES.
1052
1053 HTML_FOOTER =
1054
1055 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1056 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1057 # the HTML output. If left blank doxygen will generate a default style sheet.
1058 # See also section "Doxygen usage" for information on how to generate the style
1059 # sheet that doxygen normally uses.
1060 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1061 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1062 # obsolete.
1063 # This tag requires that the tag GENERATE_HTML is set to YES.
1064
1065 HTML_STYLESHEET =
1066
1067 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1068 # defined cascading style sheet that is included after the standard style sheets
1069 # created by doxygen. Using this option one can overrule certain style aspects.
1070 # This is preferred over using HTML_STYLESHEET since it does not replace the
1071 # standard style sheet and is therefor more robust against future updates.
1072 # Doxygen will copy the style sheet file to the output directory. For an example
1073 # see the documentation.
1074 # This tag requires that the tag GENERATE_HTML is set to YES.
1075
1076 HTML_EXTRA_STYLESHEET =
1077
1078 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1079 # other source files which should be copied to the HTML output directory. Note
1080 # that these files will be copied to the base HTML output directory. Use the
1081 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1082 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1083 # files will be copied as-is; there are no commands or markers available.
1084 # This tag requires that the tag GENERATE_HTML is set to YES.
1085
1086 HTML_EXTRA_FILES =
1087
1088 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1089 # will adjust the colors in the stylesheet and background images according to
1090 # this color. Hue is specified as an angle on a colorwheel, see
1091 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1092 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1093 # purple, and 360 is red again.
1094 # Minimum value: 0, maximum value: 359, default value: 220.
1095 # This tag requires that the tag GENERATE_HTML is set to YES.
1096
1097 HTML_COLORSTYLE_HUE = 220
1098
1099 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1100 # in the HTML output. For a value of 0 the output will use grayscales only. A
1101 # value of 255 will produce the most vivid colors.
1102 # Minimum value: 0, maximum value: 255, default value: 100.
1103 # This tag requires that the tag GENERATE_HTML is set to YES.
1104
1105 HTML_COLORSTYLE_SAT = 100
1106
1107 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1108 # luminance component of the colors in the HTML output. Values below 100
1109 # gradually make the output lighter, whereas values above 100 make the output
1110 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1111 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1112 # change the gamma.
1113 # Minimum value: 40, maximum value: 240, default value: 80.
1114 # This tag requires that the tag GENERATE_HTML is set to YES.
1115
1116 HTML_COLORSTYLE_GAMMA = 80
1117
1118 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1119 # page will contain the date and time when the page was generated. Setting this
1120 # to NO can help when comparing the output of multiple runs.
1121 # The default value is: YES.
1122 # This tag requires that the tag GENERATE_HTML is set to YES.
1123
1124 HTML_TIMESTAMP = YES
1125
1126 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1127 # documentation will contain sections that can be hidden and shown after the
1128 # page has loaded.
1129 # The default value is: NO.
1130 # This tag requires that the tag GENERATE_HTML is set to YES.
1131
1132 HTML_DYNAMIC_SECTIONS = NO
1133
1134 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1135 # shown in the various tree structured indices initially; the user can expand
1136 # and collapse entries dynamically later on. Doxygen will expand the tree to
1137 # such a level that at most the specified number of entries are visible (unless
1138 # a fully collapsed tree already exceeds this amount). So setting the number of
1139 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1140 # representing an infinite number of entries and will result in a full expanded
1141 # tree by default.
1142 # Minimum value: 0, maximum value: 9999, default value: 100.
1143 # This tag requires that the tag GENERATE_HTML is set to YES.
1144
1145 HTML_INDEX_NUM_ENTRIES = 100
1146
1147 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1148 # generated that can be used as input for Apple's Xcode 3 integrated development
1149 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1150 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1151 # Makefile in the HTML output directory. Running make will produce the docset in
1152 # that directory and running make install will install the docset in
1153 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1154 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1155 # for more information.
1156 # The default value is: NO.
1157 # This tag requires that the tag GENERATE_HTML is set to YES.
1158
1159 GENERATE_DOCSET = NO
1160
1161 # This tag determines the name of the docset feed. A documentation feed provides
1162 # an umbrella under which multiple documentation sets from a single provider
1163 # (such as a company or product suite) can be grouped.
1164 # The default value is: Doxygen generated docs.
1165 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1166
1167 DOCSET_FEEDNAME = "Doxygen generated docs"
1168
1169 # This tag specifies a string that should uniquely identify the documentation
1170 # set bundle. This should be a reverse domain-name style string, e.g.
1171 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1172 # The default value is: org.doxygen.Project.
1173 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1174
1175 DOCSET_BUNDLE_ID = org.doxygen.Project
1176
1177 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1178 # the documentation publisher. This should be a reverse domain-name style
1179 # string, e.g. com.mycompany.MyDocSet.documentation.
1180 # The default value is: org.doxygen.Publisher.
1181 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1182
1183 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1184
1185 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1186 # The default value is: Publisher.
1187 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1188
1189 DOCSET_PUBLISHER_NAME = Publisher
1190
1191 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1192 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1193 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1194 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1195 # Windows.
1196 #
1197 # The HTML Help Workshop contains a compiler that can convert all HTML output
1198 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1199 # files are now used as the Windows 98 help format, and will replace the old
1200 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1201 # HTML files also contain an index, a table of contents, and you can search for
1202 # words in the documentation. The HTML workshop also contains a viewer for
1203 # compressed HTML files.
1204 # The default value is: NO.
1205 # This tag requires that the tag GENERATE_HTML is set to YES.
1206
1207 GENERATE_HTMLHELP = NO
1208
1209 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1210 # file. You can add a path in front of the file if the result should not be
1211 # written to the html output directory.
1212 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1213
1214 CHM_FILE =
1215
1216 # The HHC_LOCATION tag can be used to specify the location (absolute path
1217 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1218 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1219 # The file has to be specified with full path.
1220 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1221
1222 HHC_LOCATION =
1223
1224 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1225 # YES) or that it should be included in the master .chm file ( NO).
1226 # The default value is: NO.
1227 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1228
1229 GENERATE_CHI = NO
1230
1231 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1232 # and project file content.
1233 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1234
1235 CHM_INDEX_ENCODING =
1236
1237 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1238 # YES) or a normal table of contents ( NO) in the .chm file.
1239 # The default value is: NO.
1240 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1241
1242 BINARY_TOC = NO
1243
1244 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1245 # the table of contents of the HTML help documentation and to the tree view.
1246 # The default value is: NO.
1247 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1248
1249 TOC_EXPAND = NO
1250
1251 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1252 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1253 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1254 # (.qch) of the generated HTML documentation.
1255 # The default value is: NO.
1256 # This tag requires that the tag GENERATE_HTML is set to YES.
1257
1258 GENERATE_QHP = NO
1259
1260 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1261 # the file name of the resulting .qch file. The path specified is relative to
1262 # the HTML output folder.
1263 # This tag requires that the tag GENERATE_QHP is set to YES.
1264
1265 QCH_FILE =
1266
1267 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1268 # Project output. For more information please see Qt Help Project / Namespace
1269 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1270 # The default value is: org.doxygen.Project.
1271 # This tag requires that the tag GENERATE_QHP is set to YES.
1272
1273 QHP_NAMESPACE = org.doxygen.Project
1274
1275 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1276 # Help Project output. For more information please see Qt Help Project / Virtual
1277 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1278 # folders).
1279 # The default value is: doc.
1280 # This tag requires that the tag GENERATE_QHP is set to YES.
1281
1282 QHP_VIRTUAL_FOLDER = doc
1283
1284 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1285 # filter to add. For more information please see Qt Help Project / Custom
1286 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1287 # filters).
1288 # This tag requires that the tag GENERATE_QHP is set to YES.
1289
1290 QHP_CUST_FILTER_NAME =
1291
1292 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1293 # custom filter to add. For more information please see Qt Help Project / Custom
1294 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1295 # filters).
1296 # This tag requires that the tag GENERATE_QHP is set to YES.
1297
1298 QHP_CUST_FILTER_ATTRS =
1299
1300 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1301 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1302 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1303 # This tag requires that the tag GENERATE_QHP is set to YES.
1304
1305 QHP_SECT_FILTER_ATTRS =
1306
1307 # The QHG_LOCATION tag can be used to specify the location of Qt's
1308 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1309 # generated .qhp file.
1310 # This tag requires that the tag GENERATE_QHP is set to YES.
1311
1312 QHG_LOCATION =
1313
1314 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1315 # generated, together with the HTML files, they form an Eclipse help plugin. To
1316 # install this plugin and make it available under the help contents menu in
1317 # Eclipse, the contents of the directory containing the HTML and XML files needs
1318 # to be copied into the plugins directory of eclipse. The name of the directory
1319 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1320 # After copying Eclipse needs to be restarted before the help appears.
1321 # The default value is: NO.
1322 # This tag requires that the tag GENERATE_HTML is set to YES.
1323
1324 GENERATE_ECLIPSEHELP = NO
1325
1326 # A unique identifier for the Eclipse help plugin. When installing the plugin
1327 # the directory name containing the HTML and XML files should also have this
1328 # name. Each documentation set should have its own identifier.
1329 # The default value is: org.doxygen.Project.
1330 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1331
1332 ECLIPSE_DOC_ID = org.doxygen.Project
1333
1334 # If you want full control over the layout of the generated HTML pages it might
1335 # be necessary to disable the index and replace it with your own. The
1336 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1337 # of each HTML page. A value of NO enables the index and the value YES disables
1338 # it. Since the tabs in the index contain the same information as the navigation
1339 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1340 # The default value is: NO.
1341 # This tag requires that the tag GENERATE_HTML is set to YES.
1342
1343 DISABLE_INDEX = NO
1344
1345 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1346 # structure should be generated to display hierarchical information. If the tag
1347 # value is set to YES, a side panel will be generated containing a tree-like
1348 # index structure (just like the one that is generated for HTML Help). For this
1349 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1350 # (i.e. any modern browser). Windows users are probably better off using the
1351 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1352 # further fine-tune the look of the index. As an example, the default style
1353 # sheet generated by doxygen has an example that shows how to put an image at
1354 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1355 # the same information as the tab index, you could consider setting
1356 # DISABLE_INDEX to YES when enabling this option.
1357 # The default value is: NO.
1358 # This tag requires that the tag GENERATE_HTML is set to YES.
1359
1360 GENERATE_TREEVIEW = NO
1361
1362 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1363 # doxygen will group on one line in the generated HTML documentation.
1364 #
1365 # Note that a value of 0 will completely suppress the enum values from appearing
1366 # in the overview section.
1367 # Minimum value: 0, maximum value: 20, default value: 4.
1368 # This tag requires that the tag GENERATE_HTML is set to YES.
1369
1370 ENUM_VALUES_PER_LINE = 4
1371
1372 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1373 # to set the initial width (in pixels) of the frame in which the tree is shown.
1374 # Minimum value: 0, maximum value: 1500, default value: 250.
1375 # This tag requires that the tag GENERATE_HTML is set to YES.
1376
1377 TREEVIEW_WIDTH = 250
1378
1379 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1380 # external symbols imported via tag files in a separate window.
1381 # The default value is: NO.
1382 # This tag requires that the tag GENERATE_HTML is set to YES.
1383
1384 EXT_LINKS_IN_WINDOW = NO
1385
1386 # Use this tag to change the font size of LaTeX formulas included as images in
1387 # the HTML documentation. When you change the font size after a successful
1388 # doxygen run you need to manually remove any form_*.png images from the HTML
1389 # output directory to force them to be regenerated.
1390 # Minimum value: 8, maximum value: 50, default value: 10.
1391 # This tag requires that the tag GENERATE_HTML is set to YES.
1392
1393 FORMULA_FONTSIZE = 10
1394
1395 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1396 # generated for formulas are transparent PNGs. Transparent PNGs are not
1397 # supported properly for IE 6.0, but are supported on all modern browsers.
1398 #
1399 # Note that when changing this option you need to delete any form_*.png files in
1400 # the HTML output directory before the changes have effect.
1401 # The default value is: YES.
1402 # This tag requires that the tag GENERATE_HTML is set to YES.
1403
1404 FORMULA_TRANSPARENT = YES
1405
1406 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1407 # http://www.mathjax.org) which uses client side Javascript for the rendering
1408 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1409 # installed or if you want to formulas look prettier in the HTML output. When
1410 # enabled you may also need to install MathJax separately and configure the path
1411 # to it using the MATHJAX_RELPATH option.
1412 # The default value is: NO.
1413 # This tag requires that the tag GENERATE_HTML is set to YES.
1414
1415 USE_MATHJAX = NO
1416
1417 # When MathJax is enabled you can set the default output format to be used for
1418 # the MathJax output. See the MathJax site (see:
1419 # http://docs.mathjax.org/en/latest/output.html) for more details.
1420 # Possible values are: HTML-CSS (which is slower, but has the best
1421 # compatibility), NativeMML (i.e. MathML) and SVG.
1422 # The default value is: HTML-CSS.
1423 # This tag requires that the tag USE_MATHJAX is set to YES.
1424
1425 MATHJAX_FORMAT = HTML-CSS
1426
1427 # When MathJax is enabled you need to specify the location relative to the HTML
1428 # output directory using the MATHJAX_RELPATH option. The destination directory
1429 # should contain the MathJax.js script. For instance, if the mathjax directory
1430 # is located at the same level as the HTML output directory, then
1431 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1432 # Content Delivery Network so you can quickly see the result without installing
1433 # MathJax. However, it is strongly recommended to install a local copy of
1434 # MathJax from http://www.mathjax.org before deployment.
1435 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1436 # This tag requires that the tag USE_MATHJAX is set to YES.
1437
1438 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1439
1440 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1441 # extension names that should be enabled during MathJax rendering. For example
1442 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1443 # This tag requires that the tag USE_MATHJAX is set to YES.
1444
1445 MATHJAX_EXTENSIONS =
1446
1447 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1448 # of code that will be used on startup of the MathJax code. See the MathJax site
1449 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1450 # example see the documentation.
1451 # This tag requires that the tag USE_MATHJAX is set to YES.
1452
1453 MATHJAX_CODEFILE =
1454
1455 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1456 # the HTML output. The underlying search engine uses javascript and DHTML and
1457 # should work on any modern browser. Note that when using HTML help
1458 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1459 # there is already a search function so this one should typically be disabled.
1460 # For large projects the javascript based search engine can be slow, then
1461 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1462 # search using the keyboard; to jump to the search box use <access key> + S
1463 # (what the <access key> is depends on the OS and browser, but it is typically
1464 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1465 # key> to jump into the search results window, the results can be navigated
1466 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1467 # the search. The filter options can be selected when the cursor is inside the
1468 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1469 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1470 # option.
1471 # The default value is: YES.
1472 # This tag requires that the tag GENERATE_HTML is set to YES.
1473
1474 SEARCHENGINE = YES
1475
1476 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1477 # implemented using a web server instead of a web client using Javascript. There
1478 # are two flavours of web server based searching depending on the
1479 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1480 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1481 # enabled the indexing and searching needs to be provided by external tools. See
1482 # the section "External Indexing and Searching" for details.
1483 # The default value is: NO.
1484 # This tag requires that the tag SEARCHENGINE is set to YES.
1485
1486 SERVER_BASED_SEARCH = NO
1487
1488 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1489 # script for searching. Instead the search results are written to an XML file
1490 # which needs to be processed by an external indexer. Doxygen will invoke an
1491 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1492 # search results.
1493 #
1494 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1495 # (doxysearch.cgi) which are based on the open source search engine library
1496 # Xapian (see: http://xapian.org/).
1497 #
1498 # See the section "External Indexing and Searching" for details.
1499 # The default value is: NO.
1500 # This tag requires that the tag SEARCHENGINE is set to YES.
1501
1502 EXTERNAL_SEARCH = NO
1503
1504 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1505 # which will return the search results when EXTERNAL_SEARCH is enabled.
1506 #
1507 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1508 # (doxysearch.cgi) which are based on the open source search engine library
1509 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1510 # Searching" for details.
1511 # This tag requires that the tag SEARCHENGINE is set to YES.
1512
1513 SEARCHENGINE_URL =
1514
1515 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1516 # search data is written to a file for indexing by an external tool. With the
1517 # SEARCHDATA_FILE tag the name of this file can be specified.
1518 # The default file is: searchdata.xml.
1519 # This tag requires that the tag SEARCHENGINE is set to YES.
1520
1521 SEARCHDATA_FILE = searchdata.xml
1522
1523 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1524 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1525 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1526 # projects and redirect the results back to the right project.
1527 # This tag requires that the tag SEARCHENGINE is set to YES.
1528
1529 EXTERNAL_SEARCH_ID =
1530
1531 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1532 # projects other than the one defined by this configuration file, but that are
1533 # all added to the same external search index. Each project needs to have a
1534 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1535 # to a relative location where the documentation can be found. The format is:
1536 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1537 # This tag requires that the tag SEARCHENGINE is set to YES.
1538
1539 EXTRA_SEARCH_MAPPINGS =
1540
1541 #---------------------------------------------------------------------------
1542 # Configuration options related to the LaTeX output
1543 #---------------------------------------------------------------------------
1544
1545 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1546 # The default value is: YES.
1547
1548 GENERATE_LATEX = NO
1549
1550 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1551 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1552 # it.
1553 # The default directory is: latex.
1554 # This tag requires that the tag GENERATE_LATEX is set to YES.
1555
1556 LATEX_OUTPUT = latex
1557
1558 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1559 # invoked.
1560 #
1561 # Note that when enabling USE_PDFLATEX this option is only used for generating
1562 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1563 # written to the output directory.
1564 # The default file is: latex.
1565 # This tag requires that the tag GENERATE_LATEX is set to YES.
1566
1567 LATEX_CMD_NAME = latex
1568
1569 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1570 # index for LaTeX.
1571 # The default file is: makeindex.
1572 # This tag requires that the tag GENERATE_LATEX is set to YES.
1573
1574 MAKEINDEX_CMD_NAME = makeindex
1575
1576 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1577 # documents. This may be useful for small projects and may help to save some
1578 # trees in general.
1579 # The default value is: NO.
1580 # This tag requires that the tag GENERATE_LATEX is set to YES.
1581
1582 COMPACT_LATEX = NO
1583
1584 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1585 # printer.
1586 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1587 # 14 inches) and executive (7.25 x 10.5 inches).
1588 # The default value is: a4.
1589 # This tag requires that the tag GENERATE_LATEX is set to YES.
1590
1591 PAPER_TYPE = a4
1592
1593 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1594 # that should be included in the LaTeX output. To get the times font for
1595 # instance you can specify
1596 # EXTRA_PACKAGES=times
1597 # If left blank no extra packages will be included.
1598 # This tag requires that the tag GENERATE_LATEX is set to YES.
1599
1600 EXTRA_PACKAGES =
1601
1602 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1603 # generated LaTeX document. The header should contain everything until the first
1604 # chapter. If it is left blank doxygen will generate a standard header. See
1605 # section "Doxygen usage" for information on how to let doxygen write the
1606 # default header to a separate file.
1607 #
1608 # Note: Only use a user-defined header if you know what you are doing! The
1609 # following commands have a special meaning inside the header: $title,
1610 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1611 # replace them by respectively the title of the page, the current date and time,
1612 # only the current date, the version number of doxygen, the project name (see
1613 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1614 # This tag requires that the tag GENERATE_LATEX is set to YES.
1615
1616 LATEX_HEADER =
1617
1618 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1619 # generated LaTeX document. The footer should contain everything after the last
1620 # chapter. If it is left blank doxygen will generate a standard footer.
1621 #
1622 # Note: Only use a user-defined footer if you know what you are doing!
1623 # This tag requires that the tag GENERATE_LATEX is set to YES.
1624
1625 LATEX_FOOTER =
1626
1627 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1628 # other source files which should be copied to the LATEX_OUTPUT output
1629 # directory. Note that the files will be copied as-is; there are no commands or
1630 # markers available.
1631 # This tag requires that the tag GENERATE_LATEX is set to YES.
1632
1633 LATEX_EXTRA_FILES =
1634
1635 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1636 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1637 # contain links (just like the HTML output) instead of page references. This
1638 # makes the output suitable for online browsing using a PDF viewer.
1639 # The default value is: YES.
1640 # This tag requires that the tag GENERATE_LATEX is set to YES.
1641
1642 PDF_HYPERLINKS = YES
1643
1644 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1645 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1646 # higher quality PDF documentation.
1647 # The default value is: YES.
1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
1649
1650 USE_PDFLATEX = YES
1651
1652 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1653 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1654 # if errors occur, instead of asking the user for help. This option is also used
1655 # when generating formulas in HTML.
1656 # The default value is: NO.
1657 # This tag requires that the tag GENERATE_LATEX is set to YES.
1658
1659 LATEX_BATCHMODE = NO
1660
1661 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1662 # index chapters (such as File Index, Compound Index, etc.) in the output.
1663 # The default value is: NO.
1664 # This tag requires that the tag GENERATE_LATEX is set to YES.
1665
1666 LATEX_HIDE_INDICES = NO
1667
1668 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1669 # code with syntax highlighting in the LaTeX output.
1670 #
1671 # Note that which sources are shown also depends on other settings such as
1672 # SOURCE_BROWSER.
1673 # The default value is: NO.
1674 # This tag requires that the tag GENERATE_LATEX is set to YES.
1675
1676 LATEX_SOURCE_CODE = NO
1677
1678 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1679 # bibliography, e.g. plainnat, or ieeetr. See
1680 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1681 # The default value is: plain.
1682 # This tag requires that the tag GENERATE_LATEX is set to YES.
1683
1684 LATEX_BIB_STYLE = plain
1685
1686 #---------------------------------------------------------------------------
1687 # Configuration options related to the RTF output
1688 #---------------------------------------------------------------------------
1689
1690 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1691 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1692 # readers/editors.
1693 # The default value is: NO.
1694
1695 GENERATE_RTF = NO
1696
1697 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1698 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1699 # it.
1700 # The default directory is: rtf.
1701 # This tag requires that the tag GENERATE_RTF is set to YES.
1702
1703 RTF_OUTPUT = rtf
1704
1705 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1706 # documents. This may be useful for small projects and may help to save some
1707 # trees in general.
1708 # The default value is: NO.
1709 # This tag requires that the tag GENERATE_RTF is set to YES.
1710
1711 COMPACT_RTF = NO
1712
1713 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1714 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1715 # output) instead of page references. This makes the output suitable for online
1716 # browsing using Word or some other Word compatible readers that support those
1717 # fields.
1718 #
1719 # Note: WordPad (write) and others do not support links.
1720 # The default value is: NO.
1721 # This tag requires that the tag GENERATE_RTF is set to YES.
1722
1723 RTF_HYPERLINKS = NO
1724
1725 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1726 # file, i.e. a series of assignments. You only have to provide replacements,
1727 # missing definitions are set to their default value.
1728 #
1729 # See also section "Doxygen usage" for information on how to generate the
1730 # default style sheet that doxygen normally uses.
1731 # This tag requires that the tag GENERATE_RTF is set to YES.
1732
1733 RTF_STYLESHEET_FILE =
1734
1735 # Set optional variables used in the generation of an RTF document. Syntax is
1736 # similar to doxygen's config file. A template extensions file can be generated
1737 # using doxygen -e rtf extensionFile.
1738 # This tag requires that the tag GENERATE_RTF is set to YES.
1739
1740 RTF_EXTENSIONS_FILE =
1741
1742 #---------------------------------------------------------------------------
1743 # Configuration options related to the man page output
1744 #---------------------------------------------------------------------------
1745
1746 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1747 # classes and files.
1748 # The default value is: NO.
1749
1750 GENERATE_MAN = NO
1751
1752 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1753 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1754 # it. A directory man3 will be created inside the directory specified by
1755 # MAN_OUTPUT.
1756 # The default directory is: man.
1757 # This tag requires that the tag GENERATE_MAN is set to YES.
1758
1759 MAN_OUTPUT = man
1760
1761 # The MAN_EXTENSION tag determines the extension that is added to the generated
1762 # man pages. In case the manual section does not start with a number, the number
1763 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1764 # optional.
1765 # The default value is: .3.
1766 # This tag requires that the tag GENERATE_MAN is set to YES.
1767
1768 MAN_EXTENSION = .3
1769
1770 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1771 # will generate one additional man file for each entity documented in the real
1772 # man page(s). These additional files only source the real man page, but without
1773 # them the man command would be unable to find the correct page.
1774 # The default value is: NO.
1775 # This tag requires that the tag GENERATE_MAN is set to YES.
1776
1777 MAN_LINKS = NO
1778
1779 #---------------------------------------------------------------------------
1780 # Configuration options related to the XML output
1781 #---------------------------------------------------------------------------
1782
1783 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1784 # captures the structure of the code including all documentation.
1785 # The default value is: NO.
1786
1787 GENERATE_XML = NO
1788
1789 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1790 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1791 # it.
1792 # The default directory is: xml.
1793 # This tag requires that the tag GENERATE_XML is set to YES.
1794
1795 XML_OUTPUT = xml
1796
1797 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1798 # listings (including syntax highlighting and cross-referencing information) to
1799 # the XML output. Note that enabling this will significantly increase the size
1800 # of the XML output.
1801 # The default value is: YES.
1802 # This tag requires that the tag GENERATE_XML is set to YES.
1803
1804 XML_PROGRAMLISTING = YES
1805
1806 #---------------------------------------------------------------------------
1807 # Configuration options related to the DOCBOOK output
1808 #---------------------------------------------------------------------------
1809
1810 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1811 # that can be used to generate PDF.
1812 # The default value is: NO.
1813
1814 GENERATE_DOCBOOK = NO
1815
1816 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1817 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1818 # front of it.
1819 # The default directory is: docbook.
1820 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1821
1822 DOCBOOK_OUTPUT = docbook
1823
1824 #---------------------------------------------------------------------------
1825 # Configuration options for the AutoGen Definitions output
1826 #---------------------------------------------------------------------------
1827
1828 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1829 # Definitions (see http://autogen.sf.net) file that captures the structure of
1830 # the code including all documentation. Note that this feature is still
1831 # experimental and incomplete at the moment.
1832 # The default value is: NO.
1833
1834 GENERATE_AUTOGEN_DEF = NO
1835
1836 #---------------------------------------------------------------------------
1837 # Configuration options related to the Perl module output
1838 #---------------------------------------------------------------------------
1839
1840 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1841 # file that captures the structure of the code including all documentation.
1842 #
1843 # Note that this feature is still experimental and incomplete at the moment.
1844 # The default value is: NO.
1845
1846 GENERATE_PERLMOD = NO
1847
1848 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1849 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1850 # output from the Perl module output.
1851 # The default value is: NO.
1852 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1853
1854 PERLMOD_LATEX = NO
1855
1856 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1857 # formatted so it can be parsed by a human reader. This is useful if you want to
1858 # understand what is going on. On the other hand, if this tag is set to NO the
1859 # size of the Perl module output will be much smaller and Perl will parse it
1860 # just the same.
1861 # The default value is: YES.
1862 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1863
1864 PERLMOD_PRETTY = YES
1865
1866 # The names of the make variables in the generated doxyrules.make file are
1867 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1868 # so different doxyrules.make files included by the same Makefile don't
1869 # overwrite each other's variables.
1870 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1871
1872 PERLMOD_MAKEVAR_PREFIX =
1873
1874 #---------------------------------------------------------------------------
1875 # Configuration options related to the preprocessor
1876 #---------------------------------------------------------------------------
1877
1878 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1879 # C-preprocessor directives found in the sources and include files.
1880 # The default value is: YES.
1881
1882 ENABLE_PREPROCESSING = YES
1883
1884 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1885 # in the source code. If set to NO only conditional compilation will be
1886 # performed. Macro expansion can be done in a controlled way by setting
1887 # EXPAND_ONLY_PREDEF to YES.
1888 # The default value is: NO.
1889 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1890
1891 MACRO_EXPANSION = YES
1892
1893 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1894 # the macro expansion is limited to the macros specified with the PREDEFINED and
1895 # EXPAND_AS_DEFINED tags.
1896 # The default value is: NO.
1897 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1898
1899 EXPAND_ONLY_PREDEF = YES
1900
1901 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1902 # INCLUDE_PATH will be searched if a #include is found.
1903 # The default value is: YES.
1904 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1905
1906 SEARCH_INCLUDES = YES
1907
1908 # The INCLUDE_PATH tag can be used to specify one or more directories that
1909 # contain include files that are not input files but should be processed by the
1910 # preprocessor.
1911 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1912
1913 INCLUDE_PATH =
1914
1915 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1916 # patterns (like *.h and *.hpp) to filter out the header-files in the
1917 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1918 # used.
1919 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1920
1921 INCLUDE_FILE_PATTERNS =
1922
1923 # The PREDEFINED tag can be used to specify one or more macro names that are
1924 # defined before the preprocessor is started (similar to the -D option of e.g.
1925 # gcc). The argument of the tag is a list of macros of the form: name or
1926 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1927 # is assumed. To prevent a macro definition from being undefined via #undef or
1928 # recursively expanded use the := operator instead of the = operator.
1929 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1930
1931 PREDEFINED = __cplusplus=201402
1932
1933 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1934 # tag can be used to specify a list of macro names that should be expanded. The
1935 # macro definition that is found in the sources will be used. Use the PREDEFINED
1936 # tag if you want to use a different macro definition that overrules the
1937 # definition found in the source code.
1938 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1939
1940 EXPAND_AS_DEFINED =
1941
1942 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1943 # remove all refrences to function-like macros that are alone on a line, have an
1944 # all uppercase name, and do not end with a semicolon. Such function macros are
1945 # typically used for boiler-plate code, and will confuse the parser if not
1946 # removed.
1947 # The default value is: YES.
1948 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1949
1950 SKIP_FUNCTION_MACROS = YES
1951
1952 #---------------------------------------------------------------------------
1953 # Configuration options related to external references
1954 #---------------------------------------------------------------------------
1955
1956 # The TAGFILES tag can be used to specify one or more tag files. For each tag
1957 # file the location of the external documentation should be added. The format of
1958 # a tag file without this location is as follows:
1959 # TAGFILES = file1 file2 ...
1960 # Adding location for the tag files is done as follows:
1961 # TAGFILES = file1=loc1 "file2 = loc2" ...
1962 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
1963 # section "Linking to external documentation" for more information about the use
1964 # of tag files.
1965 # Note: Each tag file must have an unique name (where the name does NOT include
1966 # the path). If a tag file is not located in the directory in which doxygen is
1967 # run, you must also specify the path to the tagfile here.
1968
1969 TAGFILES =
1970
1971 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1972 # tag file that is based on the input files it reads. See section "Linking to
1973 # external documentation" for more information about the usage of tag files.
1974
1975 GENERATE_TAGFILE =
1976
1977 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1978 # class index. If set to NO only the inherited external classes will be listed.
1979 # The default value is: NO.
1980
1981 ALLEXTERNALS = NO
1982
1983 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1984 # the modules index. If set to NO, only the current project's groups will be
1985 # listed.
1986 # The default value is: YES.
1987
1988 EXTERNAL_GROUPS = NO
1989
1990 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
1991 # the related pages index. If set to NO, only the current project's pages will
1992 # be listed.
1993 # The default value is: YES.
1994
1995 EXTERNAL_PAGES = NO
1996
1997 # The PERL_PATH should be the absolute path and name of the perl script
1998 # interpreter (i.e. the result of 'which perl').
1999 # The default file (with absolute path) is: /usr/bin/perl.
2000
2001 PERL_PATH = /usr/bin/perl
2002
2003 #---------------------------------------------------------------------------
2004 # Configuration options related to the dot tool
2005 #---------------------------------------------------------------------------
2006
2007 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2008 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2009 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2010 # disabled, but it is recommended to install and use dot, since it yields more
2011 # powerful graphs.
2012 # The default value is: YES.
2013
2014 CLASS_DIAGRAMS = YES
2015
2016 # You can define message sequence charts within doxygen comments using the \msc
2017 # command. Doxygen will then run the mscgen tool (see:
2018 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2019 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2020 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2021 # default search path.
2022
2023 MSCGEN_PATH =
2024
2025 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2026 # and usage relations if the target is undocumented or is not a class.
2027 # The default value is: YES.
2028
2029 HIDE_UNDOC_RELATIONS = YES
2030
2031 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2032 # available from the path. This tool is part of Graphviz (see:
2033 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2034 # Bell Labs. The other options in this section have no effect if this option is
2035 # set to NO
2036 # The default value is: NO.
2037
2038 HAVE_DOT = NO
2039
2040 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2041 # to run in parallel. When set to 0 doxygen will base this on the number of
2042 # processors available in the system. You can set it explicitly to a value
2043 # larger than 0 to get control over the balance between CPU load and processing
2044 # speed.
2045 # Minimum value: 0, maximum value: 32, default value: 0.
2046 # This tag requires that the tag HAVE_DOT is set to YES.
2047
2048 DOT_NUM_THREADS = 0
2049
2050 # When you want a differently looking font n the dot files that doxygen
2051 # generates you can specify the font name using DOT_FONTNAME. You need to make
2052 # sure dot is able to find the font, which can be done by putting it in a
2053 # standard location or by setting the DOTFONTPATH environment variable or by
2054 # setting DOT_FONTPATH to the directory containing the font.
2055 # The default value is: Helvetica.
2056 # This tag requires that the tag HAVE_DOT is set to YES.
2057
2058 DOT_FONTNAME = Helvetica
2059
2060 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2061 # dot graphs.
2062 # Minimum value: 4, maximum value: 24, default value: 10.
2063 # This tag requires that the tag HAVE_DOT is set to YES.
2064
2065 DOT_FONTSIZE = 10
2066
2067 # By default doxygen will tell dot to use the default font as specified with
2068 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2069 # the path where dot can find it using this tag.
2070 # This tag requires that the tag HAVE_DOT is set to YES.
2071
2072 DOT_FONTPATH =
2073
2074 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2075 # each documented class showing the direct and indirect inheritance relations.
2076 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2077 # The default value is: YES.
2078 # This tag requires that the tag HAVE_DOT is set to YES.
2079
2080 CLASS_GRAPH = YES
2081
2082 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2083 # graph for each documented class showing the direct and indirect implementation
2084 # dependencies (inheritance, containment, and class references variables) of the
2085 # class with other documented classes.
2086 # The default value is: YES.
2087 # This tag requires that the tag HAVE_DOT is set to YES.
2088
2089 COLLABORATION_GRAPH = YES
2090
2091 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2092 # groups, showing the direct groups dependencies.
2093 # The default value is: YES.
2094 # This tag requires that the tag HAVE_DOT is set to YES.
2095
2096 GROUP_GRAPHS = YES
2097
2098 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2099 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2100 # Language.
2101 # The default value is: NO.
2102 # This tag requires that the tag HAVE_DOT is set to YES.
2103
2104 UML_LOOK = NO
2105
2106 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2107 # class node. If there are many fields or methods and many nodes the graph may
2108 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2109 # number of items for each type to make the size more manageable. Set this to 0
2110 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2111 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2112 # but if the number exceeds 15, the total amount of fields shown is limited to
2113 # 10.
2114 # Minimum value: 0, maximum value: 100, default value: 10.
2115 # This tag requires that the tag HAVE_DOT is set to YES.
2116
2117 UML_LIMIT_NUM_FIELDS = 10
2118
2119 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2120 # collaboration graphs will show the relations between templates and their
2121 # instances.
2122 # The default value is: NO.
2123 # This tag requires that the tag HAVE_DOT is set to YES.
2124
2125 TEMPLATE_RELATIONS = NO
2126
2127 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2128 # YES then doxygen will generate a graph for each documented file showing the
2129 # direct and indirect include dependencies of the file with other documented
2130 # files.
2131 # The default value is: YES.
2132 # This tag requires that the tag HAVE_DOT is set to YES.
2133
2134 INCLUDE_GRAPH = YES
2135
2136 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2137 # set to YES then doxygen will generate a graph for each documented file showing
2138 # the direct and indirect include dependencies of the file with other documented
2139 # files.
2140 # The default value is: YES.
2141 # This tag requires that the tag HAVE_DOT is set to YES.
2142
2143 INCLUDED_BY_GRAPH = YES
2144
2145 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2146 # dependency graph for every global function or class method.
2147 #
2148 # Note that enabling this option will significantly increase the time of a run.
2149 # So in most cases it will be better to enable call graphs for selected
2150 # functions only using the \callgraph command.
2151 # The default value is: NO.
2152 # This tag requires that the tag HAVE_DOT is set to YES.
2153
2154 CALL_GRAPH = NO
2155
2156 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2157 # dependency graph for every global function or class method.
2158 #
2159 # Note that enabling this option will significantly increase the time of a run.
2160 # So in most cases it will be better to enable caller graphs for selected
2161 # functions only using the \callergraph command.
2162 # The default value is: NO.
2163 # This tag requires that the tag HAVE_DOT is set to YES.
2164
2165 CALLER_GRAPH = NO
2166
2167 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2168 # hierarchy of all classes instead of a textual one.
2169 # The default value is: YES.
2170 # This tag requires that the tag HAVE_DOT is set to YES.
2171
2172 GRAPHICAL_HIERARCHY = YES
2173
2174 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2175 # dependencies a directory has on other directories in a graphical way. The
2176 # dependency relations are determined by the #include relations between the
2177 # files in the directories.
2178 # The default value is: YES.
2179 # This tag requires that the tag HAVE_DOT is set to YES.
2180
2181 DIRECTORY_GRAPH = YES
2182
2183 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2184 # generated by dot.
2185 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2186 # to make the SVG files visible in IE 9+ (other browsers do not have this
2187 # requirement).
2188 # Possible values are: png, jpg, gif and svg.
2189 # The default value is: png.
2190 # This tag requires that the tag HAVE_DOT is set to YES.
2191
2192 DOT_IMAGE_FORMAT = png
2193
2194 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2195 # enable generation of interactive SVG images that allow zooming and panning.
2196 #
2197 # Note that this requires a modern browser other than Internet Explorer. Tested
2198 # and working are Firefox, Chrome, Safari, and Opera.
2199 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2200 # the SVG files visible. Older versions of IE do not have SVG support.
2201 # The default value is: NO.
2202 # This tag requires that the tag HAVE_DOT is set to YES.
2203
2204 INTERACTIVE_SVG = NO
2205
2206 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2207 # found. If left blank, it is assumed the dot tool can be found in the path.
2208 # This tag requires that the tag HAVE_DOT is set to YES.
2209
2210 DOT_PATH =
2211
2212 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2213 # contain dot files that are included in the documentation (see the \dotfile
2214 # command).
2215 # This tag requires that the tag HAVE_DOT is set to YES.
2216
2217 DOTFILE_DIRS =
2218
2219 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2220 # contain msc files that are included in the documentation (see the \mscfile
2221 # command).
2222
2223 MSCFILE_DIRS =
2224
2225 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2226 # that will be shown in the graph. If the number of nodes in a graph becomes
2227 # larger than this value, doxygen will truncate the graph, which is visualized
2228 # by representing a node as a red box. Note that doxygen if the number of direct
2229 # children of the root node in a graph is already larger than
2230 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2231 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2232 # Minimum value: 0, maximum value: 10000, default value: 50.
2233 # This tag requires that the tag HAVE_DOT is set to YES.
2234
2235 DOT_GRAPH_MAX_NODES = 50
2236
2237 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2238 # generated by dot. A depth value of 3 means that only nodes reachable from the
2239 # root by following a path via at most 3 edges will be shown. Nodes that lay
2240 # further from the root node will be omitted. Note that setting this option to 1
2241 # or 2 may greatly reduce the computation time needed for large code bases. Also
2242 # note that the size of a graph can be further restricted by
2243 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2244 # Minimum value: 0, maximum value: 1000, default value: 0.
2245 # This tag requires that the tag HAVE_DOT is set to YES.
2246
2247 MAX_DOT_GRAPH_DEPTH = 0
2248
2249 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2250 # background. This is disabled by default, because dot on Windows does not seem
2251 # to support this out of the box.
2252 #
2253 # Warning: Depending on the platform used, enabling this option may lead to
2254 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2255 # read).
2256 # The default value is: NO.
2257 # This tag requires that the tag HAVE_DOT is set to YES.
2258
2259 DOT_TRANSPARENT = NO
2260
2261 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2262 # files in one run (i.e. multiple -o and -T options on the command line). This
2263 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2264 # this, this feature is disabled by default.
2265 # The default value is: NO.
2266 # This tag requires that the tag HAVE_DOT is set to YES.
2267
2268 DOT_MULTI_TARGETS = NO
2269
2270 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2271 # explaining the meaning of the various boxes and arrows in the dot generated
2272 # graphs.
2273 # The default value is: YES.
2274 # This tag requires that the tag HAVE_DOT is set to YES.
2275
2276 GENERATE_LEGEND = YES
2277
2278 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2279 # files that are used to generate the various graphs.
2280 # The default value is: YES.
2281 # This tag requires that the tag HAVE_DOT is set to YES.
2282
2283 DOT_CLEANUP = YES