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 that
18 # follow. The default is UTF-8 which is also the encoding used for all text before
19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
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 = "Quassel IRC"
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 = Pre-Release
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, Finnish, French, German, Greek, Hungarian,
58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
62 OUTPUT_LANGUAGE = English
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65 # include brief member descriptions after the members that are listed in
66 # the file and class documentation (similar to JavaDoc).
67 # Set to NO to disable this.
69 BRIEF_MEMBER_DESC = YES
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72 # the brief description of a member or function before the detailed description.
73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74 # brief descriptions will be completely suppressed.
78 # This tag implements a quasi-intelligent brief description abbreviator
79 # that is used to form the text in various listings. Each string
80 # in this list, if found as the leading text of the brief description, will be
81 # stripped from the text and the result after processing the whole list, is
82 # used as the annotated text. Otherwise, the brief description is used as-is.
83 # If left blank, the following values are used ("$name" is automatically
84 # replaced with the name of the entity): "The $name class" "The $name widget"
85 # "The $name file" "is" "provides" "specifies" "contains"
86 # "represents" "a" "an" "the"
88 ABBREVIATE_BRIEF = "The $name class" \
100 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
101 # Doxygen will generate a detailed section even if there is only a brief
104 ALWAYS_DETAILED_SEC = NO
106 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
107 # inherited members of a class in the documentation of that class as if those
108 # members were ordinary class members. Constructors, destructors and assignment
109 # operators of the base classes will not be shown.
111 INLINE_INHERITED_MEMB = YES
113 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
114 # path before files name in the file list and in the header files. If set
115 # to NO the shortest path that makes the file name unique will be used.
119 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
120 # can be used to strip a user-defined part of the path. Stripping is
121 # only done if one of the specified strings matches the left-hand part of
122 # the path. The tag can be used to show relative paths in the file list.
123 # If left blank the directory from which doxygen is run is used as the
128 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
129 # the path mentioned in the documentation of a class, which tells
130 # the reader which header file to include in order to use a class.
131 # If left blank only the name of the header file containing the class
132 # definition is used. Otherwise one should specify the include paths that
133 # are normally passed to the compiler using the -I flag.
135 STRIP_FROM_INC_PATH = /home/sputnick/devel/local-quassel/
137 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
138 # (but less readable) file names. This can be useful is your file systems
139 # doesn't support long names like on DOS, Mac, or CD-ROM.
143 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
144 # will interpret the first line (until the first dot) of a JavaDoc-style
145 # comment as the brief description. If set to NO, the JavaDoc
146 # comments will behave just like the Qt-style comments (thus requiring an
147 # explicit @brief command for a brief description.
149 JAVADOC_AUTOBRIEF = NO
151 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
152 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
153 # comments) as a brief description. This used to be the default behaviour.
154 # The new default is to treat a multi-line C++ comment block as a detailed
155 # description. Set this tag to YES if you prefer the old behaviour instead.
157 MULTILINE_CPP_IS_BRIEF = NO
159 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
160 # will output the detailed description near the top, like JavaDoc.
161 # If set to NO, the detailed description appears after the member
166 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
167 # member inherits the documentation from any documented member that it
172 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
173 # a new page for each member. If set to NO, the documentation of a member will
174 # be part of the file/class/namespace that contains it.
176 SEPARATE_MEMBER_PAGES = NO
178 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
179 # Doxygen uses this value to replace tabs by spaces in code fragments.
183 # This tag can be used to specify a number of aliases that acts
184 # as commands in the documentation. An alias has the form "name=value".
185 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
186 # put the command \sideeffect (or @sideeffect) in the documentation, which
187 # will result in a user-defined paragraph with heading "Side Effects:".
188 # You can put \n's in the value part of an alias to insert newlines.
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 = NO
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 Java.
201 # For instance, namespaces will be presented as packages, qualified scopes
202 # will look different, etc.
204 OPTIMIZE_OUTPUT_JAVA = NO
206 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
207 # include (a tag file for) the STL sources as input, then you should
208 # set this tag to YES in order to let doxygen match functions declarations and
209 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
210 # func(std::string) {}). This also make the inheritance and collaboration
211 # diagrams that involve STL classes more complete and accurate.
213 BUILTIN_STL_SUPPORT = NO
215 # If you use Microsoft's C++/CLI language, you should set this option to YES to
216 # enable parsing support.
220 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
221 # tag is set to YES, then doxygen will reuse the documentation of the first
222 # member in the group (if any) for the other members of the group. By default
223 # all members of a group must be documented explicitly.
225 DISTRIBUTE_GROUP_DOC = YES
227 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
228 # the same type (for instance a group of public functions) to be put as a
229 # subgroup of that type (e.g. under the Public Functions section). Set it to
230 # NO to prevent subgrouping. Alternatively, this can be done per class using
231 # the \nosubgrouping command.
235 #---------------------------------------------------------------------------
236 # Build related configuration options
237 #---------------------------------------------------------------------------
239 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
240 # documentation are documented, even if no documentation was available.
241 # Private class members and static file members will be hidden unless
242 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
246 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
247 # will be included in the documentation.
249 EXTRACT_PRIVATE = YES
251 # If the EXTRACT_STATIC tag is set to YES all static members of a file
252 # will be included in the documentation.
256 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
257 # defined locally in source files will be included in the documentation.
258 # If set to NO only classes defined in header files are included.
260 EXTRACT_LOCAL_CLASSES = NO
262 # This flag is only useful for Objective-C code. When set to YES local
263 # methods, which are defined in the implementation section but not in
264 # the interface are included in the documentation.
265 # If set to NO (the default) only methods in the interface are included.
267 EXTRACT_LOCAL_METHODS = NO
269 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
270 # undocumented members of documented classes, files or namespaces.
271 # If set to NO (the default) these members will be included in the
272 # various overviews, but no documentation section is generated.
273 # This option has no effect if EXTRACT_ALL is enabled.
275 HIDE_UNDOC_MEMBERS = NO
277 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
278 # undocumented classes that are normally visible in the class hierarchy.
279 # If set to NO (the default) these classes will be included in the various
280 # overviews. This option has no effect if EXTRACT_ALL is enabled.
282 HIDE_UNDOC_CLASSES = NO
284 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
285 # friend (class|struct|union) declarations.
286 # If set to NO (the default) these declarations will be included in the
289 HIDE_FRIEND_COMPOUNDS = NO
291 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
292 # documentation blocks found inside the body of a function.
293 # If set to NO (the default) these blocks will be appended to the
294 # function's detailed documentation block.
296 HIDE_IN_BODY_DOCS = NO
298 # The INTERNAL_DOCS tag determines if documentation
299 # that is typed after a \internal command is included. If the tag is set
300 # to NO (the default) then the documentation will be excluded.
301 # Set it to YES to include the internal documentation.
305 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
306 # file names in lower-case letters. If set to YES upper-case letters are also
307 # allowed. This is useful if you have classes or files whose names only differ
308 # in case and if your file system supports case sensitive file names. Windows
309 # and Mac users are advised to set this option to NO.
311 CASE_SENSE_NAMES = YES
313 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
314 # will show members with their full class and namespace scopes in the
315 # documentation. If set to YES the scope will be hidden.
317 HIDE_SCOPE_NAMES = YES
319 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
320 # will put a list of the files that are included by a file in the documentation
323 SHOW_INCLUDE_FILES = YES
325 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
326 # is inserted in the documentation for inline members.
330 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
331 # will sort the (detailed) documentation of file and class members
332 # alphabetically by member name. If set to NO the members will appear in
335 SORT_MEMBER_DOCS = NO
337 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
338 # brief documentation of file, namespace and class members alphabetically
339 # by member name. If set to NO (the default) the members will appear in
344 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
345 # sorted by fully-qualified names, including namespaces. If set to
346 # NO (the default), the class list will be sorted only by class name,
347 # not including the namespace part.
348 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
349 # Note: This option applies only to the class list, not to the
352 SORT_BY_SCOPE_NAME = NO
354 # The GENERATE_TODOLIST tag can be used to enable (YES) or
355 # disable (NO) the todo list. This list is created by putting \todo
356 # commands in the documentation.
358 GENERATE_TODOLIST = YES
360 # The GENERATE_TESTLIST tag can be used to enable (YES) or
361 # disable (NO) the test list. This list is created by putting \test
362 # commands in the documentation.
364 GENERATE_TESTLIST = YES
366 # The GENERATE_BUGLIST tag can be used to enable (YES) or
367 # disable (NO) the bug list. This list is created by putting \bug
368 # commands in the documentation.
370 GENERATE_BUGLIST = YES
372 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
373 # disable (NO) the deprecated list. This list is created by putting
374 # \deprecated commands in the documentation.
376 GENERATE_DEPRECATEDLIST= YES
378 # The ENABLED_SECTIONS tag can be used to enable conditional
379 # documentation sections, marked by \if sectionname ... \endif.
383 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
384 # the initial value of a variable or define consists of for it to appear in
385 # the documentation. If the initializer consists of more lines than specified
386 # here it will be hidden. Use a value of 0 to hide initializers completely.
387 # The appearance of the initializer of individual variables and defines in the
388 # documentation can be controlled using \showinitializer or \hideinitializer
389 # command in the documentation regardless of this setting.
391 MAX_INITIALIZER_LINES = 30
393 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
394 # at the bottom of the documentation of classes and structs. If set to YES the
395 # list will mention the files that were used to generate the documentation.
397 SHOW_USED_FILES = YES
399 # If the sources in your project are distributed over multiple directories
400 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
401 # in the documentation. The default is NO.
403 SHOW_DIRECTORIES = YES
405 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
406 # doxygen should invoke to get the current version for each file (typically from the
407 # version control system). Doxygen will invoke the program by executing (via
408 # popen()) the command <command> <input-file>, where <command> is the value of
409 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
410 # provided by doxygen. Whatever the program writes to standard output
411 # is used as the file version. See the manual for examples.
413 FILE_VERSION_FILTER =
415 #---------------------------------------------------------------------------
416 # configuration options related to warning and progress messages
417 #---------------------------------------------------------------------------
419 # The QUIET tag can be used to turn on/off the messages that are generated
420 # by doxygen. Possible values are YES and NO. If left blank NO is used.
424 # The WARNINGS tag can be used to turn on/off the warning messages that are
425 # generated by doxygen. Possible values are YES and NO. If left blank
430 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
431 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
432 # automatically be disabled.
434 WARN_IF_UNDOCUMENTED = YES
436 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
437 # potential errors in the documentation, such as not documenting some
438 # parameters in a documented function, or documenting parameters that
439 # don't exist or using markup commands wrongly.
441 WARN_IF_DOC_ERROR = YES
443 # This WARN_NO_PARAMDOC option can be abled to get warnings for
444 # functions that are documented, but have no documentation for their parameters
445 # or return value. If set to NO (the default) doxygen will only warn about
446 # wrong or incomplete parameter documentation, but not about the absence of
449 WARN_NO_PARAMDOC = NO
451 # The WARN_FORMAT tag determines the format of the warning messages that
452 # doxygen can produce. The string should contain the $file, $line, and $text
453 # tags, which will be replaced by the file and line number from which the
454 # warning originated and the warning text. Optionally the format may contain
455 # $version, which will be replaced by the version of the file (if it could
456 # be obtained via FILE_VERSION_FILTER)
458 WARN_FORMAT = "$file:$line: $text"
460 # The WARN_LOGFILE tag can be used to specify a file to which warning
461 # and error messages should be written. If left blank the output is written
466 #---------------------------------------------------------------------------
467 # configuration options related to the input files
468 #---------------------------------------------------------------------------
470 # The INPUT tag can be used to specify the files and/or directories that contain
471 # documented source files. You may enter file names like "myfile.cpp" or
472 # directories like "/usr/src/myproject". Separate the files or directories
477 # This tag can be used to specify the character encoding of the source files that
478 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
479 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
480 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
482 INPUT_ENCODING = UTF-8
484 # If the value of the INPUT tag contains directories, you can use the
485 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
486 # and *.h) to filter out the source-files in the directories. If left
487 # blank the following patterns are tested:
488 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
489 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
491 FILE_PATTERNS = *.c \
538 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
539 # should be searched for input files as well. Possible values are YES and NO.
540 # If left blank NO is used.
544 # The EXCLUDE tag can be used to specify files and/or directories that should
545 # excluded from the INPUT source files. This way you can easily exclude a
546 # subdirectory from a directory tree whose root is specified with the INPUT tag.
550 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
551 # directories that are symbolic links (a Unix filesystem feature) are excluded
554 EXCLUDE_SYMLINKS = NO
556 # If the value of the INPUT tag contains directories, you can use the
557 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
558 # certain files from those directories. Note that the wildcards are matched
559 # against the file with absolute path, so to exclude all test directories
560 # for example use the pattern */test/*
564 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
565 # (namespaces, classes, functions, etc.) that should be excluded from the output.
566 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
567 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
571 # The EXAMPLE_PATH tag can be used to specify one or more files or
572 # directories that contain example code fragments that are included (see
573 # the \include command).
577 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
578 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
579 # and *.h) to filter out the source-files in the directories. If left
580 # blank all files are included.
584 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
585 # searched for input files to be used with the \include or \dontinclude
586 # commands irrespective of the value of the RECURSIVE tag.
587 # Possible values are YES and NO. If left blank NO is used.
589 EXAMPLE_RECURSIVE = NO
591 # The IMAGE_PATH tag can be used to specify one or more files or
592 # directories that contain image that are included in the documentation (see
593 # the \image command).
597 # The INPUT_FILTER tag can be used to specify a program that doxygen should
598 # invoke to filter for each input file. Doxygen will invoke the filter program
599 # by executing (via popen()) the command <filter> <input-file>, where <filter>
600 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
601 # input file. Doxygen will then use the output that the filter program writes
602 # to standard output. If FILTER_PATTERNS is specified, this tag will be
607 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
608 # basis. Doxygen will compare the file name with each pattern and apply the
609 # filter if there is a match. The filters are a list of the form:
610 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
611 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
612 # is applied to all files.
616 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
617 # INPUT_FILTER) will be used to filter the input files when producing source
618 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
620 FILTER_SOURCE_FILES = YES
622 #---------------------------------------------------------------------------
623 # configuration options related to source browsing
624 #---------------------------------------------------------------------------
626 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
627 # be generated. Documented entities will be cross-referenced with these sources.
628 # Note: To get rid of all source code in the generated output, make sure also
629 # VERBATIM_HEADERS is set to NO.
633 # Setting the INLINE_SOURCES tag to YES will include the body
634 # of functions and classes directly in the documentation.
638 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
639 # doxygen to hide any special comment blocks from generated source code
640 # fragments. Normal C and C++ comments will always remain visible.
642 STRIP_CODE_COMMENTS = YES
644 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
645 # then for each documented function all documented
646 # functions referencing it will be listed.
648 REFERENCED_BY_RELATION = YES
650 # If the REFERENCES_RELATION tag is set to YES (the default)
651 # then for each documented function all documented entities
652 # called/used by that function will be listed.
654 REFERENCES_RELATION = YES
656 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
657 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
658 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
659 # link to the source code. Otherwise they will link to the documentstion.
661 REFERENCES_LINK_SOURCE = YES
663 # If the USE_HTAGS tag is set to YES then the references to source code
664 # will point to the HTML generated by the htags(1) tool instead of doxygen
665 # built-in source browser. The htags tool is part of GNU's global source
666 # tagging system (see http://www.gnu.org/software/global/global.html). You
667 # will need version 4.8.6 or higher.
671 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
672 # will generate a verbatim copy of the header file for each class for
673 # which an include is specified. Set to NO to disable this.
675 VERBATIM_HEADERS = YES
677 #---------------------------------------------------------------------------
678 # configuration options related to the alphabetical class index
679 #---------------------------------------------------------------------------
681 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
682 # of all compounds will be generated. Enable this if the project
683 # contains a lot of classes, structs, unions or interfaces.
685 ALPHABETICAL_INDEX = YES
687 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
688 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
689 # in which this list will be split (can be a number in the range [1..20])
691 COLS_IN_ALPHA_INDEX = 5
693 # In case all classes in a project start with a common prefix, all
694 # classes will be put under the same header in the alphabetical index.
695 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
696 # should be ignored while generating the index headers.
700 #---------------------------------------------------------------------------
701 # configuration options related to the HTML output
702 #---------------------------------------------------------------------------
704 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
705 # generate HTML output.
709 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
710 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
711 # put in front of it. If left blank `html' will be used as the default path.
715 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
716 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
717 # doxygen will generate files with .html extension.
719 HTML_FILE_EXTENSION = .html
721 # The HTML_HEADER tag can be used to specify a personal HTML header for
722 # each generated HTML page. If it is left blank doxygen will generate a
727 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
728 # each generated HTML page. If it is left blank doxygen will generate a
733 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
734 # style sheet that is used by each HTML page. It can be used to
735 # fine-tune the look of the HTML output. If the tag is left blank doxygen
736 # will generate a default style sheet. Note that doxygen will try to copy
737 # the style sheet file to the HTML output directory, so don't put your own
738 # stylesheet in the HTML output directory as well, or it will be erased!
742 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
743 # files or namespaces will be aligned in HTML using tables. If set to
744 # NO a bullet list will be used.
746 HTML_ALIGN_MEMBERS = YES
748 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
749 # will be generated that can be used as input for tools like the
750 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
751 # of the generated HTML documentation.
753 GENERATE_HTMLHELP = NO
755 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
756 # be used to specify the file name of the resulting .chm file. You
757 # can add a path in front of the file if the result should not be
758 # written to the html output directory.
762 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
763 # be used to specify the location (absolute path including file name) of
764 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
765 # the HTML help compiler on the generated index.hhp.
769 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
770 # controls if a separate .chi index file is generated (YES) or that
771 # it should be included in the master .chm file (NO).
775 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
776 # controls whether a binary table of contents is generated (YES) or a
777 # normal table of contents (NO) in the .chm file.
781 # The TOC_EXPAND flag can be set to YES to add extra items for group members
782 # to the contents of the HTML help documentation and to the tree view.
786 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
787 # top of each HTML page. The value NO (the default) enables the index and
788 # the value YES disables it.
792 # This tag can be used to set the number of enum values (range [1..20])
793 # that doxygen will group on one line in the generated HTML documentation.
795 ENUM_VALUES_PER_LINE = 4
797 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
798 # generated containing a tree-like index structure (just like the one that
799 # is generated for HTML Help). For this to work a browser that supports
800 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
801 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
802 # probably better off using the HTML help feature.
804 GENERATE_TREEVIEW = NO
806 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
807 # used to set the initial width (in pixels) of the frame in which the tree
812 #---------------------------------------------------------------------------
813 # configuration options related to the LaTeX output
814 #---------------------------------------------------------------------------
816 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
817 # generate Latex output.
821 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
822 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
823 # put in front of it. If left blank `latex' will be used as the default path.
827 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
828 # invoked. If left blank `latex' will be used as the default command name.
830 LATEX_CMD_NAME = latex
832 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
833 # generate index for LaTeX. If left blank `makeindex' will be used as the
834 # default command name.
836 MAKEINDEX_CMD_NAME = makeindex
838 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
839 # LaTeX documents. This may be useful for small projects and may help to
840 # save some trees in general.
844 # The PAPER_TYPE tag can be used to set the paper type that is used
845 # by the printer. Possible values are: a4, a4wide, letter, legal and
846 # executive. If left blank a4wide will be used.
850 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
851 # packages that should be included in the LaTeX output.
855 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
856 # the generated latex document. The header should contain everything until
857 # the first chapter. If it is left blank doxygen will generate a
858 # standard header. Notice: only use this tag if you know what you are doing!
862 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
863 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
864 # contain links (just like the HTML output) instead of page references
865 # This makes the output suitable for online browsing using a pdf viewer.
869 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
870 # plain latex in the generated Makefile. Set this option to YES to get a
871 # higher quality PDF documentation.
875 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
876 # command to the generated LaTeX files. This will instruct LaTeX to keep
877 # running if errors occur, instead of asking the user for help.
878 # This option is also used when generating formulas in HTML.
882 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
883 # include the index chapters (such as File Index, Compound Index, etc.)
886 LATEX_HIDE_INDICES = NO
888 #---------------------------------------------------------------------------
889 # configuration options related to the RTF output
890 #---------------------------------------------------------------------------
892 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
893 # The RTF output is optimized for Word 97 and may not look very pretty with
894 # other RTF readers or editors.
898 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
899 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
900 # put in front of it. If left blank `rtf' will be used as the default path.
904 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
905 # RTF documents. This may be useful for small projects and may help to
906 # save some trees in general.
910 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
911 # will contain hyperlink fields. The RTF file will
912 # contain links (just like the HTML output) instead of page references.
913 # This makes the output suitable for online browsing using WORD or other
914 # programs which support those fields.
915 # Note: wordpad (write) and others do not support links.
919 # Load stylesheet definitions from file. Syntax is similar to doxygen's
920 # config file, i.e. a series of assignments. You only have to provide
921 # replacements, missing definitions are set to their default value.
923 RTF_STYLESHEET_FILE =
925 # Set optional variables used in the generation of an rtf document.
926 # Syntax is similar to doxygen's config file.
928 RTF_EXTENSIONS_FILE =
930 #---------------------------------------------------------------------------
931 # configuration options related to the man page output
932 #---------------------------------------------------------------------------
934 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
939 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
940 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
941 # put in front of it. If left blank `man' will be used as the default path.
945 # The MAN_EXTENSION tag determines the extension that is added to
946 # the generated man pages (default is the subroutine's section .3)
950 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
951 # then it will generate one additional man file for each entity
952 # documented in the real man page(s). These additional files
953 # only source the real man page, but without them the man command
954 # would be unable to find the correct page. The default is NO.
958 #---------------------------------------------------------------------------
959 # configuration options related to the XML output
960 #---------------------------------------------------------------------------
962 # If the GENERATE_XML tag is set to YES Doxygen will
963 # generate an XML file that captures the structure of
964 # the code including all documentation.
968 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
969 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
970 # put in front of it. If left blank `xml' will be used as the default path.
974 # The XML_SCHEMA tag can be used to specify an XML schema,
975 # which can be used by a validating XML parser to check the
976 # syntax of the XML files.
980 # The XML_DTD tag can be used to specify an XML DTD,
981 # which can be used by a validating XML parser to check the
982 # syntax of the XML files.
986 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
987 # dump the program listings (including syntax highlighting
988 # and cross-referencing information) to the XML output. Note that
989 # enabling this will significantly increase the size of the XML output.
991 XML_PROGRAMLISTING = YES
993 #---------------------------------------------------------------------------
994 # configuration options for the AutoGen Definitions output
995 #---------------------------------------------------------------------------
997 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
998 # generate an AutoGen Definitions (see autogen.sf.net) file
999 # that captures the structure of the code including all
1000 # documentation. Note that this feature is still experimental
1001 # and incomplete at the moment.
1003 GENERATE_AUTOGEN_DEF = NO
1005 #---------------------------------------------------------------------------
1006 # configuration options related to the Perl module output
1007 #---------------------------------------------------------------------------
1009 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1010 # generate a Perl module file that captures the structure of
1011 # the code including all documentation. Note that this
1012 # feature is still experimental and incomplete at the
1015 GENERATE_PERLMOD = NO
1017 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1018 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1019 # to generate PDF and DVI output from the Perl module output.
1023 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1024 # nicely formatted so it can be parsed by a human reader. This is useful
1025 # if you want to understand what is going on. On the other hand, if this
1026 # tag is set to NO the size of the Perl module output will be much smaller
1027 # and Perl will parse it just the same.
1029 PERLMOD_PRETTY = YES
1031 # The names of the make variables in the generated doxyrules.make file
1032 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1033 # This is useful so different doxyrules.make files included by the same
1034 # Makefile don't overwrite each other's variables.
1036 PERLMOD_MAKEVAR_PREFIX =
1038 #---------------------------------------------------------------------------
1039 # Configuration options related to the preprocessor
1040 #---------------------------------------------------------------------------
1042 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1043 # evaluate all C-preprocessor directives found in the sources and include
1046 ENABLE_PREPROCESSING = YES
1048 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1049 # names in the source code. If set to NO (the default) only conditional
1050 # compilation will be performed. Macro expansion can be done in a controlled
1051 # way by setting EXPAND_ONLY_PREDEF to YES.
1053 MACRO_EXPANSION = YES
1055 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1056 # then the macro expansion is limited to the macros specified with the
1057 # PREDEFINED and EXPAND_AS_DEFINED tags.
1059 EXPAND_ONLY_PREDEF = NO
1061 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1062 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1064 SEARCH_INCLUDES = YES
1066 # The INCLUDE_PATH tag can be used to specify one or more directories that
1067 # contain include files that are not input files but should be processed by
1070 INCLUDE_PATH = /usr/include/qt4
1072 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1073 # patterns (like *.h and *.hpp) to filter out the header-files in the
1074 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1077 INCLUDE_FILE_PATTERNS =
1079 # The PREDEFINED tag can be used to specify one or more macro names that
1080 # are defined before the preprocessor is started (similar to the -D option of
1081 # gcc). The argument of the tag is a list of macros of the form: name
1082 # or name=definition (no spaces). If the definition and the = are
1083 # omitted =1 is assumed. To prevent a macro definition from being
1084 # undefined via #undef or recursively expanded use the := operator
1085 # instead of the = operator.
1089 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1090 # this tag can be used to specify a list of macro names that should be expanded.
1091 # The macro definition that is found in the sources will be used.
1092 # Use the PREDEFINED tag if you want to use a different macro definition.
1096 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1097 # doxygen's preprocessor will remove all function-like macros that are alone
1098 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1099 # function macros are typically used for boiler-plate code, and will confuse
1100 # the parser if not removed.
1102 SKIP_FUNCTION_MACROS = NO
1104 #---------------------------------------------------------------------------
1105 # Configuration::additions related to external references
1106 #---------------------------------------------------------------------------
1108 # The TAGFILES option can be used to specify one or more tagfiles.
1109 # Optionally an initial location of the external documentation
1110 # can be added for each tagfile. The format of a tag file without
1111 # this location is as follows:
1112 # TAGFILES = file1 file2 ...
1113 # Adding location for the tag files is done as follows:
1114 # TAGFILES = file1=loc1 "file2 = loc2" ...
1115 # where "loc1" and "loc2" can be relative or absolute paths or
1116 # URLs. If a location is present for each tag, the installdox tool
1117 # does not have to be run to correct the links.
1118 # Note that each tag file must have a unique name
1119 # (where the name does NOT include the path)
1120 # If a tag file is not located in the directory in which doxygen
1121 # is run, you must also specify the path to the tagfile here.
1125 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1126 # a tag file that is based on the input files it reads.
1128 GENERATE_TAGFILE = quassel.tag
1130 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1131 # in the class index. If set to NO only the inherited external classes
1136 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1137 # in the modules index. If set to NO, only the current project's groups will
1140 EXTERNAL_GROUPS = YES
1142 # The PERL_PATH should be the absolute path and name of the perl script
1143 # interpreter (i.e. the result of `which perl').
1145 PERL_PATH = /usr/bin/perl
1147 #---------------------------------------------------------------------------
1148 # Configuration options related to the dot tool
1149 #---------------------------------------------------------------------------
1151 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1152 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1153 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1154 # this option is superseded by the HAVE_DOT option below. This is only a
1155 # fallback. It is recommended to install and use dot, since it yields more
1158 CLASS_DIAGRAMS = YES
1160 # You can define message sequence charts within doxygen comments using the \msc
1161 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1162 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1163 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1164 # be found in the default search path.
1168 # If set to YES, the inheritance and collaboration graphs will hide
1169 # inheritance and usage relations if the target is undocumented
1170 # or is not a class.
1172 HIDE_UNDOC_RELATIONS = YES
1174 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1175 # available from the path. This tool is part of Graphviz, a graph visualization
1176 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1177 # have no effect if this option is set to NO (the default)
1181 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1182 # will generate a graph for each documented class showing the direct and
1183 # indirect inheritance relations. Setting this tag to YES will force the
1184 # the CLASS_DIAGRAMS tag to NO.
1188 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1189 # will generate a graph for each documented class showing the direct and
1190 # indirect implementation dependencies (inheritance, containment, and
1191 # class references variables) of the class with other documented classes.
1193 COLLABORATION_GRAPH = YES
1195 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1196 # will generate a graph for groups, showing the direct groups dependencies
1200 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1201 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1206 # If set to YES, the inheritance and collaboration graphs will show the
1207 # relations between templates and their instances.
1209 TEMPLATE_RELATIONS = NO
1211 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1212 # tags are set to YES then doxygen will generate a graph for each documented
1213 # file showing the direct and indirect include dependencies of the file with
1214 # other documented files.
1218 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1219 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1220 # documented header file showing the documented files that directly or
1221 # indirectly include this file.
1223 INCLUDED_BY_GRAPH = YES
1225 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1226 # generate a call dependency graph for every global function or class method.
1227 # Note that enabling this option will significantly increase the time of a run.
1228 # So in most cases it will be better to enable call graphs for selected
1229 # functions only using the \callgraph command.
1233 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1234 # generate a caller dependency graph for every global function or class method.
1235 # Note that enabling this option will significantly increase the time of a run.
1236 # So in most cases it will be better to enable caller graphs for selected
1237 # functions only using the \callergraph command.
1241 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1242 # will graphical hierarchy of all classes instead of a textual one.
1244 GRAPHICAL_HIERARCHY = YES
1246 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1247 # then doxygen will show the dependencies a directory has on other directories
1248 # in a graphical way. The dependency relations are determined by the #include
1249 # relations between the files in the directories.
1251 DIRECTORY_GRAPH = YES
1253 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1254 # generated by dot. Possible values are png, jpg, or gif
1255 # If left blank png will be used.
1257 DOT_IMAGE_FORMAT = png
1259 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1260 # found. If left blank, it is assumed the dot tool can be found in the path.
1264 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1265 # contain dot files that are included in the documentation (see the
1266 # \dotfile command).
1270 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1271 # nodes that will be shown in the graph. If the number of nodes in a graph
1272 # becomes larger than this value, doxygen will truncate the graph, which is
1273 # visualized by representing a node as a red box. Note that doxygen will always
1274 # show the root nodes and its direct children regardless of this setting.
1276 DOT_GRAPH_MAX_NODES = 50
1278 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1279 # background. This is disabled by default, which results in a white background.
1280 # Warning: Depending on the platform used, enabling this option may lead to
1281 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1284 DOT_TRANSPARENT = NO
1286 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1287 # files in one run (i.e. multiple -o and -T options on the command line). This
1288 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1289 # support this, this feature is disabled by default.
1291 DOT_MULTI_TARGETS = NO
1293 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1294 # generate a legend page explaining the meaning of the various boxes and
1295 # arrows in the dot generated graphs.
1297 GENERATE_LEGEND = YES
1299 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1300 # remove the intermediate dot files that are used to generate
1301 # the various graphs.
1305 #---------------------------------------------------------------------------
1306 # Configuration::additions related to the search engine
1307 #---------------------------------------------------------------------------
1309 # The SEARCHENGINE tag specifies whether or not a search engine should be
1310 # used. If set to NO the values of all tags below this one will be ignored.