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