524d639e04d937a7fe9360a82985047f5a02b245
[strongswan.git] / Doxyfile.in
1 # Doxyfile 1.5.6
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 hash (#) is considered a comment and will be ignored
7 # The format is:
8 #       TAG = value [value, ...]
9 # For lists items can also be appended using:
10 #       TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
12
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING      = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
27
28 PROJECT_NAME           = "@PACKAGE_NAME@"
29
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
33
34 PROJECT_NUMBER         = "@PACKAGE_VERSION@"
35
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
40
41 OUTPUT_DIRECTORY       = apidoc
42
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
49
50 CREATE_SUBDIRS         = NO
51
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61 # and Ukrainian.
62
63 OUTPUT_LANGUAGE        = English
64
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
69
70 BRIEF_MEMBER_DESC      = YES
71
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
76
77 REPEAT_BRIEF           = YES
78
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
88
89 ABBREVIATE_BRIEF       =
90
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92 # Doxygen will generate a detailed section even if there is only a brief
93 # description.
94
95 ALWAYS_DETAILED_SEC    = NO
96
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98 # inherited members of a class in the documentation of that class as if those
99 # members were ordinary class members. Constructors, destructors and assignment
100 # operators of the base classes will not be shown.
101
102 INLINE_INHERITED_MEMB  = NO
103
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
106 # to NO the shortest path that makes the file name unique will be used.
107
108 FULL_PATH_NAMES        = YES
109
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 # can be used to strip a user-defined part of the path. Stripping is
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
115 # path to strip.
116
117 STRIP_FROM_PATH        =
118
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
124 # are normally passed to the compiler using the -I flag.
125
126 STRIP_FROM_INC_PATH    =
127
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129 # (but less readable) file names. This can be useful is your file systems
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
131
132 SHORT_NAMES            = NO
133
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comment as the brief description. If set to NO, the JavaDoc
137 # comments will behave just like regular Qt-style comments
138 # (thus requiring an explicit @brief command for a brief description.)
139
140 JAVADOC_AUTOBRIEF      = YES
141
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
147
148 QT_AUTOBRIEF           = NO
149
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
154 # description. Set this tag to YES if you prefer the old behaviour instead.
155
156 MULTILINE_CPP_IS_BRIEF = NO
157
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159 # member inherits the documentation from any documented member that it
160 # re-implements.
161
162 INHERIT_DOCS           = YES
163
164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165 # a new page for each member. If set to NO, the documentation of a member will
166 # be part of the file/class/namespace that contains it.
167
168 SEPARATE_MEMBER_PAGES  = NO
169
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
171 # Doxygen uses this value to replace tabs by spaces in code fragments.
172
173 TAB_SIZE               = 4
174
175 # This tag can be used to specify a number of aliases that acts
176 # as commands in the documentation. An alias has the form "name=value".
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
178 # put the command \sideeffect (or @sideeffect) in the documentation, which
179 # will result in a user-defined paragraph with heading "Side Effects:".
180 # You can put \n's in the value part of an alias to insert newlines.
181
182 ALIASES                =
183
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185 # sources only. Doxygen will then generate output that is more tailored for C.
186 # For instance, some of the names that are used will be different. The list
187 # of all members will be omitted, etc.
188
189 OPTIMIZE_OUTPUT_FOR_C  = NO
190
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192 # sources only. Doxygen will then generate output that is more tailored for
193 # Java. For instance, namespaces will be presented as packages, qualified
194 # scopes will look different, etc.
195
196 OPTIMIZE_OUTPUT_JAVA   = NO
197
198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199 # sources only. Doxygen will then generate output that is more tailored for
200 # Fortran.
201
202 OPTIMIZE_FOR_FORTRAN   = NO
203
204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205 # sources. Doxygen will then generate output that is tailored for
206 # VHDL.
207
208 OPTIMIZE_OUTPUT_VHDL   = NO
209
210 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
211 # to include (a tag file for) the STL sources as input, then you should
212 # set this tag to YES in order to let doxygen match functions declarations and
213 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
214 # func(std::string) {}). This also make the inheritance and collaboration
215 # diagrams that involve STL classes more complete and accurate.
216
217 BUILTIN_STL_SUPPORT    = NO
218
219 # If you use Microsoft's C++/CLI language, you should set this option to YES to
220 # enable parsing support.
221
222 CPP_CLI_SUPPORT        = NO
223
224 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
225 # Doxygen will parse them like normal C++ but will assume all classes use public
226 # instead of private inheritance when no explicit protection keyword is present.
227
228 SIP_SUPPORT            = NO
229
230 # For Microsoft's IDL there are propget and propput attributes to indicate getter
231 # and setter methods for a property. Setting this option to YES (the default)
232 # will make doxygen to replace the get and set methods by a property in the
233 # documentation. This will only work if the methods are indeed getting or
234 # setting a simple type. If this is not the case, or you want to show the
235 # methods anyway, you should set this option to NO.
236
237 IDL_PROPERTY_SUPPORT   = YES
238
239 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
240 # tag is set to YES, then doxygen will reuse the documentation of the first
241 # member in the group (if any) for the other members of the group. By default
242 # all members of a group must be documented explicitly.
243
244 DISTRIBUTE_GROUP_DOC   = NO
245
246 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
247 # the same type (for instance a group of public functions) to be put as a
248 # subgroup of that type (e.g. under the Public Functions section). Set it to
249 # NO to prevent subgrouping. Alternatively, this can be done per class using
250 # the \nosubgrouping command.
251
252 SUBGROUPING            = YES
253
254 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
255 # is documented as struct, union, or enum with the name of the typedef. So
256 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
257 # with name TypeT. When disabled the typedef will appear as a member of a file,
258 # namespace, or class. And the struct will be named TypeS. This can typically
259 # be useful for C code in case the coding convention dictates that all compound
260 # types are typedef'ed and only the typedef is referenced, never the tag name.
261
262 TYPEDEF_HIDES_STRUCT   = YES
263
264 #---------------------------------------------------------------------------
265 # Build related configuration options
266 #---------------------------------------------------------------------------
267
268 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
269 # documentation are documented, even if no documentation was available.
270 # Private class members and static file members will be hidden unless
271 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
272
273 EXTRACT_ALL            = NO
274
275 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
276 # will be included in the documentation.
277
278 EXTRACT_PRIVATE        = NO
279
280 # If the EXTRACT_STATIC tag is set to YES all static members of a file
281 # will be included in the documentation.
282
283 EXTRACT_STATIC         = NO
284
285 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
286 # defined locally in source files will be included in the documentation.
287 # If set to NO only classes defined in header files are included.
288
289 EXTRACT_LOCAL_CLASSES  = NO
290
291 # This flag is only useful for Objective-C code. When set to YES local
292 # methods, which are defined in the implementation section but not in
293 # the interface are included in the documentation.
294 # If set to NO (the default) only methods in the interface are included.
295
296 EXTRACT_LOCAL_METHODS  = NO
297
298 # If this flag is set to YES, the members of anonymous namespaces will be
299 # extracted and appear in the documentation as a namespace called
300 # 'anonymous_namespace{file}', where file will be replaced with the base
301 # name of the file that contains the anonymous namespace. By default
302 # anonymous namespace are hidden.
303
304 EXTRACT_ANON_NSPACES   = NO
305
306 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
307 # undocumented members of documented classes, files or namespaces.
308 # If set to NO (the default) these members will be included in the
309 # various overviews, but no documentation section is generated.
310 # This option has no effect if EXTRACT_ALL is enabled.
311
312 HIDE_UNDOC_MEMBERS     = NO
313
314 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
315 # undocumented classes that are normally visible in the class hierarchy.
316 # If set to NO (the default) these classes will be included in the various
317 # overviews. This option has no effect if EXTRACT_ALL is enabled.
318
319 HIDE_UNDOC_CLASSES     = NO
320
321 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
322 # friend (class|struct|union) declarations.
323 # If set to NO (the default) these declarations will be included in the
324 # documentation.
325
326 HIDE_FRIEND_COMPOUNDS  = NO
327
328 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
329 # documentation blocks found inside the body of a function.
330 # If set to NO (the default) these blocks will be appended to the
331 # function's detailed documentation block.
332
333 HIDE_IN_BODY_DOCS      = NO
334
335 # The INTERNAL_DOCS tag determines if documentation
336 # that is typed after a \internal command is included. If the tag is set
337 # to NO (the default) then the documentation will be excluded.
338 # Set it to YES to include the internal documentation.
339
340 INTERNAL_DOCS          = NO
341
342 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
343 # file names in lower-case letters. If set to YES upper-case letters are also
344 # allowed. This is useful if you have classes or files whose names only differ
345 # in case and if your file system supports case sensitive file names. Windows
346 # and Mac users are advised to set this option to NO.
347
348 CASE_SENSE_NAMES       = YES
349
350 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
351 # will show members with their full class and namespace scopes in the
352 # documentation. If set to YES the scope will be hidden.
353
354 HIDE_SCOPE_NAMES       = NO
355
356 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
357 # will put a list of the files that are included by a file in the documentation
358 # of that file.
359
360 SHOW_INCLUDE_FILES     = NO
361
362 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
363 # is inserted in the documentation for inline members.
364
365 INLINE_INFO            = YES
366
367 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
368 # will sort the (detailed) documentation of file and class members
369 # alphabetically by member name. If set to NO the members will appear in
370 # declaration order.
371
372 SORT_MEMBER_DOCS       = NO
373
374 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
375 # brief documentation of file, namespace and class members alphabetically
376 # by member name. If set to NO (the default) the members will appear in
377 # declaration order.
378
379 SORT_BRIEF_DOCS        = NO
380
381 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
382 # hierarchy of group names into alphabetical order. If set to NO (the default)
383 # the group names will appear in their defined order.
384
385 SORT_GROUP_NAMES       = NO
386
387 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
388 # sorted by fully-qualified names, including namespaces. If set to
389 # NO (the default), the class list will be sorted only by class name,
390 # not including the namespace part.
391 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
392 # Note: This option applies only to the class list, not to the
393 # alphabetical list.
394
395 SORT_BY_SCOPE_NAME     = NO
396
397 # The GENERATE_TODOLIST tag can be used to enable (YES) or
398 # disable (NO) the todo list. This list is created by putting \todo
399 # commands in the documentation.
400
401 GENERATE_TODOLIST      = NO
402
403 # The GENERATE_TESTLIST tag can be used to enable (YES) or
404 # disable (NO) the test list. This list is created by putting \test
405 # commands in the documentation.
406
407 GENERATE_TESTLIST      = NO
408
409 # The GENERATE_BUGLIST tag can be used to enable (YES) or
410 # disable (NO) the bug list. This list is created by putting \bug
411 # commands in the documentation.
412
413 GENERATE_BUGLIST       = NO
414
415 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
416 # disable (NO) the deprecated list. This list is created by putting
417 # \deprecated commands in the documentation.
418
419 GENERATE_DEPRECATEDLIST= NO
420
421 # The ENABLED_SECTIONS tag can be used to enable conditional
422 # documentation sections, marked by \if sectionname ... \endif.
423
424 ENABLED_SECTIONS       =
425
426 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
427 # the initial value of a variable or define consists of for it to appear in
428 # the documentation. If the initializer consists of more lines than specified
429 # here it will be hidden. Use a value of 0 to hide initializers completely.
430 # The appearance of the initializer of individual variables and defines in the
431 # documentation can be controlled using \showinitializer or \hideinitializer
432 # command in the documentation regardless of this setting.
433
434 MAX_INITIALIZER_LINES  = 30
435
436 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
437 # at the bottom of the documentation of classes and structs. If set to YES the
438 # list will mention the files that were used to generate the documentation.
439
440 SHOW_USED_FILES        = NO
441
442 # If the sources in your project are distributed over multiple directories
443 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
444 # in the documentation. The default is NO.
445
446 SHOW_DIRECTORIES       = YES
447
448 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
449 # This will remove the Files entry from the Quick Index and from the
450 # Folder Tree View (if specified). The default is YES.
451
452 SHOW_FILES             = NO
453
454 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
455 # Namespaces page.  This will remove the Namespaces entry from the Quick Index
456 # and from the Folder Tree View (if specified). The default is YES.
457
458 SHOW_NAMESPACES        = YES
459
460 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
461 # doxygen should invoke to get the current version for each file (typically from
462 # the version control system). Doxygen will invoke the program by executing (via
463 # popen()) the command <command> <input-file>, where <command> is the value of
464 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
465 # provided by doxygen. Whatever the program writes to standard output
466 # is used as the file version. See the manual for examples.
467
468 FILE_VERSION_FILTER    =
469
470 #---------------------------------------------------------------------------
471 # configuration options related to warning and progress messages
472 #---------------------------------------------------------------------------
473
474 # The QUIET tag can be used to turn on/off the messages that are generated
475 # by doxygen. Possible values are YES and NO. If left blank NO is used.
476
477 QUIET                  = NO
478
479 # The WARNINGS tag can be used to turn on/off the warning messages that are
480 # generated by doxygen. Possible values are YES and NO. If left blank
481 # NO is used.
482
483 WARNINGS               = YES
484
485 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
486 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
487 # automatically be disabled.
488
489 WARN_IF_UNDOCUMENTED   = NO
490
491 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
492 # potential errors in the documentation, such as not documenting some
493 # parameters in a documented function, or documenting parameters that
494 # don't exist or using markup commands wrongly.
495
496 WARN_IF_DOC_ERROR      = YES
497
498 # This WARN_NO_PARAMDOC option can be abled to get warnings for
499 # functions that are documented, but have no documentation for their parameters
500 # or return value. If set to NO (the default) doxygen will only warn about
501 # wrong or incomplete parameter documentation, but not about the absence of
502 # documentation.
503
504 WARN_NO_PARAMDOC       = NO
505
506 # The WARN_FORMAT tag determines the format of the warning messages that
507 # doxygen can produce. The string should contain the $file, $line, and $text
508 # tags, which will be replaced by the file and line number from which the
509 # warning originated and the warning text. Optionally the format may contain
510 # $version, which will be replaced by the version of the file (if it could
511 # be obtained via FILE_VERSION_FILTER)
512
513 WARN_FORMAT            = "$file:$line: $text"
514
515 # The WARN_LOGFILE tag can be used to specify a file to which warning
516 # and error messages should be written. If left blank the output is written
517 # to stderr.
518
519 WARN_LOGFILE           =
520
521 #---------------------------------------------------------------------------
522 # configuration options related to the input files
523 #---------------------------------------------------------------------------
524
525 # The INPUT tag can be used to specify the files and/or directories that contain
526 # documented source files. You may enter file names like "myfile.cpp" or
527 # directories like "/usr/src/myproject". Separate the files or directories
528 # with spaces.
529
530 INPUT                  = @SRC_DIR@/src/libstrongswan \
531                          @SRC_DIR@/src/libhydra \
532                          @SRC_DIR@/src/libcharon \
533                          @SRC_DIR@/src/libsimaka \
534                          @SRC_DIR@/src/libtls \
535                          @SRC_DIR@/src/libtnccs \
536                          @SRC_DIR@/src/libtncif \
537                          @SRC_DIR@/src/libfast \
538                          @SRC_DIR@/src/manager
539
540 # This tag can be used to specify the character encoding of the source files
541 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
542 # also the default input encoding. Doxygen uses libiconv (or the iconv built
543 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
544 # the list of possible encodings.
545
546 INPUT_ENCODING         = UTF-8
547
548 # If the value of the INPUT tag contains directories, you can use the
549 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
550 # and *.h) to filter out the source-files in the directories. If left
551 # blank the following patterns are tested:
552 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
553 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
554
555 FILE_PATTERNS          = *.h
556
557 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
558 # should be searched for input files as well. Possible values are YES and NO.
559 # If left blank NO is used.
560
561 RECURSIVE              = YES
562
563 # The EXCLUDE tag can be used to specify files and/or directories that should
564 # excluded from the INPUT source files. This way you can easily exclude a
565 # subdirectory from a directory tree whose root is specified with the INPUT tag.
566
567 EXCLUDE                =
568
569 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
570 # directories that are symbolic links (a Unix filesystem feature) are excluded
571 # from the input.
572
573 EXCLUDE_SYMLINKS       = NO
574
575 # If the value of the INPUT tag contains directories, you can use the
576 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
577 # certain files from those directories. Note that the wildcards are matched
578 # against the file with absolute path, so to exclude all test directories
579 # for example use the pattern */test/*
580
581 EXCLUDE_PATTERNS       = */.git/*
582
583 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
584 # (namespaces, classes, functions, etc.) that should be excluded from the
585 # output. The symbol name can be a fully qualified name, a word, or if the
586 # wildcard * is used, a substring. Examples: ANamespace, AClass,
587 # AClass::ANamespace, ANamespace::*Test
588
589 EXCLUDE_SYMBOLS        =
590
591 # The EXAMPLE_PATH tag can be used to specify one or more files or
592 # directories that contain example code fragments that are included (see
593 # the \include command).
594
595 EXAMPLE_PATH           =
596
597 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
598 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
599 # and *.h) to filter out the source-files in the directories. If left
600 # blank all files are included.
601
602 EXAMPLE_PATTERNS       =
603
604 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
605 # searched for input files to be used with the \include or \dontinclude
606 # commands irrespective of the value of the RECURSIVE tag.
607 # Possible values are YES and NO. If left blank NO is used.
608
609 EXAMPLE_RECURSIVE      = NO
610
611 # The IMAGE_PATH tag can be used to specify one or more files or
612 # directories that contain image that are included in the documentation (see
613 # the \image command).
614
615 IMAGE_PATH             =
616
617 # The INPUT_FILTER tag can be used to specify a program that doxygen should
618 # invoke to filter for each input file. Doxygen will invoke the filter program
619 # by executing (via popen()) the command <filter> <input-file>, where <filter>
620 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
621 # input file. Doxygen will then use the output that the filter program writes
622 # to standard output.  If FILTER_PATTERNS is specified, this tag will be
623 # ignored.
624
625 INPUT_FILTER           =
626
627 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
628 # basis.  Doxygen will compare the file name with each pattern and apply the
629 # filter if there is a match.  The filters are a list of the form:
630 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
631 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
632 # is applied to all files.
633
634 FILTER_PATTERNS        =
635
636 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
637 # INPUT_FILTER) will be used to filter the input files when producing source
638 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
639
640 FILTER_SOURCE_FILES    = NO
641
642 #---------------------------------------------------------------------------
643 # configuration options related to source browsing
644 #---------------------------------------------------------------------------
645
646 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
647 # be generated. Documented entities will be cross-referenced with these sources.
648 # Note: To get rid of all source code in the generated output, make sure also
649 # VERBATIM_HEADERS is set to NO.
650
651 SOURCE_BROWSER         = NO
652
653 # Setting the INLINE_SOURCES tag to YES will include the body
654 # of functions and classes directly in the documentation.
655
656 INLINE_SOURCES         = NO
657
658 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
659 # doxygen to hide any special comment blocks from generated source code
660 # fragments. Normal C and C++ comments will always remain visible.
661
662 STRIP_CODE_COMMENTS    = NO
663
664 # If the REFERENCED_BY_RELATION tag is set to YES
665 # then for each documented function all documented
666 # functions referencing it will be listed.
667
668 REFERENCED_BY_RELATION = NO
669
670 # If the REFERENCES_RELATION tag is set to YES
671 # then for each documented function all documented entities
672 # called/used by that function will be listed.
673
674 REFERENCES_RELATION    = NO
675
676 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
677 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
678 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
679 # link to the source code.  Otherwise they will link to the documentstion.
680
681 REFERENCES_LINK_SOURCE = YES
682
683 # If the USE_HTAGS tag is set to YES then the references to source code
684 # will point to the HTML generated by the htags(1) tool instead of doxygen
685 # built-in source browser. The htags tool is part of GNU's global source
686 # tagging system (see http://www.gnu.org/software/global/global.html). You
687 # will need version 4.8.6 or higher.
688
689 USE_HTAGS              = NO
690
691 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
692 # will generate a verbatim copy of the header file for each class for
693 # which an include is specified. Set to NO to disable this.
694
695 VERBATIM_HEADERS       = YES
696
697 #---------------------------------------------------------------------------
698 # configuration options related to the alphabetical class index
699 #---------------------------------------------------------------------------
700
701 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
702 # of all compounds will be generated. Enable this if the project
703 # contains a lot of classes, structs, unions or interfaces.
704
705 ALPHABETICAL_INDEX     = YES
706
707 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
708 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
709 # in which this list will be split (can be a number in the range [1..20])
710
711 COLS_IN_ALPHA_INDEX    = 5
712
713 # In case all classes in a project start with a common prefix, all
714 # classes will be put under the same header in the alphabetical index.
715 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
716 # should be ignored while generating the index headers.
717
718 IGNORE_PREFIX          =
719
720 #---------------------------------------------------------------------------
721 # configuration options related to the HTML output
722 #---------------------------------------------------------------------------
723
724 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
725 # generate HTML output.
726
727 GENERATE_HTML          = YES
728
729 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
730 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
731 # put in front of it. If left blank `html' will be used as the default path.
732
733 HTML_OUTPUT            = .
734
735 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
736 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
737 # doxygen will generate files with .html extension.
738
739 HTML_FILE_EXTENSION    = .html
740
741 # The HTML_HEADER tag can be used to specify a personal HTML header for
742 # each generated HTML page. If it is left blank doxygen will generate a
743 # standard header.
744
745 HTML_HEADER            =
746
747 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
748 # each generated HTML page. If it is left blank doxygen will generate a
749 # standard footer.
750
751 HTML_FOOTER            =
752
753 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
754 # style sheet that is used by each HTML page. It can be used to
755 # fine-tune the look of the HTML output. If the tag is left blank doxygen
756 # will generate a default style sheet. Note that doxygen will try to copy
757 # the style sheet file to the HTML output directory, so don't put your own
758 # stylesheet in the HTML output directory as well, or it will be erased!
759
760 HTML_STYLESHEET        =
761
762 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
763 # files or namespaces will be aligned in HTML using tables. If set to
764 # NO a bullet list will be used.
765
766 HTML_ALIGN_MEMBERS     = YES
767
768 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
769 # will be generated that can be used as input for tools like the
770 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
771 # of the generated HTML documentation.
772
773 GENERATE_HTMLHELP      = NO
774
775 # If the GENERATE_DOCSET tag is set to YES, additional index files
776 # will be generated that can be used as input for Apple's Xcode 3
777 # integrated development environment, introduced with OSX 10.5 (Leopard).
778 # To create a documentation set, doxygen will generate a Makefile in the
779 # HTML output directory. Running make will produce the docset in that
780 # directory and running "make install" will install the docset in
781 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
782 # it at startup.
783
784 GENERATE_DOCSET        = NO
785
786 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
787 # feed. A documentation feed provides an umbrella under which multiple
788 # documentation sets from a single provider (such as a company or product suite)
789 # can be grouped.
790
791 DOCSET_FEEDNAME        = "Doxygen generated docs"
792
793 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
794 # should uniquely identify the documentation set bundle. This should be a
795 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
796 # will append .docset to the name.
797
798 DOCSET_BUNDLE_ID       = org.doxygen.Project
799
800 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
801 # documentation will contain sections that can be hidden and shown after the
802 # page has loaded. For this to work a browser that supports
803 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
804 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
805
806 HTML_DYNAMIC_SECTIONS  = NO
807
808 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
809 # be used to specify the file name of the resulting .chm file. You
810 # can add a path in front of the file if the result should not be
811 # written to the html output directory.
812
813 CHM_FILE               =
814
815 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
816 # be used to specify the location (absolute path including file name) of
817 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
818 # the HTML help compiler on the generated index.hhp.
819
820 HHC_LOCATION           =
821
822 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
823 # controls if a separate .chi index file is generated (YES) or that
824 # it should be included in the master .chm file (NO).
825
826 GENERATE_CHI           = NO
827
828 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
829 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
830 # content.
831
832 CHM_INDEX_ENCODING     =
833
834 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
835 # controls whether a binary table of contents is generated (YES) or a
836 # normal table of contents (NO) in the .chm file.
837
838 BINARY_TOC             = NO
839
840 # The TOC_EXPAND flag can be set to YES to add extra items for group members
841 # to the contents of the HTML help documentation and to the tree view.
842
843 TOC_EXPAND             = NO
844
845 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
846 # top of each HTML page. The value NO (the default) enables the index and
847 # the value YES disables it.
848
849 DISABLE_INDEX          = NO
850
851 # This tag can be used to set the number of enum values (range [1..20])
852 # that doxygen will group on one line in the generated HTML documentation.
853
854 ENUM_VALUES_PER_LINE   = 1
855
856 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
857 # structure should be generated to display hierarchical information.
858 # If the tag value is set to FRAME, a side panel will be generated
859 # containing a tree-like index structure (just like the one that
860 # is generated for HTML Help). For this to work a browser that supports
861 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
862 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
863 # probably better off using the HTML help feature. Other possible values
864 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
865 # and Class Hiererachy pages using a tree view instead of an ordered list;
866 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
867 # disables this behavior completely. For backwards compatibility with previous
868 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
869 # respectively.
870
871 GENERATE_TREEVIEW      = YES
872
873 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
874 # used to set the initial width (in pixels) of the frame in which the tree
875 # is shown.
876
877 TREEVIEW_WIDTH         = 250
878
879 # Use this tag to change the font size of Latex formulas included
880 # as images in the HTML documentation. The default is 10. Note that
881 # when you change the font size after a successful doxygen run you need
882 # to manually remove any form_*.png images from the HTML output directory
883 # to force them to be regenerated.
884
885 FORMULA_FONTSIZE       = 10
886
887 #---------------------------------------------------------------------------
888 # configuration options related to the LaTeX output
889 #---------------------------------------------------------------------------
890
891 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
892 # generate Latex output.
893
894 GENERATE_LATEX         = NO
895
896 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
897 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
898 # put in front of it. If left blank `latex' will be used as the default path.
899
900 LATEX_OUTPUT           = latex
901
902 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
903 # invoked. If left blank `latex' will be used as the default command name.
904
905 LATEX_CMD_NAME         = latex
906
907 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
908 # generate index for LaTeX. If left blank `makeindex' will be used as the
909 # default command name.
910
911 MAKEINDEX_CMD_NAME     = makeindex
912
913 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
914 # LaTeX documents. This may be useful for small projects and may help to
915 # save some trees in general.
916
917 COMPACT_LATEX          = NO
918
919 # The PAPER_TYPE tag can be used to set the paper type that is used
920 # by the printer. Possible values are: a4, a4wide, letter, legal and
921 # executive. If left blank a4wide will be used.
922
923 PAPER_TYPE             = a4wide
924
925 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
926 # packages that should be included in the LaTeX output.
927
928 EXTRA_PACKAGES         =
929
930 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
931 # the generated latex document. The header should contain everything until
932 # the first chapter. If it is left blank doxygen will generate a
933 # standard header. Notice: only use this tag if you know what you are doing!
934
935 LATEX_HEADER           =
936
937 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
938 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
939 # contain links (just like the HTML output) instead of page references
940 # This makes the output suitable for online browsing using a pdf viewer.
941
942 PDF_HYPERLINKS         = NO
943
944 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
945 # plain latex in the generated Makefile. Set this option to YES to get a
946 # higher quality PDF documentation.
947
948 USE_PDFLATEX           = NO
949
950 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
951 # command to the generated LaTeX files. This will instruct LaTeX to keep
952 # running if errors occur, instead of asking the user for help.
953 # This option is also used when generating formulas in HTML.
954
955 LATEX_BATCHMODE        = NO
956
957 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
958 # include the index chapters (such as File Index, Compound Index, etc.)
959 # in the output.
960
961 LATEX_HIDE_INDICES     = NO
962
963 #---------------------------------------------------------------------------
964 # configuration options related to the RTF output
965 #---------------------------------------------------------------------------
966
967 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
968 # The RTF output is optimized for Word 97 and may not look very pretty with
969 # other RTF readers or editors.
970
971 GENERATE_RTF           = NO
972
973 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
974 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
975 # put in front of it. If left blank `rtf' will be used as the default path.
976
977 RTF_OUTPUT             = rtf
978
979 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
980 # RTF documents. This may be useful for small projects and may help to
981 # save some trees in general.
982
983 COMPACT_RTF            = NO
984
985 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
986 # will contain hyperlink fields. The RTF file will
987 # contain links (just like the HTML output) instead of page references.
988 # This makes the output suitable for online browsing using WORD or other
989 # programs which support those fields.
990 # Note: wordpad (write) and others do not support links.
991
992 RTF_HYPERLINKS         = NO
993
994 # Load stylesheet definitions from file. Syntax is similar to doxygen's
995 # config file, i.e. a series of assignments. You only have to provide
996 # replacements, missing definitions are set to their default value.
997
998 RTF_STYLESHEET_FILE    =
999
1000 # Set optional variables used in the generation of an rtf document.
1001 # Syntax is similar to doxygen's config file.
1002
1003 RTF_EXTENSIONS_FILE    =
1004
1005 #---------------------------------------------------------------------------
1006 # configuration options related to the man page output
1007 #---------------------------------------------------------------------------
1008
1009 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1010 # generate man pages
1011
1012 GENERATE_MAN           = NO
1013
1014 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1015 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1016 # put in front of it. If left blank `man' will be used as the default path.
1017
1018 MAN_OUTPUT             = man
1019
1020 # The MAN_EXTENSION tag determines the extension that is added to
1021 # the generated man pages (default is the subroutine's section .3)
1022
1023 MAN_EXTENSION          = .3
1024
1025 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1026 # then it will generate one additional man file for each entity
1027 # documented in the real man page(s). These additional files
1028 # only source the real man page, but without them the man command
1029 # would be unable to find the correct page. The default is NO.
1030
1031 MAN_LINKS              = YES
1032
1033 #---------------------------------------------------------------------------
1034 # configuration options related to the XML output
1035 #---------------------------------------------------------------------------
1036
1037 # If the GENERATE_XML tag is set to YES Doxygen will
1038 # generate an XML file that captures the structure of
1039 # the code including all documentation.
1040
1041 GENERATE_XML           = NO
1042
1043 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1044 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1045 # put in front of it. If left blank `xml' will be used as the default path.
1046
1047 XML_OUTPUT             = xml
1048
1049 # The XML_SCHEMA tag can be used to specify an XML schema,
1050 # which can be used by a validating XML parser to check the
1051 # syntax of the XML files.
1052
1053 XML_SCHEMA             =
1054
1055 # The XML_DTD tag can be used to specify an XML DTD,
1056 # which can be used by a validating XML parser to check the
1057 # syntax of the XML files.
1058
1059 XML_DTD                =
1060
1061 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1062 # dump the program listings (including syntax highlighting
1063 # and cross-referencing information) to the XML output. Note that
1064 # enabling this will significantly increase the size of the XML output.
1065
1066 XML_PROGRAMLISTING     = YES
1067
1068 #---------------------------------------------------------------------------
1069 # configuration options for the AutoGen Definitions output
1070 #---------------------------------------------------------------------------
1071
1072 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1073 # generate an AutoGen Definitions (see autogen.sf.net) file
1074 # that captures the structure of the code including all
1075 # documentation. Note that this feature is still experimental
1076 # and incomplete at the moment.
1077
1078 GENERATE_AUTOGEN_DEF   = NO
1079
1080 #---------------------------------------------------------------------------
1081 # configuration options related to the Perl module output
1082 #---------------------------------------------------------------------------
1083
1084 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1085 # generate a Perl module file that captures the structure of
1086 # the code including all documentation. Note that this
1087 # feature is still experimental and incomplete at the
1088 # moment.
1089
1090 GENERATE_PERLMOD       = NO
1091
1092 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1093 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1094 # to generate PDF and DVI output from the Perl module output.
1095
1096 PERLMOD_LATEX          = NO
1097
1098 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1099 # nicely formatted so it can be parsed by a human reader.  This is useful
1100 # if you want to understand what is going on.  On the other hand, if this
1101 # tag is set to NO the size of the Perl module output will be much smaller
1102 # and Perl will parse it just the same.
1103
1104 PERLMOD_PRETTY         = YES
1105
1106 # The names of the make variables in the generated doxyrules.make file
1107 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1108 # This is useful so different doxyrules.make files included by the same
1109 # Makefile don't overwrite each other's variables.
1110
1111 PERLMOD_MAKEVAR_PREFIX =
1112
1113 #---------------------------------------------------------------------------
1114 # Configuration options related to the preprocessor
1115 #---------------------------------------------------------------------------
1116
1117 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1118 # evaluate all C-preprocessor directives found in the sources and include
1119 # files.
1120
1121 ENABLE_PREPROCESSING   = YES
1122
1123 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1124 # names in the source code. If set to NO (the default) only conditional
1125 # compilation will be performed. Macro expansion can be done in a controlled
1126 # way by setting EXPAND_ONLY_PREDEF to YES.
1127
1128 MACRO_EXPANSION        = YES
1129
1130 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1131 # then the macro expansion is limited to the macros specified with the
1132 # PREDEFINED and EXPAND_AS_DEFINED tags.
1133
1134 EXPAND_ONLY_PREDEF     = NO
1135
1136 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1137 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1138
1139 SEARCH_INCLUDES        = YES
1140
1141 # The INCLUDE_PATH tag can be used to specify one or more directories that
1142 # contain include files that are not input files but should be processed by
1143 # the preprocessor.
1144
1145 INCLUDE_PATH           =
1146
1147 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1148 # patterns (like *.h and *.hpp) to filter out the header-files in the
1149 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1150 # be used.
1151
1152 INCLUDE_FILE_PATTERNS  =
1153
1154 # The PREDEFINED tag can be used to specify one or more macro names that
1155 # are defined before the preprocessor is started (similar to the -D option of
1156 # gcc). The argument of the tag is a list of macros of the form: name
1157 # or name=definition (no spaces). If the definition and the = are
1158 # omitted =1 is assumed. To prevent a macro definition from being
1159 # undefined via #undef or recursively expanded use the := operator
1160 # instead of the = operator.
1161
1162 PREDEFINED             = LEAK_DETECTIVE
1163
1164 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1165 # this tag can be used to specify a list of macro names that should be expanded.
1166 # The macro definition that is found in the sources will be used.
1167 # Use the PREDEFINED tag if you want to use a different macro definition.
1168
1169 EXPAND_AS_DEFINED      =
1170
1171 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1172 # doxygen's preprocessor will remove all function-like macros that are alone
1173 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1174 # function macros are typically used for boiler-plate code, and will confuse
1175 # the parser if not removed.
1176
1177 SKIP_FUNCTION_MACROS   = YES
1178
1179 #---------------------------------------------------------------------------
1180 # Configuration::additions related to external references
1181 #---------------------------------------------------------------------------
1182
1183 # The TAGFILES option can be used to specify one or more tagfiles.
1184 # Optionally an initial location of the external documentation
1185 # can be added for each tagfile. The format of a tag file without
1186 # this location is as follows:
1187 #   TAGFILES = file1 file2 ...
1188 # Adding location for the tag files is done as follows:
1189 #   TAGFILES = file1=loc1 "file2 = loc2" ...
1190 # where "loc1" and "loc2" can be relative or absolute paths or
1191 # URLs. If a location is present for each tag, the installdox tool
1192 # does not have to be run to correct the links.
1193 # Note that each tag file must have a unique name
1194 # (where the name does NOT include the path)
1195 # If a tag file is not located in the directory in which doxygen
1196 # is run, you must also specify the path to the tagfile here.
1197
1198 TAGFILES               =
1199
1200 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1201 # a tag file that is based on the input files it reads.
1202
1203 GENERATE_TAGFILE       =
1204
1205 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1206 # in the class index. If set to NO only the inherited external classes
1207 # will be listed.
1208
1209 ALLEXTERNALS           = NO
1210
1211 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1212 # in the modules index. If set to NO, only the current project's groups will
1213 # be listed.
1214
1215 EXTERNAL_GROUPS        = YES
1216
1217 # The PERL_PATH should be the absolute path and name of the perl script
1218 # interpreter (i.e. the result of `which perl').
1219
1220 PERL_PATH              = /usr/bin/perl
1221
1222 #---------------------------------------------------------------------------
1223 # Configuration options related to the dot tool
1224 #---------------------------------------------------------------------------
1225
1226 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1227 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1228 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1229 # this option is superseded by the HAVE_DOT option below. This is only a
1230 # fallback. It is recommended to install and use dot, since it yields more
1231 # powerful graphs.
1232
1233 CLASS_DIAGRAMS         = YES
1234
1235 # You can define message sequence charts within doxygen comments using the \msc
1236 # command. Doxygen will then run the mscgen tool (see
1237 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1238 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1239 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1240 # default search path.
1241
1242 MSCGEN_PATH            =
1243
1244 # If set to YES, the inheritance and collaboration graphs will hide
1245 # inheritance and usage relations if the target is undocumented
1246 # or is not a class.
1247
1248 HIDE_UNDOC_RELATIONS   = YES
1249
1250 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1251 # available from the path. This tool is part of Graphviz, a graph visualization
1252 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1253 # have no effect if this option is set to NO (the default)
1254
1255 HAVE_DOT               = NO
1256
1257 # By default doxygen will write a font called FreeSans.ttf to the output
1258 # directory and reference it in all dot files that doxygen generates. This
1259 # font does not include all possible unicode characters however, so when you need
1260 # these (or just want a differently looking font) you can specify the font name
1261 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1262 # which can be done by putting it in a standard location or by setting the
1263 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1264 # containing the font.
1265
1266 DOT_FONTNAME           = FreeSans
1267
1268 # By default doxygen will tell dot to use the output directory to look for the
1269 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1270 # different font using DOT_FONTNAME you can set the path where dot
1271 # can find it using this tag.
1272
1273 DOT_FONTPATH           =
1274
1275 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1276 # will generate a graph for each documented class showing the direct and
1277 # indirect inheritance relations. Setting this tag to YES will force the
1278 # the CLASS_DIAGRAMS tag to NO.
1279
1280 CLASS_GRAPH            = YES
1281
1282 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1283 # will generate a graph for each documented class showing the direct and
1284 # indirect implementation dependencies (inheritance, containment, and
1285 # class references variables) of the class with other documented classes.
1286
1287 COLLABORATION_GRAPH    = YES
1288
1289 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1290 # will generate a graph for groups, showing the direct groups dependencies
1291
1292 GROUP_GRAPHS           = YES
1293
1294 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1295 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1296 # Language.
1297
1298 UML_LOOK               = NO
1299
1300 # If set to YES, the inheritance and collaboration graphs will show the
1301 # relations between templates and their instances.
1302
1303 TEMPLATE_RELATIONS     = NO
1304
1305 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1306 # tags are set to YES then doxygen will generate a graph for each documented
1307 # file showing the direct and indirect include dependencies of the file with
1308 # other documented files.
1309
1310 INCLUDE_GRAPH          = YES
1311
1312 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1313 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1314 # documented header file showing the documented files that directly or
1315 # indirectly include this file.
1316
1317 INCLUDED_BY_GRAPH      = YES
1318
1319 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1320 # doxygen will generate a call dependency graph for every global function
1321 # or class method. Note that enabling this option will significantly increase
1322 # the time of a run. So in most cases it will be better to enable call graphs
1323 # for selected functions only using the \callgraph command.
1324
1325 CALL_GRAPH             = NO
1326
1327 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1328 # doxygen will generate a caller dependency graph for every global function
1329 # or class method. Note that enabling this option will significantly increase
1330 # the time of a run. So in most cases it will be better to enable caller
1331 # graphs for selected functions only using the \callergraph command.
1332
1333 CALLER_GRAPH           = NO
1334
1335 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1336 # will graphical hierarchy of all classes instead of a textual one.
1337
1338 GRAPHICAL_HIERARCHY    = YES
1339
1340 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1341 # then doxygen will show the dependencies a directory has on other directories
1342 # in a graphical way. The dependency relations are determined by the #include
1343 # relations between the files in the directories.
1344
1345 DIRECTORY_GRAPH        = YES
1346
1347 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1348 # generated by dot. Possible values are png, jpg, or gif
1349 # If left blank png will be used.
1350
1351 DOT_IMAGE_FORMAT       = png
1352
1353 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1354 # found. If left blank, it is assumed the dot tool can be found in the path.
1355
1356 DOT_PATH               =
1357
1358 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1359 # contain dot files that are included in the documentation (see the
1360 # \dotfile command).
1361
1362 DOTFILE_DIRS           =
1363
1364 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1365 # nodes that will be shown in the graph. If the number of nodes in a graph
1366 # becomes larger than this value, doxygen will truncate the graph, which is
1367 # visualized by representing a node as a red box. Note that doxygen if the
1368 # number of direct children of the root node in a graph is already larger than
1369 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1370 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1371
1372 DOT_GRAPH_MAX_NODES    = 50
1373
1374 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1375 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1376 # from the root by following a path via at most 3 edges will be shown. Nodes
1377 # that lay further from the root node will be omitted. Note that setting this
1378 # option to 1 or 2 may greatly reduce the computation time needed for large
1379 # code bases. Also note that the size of a graph can be further restricted by
1380 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1381
1382 MAX_DOT_GRAPH_DEPTH    = 0
1383
1384 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1385 # background. This is enabled by default, which results in a transparent
1386 # background. Warning: Depending on the platform used, enabling this option
1387 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1388 # become hard to read).
1389
1390 DOT_TRANSPARENT        = NO
1391
1392 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1393 # files in one run (i.e. multiple -o and -T options on the command line). This
1394 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1395 # support this, this feature is disabled by default.
1396
1397 DOT_MULTI_TARGETS      = NO
1398
1399 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1400 # generate a legend page explaining the meaning of the various boxes and
1401 # arrows in the dot generated graphs.
1402
1403 GENERATE_LEGEND        = YES
1404
1405 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1406 # remove the intermediate dot files that are used to generate
1407 # the various graphs.
1408
1409 DOT_CLEANUP            = YES
1410
1411 #---------------------------------------------------------------------------
1412 # Configuration::additions related to the search engine
1413 #---------------------------------------------------------------------------
1414
1415 # The SEARCHENGINE tag specifies whether or not a search engine should be
1416 # used. If set to NO the values of all tags below this one will be ignored.
1417
1418 SEARCHENGINE           = NO