Updated Changelog
[libgpiv.git] / Doxyfile.in
blob76a28699daafa72bfb7c8341a231a181b06a04cf
1 # Doxyfile 1.7.6.1
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
6 # All text after a hash (#) is considered a comment and will be ignored.
7 # The format is:
8 #       TAG = value [value, ...]
9 # For lists items can also be appended using:
10 #       TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ").
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
23 DOXYFILE_ENCODING      = UTF-8
25 # The PROJECT_NAME tag is a single word (or sequence of words) that should
26 # identify the project. Note that if you do not use Doxywizard you need
27 # to put quotes around the project name if it contains spaces.
29 #PROJECT_NAME           = $(PROJECT)-$(VERSION)
30 PROJECT_NAME           = @CMAKE_PROJECT_NAME@-
32 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
33 # This could be handy for archiving the generated documentation or
34 # if some version control system is used.
36 PROJECT_NUMBER         =
38 # Using the PROJECT_BRIEF tag one can provide an optional one line description
39 # for a project that appears at the top of each page and should give viewer
40 # a quick idea about the purpose of the project. Keep the description short.
42 PROJECT_BRIEF          =
44 # With the PROJECT_LOGO tag one can specify an logo or icon that is
45 # included in the documentation. The maximum height of the logo should not
46 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
47 # Doxygen will copy the logo to the output directory.
49 PROJECT_LOGO           =
51 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
52 # base path where the generated documentation will be put.
53 # If a relative path is entered, it will be relative to the location
54 # where doxygen was started. If left blank the current directory will be used.
56 #OUTPUT_DIRECTORY       = $(DOCDIR)
57 OUTPUT_DIRECTORY       = @CMAKE_BINARY_DIR@
59 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
60 # 4096 sub-directories (in 2 levels) under the output directory of each output
61 # format and will distribute the generated files over these directories.
62 # Enabling this option can be useful when feeding doxygen a huge amount of
63 # source files, where putting all generated files in the same directory would
64 # otherwise cause performance problems for the file system.
66 CREATE_SUBDIRS         = NO
68 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
69 # documentation generated by doxygen is written. Doxygen will use this
70 # information to generate all constant output in the proper language.
71 # The default language is English, other supported languages are:
72 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
73 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
74 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
75 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
76 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
77 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
79 OUTPUT_LANGUAGE        = English
81 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
82 # include brief member descriptions after the members that are listed in
83 # the file and class documentation (similar to JavaDoc).
84 # Set to NO to disable this.
86 BRIEF_MEMBER_DESC      = YES
88 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
89 # the brief description of a member or function before the detailed description.
90 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
91 # brief descriptions will be completely suppressed.
93 REPEAT_BRIEF           = YES
95 # This tag implements a quasi-intelligent brief description abbreviator
96 # that is used to form the text in various listings. Each string
97 # in this list, if found as the leading text of the brief description, will be
98 # stripped from the text and the result after processing the whole list, is
99 # used as the annotated text. Otherwise, the brief description is used as-is.
100 # If left blank, the following values are used ("$name" is automatically
101 # replaced with the name of the entity): "The $name class" "The $name widget"
102 # "The $name file" "is" "provides" "specifies" "contains"
103 # "represents" "a" "an" "the"
105 ABBREVIATE_BRIEF       = YES
107 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
108 # Doxygen will generate a detailed section even if there is only a brief
109 # description.
111 ALWAYS_DETAILED_SEC    = NO
113 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
114 # inherited members of a class in the documentation of that class as if those
115 # members were ordinary class members. Constructors, destructors and assignment
116 # operators of the base classes will not be shown.
118 INLINE_INHERITED_MEMB  = YES
120 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
121 # path before files name in the file list and in the header files. If set
122 # to NO the shortest path that makes the file name unique will be used.
124 FULL_PATH_NAMES        = YES
126 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
127 # can be used to strip a user-defined part of the path. Stripping is
128 # only done if one of the specified strings matches the left-hand part of
129 # the path. The tag can be used to show relative paths in the file list.
130 # If left blank the directory from which doxygen is run is used as the
131 # path to strip.
133 STRIP_FROM_PATH        = $(SRCDIR)
135 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
136 # the path mentioned in the documentation of a class, which tells
137 # the reader which header file to include in order to use a class.
138 # If left blank only the name of the header file containing the class
139 # definition is used. Otherwise one should specify the include paths that
140 # are normally passed to the compiler using the -I flag.
142 STRIP_FROM_INC_PATH    = $(SRCDIR)
144 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145 # (but less readable) file names. This can be useful if your file system
146 # doesn't support long names like on DOS, Mac, or CD-ROM.
148 SHORT_NAMES            = NO
150 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
151 # will interpret the first line (until the first dot) of a JavaDoc-style
152 # comment as the brief description. If set to NO, the JavaDoc
153 # comments will behave just like regular Qt-style comments
154 # (thus requiring an explicit @brief command for a brief description.)
156 JAVADOC_AUTOBRIEF      = YES
158 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
159 # interpret the first line (until the first dot) of a Qt-style
160 # comment as the brief description. If set to NO, the comments
161 # will behave just like regular Qt-style comments (thus requiring
162 # an explicit \brief command for a brief description.)
164 QT_AUTOBRIEF           = NO
166 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
167 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
168 # comments) as a brief description. This used to be the default behaviour.
169 # The new default is to treat a multi-line C++ comment block as a detailed
170 # description. Set this tag to YES if you prefer the old behaviour instead.
172 MULTILINE_CPP_IS_BRIEF = NO
174 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
175 # member inherits the documentation from any documented member that it
176 # re-implements.
178 INHERIT_DOCS           = YES
180 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
181 # a new page for each member. If set to NO, the documentation of a member will
182 # be part of the file/class/namespace that contains it.
184 SEPARATE_MEMBER_PAGES  = NO
186 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
187 # Doxygen uses this value to replace tabs by spaces in code fragments.
189 TAB_SIZE               = 4
191 # This tag can be used to specify a number of aliases that acts
192 # as commands in the documentation. An alias has the form "name=value".
193 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
194 # put the command \sideeffect (or @sideeffect) in the documentation, which
195 # will result in a user-defined paragraph with heading "Side Effects:".
196 # You can put \n's in the value part of an alias to insert newlines.
198 ALIASES                =
200 # This tag can be used to specify a number of word-keyword mappings (TCL only).
201 # A mapping has the form "name=value". For example adding
202 # "class=itcl::class" will allow you to use the command class in the
203 # itcl::class meaning.
205 TCL_SUBST              =
207 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
208 # sources only. Doxygen will then generate output that is more tailored for C.
209 # For instance, some of the names that are used will be different. The list
210 # of all members will be omitted, etc.
212 OPTIMIZE_OUTPUT_FOR_C  = YES
214 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
215 # sources only. Doxygen will then generate output that is more tailored for
216 # Java. For instance, namespaces will be presented as packages, qualified
217 # scopes will look different, etc.
219 OPTIMIZE_OUTPUT_JAVA   = NO
221 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
222 # sources only. Doxygen will then generate output that is more tailored for
223 # Fortran.
225 OPTIMIZE_FOR_FORTRAN   = NO
227 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
228 # sources. Doxygen will then generate output that is tailored for
229 # VHDL.
231 OPTIMIZE_OUTPUT_VHDL   = NO
233 # Doxygen selects the parser to use depending on the extension of the files it
234 # parses. With this tag you can assign which parser to use for a given extension.
235 # Doxygen has a built-in mapping, but you can override or extend it using this
236 # tag. The format is ext=language, where ext is a file extension, and language
237 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
238 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
239 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
240 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
241 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
243 EXTENSION_MAPPING      =
245 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
246 # to include (a tag file for) the STL sources as input, then you should
247 # set this tag to YES in order to let doxygen match functions declarations and
248 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
249 # func(std::string) {}). This also makes the inheritance and collaboration
250 # diagrams that involve STL classes more complete and accurate.
252 BUILTIN_STL_SUPPORT    = NO
254 # If you use Microsoft's C++/CLI language, you should set this option to YES to
255 # enable parsing support.
257 CPP_CLI_SUPPORT        = NO
259 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
260 # Doxygen will parse them like normal C++ but will assume all classes use public
261 # instead of private inheritance when no explicit protection keyword is present.
263 SIP_SUPPORT            = NO
265 # For Microsoft's IDL there are propget and propput attributes to indicate getter
266 # and setter methods for a property. Setting this option to YES (the default)
267 # will make doxygen replace the get and set methods by a property in the
268 # documentation. This will only work if the methods are indeed getting or
269 # setting a simple type. If this is not the case, or you want to show the
270 # methods anyway, you should set this option to NO.
272 IDL_PROPERTY_SUPPORT   = YES
274 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
275 # tag is set to YES, then doxygen will reuse the documentation of the first
276 # member in the group (if any) for the other members of the group. By default
277 # all members of a group must be documented explicitly.
279 DISTRIBUTE_GROUP_DOC   = NO
281 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
282 # the same type (for instance a group of public functions) to be put as a
283 # subgroup of that type (e.g. under the Public Functions section). Set it to
284 # NO to prevent subgrouping. Alternatively, this can be done per class using
285 # the \nosubgrouping command.
287 SUBGROUPING            = YES
289 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
290 # unions are shown inside the group in which they are included (e.g. using
291 # @ingroup) instead of on a separate page (for HTML and Man pages) or
292 # section (for LaTeX and RTF).
294 INLINE_GROUPED_CLASSES = NO
296 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
297 # unions with only public data fields will be shown inline in the documentation
298 # of the scope in which they are defined (i.e. file, namespace, or group
299 # documentation), provided this scope is documented. If set to NO (the default),
300 # structs, classes, and unions are shown on a separate page (for HTML and Man
301 # pages) or section (for LaTeX and RTF).
303 INLINE_SIMPLE_STRUCTS  = NO
305 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
306 # is documented as struct, union, or enum with the name of the typedef. So
307 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
308 # with name TypeT. When disabled the typedef will appear as a member of a file,
309 # namespace, or class. And the struct will be named TypeS. This can typically
310 # be useful for C code in case the coding convention dictates that all compound
311 # types are typedef'ed and only the typedef is referenced, never the tag name.
313 TYPEDEF_HIDES_STRUCT   = NO
315 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
316 # determine which symbols to keep in memory and which to flush to disk.
317 # When the cache is full, less often used symbols will be written to disk.
318 # For small to medium size projects (<1000 input files) the default value is
319 # probably good enough. For larger projects a too small cache size can cause
320 # doxygen to be busy swapping symbols to and from disk most of the time
321 # causing a significant performance penalty.
322 # If the system has enough physical memory increasing the cache will improve the
323 # performance by keeping more symbols in memory. Note that the value works on
324 # a logarithmic scale so increasing the size by one will roughly double the
325 # memory usage. The cache size is given by this formula:
326 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
327 # corresponding to a cache size of 2^16 = 65536 symbols.
329 SYMBOL_CACHE_SIZE      = 0
331 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
332 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
333 # their name and scope. Since this can be an expensive process and often the
334 # same symbol appear multiple times in the code, doxygen keeps a cache of
335 # pre-resolved symbols. If the cache is too small doxygen will become slower.
336 # If the cache is too large, memory is wasted. The cache size is given by this
337 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
338 # corresponding to a cache size of 2^16 = 65536 symbols.
340 LOOKUP_CACHE_SIZE      = 0
342 #---------------------------------------------------------------------------
343 # Build related configuration options
344 #---------------------------------------------------------------------------
346 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
347 # documentation are documented, even if no documentation was available.
348 # Private class members and static file members will be hidden unless
349 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
351 EXTRACT_ALL            = YES
353 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
354 # will be included in the documentation.
356 EXTRACT_PRIVATE        = YES
358 # If the EXTRACT_STATIC tag is set to YES all static members of a file
359 # will be included in the documentation.
361 EXTRACT_STATIC         = YES
363 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
364 # defined locally in source files will be included in the documentation.
365 # If set to NO only classes defined in header files are included.
367 EXTRACT_LOCAL_CLASSES  = YES
369 # This flag is only useful for Objective-C code. When set to YES local
370 # methods, which are defined in the implementation section but not in
371 # the interface are included in the documentation.
372 # If set to NO (the default) only methods in the interface are included.
374 EXTRACT_LOCAL_METHODS  = NO
376 # If this flag is set to YES, the members of anonymous namespaces will be
377 # extracted and appear in the documentation as a namespace called
378 # 'anonymous_namespace{file}', where file will be replaced with the base
379 # name of the file that contains the anonymous namespace. By default
380 # anonymous namespaces are hidden.
382 EXTRACT_ANON_NSPACES   = NO
384 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
385 # undocumented members of documented classes, files or namespaces.
386 # If set to NO (the default) these members will be included in the
387 # various overviews, but no documentation section is generated.
388 # This option has no effect if EXTRACT_ALL is enabled.
390 HIDE_UNDOC_MEMBERS     = NO
392 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
393 # undocumented classes that are normally visible in the class hierarchy.
394 # If set to NO (the default) these classes will be included in the various
395 # overviews. This option has no effect if EXTRACT_ALL is enabled.
397 HIDE_UNDOC_CLASSES     = NO
399 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
400 # friend (class|struct|union) declarations.
401 # If set to NO (the default) these declarations will be included in the
402 # documentation.
404 HIDE_FRIEND_COMPOUNDS  = NO
406 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
407 # documentation blocks found inside the body of a function.
408 # If set to NO (the default) these blocks will be appended to the
409 # function's detailed documentation block.
411 HIDE_IN_BODY_DOCS      = NO
413 # The INTERNAL_DOCS tag determines if documentation
414 # that is typed after a \internal command is included. If the tag is set
415 # to NO (the default) then the documentation will be excluded.
416 # Set it to YES to include the internal documentation.
418 INTERNAL_DOCS          = NO
420 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
421 # file names in lower-case letters. If set to YES upper-case letters are also
422 # allowed. This is useful if you have classes or files whose names only differ
423 # in case and if your file system supports case sensitive file names. Windows
424 # and Mac users are advised to set this option to NO.
426 CASE_SENSE_NAMES       = NO
428 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
429 # will show members with their full class and namespace scopes in the
430 # documentation. If set to YES the scope will be hidden.
432 HIDE_SCOPE_NAMES       = NO
434 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
435 # will put a list of the files that are included by a file in the documentation
436 # of that file.
438 SHOW_INCLUDE_FILES     = YES
440 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
441 # will list include files with double quotes in the documentation
442 # rather than with sharp brackets.
444 FORCE_LOCAL_INCLUDES   = NO
446 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
447 # is inserted in the documentation for inline members.
449 INLINE_INFO            = YES
451 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
452 # will sort the (detailed) documentation of file and class members
453 # alphabetically by member name. If set to NO the members will appear in
454 # declaration order.
456 SORT_MEMBER_DOCS       = YES
458 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
459 # brief documentation of file, namespace and class members alphabetically
460 # by member name. If set to NO (the default) the members will appear in
461 # declaration order.
463 SORT_BRIEF_DOCS        = NO
465 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
466 # will sort the (brief and detailed) documentation of class members so that
467 # constructors and destructors are listed first. If set to NO (the default)
468 # the constructors will appear in the respective orders defined by
469 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
470 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
471 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
473 SORT_MEMBERS_CTORS_1ST = NO
475 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
476 # hierarchy of group names into alphabetical order. If set to NO (the default)
477 # the group names will appear in their defined order.
479 SORT_GROUP_NAMES       = NO
481 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
482 # sorted by fully-qualified names, including namespaces. If set to
483 # NO (the default), the class list will be sorted only by class name,
484 # not including the namespace part.
485 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
486 # Note: This option applies only to the class list, not to the
487 # alphabetical list.
489 SORT_BY_SCOPE_NAME     = NO
491 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
492 # do proper type resolution of all parameters of a function it will reject a
493 # match between the prototype and the implementation of a member function even
494 # if there is only one candidate or it is obvious which candidate to choose
495 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
496 # will still accept a match between prototype and implementation in such cases.
498 STRICT_PROTO_MATCHING  = NO
500 # The GENERATE_TODOLIST tag can be used to enable (YES) or
501 # disable (NO) the todo list. This list is created by putting \todo
502 # commands in the documentation.
504 GENERATE_TODOLIST      = YES
506 # The GENERATE_TESTLIST tag can be used to enable (YES) or
507 # disable (NO) the test list. This list is created by putting \test
508 # commands in the documentation.
510 GENERATE_TESTLIST      = YES
512 # The GENERATE_BUGLIST tag can be used to enable (YES) or
513 # disable (NO) the bug list. This list is created by putting \bug
514 # commands in the documentation.
516 GENERATE_BUGLIST       = YES
518 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
519 # disable (NO) the deprecated list. This list is created by putting
520 # \deprecated commands in the documentation.
522 GENERATE_DEPRECATEDLIST= YES
524 # The ENABLED_SECTIONS tag can be used to enable conditional
525 # documentation sections, marked by \if sectionname ... \endif.
527 ENABLED_SECTIONS       =
529 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
530 # the initial value of a variable or macro consists of for it to appear in
531 # the documentation. If the initializer consists of more lines than specified
532 # here it will be hidden. Use a value of 0 to hide initializers completely.
533 # The appearance of the initializer of individual variables and macros in the
534 # documentation can be controlled using \showinitializer or \hideinitializer
535 # command in the documentation regardless of this setting.
537 MAX_INITIALIZER_LINES  = 30
539 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
540 # at the bottom of the documentation of classes and structs. If set to YES the
541 # list will mention the files that were used to generate the documentation.
543 SHOW_USED_FILES        = YES
545 # If the sources in your project are distributed over multiple directories
546 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
547 # in the documentation. The default is NO.
549 SHOW_DIRECTORIES       = NO
551 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
552 # This will remove the Files entry from the Quick Index and from the
553 # Folder Tree View (if specified). The default is YES.
555 SHOW_FILES             = YES
557 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
558 # Namespaces page.
559 # This will remove the Namespaces entry from the Quick Index
560 # and from the Folder Tree View (if specified). The default is YES.
562 SHOW_NAMESPACES        = YES
564 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
565 # doxygen should invoke to get the current version for each file (typically from
566 # the version control system). Doxygen will invoke the program by executing (via
567 # popen()) the command <command> <input-file>, where <command> is the value of
568 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
569 # provided by doxygen. Whatever the program writes to standard output
570 # is used as the file version. See the manual for examples.
572 FILE_VERSION_FILTER    =
574 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
575 # by doxygen. The layout file controls the global structure of the generated
576 # output files in an output format independent way. The create the layout file
577 # that represents doxygen's defaults, run doxygen with the -l option.
578 # You can optionally specify a file name after the option, if omitted
579 # DoxygenLayout.xml will be used as the name of the layout file.
581 LAYOUT_FILE            =
583 # The CITE_BIB_FILES tag can be used to specify one or more bib files
584 # containing the references data. This must be a list of .bib files. The
585 # .bib extension is automatically appended if omitted. Using this command
586 # requires the bibtex tool to be installed. See also
587 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
588 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
589 # feature you need bibtex and perl available in the search path.
591 CITE_BIB_FILES         =
593 #---------------------------------------------------------------------------
594 # configuration options related to warning and progress messages
595 #---------------------------------------------------------------------------
597 # The QUIET tag can be used to turn on/off the messages that are generated
598 # by doxygen. Possible values are YES and NO. If left blank NO is used.
600 QUIET                  = YES
602 # The WARNINGS tag can be used to turn on/off the warning messages that are
603 # generated by doxygen. Possible values are YES and NO. If left blank
604 # NO is used.
606 WARNINGS               = YES
608 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
609 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
610 # automatically be disabled.
612 WARN_IF_UNDOCUMENTED   = YES
614 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
615 # potential errors in the documentation, such as not documenting some
616 # parameters in a documented function, or documenting parameters that
617 # don't exist or using markup commands wrongly.
619 WARN_IF_DOC_ERROR      = YES
621 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
622 # functions that are documented, but have no documentation for their parameters
623 # or return value. If set to NO (the default) doxygen will only warn about
624 # wrong or incomplete parameter documentation, but not about the absence of
625 # documentation.
627 WARN_NO_PARAMDOC       = NO
629 # The WARN_FORMAT tag determines the format of the warning messages that
630 # doxygen can produce. The string should contain the $file, $line, and $text
631 # tags, which will be replaced by the file and line number from which the
632 # warning originated and the warning text. Optionally the format may contain
633 # $version, which will be replaced by the version of the file (if it could
634 # be obtained via FILE_VERSION_FILTER)
636 WARN_FORMAT            = "$file:$line: $text"
638 # The WARN_LOGFILE tag can be used to specify a file to which warning
639 # and error messages should be written. If left blank the output is written
640 # to stderr.
642 WARN_LOGFILE           =
644 #---------------------------------------------------------------------------
645 # configuration options related to the input files
646 #---------------------------------------------------------------------------
648 # The INPUT tag can be used to specify the files and/or directories that contain
649 # documented source files. You may enter file names like "myfile.cpp" or
650 # directories like "/usr/src/myproject". Separate the files or directories
651 # with spaces.
653 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/include \
654                          @CMAKE_CURRENT_SOURCE_DIR@/include/gpiv
656 # This tag can be used to specify the character encoding of the source files
657 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
658 # also the default input encoding. Doxygen uses libiconv (or the iconv built
659 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
660 # the list of possible encodings.
662 INPUT_ENCODING         = UTF-8
664 # If the value of the INPUT tag contains directories, you can use the
665 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
666 # and *.h) to filter out the source-files in the directories. If left
667 # blank the following patterns are tested:
668 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
669 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
670 # *.f90 *.f *.for *.vhd *.vhdl
672 FILE_PATTERNS          = *.cc \
673                          *.hh \
674                          *.h
676 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
677 # should be searched for input files as well. Possible values are YES and NO.
678 # If left blank NO is used.
680 RECURSIVE              = YES
682 # The EXCLUDE tag can be used to specify files and/or directories that should be
683 # excluded from the INPUT source files. This way you can easily exclude a
684 # subdirectory from a directory tree whose root is specified with the INPUT tag.
685 # Note that relative paths are relative to the directory from which doxygen is
686 # run.
688 EXCLUDE                =
690 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
691 # directories that are symbolic links (a Unix file system feature) are excluded
692 # from the input.
694 EXCLUDE_SYMLINKS       = NO
696 # If the value of the INPUT tag contains directories, you can use the
697 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
698 # certain files from those directories. Note that the wildcards are matched
699 # against the file with absolute path, so to exclude all test directories
700 # for example use the pattern */test/*
702 EXCLUDE_PATTERNS       =
704 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
705 # (namespaces, classes, functions, etc.) that should be excluded from the
706 # output. The symbol name can be a fully qualified name, a word, or if the
707 # wildcard * is used, a substring. Examples: ANamespace, AClass,
708 # AClass::ANamespace, ANamespace::*Test
710 EXCLUDE_SYMBOLS        =
712 # The EXAMPLE_PATH tag can be used to specify one or more files or
713 # directories that contain example code fragments that are included (see
714 # the \include command).
716 EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@
718 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
719 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
720 # and *.h) to filter out the source-files in the directories. If left
721 # blank all files are included.
723 EXAMPLE_PATTERNS       =
725 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
726 # searched for input files to be used with the \include or \dontinclude
727 # commands irrespective of the value of the RECURSIVE tag.
728 # Possible values are YES and NO. If left blank NO is used.
730 EXAMPLE_RECURSIVE      = NO
732 # The IMAGE_PATH tag can be used to specify one or more files or
733 # directories that contain image that are included in the documentation (see
734 # the \image command).
736 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/
738 # The INPUT_FILTER tag can be used to specify a program that doxygen should
739 # invoke to filter for each input file. Doxygen will invoke the filter program
740 # by executing (via popen()) the command <filter> <input-file>, where <filter>
741 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
742 # input file. Doxygen will then use the output that the filter program writes
743 # to standard output.
744 # If FILTER_PATTERNS is specified, this tag will be
745 # ignored.
747 INPUT_FILTER           =
749 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
750 # basis.
751 # Doxygen will compare the file name with each pattern and apply the
752 # filter if there is a match.
753 # The filters are a list of the form:
754 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
755 # info on how filters are used. If FILTER_PATTERNS is empty or if
756 # non of the patterns match the file name, INPUT_FILTER is applied.
758 FILTER_PATTERNS        =
760 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
761 # INPUT_FILTER) will be used to filter the input files when producing source
762 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
764 FILTER_SOURCE_FILES    = NO
766 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
767 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
768 # and it is also possible to disable source filtering for a specific pattern
769 # using *.ext= (so without naming a filter). This option only has effect when
770 # FILTER_SOURCE_FILES is enabled.
772 FILTER_SOURCE_PATTERNS =
774 #---------------------------------------------------------------------------
775 # configuration options related to source browsing
776 #---------------------------------------------------------------------------
778 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
779 # be generated. Documented entities will be cross-referenced with these sources.
780 # Note: To get rid of all source code in the generated output, make sure also
781 # VERBATIM_HEADERS is set to NO.
783 SOURCE_BROWSER         = YES
785 # Setting the INLINE_SOURCES tag to YES will include the body
786 # of functions and classes directly in the documentation.
788 INLINE_SOURCES         = NO
790 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
791 # doxygen to hide any special comment blocks from generated source code
792 # fragments. Normal C and C++ comments will always remain visible.
794 STRIP_CODE_COMMENTS    = YES
796 # If the REFERENCED_BY_RELATION tag is set to YES
797 # then for each documented function all documented
798 # functions referencing it will be listed.
800 REFERENCED_BY_RELATION = YES
802 # If the REFERENCES_RELATION tag is set to YES
803 # then for each documented function all documented entities
804 # called/used by that function will be listed.
806 REFERENCES_RELATION    = YES
808 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
809 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
810 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
811 # link to the source code.
812 # Otherwise they will link to the documentation.
814 REFERENCES_LINK_SOURCE = YES
816 # If the USE_HTAGS tag is set to YES then the references to source code
817 # will point to the HTML generated by the htags(1) tool instead of doxygen
818 # built-in source browser. The htags tool is part of GNU's global source
819 # tagging system (see http://www.gnu.org/software/global/global.html). You
820 # will need version 4.8.6 or higher.
822 USE_HTAGS              = NO
824 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
825 # will generate a verbatim copy of the header file for each class for
826 # which an include is specified. Set to NO to disable this.
828 VERBATIM_HEADERS       = YES
830 #---------------------------------------------------------------------------
831 # configuration options related to the alphabetical class index
832 #---------------------------------------------------------------------------
834 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
835 # of all compounds will be generated. Enable this if the project
836 # contains a lot of classes, structs, unions or interfaces.
838 ALPHABETICAL_INDEX     = NO
840 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
841 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
842 # in which this list will be split (can be a number in the range [1..20])
844 COLS_IN_ALPHA_INDEX    = 5
846 # In case all classes in a project start with a common prefix, all
847 # classes will be put under the same header in the alphabetical index.
848 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
849 # should be ignored while generating the index headers.
851 IGNORE_PREFIX          =
853 #---------------------------------------------------------------------------
854 # configuration options related to the HTML output
855 #---------------------------------------------------------------------------
857 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
858 # generate HTML output.
860 GENERATE_HTML          = @CMAKE_DOXYGEN_GENERATE_HTML@
862 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
863 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
864 # put in front of it. If left blank `html' will be used as the default path.
866 HTML_OUTPUT            = @CMAKE_BINARY_DIR@/html
868 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
869 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
870 # doxygen will generate files with .html extension.
872 HTML_FILE_EXTENSION    = .html
874 # The HTML_HEADER tag can be used to specify a personal HTML header for
875 # each generated HTML page. If it is left blank doxygen will generate a
876 # standard header. Note that when using a custom header you are responsible
877 #  for the proper inclusion of any scripts and style sheets that doxygen
878 # needs, which is dependent on the configuration options used.
879 # It is advised to generate a default header using "doxygen -w html
880 # header.html footer.html stylesheet.css YourConfigFile" and then modify
881 # that header. Note that the header is subject to change so you typically
882 # have to redo this when upgrading to a newer version of doxygen or when
883 # changing the value of configuration settings such as GENERATE_TREEVIEW!
885 HTML_HEADER            = doxygen_header.html
887 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
888 # each generated HTML page. If it is left blank doxygen will generate a
889 # standard footer.
891 HTML_FOOTER            = doxygen_footer.html
893 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
894 # style sheet that is used by each HTML page. It can be used to
895 # fine-tune the look of the HTML output. If the tag is left blank doxygen
896 # will generate a default style sheet. Note that doxygen will try to copy
897 # the style sheet file to the HTML output directory, so don't put your own
898 # style sheet in the HTML output directory as well, or it will be erased!
900 HTML_STYLESHEET        = doxygen_stylesheet.css
902 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
903 # other source files which should be copied to the HTML output directory. Note
904 # that these files will be copied to the base HTML output directory. Use the
905 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
906 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
907 # the files will be copied as-is; there are no commands or markers available.
909 HTML_EXTRA_FILES       =
911 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
912 # Doxygen will adjust the colors in the style sheet and background images
913 # according to this color. Hue is specified as an angle on a colorwheel,
914 # see http://en.wikipedia.org/wiki/Hue for more information.
915 # For instance the value 0 represents red, 60 is yellow, 120 is green,
916 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
917 # The allowed range is 0 to 359.
919 HTML_COLORSTYLE_HUE    = 220
921 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
922 # the colors in the HTML output. For a value of 0 the output will use
923 # grayscales only. A value of 255 will produce the most vivid colors.
925 HTML_COLORSTYLE_SAT    = 100
927 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
928 # the luminance component of the colors in the HTML output. Values below
929 # 100 gradually make the output lighter, whereas values above 100 make
930 # the output darker. The value divided by 100 is the actual gamma applied,
931 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
932 # and 100 does not change the gamma.
934 HTML_COLORSTYLE_GAMMA  = 80
936 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
937 # page will contain the date and time when the page was generated. Setting
938 # this to NO can help when comparing the output of multiple runs.
940 HTML_TIMESTAMP         = YES
942 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
943 # files or namespaces will be aligned in HTML using tables. If set to
944 # NO a bullet list will be used.
946 HTML_ALIGN_MEMBERS     = YES
948 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
949 # documentation will contain sections that can be hidden and shown after the
950 # page has loaded. For this to work a browser that supports
951 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
952 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
954 HTML_DYNAMIC_SECTIONS  = NO
956 # If the GENERATE_DOCSET tag is set to YES, additional index files
957 # will be generated that can be used as input for Apple's Xcode 3
958 # integrated development environment, introduced with OSX 10.5 (Leopard).
959 # To create a documentation set, doxygen will generate a Makefile in the
960 # HTML output directory. Running make will produce the docset in that
961 # directory and running "make install" will install the docset in
962 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
963 # it at startup.
964 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
965 # for more information.
967 GENERATE_DOCSET        = NO
969 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
970 # feed. A documentation feed provides an umbrella under which multiple
971 # documentation sets from a single provider (such as a company or product suite)
972 # can be grouped.
974 DOCSET_FEEDNAME        = "Doxygen generated docs"
976 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
977 # should uniquely identify the documentation set bundle. This should be a
978 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
979 # will append .docset to the name.
981 DOCSET_BUNDLE_ID       = org.doxygen.Project
983 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
984 # the documentation publisher. This should be a reverse domain-name style
985 # string, e.g. com.mycompany.MyDocSet.documentation.
987 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
989 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
991 DOCSET_PUBLISHER_NAME  = Publisher
993 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
994 # will be generated that can be used as input for tools like the
995 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
996 # of the generated HTML documentation.
998 GENERATE_HTMLHELP      = NO
1000 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1001 # be used to specify the file name of the resulting .chm file. You
1002 # can add a path in front of the file if the result should not be
1003 # written to the html output directory.
1005 CHM_FILE               = ../$(PROJECT).chm
1007 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1008 # be used to specify the location (absolute path including file name) of
1009 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1010 # the HTML help compiler on the generated index.hhp.
1012 HHC_LOCATION           = $(HHC_PATH)
1014 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1015 # controls if a separate .chi index file is generated (YES) or that
1016 # it should be included in the master .chm file (NO).
1018 GENERATE_CHI           = NO
1020 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1021 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1022 # content.
1024 CHM_INDEX_ENCODING     =
1026 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1027 # controls whether a binary table of contents is generated (YES) or a
1028 # normal table of contents (NO) in the .chm file.
1030 BINARY_TOC             = NO
1032 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1033 # to the contents of the HTML help documentation and to the tree view.
1035 TOC_EXPAND             = NO
1037 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1038 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1039 # that can be used as input for Qt's qhelpgenerator to generate a
1040 # Qt Compressed Help (.qch) of the generated HTML documentation.
1042 GENERATE_QHP           = NO
1044 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1045 # be used to specify the file name of the resulting .qch file.
1046 # The path specified is relative to the HTML output folder.
1048 QCH_FILE               =
1050 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1051 # Qt Help Project output. For more information please see
1052 # http://doc.trolltech.com/qthelpproject.html#namespace
1054 QHP_NAMESPACE          = org.doxygen.Project
1056 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1057 # Qt Help Project output. For more information please see
1058 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1060 QHP_VIRTUAL_FOLDER     = doc
1062 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1063 # add. For more information please see
1064 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1066 QHP_CUST_FILTER_NAME   =
1068 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1069 # custom filter to add. For more information please see
1070 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1071 # Qt Help Project / Custom Filters</a>.
1073 QHP_CUST_FILTER_ATTRS  =
1075 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1076 # project's
1077 # filter section matches.
1078 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1079 # Qt Help Project / Filter Attributes</a>.
1081 QHP_SECT_FILTER_ATTRS  =
1083 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1084 # be used to specify the location of Qt's qhelpgenerator.
1085 # If non-empty doxygen will try to run qhelpgenerator on the generated
1086 # .qhp file.
1088 QHG_LOCATION           =
1090 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1091 #  will be generated, which together with the HTML files, form an Eclipse help
1092 # plugin. To install this plugin and make it available under the help contents
1093 # menu in Eclipse, the contents of the directory containing the HTML and XML
1094 # files needs to be copied into the plugins directory of eclipse. The name of
1095 # the directory within the plugins directory should be the same as
1096 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1097 # the help appears.
1099 GENERATE_ECLIPSEHELP   = NO
1101 # A unique identifier for the eclipse help plugin. When installing the plugin
1102 # the directory name containing the HTML and XML files should also have
1103 # this name.
1105 ECLIPSE_DOC_ID         = org.doxygen.Project
1107 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1108 # at top of each HTML page. The value NO (the default) enables the index and
1109 # the value YES disables it. Since the tabs have the same information as the
1110 # navigation tree you can set this option to NO if you already set
1111 # GENERATE_TREEVIEW to YES.
1113 DISABLE_INDEX          = NO
1115 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1116 # structure should be generated to display hierarchical information.
1117 # If the tag value is set to YES, a side panel will be generated
1118 # containing a tree-like index structure (just like the one that
1119 # is generated for HTML Help). For this to work a browser that supports
1120 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1121 # Windows users are probably better off using the HTML help feature.
1122 # Since the tree basically has the same information as the tab index you
1123 # could consider to set DISABLE_INDEX to NO when enabling this option.
1125 GENERATE_TREEVIEW      = ALL
1127 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1128 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1129 # documentation. Note that a value of 0 will completely suppress the enum
1130 # values from appearing in the overview section.
1132 ENUM_VALUES_PER_LINE   = 4
1134 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1135 # and Class Hierarchy pages using a tree view instead of an ordered list.
1137 USE_INLINE_TREES       = NO
1139 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1140 # used to set the initial width (in pixels) of the frame in which the tree
1141 # is shown.
1143 TREEVIEW_WIDTH         = 250
1145 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1146 # links to external symbols imported via tag files in a separate window.
1148 EXT_LINKS_IN_WINDOW    = NO
1150 # Use this tag to change the font size of Latex formulas included
1151 # as images in the HTML documentation. The default is 10. Note that
1152 # when you change the font size after a successful doxygen run you need
1153 # to manually remove any form_*.png images from the HTML output directory
1154 # to force them to be regenerated.
1156 FORMULA_FONTSIZE       = 10
1158 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1159 # generated for formulas are transparent PNGs. Transparent PNGs are
1160 # not supported properly for IE 6.0, but are supported on all modern browsers.
1161 # Note that when changing this option you need to delete any form_*.png files
1162 # in the HTML output before the changes have effect.
1164 FORMULA_TRANSPARENT    = YES
1166 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1167 # (see http://www.mathjax.org) which uses client side Javascript for the
1168 # rendering instead of using prerendered bitmaps. Use this if you do not
1169 # have LaTeX installed or if you want to formulas look prettier in the HTML
1170 # output. When enabled you also need to install MathJax separately and
1171 # configure the path to it using the MATHJAX_RELPATH option.
1173 USE_MATHJAX            = NO
1175 # When MathJax is enabled you need to specify the location relative to the
1176 # HTML output directory using the MATHJAX_RELPATH option. The destination
1177 # directory should contain the MathJax.js script. For instance, if the mathjax
1178 # directory is located at the same level as the HTML output directory, then
1179 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1180 # mathjax.org site, so you can quickly see the result without installing
1181 # MathJax, but it is strongly recommended to install a local copy of MathJax
1182 # before deployment.
1184 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1186 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1187 # names that should be enabled during MathJax rendering.
1189 MATHJAX_EXTENSIONS     =
1191 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1192 # for the HTML output. The underlying search engine uses javascript
1193 # and DHTML and should work on any modern browser. Note that when using
1194 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1195 # (GENERATE_DOCSET) there is already a search function so this one should
1196 # typically be disabled. For large projects the javascript based search engine
1197 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1199 SEARCHENGINE           = NO
1201 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1202 # implemented using a PHP enabled web server instead of at the web client
1203 # using Javascript. Doxygen will generate the search PHP script and index
1204 # file to put on the web server. The advantage of the server
1205 # based approach is that it scales better to large projects and allows
1206 # full text search. The disadvantages are that it is more difficult to setup
1207 # and does not have live searching capabilities.
1209 SERVER_BASED_SEARCH    = NO
1211 #---------------------------------------------------------------------------
1212 # configuration options related to the LaTeX output
1213 #---------------------------------------------------------------------------
1215 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1216 # generate Latex output.
1218 GENERATE_LATEX         = NO
1220 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1221 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1222 # put in front of it. If left blank `latex' will be used as the default path.
1224 LATEX_OUTPUT           = latex
1226 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1227 # invoked. If left blank `latex' will be used as the default command name.
1228 # Note that when enabling USE_PDFLATEX this option is only used for
1229 # generating bitmaps for formulas in the HTML output, but not in the
1230 # Makefile that is written to the output directory.
1232 LATEX_CMD_NAME         = latex
1234 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1235 # generate index for LaTeX. If left blank `makeindex' will be used as the
1236 # default command name.
1238 MAKEINDEX_CMD_NAME     = makeindex
1240 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1241 # LaTeX documents. This may be useful for small projects and may help to
1242 # save some trees in general.
1244 COMPACT_LATEX          = NO
1246 # The PAPER_TYPE tag can be used to set the paper type that is used
1247 # by the printer. Possible values are: a4, letter, legal and
1248 # executive. If left blank a4wide will be used.
1250 PAPER_TYPE             = $(PAPER_SIZE)
1252 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1253 # packages that should be included in the LaTeX output.
1255 EXTRA_PACKAGES         =
1257 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1258 # the generated latex document. The header should contain everything until
1259 # the first chapter. If it is left blank doxygen will generate a
1260 # standard header. Notice: only use this tag if you know what you are doing!
1262 LATEX_HEADER           =
1264 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1265 # the generated latex document. The footer should contain everything after
1266 # the last chapter. If it is left blank doxygen will generate a
1267 # standard footer. Notice: only use this tag if you know what you are doing!
1269 LATEX_FOOTER           =
1271 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1272 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1273 # contain links (just like the HTML output) instead of page references
1274 # This makes the output suitable for online browsing using a pdf viewer.
1276 PDF_HYPERLINKS         = NO
1278 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1279 # plain latex in the generated Makefile. Set this option to YES to get a
1280 # higher quality PDF documentation.
1282 USE_PDFLATEX           = NO
1284 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1285 # command to the generated LaTeX files. This will instruct LaTeX to keep
1286 # running if errors occur, instead of asking the user for help.
1287 # This option is also used when generating formulas in HTML.
1289 LATEX_BATCHMODE        = YES
1291 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1292 # include the index chapters (such as File Index, Compound Index, etc.)
1293 # in the output.
1295 LATEX_HIDE_INDICES     = NO
1297 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1298 # source code with syntax highlighting in the LaTeX output.
1299 # Note that which sources are shown also depends on other settings
1300 # such as SOURCE_BROWSER.
1302 LATEX_SOURCE_CODE      = NO
1304 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1305 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1306 # http://en.wikipedia.org/wiki/BibTeX for more info.
1308 LATEX_BIB_STYLE        = plain
1310 #---------------------------------------------------------------------------
1311 # configuration options related to the RTF output
1312 #---------------------------------------------------------------------------
1314 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1315 # The RTF output is optimized for Word 97 and may not look very pretty with
1316 # other RTF readers or editors.
1318 GENERATE_RTF           = NO
1320 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1321 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1322 # put in front of it. If left blank `rtf' will be used as the default path.
1324 RTF_OUTPUT             = rtf
1326 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1327 # RTF documents. This may be useful for small projects and may help to
1328 # save some trees in general.
1330 COMPACT_RTF            = NO
1332 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1333 # will contain hyperlink fields. The RTF file will
1334 # contain links (just like the HTML output) instead of page references.
1335 # This makes the output suitable for online browsing using WORD or other
1336 # programs which support those fields.
1337 # Note: wordpad (write) and others do not support links.
1339 RTF_HYPERLINKS         = NO
1341 # Load style sheet definitions from file. Syntax is similar to doxygen's
1342 # config file, i.e. a series of assignments. You only have to provide
1343 # replacements, missing definitions are set to their default value.
1345 RTF_STYLESHEET_FILE    =
1347 # Set optional variables used in the generation of an rtf document.
1348 # Syntax is similar to doxygen's config file.
1350 RTF_EXTENSIONS_FILE    =
1352 #---------------------------------------------------------------------------
1353 # configuration options related to the man page output
1354 #---------------------------------------------------------------------------
1356 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1357 # generate man pages
1359 GENERATE_MAN           = NO
1361 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1362 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1363 # put in front of it. If left blank `man' will be used as the default path.
1365 MAN_OUTPUT             = man
1367 # The MAN_EXTENSION tag determines the extension that is added to
1368 # the generated man pages (default is the subroutine's section .3)
1370 MAN_EXTENSION          = .1
1372 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1373 # then it will generate one additional man file for each entity
1374 # documented in the real man page(s). These additional files
1375 # only source the real man page, but without them the man command
1376 # would be unable to find the correct page. The default is NO.
1378 MAN_LINKS              = NO
1380 #---------------------------------------------------------------------------
1381 # configuration options related to the XML output
1382 #---------------------------------------------------------------------------
1384 # If the GENERATE_XML tag is set to YES Doxygen will
1385 # generate an XML file that captures the structure of
1386 # the code including all documentation.
1388 GENERATE_XML           = @CMAKE_DOXYGEN_GENERATE_XML@
1390 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1391 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1392 # put in front of it. If left blank `xml' will be used as the default path.
1394 XML_OUTPUT             = xml
1396 # The XML_SCHEMA tag can be used to specify an XML schema,
1397 # which can be used by a validating XML parser to check the
1398 # syntax of the XML files.
1400 XML_SCHEMA             =
1402 # The XML_DTD tag can be used to specify an XML DTD,
1403 # which can be used by a validating XML parser to check the
1404 # syntax of the XML files.
1406 XML_DTD                =
1408 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1409 # dump the program listings (including syntax highlighting
1410 # and cross-referencing information) to the XML output. Note that
1411 # enabling this will significantly increase the size of the XML output.
1413 XML_PROGRAMLISTING     = YES
1415 #---------------------------------------------------------------------------
1416 # configuration options for the AutoGen Definitions output
1417 #---------------------------------------------------------------------------
1419 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1420 # generate an AutoGen Definitions (see autogen.sf.net) file
1421 # that captures the structure of the code including all
1422 # documentation. Note that this feature is still experimental
1423 # and incomplete at the moment.
1425 GENERATE_AUTOGEN_DEF   = NO
1427 #---------------------------------------------------------------------------
1428 # configuration options related to the Perl module output
1429 #---------------------------------------------------------------------------
1431 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1432 # generate a Perl module file that captures the structure of
1433 # the code including all documentation. Note that this
1434 # feature is still experimental and incomplete at the
1435 # moment.
1437 GENERATE_PERLMOD       = NO
1439 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1440 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1441 # to generate PDF and DVI output from the Perl module output.
1443 PERLMOD_LATEX          = NO
1445 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1446 # nicely formatted so it can be parsed by a human reader.
1447 # This is useful
1448 # if you want to understand what is going on.
1449 # On the other hand, if this
1450 # tag is set to NO the size of the Perl module output will be much smaller
1451 # and Perl will parse it just the same.
1453 PERLMOD_PRETTY         = YES
1455 # The names of the make variables in the generated doxyrules.make file
1456 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1457 # This is useful so different doxyrules.make files included by the same
1458 # Makefile don't overwrite each other's variables.
1460 PERLMOD_MAKEVAR_PREFIX =
1462 #---------------------------------------------------------------------------
1463 # Configuration options related to the preprocessor
1464 #---------------------------------------------------------------------------
1466 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1467 # evaluate all C-preprocessor directives found in the sources and include
1468 # files.
1470 ENABLE_PREPROCESSING   = YES
1472 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1473 # names in the source code. If set to NO (the default) only conditional
1474 # compilation will be performed. Macro expansion can be done in a controlled
1475 # way by setting EXPAND_ONLY_PREDEF to YES.
1477 MACRO_EXPANSION        = NO
1479 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1480 # then the macro expansion is limited to the macros specified with the
1481 # PREDEFINED and EXPAND_AS_DEFINED tags.
1483 EXPAND_ONLY_PREDEF     = NO
1485 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1486 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1488 SEARCH_INCLUDES        = YES
1490 # The INCLUDE_PATH tag can be used to specify one or more directories that
1491 # contain include files that are not input files but should be processed by
1492 # the preprocessor.
1494 INCLUDE_PATH           =
1496 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1497 # patterns (like *.h and *.hpp) to filter out the header-files in the
1498 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1499 # be used.
1501 INCLUDE_FILE_PATTERNS  =
1503 # The PREDEFINED tag can be used to specify one or more macro names that
1504 # are defined before the preprocessor is started (similar to the -D option of
1505 # gcc). The argument of the tag is a list of macros of the form: name
1506 # or name=definition (no spaces). If the definition and the = are
1507 # omitted =1 is assumed. To prevent a macro definition from being
1508 # undefined via #undef or recursively expanded use the := operator
1509 # instead of the = operator.
1511 PREDEFINED             =
1513 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1514 # this tag can be used to specify a list of macro names that should be expanded.
1515 # The macro definition that is found in the sources will be used.
1516 # Use the PREDEFINED tag if you want to use a different macro definition that
1517 # overrules the definition found in the source code.
1519 EXPAND_AS_DEFINED      =
1521 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1522 # doxygen's preprocessor will remove all references to function-like macros
1523 # that are alone on a line, have an all uppercase name, and do not end with a
1524 # semicolon, because these will confuse the parser if not removed.
1526 SKIP_FUNCTION_MACROS   = YES
1528 #---------------------------------------------------------------------------
1529 # Configuration::additions related to external references
1530 #---------------------------------------------------------------------------
1532 # The TAGFILES option can be used to specify one or more tagfiles.
1533 # Optionally an initial location of the external documentation
1534 # can be added for each tagfile. The format of a tag file without
1535 # this location is as follows:
1537 # TAGFILES = file1 file2 ...
1538 # Adding location for the tag files is done as follows:
1540 # TAGFILES = file1=loc1 "file2 = loc2" ...
1541 # where "loc1" and "loc2" can be relative or absolute paths or
1542 # URLs. If a location is present for each tag, the installdox tool
1543 # does not have to be run to correct the links.
1544 # Note that each tag file must have a unique name
1545 # (where the name does NOT include the path)
1546 # If a tag file is not located in the directory in which doxygen
1547 # is run, you must also specify the path to the tagfile here.
1549 TAGFILES               =
1551 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1552 # a tag file that is based on the input files it reads.
1554 #GENERATE_TAGFILE       = $(DOCDIR)/$(PROJECT).tag
1555 GENERATE_TAGFILE       = @CMAKE_BINARY_DIR@/@CMAKE_PROJECT_NAME@.tag
1557 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1558 # in the class index. If set to NO only the inherited external classes
1559 # will be listed.
1561 ALLEXTERNALS           = NO
1563 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1564 # in the modules index. If set to NO, only the current project's groups will
1565 # be listed.
1567 EXTERNAL_GROUPS        = YES
1569 # The PERL_PATH should be the absolute path and name of the perl script
1570 # interpreter (i.e. the result of `which perl').
1572 PERL_PATH              = $(PERL_PATH)
1574 #---------------------------------------------------------------------------
1575 # Configuration options related to the dot tool
1576 #---------------------------------------------------------------------------
1578 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1579 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1580 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1581 # this option also works with HAVE_DOT disabled, but it is recommended to
1582 # install and use dot, since it yields more powerful graphs.
1584 CLASS_DIAGRAMS         = NO
1586 # You can define message sequence charts within doxygen comments using the \msc
1587 # command. Doxygen will then run the mscgen tool (see
1588 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1589 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1590 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1591 # default search path.
1593 MSCGEN_PATH            =
1595 # If set to YES, the inheritance and collaboration graphs will hide
1596 # inheritance and usage relations if the target is undocumented
1597 # or is not a class.
1599 HIDE_UNDOC_RELATIONS   = YES
1601 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1602 # available from the path. This tool is part of Graphviz, a graph visualization
1603 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1604 # have no effect if this option is set to NO (the default)
1606 HAVE_DOT               = YES
1608 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1609 # allowed to run in parallel. When set to 0 (the default) doxygen will
1610 # base this on the number of processors available in the system. You can set it
1611 # explicitly to a value larger than 0 to get control over the balance
1612 # between CPU load and processing speed.
1614 DOT_NUM_THREADS        = 0
1616 # By default doxygen will use the Helvetica font for all dot files that
1617 # doxygen generates. When you want a differently looking font you can specify
1618 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1619 # the font, which can be done by putting it in a standard location or by setting
1620 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1621 # directory containing the font.
1623 DOT_FONTNAME           = FreeSans
1625 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1626 # The default size is 10pt.
1628 DOT_FONTSIZE           = 10
1630 # By default doxygen will tell dot to use the Helvetica font.
1631 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1632 # set the path where dot can find it.
1634 DOT_FONTPATH           =
1636 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1637 # will generate a graph for each documented class showing the direct and
1638 # indirect inheritance relations. Setting this tag to YES will force the
1639 # CLASS_DIAGRAMS tag to NO.
1641 CLASS_GRAPH            = YES
1643 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1644 # will generate a graph for each documented class showing the direct and
1645 # indirect implementation dependencies (inheritance, containment, and
1646 # class references variables) of the class with other documented classes.
1648 COLLABORATION_GRAPH    = YES
1650 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1651 # will generate a graph for groups, showing the direct groups dependencies
1653 GROUP_GRAPHS           = YES
1655 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1656 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1657 # Language.
1659 UML_LOOK               = NO
1661 # If set to YES, the inheritance and collaboration graphs will show the
1662 # relations between templates and their instances.
1664 TEMPLATE_RELATIONS     = NO
1666 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1667 # tags are set to YES then doxygen will generate a graph for each documented
1668 # file showing the direct and indirect include dependencies of the file with
1669 # other documented files.
1671 INCLUDE_GRAPH          = YES
1673 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1674 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1675 # documented header file showing the documented files that directly or
1676 # indirectly include this file.
1678 INCLUDED_BY_GRAPH      = YES
1680 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1681 # doxygen will generate a call dependency graph for every global function
1682 # or class method. Note that enabling this option will significantly increase
1683 # the time of a run. So in most cases it will be better to enable call graphs
1684 # for selected functions only using the \callgraph command.
1686 CALL_GRAPH             = NO
1688 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1689 # doxygen will generate a caller dependency graph for every global function
1690 # or class method. Note that enabling this option will significantly increase
1691 # the time of a run. So in most cases it will be better to enable caller
1692 # graphs for selected functions only using the \callergraph command.
1694 CALLER_GRAPH           = NO
1696 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1697 # will generate a graphical hierarchy of all classes instead of a textual one.
1699 GRAPHICAL_HIERARCHY    = YES
1701 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1702 # then doxygen will show the dependencies a directory has on other directories
1703 # in a graphical way. The dependency relations are determined by the #include
1704 # relations between the files in the directories.
1706 DIRECTORY_GRAPH        = YES
1708 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1709 # generated by dot. Possible values are svg, png, jpg, or gif.
1710 # If left blank png will be used. If you choose svg you need to set
1711 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1712 # visible in IE 9+ (other browsers do not have this requirement).
1714 DOT_IMAGE_FORMAT       = png
1716 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1717 # enable generation of interactive SVG images that allow zooming and panning.
1718 # Note that this requires a modern browser other than Internet Explorer.
1719 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1720 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1721 # visible. Older versions of IE do not have SVG support.
1723 INTERACTIVE_SVG        = NO
1725 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1726 # found. If left blank, it is assumed the dot tool can be found in the path.
1728 DOT_PATH               = $(DOT_PATH)
1730 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1731 # contain dot files that are included in the documentation (see the
1732 # \dotfile command).
1734 DOTFILE_DIRS           =
1736 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1737 # contain msc files that are included in the documentation (see the
1738 # \mscfile command).
1740 MSCFILE_DIRS           =
1742 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1743 # nodes that will be shown in the graph. If the number of nodes in a graph
1744 # becomes larger than this value, doxygen will truncate the graph, which is
1745 # visualized by representing a node as a red box. Note that doxygen if the
1746 # number of direct children of the root node in a graph is already larger than
1747 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1748 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1750 DOT_GRAPH_MAX_NODES    = 50
1752 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1753 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1754 # from the root by following a path via at most 3 edges will be shown. Nodes
1755 # that lay further from the root node will be omitted. Note that setting this
1756 # option to 1 or 2 may greatly reduce the computation time needed for large
1757 # code bases. Also note that the size of a graph can be further restricted by
1758 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1760 MAX_DOT_GRAPH_DEPTH    = 0
1762 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1763 # background. This is disabled by default, because dot on Windows does not
1764 # seem to support this out of the box. Warning: Depending on the platform used,
1765 # enabling this option may lead to badly anti-aliased labels on the edges of
1766 # a graph (i.e. they become hard to read).
1768 DOT_TRANSPARENT        = YES
1770 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1771 # files in one run (i.e. multiple -o and -T options on the command line). This
1772 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1773 # support this, this feature is disabled by default.
1775 DOT_MULTI_TARGETS      = NO
1777 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1778 # generate a legend page explaining the meaning of the various boxes and
1779 # arrows in the dot generated graphs.
1781 GENERATE_LEGEND        = YES
1783 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1784 # remove the intermediate dot files that are used to generate
1785 # the various graphs.
1787 DOT_CLEANUP            = YES