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