3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
6 # All text after a hash (#) is considered a comment and will be ignored
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
23 DOXYFILE_ENCODING = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
28 PROJECT_NAME = @PACKAGE@
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.
34 PROJECT_NUMBER = @VERSION@
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.
41 OUTPUT_DIRECTORY = doc
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.
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, Esperanto, Farsi, Finnish, French, German,
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
63 OUTPUT_LANGUAGE = English
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.
70 BRIEF_MEMBER_DESC = YES
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.
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"
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
95 ALWAYS_DETAILED_SEC = NO
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.
102 INLINE_INHERITED_MEMB = NO
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.
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
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.
126 STRIP_FROM_INC_PATH =
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.
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.)
140 JAVADOC_AUTOBRIEF = YES
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.)
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.
156 MULTILINE_CPP_IS_BRIEF = NO
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
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.
168 SEPARATE_MEMBER_PAGES = NO
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.
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.
182 ALIASES = "signal=- @ref " \
183 "signaldef=@section " \
185 "signalproto=@code " \
186 "endsignalproto=@endcode " \
187 "signaldesc=@par Description: " \
188 "signals=@b Signals: " \
190 "constreturn=@note The return value of this function must not be modified or freed. @return "
192 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
193 # sources only. Doxygen will then generate output that is more tailored for C.
194 # For instance, some of the names that are used will be different. The list
195 # of all members will be omitted, etc.
197 OPTIMIZE_OUTPUT_FOR_C = YES
199 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
200 # sources only. Doxygen will then generate output that is more tailored for
201 # Java. For instance, namespaces will be presented as packages, qualified
202 # scopes will look different, etc.
204 OPTIMIZE_OUTPUT_JAVA = NO
206 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
207 # sources only. Doxygen will then generate output that is more tailored for
210 OPTIMIZE_FOR_FORTRAN = NO
212 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
213 # sources. Doxygen will then generate output that is tailored for
216 OPTIMIZE_OUTPUT_VHDL = NO
218 # Doxygen selects the parser to use depending on the extension of the files it
219 # parses. With this tag you can assign which parser to use for a given extension.
220 # Doxygen has a built-in mapping, but you can override or extend it using this
221 # tag. The format is ext=language, where ext is a file extension, and language
222 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
223 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
224 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
225 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
226 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
230 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
231 # to include (a tag file for) the STL sources as input, then you should
232 # set this tag to YES in order to let doxygen match functions declarations and
233 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
234 # func(std::string) {}). This also make the inheritance and collaboration
235 # diagrams that involve STL classes more complete and accurate.
237 BUILTIN_STL_SUPPORT = NO
239 # If you use Microsoft's C++/CLI language, you should set this option to YES to
240 # enable parsing support.
244 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
245 # Doxygen will parse them like normal C++ but will assume all classes use public
246 # instead of private inheritance when no explicit protection keyword is present.
250 # For Microsoft's IDL there are propget and propput attributes to indicate getter
251 # and setter methods for a property. Setting this option to YES (the default)
252 # will make doxygen to replace the get and set methods by a property in the
253 # documentation. This will only work if the methods are indeed getting or
254 # setting a simple type. If this is not the case, or you want to show the
255 # methods anyway, you should set this option to NO.
257 IDL_PROPERTY_SUPPORT = YES
259 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
260 # tag is set to YES, then doxygen will reuse the documentation of the first
261 # member in the group (if any) for the other members of the group. By default
262 # all members of a group must be documented explicitly.
264 DISTRIBUTE_GROUP_DOC = NO
266 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
267 # the same type (for instance a group of public functions) to be put as a
268 # subgroup of that type (e.g. under the Public Functions section). Set it to
269 # NO to prevent subgrouping. Alternatively, this can be done per class using
270 # the \nosubgrouping command.
274 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
275 # is documented as struct, union, or enum with the name of the typedef. So
276 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
277 # with name TypeT. When disabled the typedef will appear as a member of a file,
278 # namespace, or class. And the struct will be named TypeS. This can typically
279 # be useful for C code in case the coding convention dictates that all compound
280 # types are typedef'ed and only the typedef is referenced, never the tag name.
282 TYPEDEF_HIDES_STRUCT = NO
284 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
285 # determine which symbols to keep in memory and which to flush to disk.
286 # When the cache is full, less often used symbols will be written to disk.
287 # For small to medium size projects (<1000 input files) the default value is
288 # probably good enough. For larger projects a too small cache size can cause
289 # doxygen to be busy swapping symbols to and from disk most of the time
290 # causing a significant performance penality.
291 # If the system has enough physical memory increasing the cache will improve the
292 # performance by keeping more symbols in memory. Note that the value works on
293 # a logarithmic scale so increasing the size by one will rougly double the
294 # memory usage. The cache size is given by this formula:
295 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
296 # corresponding to a cache size of 2^16 = 65536 symbols
298 SYMBOL_CACHE_SIZE = 0
300 #---------------------------------------------------------------------------
301 # Build related configuration options
302 #---------------------------------------------------------------------------
304 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
305 # documentation are documented, even if no documentation was available.
306 # Private class members and static file members will be hidden unless
307 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
311 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
312 # will be included in the documentation.
316 # If the EXTRACT_STATIC tag is set to YES all static members of a file
317 # will be included in the documentation.
321 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
322 # defined locally in source files will be included in the documentation.
323 # If set to NO only classes defined in header files are included.
325 EXTRACT_LOCAL_CLASSES = YES
327 # This flag is only useful for Objective-C code. When set to YES local
328 # methods, which are defined in the implementation section but not in
329 # the interface are included in the documentation.
330 # If set to NO (the default) only methods in the interface are included.
332 EXTRACT_LOCAL_METHODS = YES
334 # If this flag is set to YES, the members of anonymous namespaces will be
335 # extracted and appear in the documentation as a namespace called
336 # 'anonymous_namespace{file}', where file will be replaced with the base
337 # name of the file that contains the anonymous namespace. By default
338 # anonymous namespace are hidden.
340 EXTRACT_ANON_NSPACES = NO
342 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
343 # undocumented members of documented classes, files or namespaces.
344 # If set to NO (the default) these members will be included in the
345 # various overviews, but no documentation section is generated.
346 # This option has no effect if EXTRACT_ALL is enabled.
348 HIDE_UNDOC_MEMBERS = NO
350 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
351 # undocumented classes that are normally visible in the class hierarchy.
352 # If set to NO (the default) these classes will be included in the various
353 # overviews. This option has no effect if EXTRACT_ALL is enabled.
355 HIDE_UNDOC_CLASSES = NO
357 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
358 # friend (class|struct|union) declarations.
359 # If set to NO (the default) these declarations will be included in the
362 HIDE_FRIEND_COMPOUNDS = NO
364 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
365 # documentation blocks found inside the body of a function.
366 # If set to NO (the default) these blocks will be appended to the
367 # function's detailed documentation block.
369 HIDE_IN_BODY_DOCS = NO
371 # The INTERNAL_DOCS tag determines if documentation
372 # that is typed after a \internal command is included. If the tag is set
373 # to NO (the default) then the documentation will be excluded.
374 # Set it to YES to include the internal documentation.
378 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
379 # file names in lower-case letters. If set to YES upper-case letters are also
380 # allowed. This is useful if you have classes or files whose names only differ
381 # in case and if your file system supports case sensitive file names. Windows
382 # and Mac users are advised to set this option to NO.
384 CASE_SENSE_NAMES = YES
386 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
387 # will show members with their full class and namespace scopes in the
388 # documentation. If set to YES the scope will be hidden.
390 HIDE_SCOPE_NAMES = NO
392 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
393 # will put a list of the files that are included by a file in the documentation
396 SHOW_INCLUDE_FILES = YES
398 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
399 # will list include files with double quotes in the documentation
400 # rather than with sharp brackets.
402 FORCE_LOCAL_INCLUDES = NO
404 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
405 # is inserted in the documentation for inline members.
409 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
410 # will sort the (detailed) documentation of file and class members
411 # alphabetically by member name. If set to NO the members will appear in
414 SORT_MEMBER_DOCS = YES
416 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
417 # brief documentation of file, namespace and class members alphabetically
418 # by member name. If set to NO (the default) the members will appear in
423 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
424 # will sort the (brief and detailed) documentation of class members so that
425 # constructors and destructors are listed first. If set to NO (the default)
426 # the constructors will appear in the respective orders defined by
427 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
428 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
429 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
431 SORT_MEMBERS_CTORS_1ST = NO
433 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
434 # hierarchy of group names into alphabetical order. If set to NO (the default)
435 # the group names will appear in their defined order.
437 SORT_GROUP_NAMES = NO
439 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
440 # sorted by fully-qualified names, including namespaces. If set to
441 # NO (the default), the class list will be sorted only by class name,
442 # not including the namespace part.
443 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
444 # Note: This option applies only to the class list, not to the
447 SORT_BY_SCOPE_NAME = YES
449 # The GENERATE_TODOLIST tag can be used to enable (YES) or
450 # disable (NO) the todo list. This list is created by putting \todo
451 # commands in the documentation.
453 GENERATE_TODOLIST = YES
455 # The GENERATE_TESTLIST tag can be used to enable (YES) or
456 # disable (NO) the test list. This list is created by putting \test
457 # commands in the documentation.
459 GENERATE_TESTLIST = YES
461 # The GENERATE_BUGLIST tag can be used to enable (YES) or
462 # disable (NO) the bug list. This list is created by putting \bug
463 # commands in the documentation.
465 GENERATE_BUGLIST = YES
467 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
468 # disable (NO) the deprecated list. This list is created by putting
469 # \deprecated commands in the documentation.
471 GENERATE_DEPRECATEDLIST= YES
473 # The ENABLED_SECTIONS tag can be used to enable conditional
474 # documentation sections, marked by \if sectionname ... \endif.
478 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
479 # the initial value of a variable or define consists of for it to appear in
480 # the documentation. If the initializer consists of more lines than specified
481 # here it will be hidden. Use a value of 0 to hide initializers completely.
482 # The appearance of the initializer of individual variables and defines in the
483 # documentation can be controlled using \showinitializer or \hideinitializer
484 # command in the documentation regardless of this setting.
486 MAX_INITIALIZER_LINES = 30
488 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
489 # at the bottom of the documentation of classes and structs. If set to YES the
490 # list will mention the files that were used to generate the documentation.
492 SHOW_USED_FILES = YES
494 # If the sources in your project are distributed over multiple directories
495 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
496 # in the documentation. The default is NO.
498 SHOW_DIRECTORIES = YES
500 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
501 # This will remove the Files entry from the Quick Index and from the
502 # Folder Tree View (if specified). The default is YES.
506 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
508 # This will remove the Namespaces entry from the Quick Index
509 # and from the Folder Tree View (if specified). The default is YES.
511 SHOW_NAMESPACES = YES
513 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
514 # doxygen should invoke to get the current version for each file (typically from
515 # the version control system). Doxygen will invoke the program by executing (via
516 # popen()) the command <command> <input-file>, where <command> is the value of
517 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
518 # provided by doxygen. Whatever the program writes to standard output
519 # is used as the file version. See the manual for examples.
521 FILE_VERSION_FILTER =
523 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
524 # by doxygen. The layout file controls the global structure of the generated
525 # output files in an output format independent way. The create the layout file
526 # that represents doxygen's defaults, run doxygen with the -l option.
527 # You can optionally specify a file name after the option, if omitted
528 # DoxygenLayout.xml will be used as the name of the layout file.
532 #---------------------------------------------------------------------------
533 # configuration options related to warning and progress messages
534 #---------------------------------------------------------------------------
536 # The QUIET tag can be used to turn on/off the messages that are generated
537 # by doxygen. Possible values are YES and NO. If left blank NO is used.
541 # The WARNINGS tag can be used to turn on/off the warning messages that are
542 # generated by doxygen. Possible values are YES and NO. If left blank
547 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
548 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
549 # automatically be disabled.
551 WARN_IF_UNDOCUMENTED = NO
553 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
554 # potential errors in the documentation, such as not documenting some
555 # parameters in a documented function, or documenting parameters that
556 # don't exist or using markup commands wrongly.
558 WARN_IF_DOC_ERROR = YES
560 # This WARN_NO_PARAMDOC option can be abled to get warnings for
561 # functions that are documented, but have no documentation for their parameters
562 # or return value. If set to NO (the default) doxygen will only warn about
563 # wrong or incomplete parameter documentation, but not about the absence of
566 WARN_NO_PARAMDOC = YES
568 # The WARN_FORMAT tag determines the format of the warning messages that
569 # doxygen can produce. The string should contain the $file, $line, and $text
570 # tags, which will be replaced by the file and line number from which the
571 # warning originated and the warning text. Optionally the format may contain
572 # $version, which will be replaced by the version of the file (if it could
573 # be obtained via FILE_VERSION_FILTER)
575 WARN_FORMAT = "$file:$line: $text "
577 # The WARN_LOGFILE tag can be used to specify a file to which warning
578 # and error messages should be written. If left blank the output is written
583 #---------------------------------------------------------------------------
584 # configuration options related to the input files
585 #---------------------------------------------------------------------------
587 # The INPUT tag can be used to specify the files and/or directories that contain
588 # documented source files. You may enter file names like "myfile.cpp" or
589 # directories like "/usr/src/myproject". Separate the files or directories
592 INPUT = @top_srcdir@/libpurple \
594 @top_srcdir@/finch/libgnt \
595 @top_srcdir@/pidgin \
598 # This tag can be used to specify the character encoding of the source files
599 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
600 # also the default input encoding. Doxygen uses libiconv (or the iconv built
601 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
602 # the list of possible encodings.
604 INPUT_ENCODING = UTF-8
606 # If the value of the INPUT tag contains directories, you can use the
607 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
608 # and *.h) to filter out the source-files in the directories. If left
609 # blank the following patterns are tested:
610 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
611 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
613 FILE_PATTERNS = *.h \
616 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
617 # should be searched for input files as well. Possible values are YES and NO.
618 # If left blank NO is used.
622 # The EXCLUDE tag can be used to specify files and/or directories that should
623 # excluded from the INPUT source files. This way you can easily exclude a
624 # subdirectory from a directory tree whose root is specified with the INPUT tag.
626 EXCLUDE = libpurple/purple-client.h \
627 libpurple/purple-client-bindings.h
629 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
630 # directories that are symbolic links (a Unix filesystem feature) are excluded
633 EXCLUDE_SYMLINKS = NO
635 # If the value of the INPUT tag contains directories, you can use the
636 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
637 # certain files from those directories. Note that the wildcards are matched
638 # against the file with absolute path, so to exclude all test directories
639 # for example use the pattern */test/*
643 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
644 # (namespaces, classes, functions, etc.) that should be excluded from the
645 # output. The symbol name can be a fully qualified name, a word, or if the
646 # wildcard * is used, a substring. Examples: ANamespace, AClass,
647 # AClass::ANamespace, ANamespace::*Test
651 # The EXAMPLE_PATH tag can be used to specify one or more files or
652 # directories that contain example code fragments that are included (see
653 # the \include command).
657 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
658 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
659 # and *.h) to filter out the source-files in the directories. If left
660 # blank all files are included.
664 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
665 # searched for input files to be used with the \include or \dontinclude
666 # commands irrespective of the value of the RECURSIVE tag.
667 # Possible values are YES and NO. If left blank NO is used.
669 EXAMPLE_RECURSIVE = NO
671 # The IMAGE_PATH tag can be used to specify one or more files or
672 # directories that contain image that are included in the documentation (see
673 # the \image command).
677 # The INPUT_FILTER tag can be used to specify a program that doxygen should
678 # invoke to filter for each input file. Doxygen will invoke the filter program
679 # by executing (via popen()) the command <filter> <input-file>, where <filter>
680 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
681 # input file. Doxygen will then use the output that the filter program writes
682 # to standard output.
683 # If FILTER_PATTERNS is specified, this tag will be
688 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
690 # Doxygen will compare the file name with each pattern and apply the
691 # filter if there is a match.
692 # The filters are a list of the form:
693 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
694 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
695 # is applied to all files.
699 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
700 # INPUT_FILTER) will be used to filter the input files when producing source
701 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
703 FILTER_SOURCE_FILES = NO
705 #---------------------------------------------------------------------------
706 # configuration options related to source browsing
707 #---------------------------------------------------------------------------
709 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
710 # be generated. Documented entities will be cross-referenced with these sources.
711 # Note: To get rid of all source code in the generated output, make sure also
712 # VERBATIM_HEADERS is set to NO.
716 # Setting the INLINE_SOURCES tag to YES will include the body
717 # of functions and classes directly in the documentation.
721 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
722 # doxygen to hide any special comment blocks from generated source code
723 # fragments. Normal C and C++ comments will always remain visible.
725 STRIP_CODE_COMMENTS = YES
727 # If the REFERENCED_BY_RELATION tag is set to YES
728 # then for each documented function all documented
729 # functions referencing it will be listed.
731 REFERENCED_BY_RELATION = YES
733 # If the REFERENCES_RELATION tag is set to YES
734 # then for each documented function all documented entities
735 # called/used by that function will be listed.
737 REFERENCES_RELATION = YES
739 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
740 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
741 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
742 # link to the source code.
743 # Otherwise they will link to the documentation.
745 REFERENCES_LINK_SOURCE = YES
747 # If the USE_HTAGS tag is set to YES then the references to source code
748 # will point to the HTML generated by the htags(1) tool instead of doxygen
749 # built-in source browser. The htags tool is part of GNU's global source
750 # tagging system (see http://www.gnu.org/software/global/global.html). You
751 # will need version 4.8.6 or higher.
755 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
756 # will generate a verbatim copy of the header file for each class for
757 # which an include is specified. Set to NO to disable this.
759 VERBATIM_HEADERS = YES
761 #---------------------------------------------------------------------------
762 # configuration options related to the alphabetical class index
763 #---------------------------------------------------------------------------
765 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
766 # of all compounds will be generated. Enable this if the project
767 # contains a lot of classes, structs, unions or interfaces.
769 ALPHABETICAL_INDEX = YES
771 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
772 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
773 # in which this list will be split (can be a number in the range [1..20])
775 COLS_IN_ALPHA_INDEX = 3
777 # In case all classes in a project start with a common prefix, all
778 # classes will be put under the same header in the alphabetical index.
779 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
780 # should be ignored while generating the index headers.
782 IGNORE_PREFIX = Purple \
786 #---------------------------------------------------------------------------
787 # configuration options related to the HTML output
788 #---------------------------------------------------------------------------
790 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
791 # generate HTML output.
795 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
796 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
797 # put in front of it. If left blank `html' will be used as the default path.
801 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
802 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
803 # doxygen will generate files with .html extension.
805 HTML_FILE_EXTENSION = .html
807 # The HTML_HEADER tag can be used to specify a personal HTML header for
808 # each generated HTML page. If it is left blank doxygen will generate a
811 HTML_HEADER = @top_srcdir@/doc/TracHeader.html
813 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
814 # each generated HTML page. If it is left blank doxygen will generate a
817 HTML_FOOTER = @top_srcdir@/doc/TracFooter.html
819 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
820 # style sheet that is used by each HTML page. It can be used to
821 # fine-tune the look of the HTML output. If the tag is left blank doxygen
822 # will generate a default style sheet. Note that doxygen will try to copy
823 # the style sheet file to the HTML output directory, so don't put your own
824 # stylesheet in the HTML output directory as well, or it will be erased!
828 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
829 # Doxygen will adjust the colors in the stylesheet and background images
830 # according to this color. Hue is specified as an angle on a colorwheel,
831 # see http://en.wikipedia.org/wiki/Hue for more information.
832 # For instance the value 0 represents red, 60 is yellow, 120 is green,
833 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
834 # The allowed range is 0 to 359.
836 HTML_COLORSTYLE_HUE = 220
838 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
839 # the colors in the HTML output. For a value of 0 the output will use
840 # grayscales only. A value of 255 will produce the most vivid colors.
842 HTML_COLORSTYLE_SAT = 100
844 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
845 # the luminance component of the colors in the HTML output. Values below
846 # 100 gradually make the output lighter, whereas values above 100 make
847 # the output darker. The value divided by 100 is the actual gamma applied,
848 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
849 # and 100 does not change the gamma.
851 HTML_COLORSTYLE_GAMMA = 80
853 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
854 # page will contain the date and time when the page was generated. Setting
855 # this to NO can help when comparing the output of multiple runs.
859 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
860 # files or namespaces will be aligned in HTML using tables. If set to
861 # NO a bullet list will be used.
863 HTML_ALIGN_MEMBERS = YES
865 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
866 # documentation will contain sections that can be hidden and shown after the
867 # page has loaded. For this to work a browser that supports
868 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
869 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
871 HTML_DYNAMIC_SECTIONS = NO
873 # If the GENERATE_DOCSET tag is set to YES, additional index files
874 # will be generated that can be used as input for Apple's Xcode 3
875 # integrated development environment, introduced with OSX 10.5 (Leopard).
876 # To create a documentation set, doxygen will generate a Makefile in the
877 # HTML output directory. Running make will produce the docset in that
878 # directory and running "make install" will install the docset in
879 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
881 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
882 # for more information.
886 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
887 # feed. A documentation feed provides an umbrella under which multiple
888 # documentation sets from a single provider (such as a company or product suite)
891 DOCSET_FEEDNAME = "Doxygen generated docs"
893 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
894 # should uniquely identify the documentation set bundle. This should be a
895 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
896 # will append .docset to the name.
898 DOCSET_BUNDLE_ID = org.doxygen.Project
900 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
901 # the documentation publisher. This should be a reverse domain-name style
902 # string, e.g. com.mycompany.MyDocSet.documentation.
904 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
906 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
908 DOCSET_PUBLISHER_NAME = Publisher
910 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
911 # will be generated that can be used as input for tools like the
912 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
913 # of the generated HTML documentation.
915 GENERATE_HTMLHELP = YES
917 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
918 # be used to specify the file name of the resulting .chm file. You
919 # can add a path in front of the file if the result should not be
920 # written to the html output directory.
924 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
925 # be used to specify the location (absolute path including file name) of
926 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
927 # the HTML help compiler on the generated index.hhp.
931 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
932 # controls if a separate .chi index file is generated (YES) or that
933 # it should be included in the master .chm file (NO).
937 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
938 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
943 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
944 # controls whether a binary table of contents is generated (YES) or a
945 # normal table of contents (NO) in the .chm file.
949 # The TOC_EXPAND flag can be set to YES to add extra items for group members
950 # to the contents of the HTML help documentation and to the tree view.
954 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
955 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
956 # that can be used as input for Qt's qhelpgenerator to generate a
957 # Qt Compressed Help (.qch) of the generated HTML documentation.
961 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
962 # be used to specify the file name of the resulting .qch file.
963 # The path specified is relative to the HTML output folder.
967 # The QHP_NAMESPACE tag specifies the namespace to use when generating
968 # Qt Help Project output. For more information please see
969 # http://doc.trolltech.com/qthelpproject.html#namespace
971 QHP_NAMESPACE = org.doxygen.Project
973 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
974 # Qt Help Project output. For more information please see
975 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
977 QHP_VIRTUAL_FOLDER = doc
979 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
980 # add. For more information please see
981 # http://doc.trolltech.com/qthelpproject.html#custom-filters
983 QHP_CUST_FILTER_NAME =
985 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
986 # custom filter to add. For more information please see
987 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
988 # Qt Help Project / Custom Filters</a>.
990 QHP_CUST_FILTER_ATTRS =
992 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
994 # filter section matches.
995 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
996 # Qt Help Project / Filter Attributes</a>.
998 QHP_SECT_FILTER_ATTRS =
1000 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1001 # be used to specify the location of Qt's qhelpgenerator.
1002 # If non-empty doxygen will try to run qhelpgenerator on the generated
1007 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1008 # will be generated, which together with the HTML files, form an Eclipse help
1009 # plugin. To install this plugin and make it available under the help contents
1010 # menu in Eclipse, the contents of the directory containing the HTML and XML
1011 # files needs to be copied into the plugins directory of eclipse. The name of
1012 # the directory within the plugins directory should be the same as
1013 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1016 GENERATE_ECLIPSEHELP = NO
1018 # A unique identifier for the eclipse help plugin. When installing the plugin
1019 # the directory name containing the HTML and XML files should also have
1022 ECLIPSE_DOC_ID = org.doxygen.Project
1024 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1025 # top of each HTML page. The value NO (the default) enables the index and
1026 # the value YES disables it.
1030 # This tag can be used to set the number of enum values (range [1..20])
1031 # that doxygen will group on one line in the generated HTML documentation.
1033 ENUM_VALUES_PER_LINE = 4
1035 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1036 # structure should be generated to display hierarchical information.
1037 # If the tag value is set to YES, a side panel will be generated
1038 # containing a tree-like index structure (just like the one that
1039 # is generated for HTML Help). For this to work a browser that supports
1040 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1041 # Windows users are probably better off using the HTML help feature.
1043 GENERATE_TREEVIEW = YES
1045 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1046 # and Class Hierarchy pages using a tree view instead of an ordered list.
1048 USE_INLINE_TREES = NO
1050 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1051 # used to set the initial width (in pixels) of the frame in which the tree
1054 TREEVIEW_WIDTH = 250
1056 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1057 # links to external symbols imported via tag files in a separate window.
1059 EXT_LINKS_IN_WINDOW = NO
1061 # Use this tag to change the font size of Latex formulas included
1062 # as images in the HTML documentation. The default is 10. Note that
1063 # when you change the font size after a successful doxygen run you need
1064 # to manually remove any form_*.png images from the HTML output directory
1065 # to force them to be regenerated.
1067 FORMULA_FONTSIZE = 10
1069 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1070 # generated for formulas are transparent PNGs. Transparent PNGs are
1071 # not supported properly for IE 6.0, but are supported on all modern browsers.
1072 # Note that when changing this option you need to delete any form_*.png files
1073 # in the HTML output before the changes have effect.
1075 FORMULA_TRANSPARENT = YES
1077 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1078 # for the HTML output. The underlying search engine uses javascript
1079 # and DHTML and should work on any modern browser. Note that when using
1080 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1081 # (GENERATE_DOCSET) there is already a search function so this one should
1082 # typically be disabled. For large projects the javascript based search engine
1083 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1087 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1088 # implemented using a PHP enabled web server instead of at the web client
1089 # using Javascript. Doxygen will generate the search PHP script and index
1090 # file to put on the web server. The advantage of the server
1091 # based approach is that it scales better to large projects and allows
1092 # full text search. The disadvances is that it is more difficult to setup
1093 # and does not have live searching capabilities.
1095 SERVER_BASED_SEARCH = NO
1097 #---------------------------------------------------------------------------
1098 # configuration options related to the LaTeX output
1099 #---------------------------------------------------------------------------
1101 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1102 # generate Latex output.
1106 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1107 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1108 # put in front of it. If left blank `latex' will be used as the default path.
1110 LATEX_OUTPUT = latex
1112 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1113 # invoked. If left blank `latex' will be used as the default command name.
1114 # Note that when enabling USE_PDFLATEX this option is only used for
1115 # generating bitmaps for formulas in the HTML output, but not in the
1116 # Makefile that is written to the output directory.
1118 LATEX_CMD_NAME = latex
1120 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1121 # generate index for LaTeX. If left blank `makeindex' will be used as the
1122 # default command name.
1124 MAKEINDEX_CMD_NAME = makeindex
1126 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1127 # LaTeX documents. This may be useful for small projects and may help to
1128 # save some trees in general.
1132 # The PAPER_TYPE tag can be used to set the paper type that is used
1133 # by the printer. Possible values are: a4, a4wide, letter, legal and
1134 # executive. If left blank a4wide will be used.
1138 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1139 # packages that should be included in the LaTeX output.
1143 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1144 # the generated latex document. The header should contain everything until
1145 # the first chapter. If it is left blank doxygen will generate a
1146 # standard header. Notice: only use this tag if you know what you are doing!
1150 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1151 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1152 # contain links (just like the HTML output) instead of page references
1153 # This makes the output suitable for online browsing using a pdf viewer.
1157 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1158 # plain latex in the generated Makefile. Set this option to YES to get a
1159 # higher quality PDF documentation.
1163 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1164 # command to the generated LaTeX files. This will instruct LaTeX to keep
1165 # running if errors occur, instead of asking the user for help.
1166 # This option is also used when generating formulas in HTML.
1168 LATEX_BATCHMODE = NO
1170 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1171 # include the index chapters (such as File Index, Compound Index, etc.)
1174 LATEX_HIDE_INDICES = NO
1176 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1177 # source code with syntax highlighting in the LaTeX output.
1178 # Note that which sources are shown also depends on other settings
1179 # such as SOURCE_BROWSER.
1181 LATEX_SOURCE_CODE = NO
1183 #---------------------------------------------------------------------------
1184 # configuration options related to the RTF output
1185 #---------------------------------------------------------------------------
1187 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1188 # The RTF output is optimized for Word 97 and may not look very pretty with
1189 # other RTF readers or editors.
1193 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1194 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1195 # put in front of it. If left blank `rtf' will be used as the default path.
1199 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1200 # RTF documents. This may be useful for small projects and may help to
1201 # save some trees in general.
1205 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1206 # will contain hyperlink fields. The RTF file will
1207 # contain links (just like the HTML output) instead of page references.
1208 # This makes the output suitable for online browsing using WORD or other
1209 # programs which support those fields.
1210 # Note: wordpad (write) and others do not support links.
1214 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1215 # config file, i.e. a series of assignments. You only have to provide
1216 # replacements, missing definitions are set to their default value.
1218 RTF_STYLESHEET_FILE =
1220 # Set optional variables used in the generation of an rtf document.
1221 # Syntax is similar to doxygen's config file.
1223 RTF_EXTENSIONS_FILE =
1225 #---------------------------------------------------------------------------
1226 # configuration options related to the man page output
1227 #---------------------------------------------------------------------------
1229 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1230 # generate man pages
1234 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1235 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1236 # put in front of it. If left blank `man' will be used as the default path.
1240 # The MAN_EXTENSION tag determines the extension that is added to
1241 # the generated man pages (default is the subroutine's section .3)
1245 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1246 # then it will generate one additional man file for each entity
1247 # documented in the real man page(s). These additional files
1248 # only source the real man page, but without them the man command
1249 # would be unable to find the correct page. The default is NO.
1253 #---------------------------------------------------------------------------
1254 # configuration options related to the XML output
1255 #---------------------------------------------------------------------------
1257 # If the GENERATE_XML tag is set to YES Doxygen will
1258 # generate an XML file that captures the structure of
1259 # the code including all documentation.
1263 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1264 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1265 # put in front of it. If left blank `xml' will be used as the default path.
1269 # The XML_SCHEMA tag can be used to specify an XML schema,
1270 # which can be used by a validating XML parser to check the
1271 # syntax of the XML files.
1275 # The XML_DTD tag can be used to specify an XML DTD,
1276 # which can be used by a validating XML parser to check the
1277 # syntax of the XML files.
1281 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1282 # dump the program listings (including syntax highlighting
1283 # and cross-referencing information) to the XML output. Note that
1284 # enabling this will significantly increase the size of the XML output.
1286 XML_PROGRAMLISTING = YES
1288 #---------------------------------------------------------------------------
1289 # configuration options for the AutoGen Definitions output
1290 #---------------------------------------------------------------------------
1292 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1293 # generate an AutoGen Definitions (see autogen.sf.net) file
1294 # that captures the structure of the code including all
1295 # documentation. Note that this feature is still experimental
1296 # and incomplete at the moment.
1298 GENERATE_AUTOGEN_DEF = NO
1300 #---------------------------------------------------------------------------
1301 # configuration options related to the Perl module output
1302 #---------------------------------------------------------------------------
1304 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1305 # generate a Perl module file that captures the structure of
1306 # the code including all documentation. Note that this
1307 # feature is still experimental and incomplete at the
1310 GENERATE_PERLMOD = NO
1312 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1313 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1314 # to generate PDF and DVI output from the Perl module output.
1318 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1319 # nicely formatted so it can be parsed by a human reader.
1321 # if you want to understand what is going on.
1322 # On the other hand, if this
1323 # tag is set to NO the size of the Perl module output will be much smaller
1324 # and Perl will parse it just the same.
1326 PERLMOD_PRETTY = YES
1328 # The names of the make variables in the generated doxyrules.make file
1329 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1330 # This is useful so different doxyrules.make files included by the same
1331 # Makefile don't overwrite each other's variables.
1333 PERLMOD_MAKEVAR_PREFIX =
1335 #---------------------------------------------------------------------------
1336 # Configuration options related to the preprocessor
1337 #---------------------------------------------------------------------------
1339 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1340 # evaluate all C-preprocessor directives found in the sources and include
1343 ENABLE_PREPROCESSING = YES
1345 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1346 # names in the source code. If set to NO (the default) only conditional
1347 # compilation will be performed. Macro expansion can be done in a controlled
1348 # way by setting EXPAND_ONLY_PREDEF to YES.
1350 MACRO_EXPANSION = NO
1352 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1353 # then the macro expansion is limited to the macros specified with the
1354 # PREDEFINED and EXPAND_AS_DEFINED tags.
1356 EXPAND_ONLY_PREDEF = NO
1358 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1359 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1361 SEARCH_INCLUDES = YES
1363 # The INCLUDE_PATH tag can be used to specify one or more directories that
1364 # contain include files that are not input files but should be processed by
1369 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1370 # patterns (like *.h and *.hpp) to filter out the header-files in the
1371 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1374 INCLUDE_FILE_PATTERNS =
1376 # The PREDEFINED tag can be used to specify one or more macro names that
1377 # are defined before the preprocessor is started (similar to the -D option of
1378 # gcc). The argument of the tag is a list of macros of the form: name
1379 # or name=definition (no spaces). If the definition and the = are
1380 # omitted =1 is assumed. To prevent a macro definition from being
1381 # undefined via #undef or recursively expanded use the := operator
1382 # instead of the = operator.
1386 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1387 # this tag can be used to specify a list of macro names that should be expanded.
1388 # The macro definition that is found in the sources will be used.
1389 # Use the PREDEFINED tag if you want to use a different macro definition.
1393 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1394 # doxygen's preprocessor will remove all function-like macros that are alone
1395 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1396 # function macros are typically used for boiler-plate code, and will confuse
1397 # the parser if not removed.
1399 SKIP_FUNCTION_MACROS = YES
1401 #---------------------------------------------------------------------------
1402 # Configuration::additions related to external references
1403 #---------------------------------------------------------------------------
1405 # The TAGFILES option can be used to specify one or more tagfiles.
1406 # Optionally an initial location of the external documentation
1407 # can be added for each tagfile. The format of a tag file without
1408 # this location is as follows:
1410 # TAGFILES = file1 file2 ...
1411 # Adding location for the tag files is done as follows:
1413 # TAGFILES = file1=loc1 "file2 = loc2" ...
1414 # where "loc1" and "loc2" can be relative or absolute paths or
1415 # URLs. If a location is present for each tag, the installdox tool
1416 # does not have to be run to correct the links.
1417 # Note that each tag file must have a unique name
1418 # (where the name does NOT include the path)
1419 # If a tag file is not located in the directory in which doxygen
1420 # is run, you must also specify the path to the tagfile here.
1424 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1425 # a tag file that is based on the input files it reads.
1429 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1430 # in the class index. If set to NO only the inherited external classes
1435 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1436 # in the modules index. If set to NO, only the current project's groups will
1439 EXTERNAL_GROUPS = YES
1441 # The PERL_PATH should be the absolute path and name of the perl script
1442 # interpreter (i.e. the result of `which perl').
1444 PERL_PATH = /usr/bin/perl
1446 #---------------------------------------------------------------------------
1447 # Configuration options related to the dot tool
1448 #---------------------------------------------------------------------------
1450 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1451 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1452 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1453 # this option is superseded by the HAVE_DOT option below. This is only a
1454 # fallback. It is recommended to install and use dot, since it yields more
1457 CLASS_DIAGRAMS = YES
1459 # You can define message sequence charts within doxygen comments using the \msc
1460 # command. Doxygen will then run the mscgen tool (see
1461 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1462 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1463 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1464 # default search path.
1468 # If set to YES, the inheritance and collaboration graphs will hide
1469 # inheritance and usage relations if the target is undocumented
1470 # or is not a class.
1472 HIDE_UNDOC_RELATIONS = YES
1474 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1475 # available from the path. This tool is part of Graphviz, a graph visualization
1476 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1477 # have no effect if this option is set to NO (the default)
1479 HAVE_DOT = @enable_dot@
1481 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1482 # allowed to run in parallel. When set to 0 (the default) doxygen will
1483 # base this on the number of processors available in the system. You can set it
1484 # explicitly to a value larger than 0 to get control over the balance
1485 # between CPU load and processing speed.
1489 # By default doxygen will write a font called FreeSans.ttf to the output
1490 # directory and reference it in all dot files that doxygen generates. This
1491 # font does not include all possible unicode characters however, so when you need
1492 # these (or just want a differently looking font) you can specify the font name
1493 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1494 # which can be done by putting it in a standard location or by setting the
1495 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1496 # containing the font.
1498 DOT_FONTNAME = FreeSans.ttf
1500 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1501 # The default size is 10pt.
1505 # By default doxygen will tell dot to use the output directory to look for the
1506 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1507 # different font using DOT_FONTNAME you can set the path where dot
1508 # can find it using this tag.
1512 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1513 # will generate a graph for each documented class showing the direct and
1514 # indirect inheritance relations. Setting this tag to YES will force the
1515 # the CLASS_DIAGRAMS tag to NO.
1519 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1520 # will generate a graph for each documented class showing the direct and
1521 # indirect implementation dependencies (inheritance, containment, and
1522 # class references variables) of the class with other documented classes.
1524 COLLABORATION_GRAPH = YES
1526 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1527 # will generate a graph for groups, showing the direct groups dependencies
1531 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1532 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1537 # If set to YES, the inheritance and collaboration graphs will show the
1538 # relations between templates and their instances.
1540 TEMPLATE_RELATIONS = YES
1542 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1543 # tags are set to YES then doxygen will generate a graph for each documented
1544 # file showing the direct and indirect include dependencies of the file with
1545 # other documented files.
1549 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1550 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1551 # documented header file showing the documented files that directly or
1552 # indirectly include this file.
1554 INCLUDED_BY_GRAPH = YES
1556 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1557 # doxygen will generate a call dependency graph for every global function
1558 # or class method. Note that enabling this option will significantly increase
1559 # the time of a run. So in most cases it will be better to enable call graphs
1560 # for selected functions only using the \callgraph command.
1564 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1565 # doxygen will generate a caller dependency graph for every global function
1566 # or class method. Note that enabling this option will significantly increase
1567 # the time of a run. So in most cases it will be better to enable caller
1568 # graphs for selected functions only using the \callergraph command.
1572 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1573 # will graphical hierarchy of all classes instead of a textual one.
1575 GRAPHICAL_HIERARCHY = YES
1577 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1578 # then doxygen will show the dependencies a directory has on other directories
1579 # in a graphical way. The dependency relations are determined by the #include
1580 # relations between the files in the directories.
1582 DIRECTORY_GRAPH = YES
1584 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1585 # generated by dot. Possible values are png, jpg, or gif
1586 # If left blank png will be used.
1588 DOT_IMAGE_FORMAT = png
1590 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1591 # found. If left blank, it is assumed the dot tool can be found in the path.
1595 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1596 # contain dot files that are included in the documentation (see the
1597 # \dotfile command).
1601 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1602 # nodes that will be shown in the graph. If the number of nodes in a graph
1603 # becomes larger than this value, doxygen will truncate the graph, which is
1604 # visualized by representing a node as a red box. Note that doxygen if the
1605 # number of direct children of the root node in a graph is already larger than
1606 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1607 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1609 DOT_GRAPH_MAX_NODES = 50
1611 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1612 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1613 # from the root by following a path via at most 3 edges will be shown. Nodes
1614 # that lay further from the root node will be omitted. Note that setting this
1615 # option to 1 or 2 may greatly reduce the computation time needed for large
1616 # code bases. Also note that the size of a graph can be further restricted by
1617 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1619 MAX_DOT_GRAPH_DEPTH = 2
1621 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1622 # background. This is disabled by default, because dot on Windows does not
1623 # seem to support this out of the box. Warning: Depending on the platform used,
1624 # enabling this option may lead to badly anti-aliased labels on the edges of
1625 # a graph (i.e. they become hard to read).
1627 DOT_TRANSPARENT = NO
1629 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1630 # files in one run (i.e. multiple -o and -T options on the command line). This
1631 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1632 # support this, this feature is disabled by default.
1634 DOT_MULTI_TARGETS = YES
1636 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1637 # generate a legend page explaining the meaning of the various boxes and
1638 # arrows in the dot generated graphs.
1640 GENERATE_LEGEND = YES
1642 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1643 # remove the intermediate dot files that are used to generate
1644 # the various graphs.