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