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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
20 PROJECT_NAME = "Unnamed C Project"
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or
24 # if some version control system is used.
26 PROJECT_NUMBER = "Version 0.1"
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
33 OUTPUT_DIRECTORY = doc/reference
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36 # 4096 sub-directories (in 2 levels) under the output directory of each output
37 # format and will distribute the generated files over these directories.
38 # Enabling this option can be useful when feeding doxygen a huge amount of source
39 # files, where putting all generated files in the same directory would otherwise
40 # cause performance problems for the file system.
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
45 # documentation generated by doxygen is written. Doxygen will use this
46 # information to generate all constant output in the proper language.
47 # The default language is English, other supported languages are:
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52 # Swedish, and Ukrainian.
54 OUTPUT_LANGUAGE = English
56 # This tag can be used to specify the encoding used in the generated output.
57 # The encoding is not always determined by the language that is chosen,
58 # but also whether or not the output is meant for Windows or non-Windows users.
59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
60 # forces the Windows encoding (this is the default for the Windows binary),
61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
62 # all platforms other than Windows).
64 USE_WINDOWS_ENCODING = NO
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67 # include brief member descriptions after the members that are listed in
68 # the file and class documentation (similar to JavaDoc).
69 # Set to NO to disable this.
71 BRIEF_MEMBER_DESC = YES
73 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74 # the brief description of a member or function before the detailed description.
75 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76 # brief descriptions will be completely suppressed.
80 # This tag implements a quasi-intelligent brief description abbreviator
81 # that is used to form the text in various listings. Each string
82 # in this list, if found as the leading text of the brief description, will be
83 # stripped from the text and the result after processing the whole list, is used
84 # as the annotated text. Otherwise, the brief description is used as-is. If left
85 # blank, the following values are used ("$name" is automatically replaced with the
86 # name of the entity): "The $name class" "The $name widget" "The $name file"
87 # "is" "provides" "specifies" "contains" "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 inherited
98 # members of a class in the documentation of that class as if those members were
99 # ordinary class members. Constructors, destructors and assignment operators of
100 # 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 the Qt-style comments (thus requiring an
138 # explicit @brief command for a brief description.
140 JAVADOC_AUTOBRIEF = YES
142 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
143 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
144 # comments) as a brief description. This used to be the default behaviour.
145 # The new default is to treat a multi-line C++ comment block as a detailed
146 # description. Set this tag to YES if you prefer the old behaviour instead.
148 MULTILINE_CPP_IS_BRIEF = NO
150 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
151 # will output the detailed description near the top, like JavaDoc.
152 # If set to NO, the detailed description appears after the member
157 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
158 # member inherits the documentation from any documented member that it
163 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
164 # tag is set to YES, then doxygen will reuse the documentation of the first
165 # member in the group (if any) for the other members of the group. By default
166 # all members of a group must be documented explicitly.
168 DISTRIBUTE_GROUP_DOC = 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.
184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
185 # only. Doxygen will then generate output that is more tailored for C.
186 # For instance, some of the names that are used will be different. The list
187 # of all members will be omitted, etc.
189 OPTIMIZE_OUTPUT_FOR_C = YES
191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
192 # only. Doxygen will then generate output that is more tailored for Java.
193 # For instance, namespaces will be presented as packages, qualified scopes
194 # will look different, etc.
196 OPTIMIZE_OUTPUT_JAVA = NO
198 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
199 # the same type (for instance a group of public functions) to be put as a
200 # subgroup of that type (e.g. under the Public Functions section). Set it to
201 # NO to prevent subgrouping. Alternatively, this can be done per class using
202 # the \nosubgrouping command.
206 #---------------------------------------------------------------------------
207 # Build related configuration options
208 #---------------------------------------------------------------------------
210 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
211 # documentation are documented, even if no documentation was available.
212 # Private class members and static file members will be hidden unless
213 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
217 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
218 # will be included in the documentation.
220 EXTRACT_PRIVATE = YES
222 # If the EXTRACT_STATIC tag is set to YES all static members of a file
223 # will be included in the documentation.
227 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
228 # defined locally in source files will be included in the documentation.
229 # If set to NO only classes defined in header files are included.
231 EXTRACT_LOCAL_CLASSES = YES
233 # This flag is only useful for Objective-C code. When set to YES local
234 # methods, which are defined in the implementation section but not in
235 # the interface are included in the documentation.
236 # If set to NO (the default) only methods in the interface are included.
238 EXTRACT_LOCAL_METHODS = NO
240 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
241 # undocumented members of documented classes, files or namespaces.
242 # If set to NO (the default) these members will be included in the
243 # various overviews, but no documentation section is generated.
244 # This option has no effect if EXTRACT_ALL is enabled.
246 HIDE_UNDOC_MEMBERS = YES
248 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
249 # undocumented classes that are normally visible in the class hierarchy.
250 # If set to NO (the default) these classes will be included in the various
251 # overviews. This option has no effect if EXTRACT_ALL is enabled.
253 HIDE_UNDOC_CLASSES = YES
255 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
256 # friend (class|struct|union) declarations.
257 # If set to NO (the default) these declarations will be included in the
260 HIDE_FRIEND_COMPOUNDS = NO
262 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
263 # documentation blocks found inside the body of a function.
264 # If set to NO (the default) these blocks will be appended to the
265 # function's detailed documentation block.
267 HIDE_IN_BODY_DOCS = NO
269 # The INTERNAL_DOCS tag determines if documentation
270 # that is typed after a \internal command is included. If the tag is set
271 # to NO (the default) then the documentation will be excluded.
272 # Set it to YES to include the internal documentation.
276 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
277 # file names in lower-case letters. If set to YES upper-case letters are also
278 # allowed. This is useful if you have classes or files whose names only differ
279 # in case and if your file system supports case sensitive file names. Windows
280 # and Mac users are advised to set this option to NO.
282 CASE_SENSE_NAMES = YES
284 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
285 # will show members with their full class and namespace scopes in the
286 # documentation. If set to YES the scope will be hidden.
288 HIDE_SCOPE_NAMES = NO
290 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
291 # will put a list of the files that are included by a file in the documentation
294 SHOW_INCLUDE_FILES = YES
296 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
297 # is inserted in the documentation for inline members.
301 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
302 # will sort the (detailed) documentation of file and class members
303 # alphabetically by member name. If set to NO the members will appear in
306 SORT_MEMBER_DOCS = YES
308 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
309 # brief documentation of file, namespace and class members alphabetically
310 # by member name. If set to NO (the default) the members will appear in
315 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
316 # sorted by fully-qualified names, including namespaces. If set to
317 # NO (the default), the class list will be sorted only by class name,
318 # not including the namespace part.
319 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
320 # Note: This option applies only to the class list, not to the
323 SORT_BY_SCOPE_NAME = NO
325 # The GENERATE_TODOLIST tag can be used to enable (YES) or
326 # disable (NO) the todo list. This list is created by putting \todo
327 # commands in the documentation.
329 GENERATE_TODOLIST = YES
331 # The GENERATE_TESTLIST tag can be used to enable (YES) or
332 # disable (NO) the test list. This list is created by putting \test
333 # commands in the documentation.
335 GENERATE_TESTLIST = YES
337 # The GENERATE_BUGLIST tag can be used to enable (YES) or
338 # disable (NO) the bug list. This list is created by putting \bug
339 # commands in the documentation.
341 GENERATE_BUGLIST = YES
343 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
344 # disable (NO) the deprecated list. This list is created by putting
345 # \deprecated commands in the documentation.
347 GENERATE_DEPRECATEDLIST= YES
349 # The ENABLED_SECTIONS tag can be used to enable conditional
350 # documentation sections, marked by \if sectionname ... \endif.
354 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
355 # the initial value of a variable or define consists of for it to appear in
356 # the documentation. If the initializer consists of more lines than specified
357 # here it will be hidden. Use a value of 0 to hide initializers completely.
358 # The appearance of the initializer of individual variables and defines in the
359 # documentation can be controlled using \showinitializer or \hideinitializer
360 # command in the documentation regardless of this setting.
362 MAX_INITIALIZER_LINES = 30
364 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
365 # at the bottom of the documentation of classes and structs. If set to YES the
366 # list will mention the files that were used to generate the documentation.
368 SHOW_USED_FILES = YES
370 # If the sources in your project are distributed over multiple directories
371 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
372 # in the documentation.
374 SHOW_DIRECTORIES = YES
376 #---------------------------------------------------------------------------
377 # configuration options related to warning and progress messages
378 #---------------------------------------------------------------------------
380 # The QUIET tag can be used to turn on/off the messages that are generated
381 # by doxygen. Possible values are YES and NO. If left blank NO is used.
385 # The WARNINGS tag can be used to turn on/off the warning messages that are
386 # generated by doxygen. Possible values are YES and NO. If left blank
391 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
392 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
393 # automatically be disabled.
395 WARN_IF_UNDOCUMENTED = YES
397 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
398 # potential errors in the documentation, such as not documenting some
399 # parameters in a documented function, or documenting parameters that
400 # don't exist or using markup commands wrongly.
402 WARN_IF_DOC_ERROR = YES
404 # The WARN_FORMAT tag determines the format of the warning messages that
405 # doxygen can produce. The string should contain the $file, $line, and $text
406 # tags, which will be replaced by the file and line number from which the
407 # warning originated and the warning text.
409 WARN_FORMAT = "$file:$line: $text"
411 # The WARN_LOGFILE tag can be used to specify a file to which warning
412 # and error messages should be written. If left blank the output is written
417 #---------------------------------------------------------------------------
418 # configuration options related to the input files
419 #---------------------------------------------------------------------------
421 # The INPUT tag can be used to specify the files and/or directories that contain
422 # documented source files. You may enter file names like "myfile.cpp" or
423 # directories like "/usr/src/myproject". Separate the files or directories
428 # If the value of the INPUT tag contains directories, you can use the
429 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
430 # and *.h) to filter out the source-files in the directories. If left
431 # blank the following patterns are tested:
432 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
433 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
435 FILE_PATTERNS = *.c \
456 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
457 # should be searched for input files as well. Possible values are YES and NO.
458 # If left blank NO is used.
462 # The EXCLUDE tag can be used to specify files and/or directories that should
463 # excluded from the INPUT source files. This way you can easily exclude a
464 # subdirectory from a directory tree whose root is specified with the INPUT tag.
468 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
469 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
471 EXCLUDE_SYMLINKS = NO
473 # If the value of the INPUT tag contains directories, you can use the
474 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
475 # certain files from those directories.
479 # The EXAMPLE_PATH tag can be used to specify one or more files or
480 # directories that contain example code fragments that are included (see
481 # the \include command).
485 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
486 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
487 # and *.h) to filter out the source-files in the directories. If left
488 # blank all files are included.
492 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
493 # searched for input files to be used with the \include or \dontinclude
494 # commands irrespective of the value of the RECURSIVE tag.
495 # Possible values are YES and NO. If left blank NO is used.
497 EXAMPLE_RECURSIVE = NO
499 # The IMAGE_PATH tag can be used to specify one or more files or
500 # directories that contain image that are included in the documentation (see
501 # the \image command).
505 # The INPUT_FILTER tag can be used to specify a program that doxygen should
506 # invoke to filter for each input file. Doxygen will invoke the filter program
507 # by executing (via popen()) the command <filter> <input-file>, where <filter>
508 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
509 # input file. Doxygen will then use the output that the filter program writes
510 # to standard output. If FILTER_PATTERNS is specified, this tag will be
515 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
516 # basis. Doxygen will compare the file name with each pattern and apply the
517 # filter if there is a match. The filters are a list of the form:
518 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
519 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
520 # is applied to all files.
524 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
525 # INPUT_FILTER) will be used to filter the input files when producing source
526 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
528 FILTER_SOURCE_FILES = NO
530 #---------------------------------------------------------------------------
531 # configuration options related to source browsing
532 #---------------------------------------------------------------------------
534 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
535 # be generated. Documented entities will be cross-referenced with these sources.
536 # Note: To get rid of all source code in the generated output, make sure also
537 # VERBATIM_HEADERS is set to NO.
541 # Setting the INLINE_SOURCES tag to YES will include the body
542 # of functions and classes directly in the documentation.
546 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
547 # doxygen to hide any special comment blocks from generated source code
548 # fragments. Normal C and C++ comments will always remain visible.
550 STRIP_CODE_COMMENTS = YES
552 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
553 # then for each documented function all documented
554 # functions referencing it will be listed.
556 REFERENCED_BY_RELATION = NO
558 # If the REFERENCES_RELATION tag is set to YES (the default)
559 # then for each documented function all documented entities
560 # called/used by that function will be listed.
562 REFERENCES_RELATION = YES
564 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
565 # will generate a verbatim copy of the header file for each class for
566 # which an include is specified. Set to NO to disable this.
568 VERBATIM_HEADERS = YES
570 #---------------------------------------------------------------------------
571 # configuration options related to the alphabetical class index
572 #---------------------------------------------------------------------------
574 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
575 # of all compounds will be generated. Enable this if the project
576 # contains a lot of classes, structs, unions or interfaces.
578 ALPHABETICAL_INDEX = YES
580 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
581 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
582 # in which this list will be split (can be a number in the range [1..20])
584 COLS_IN_ALPHA_INDEX = 1
586 # In case all classes in a project start with a common prefix, all
587 # classes will be put under the same header in the alphabetical index.
588 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
589 # should be ignored while generating the index headers.
593 #---------------------------------------------------------------------------
594 # configuration options related to the HTML output
595 #---------------------------------------------------------------------------
597 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
598 # generate HTML output.
602 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
603 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
604 # put in front of it. If left blank `html' will be used as the default path.
608 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
609 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
610 # doxygen will generate files with .html extension.
612 HTML_FILE_EXTENSION = .html
614 # The HTML_HEADER tag can be used to specify a personal HTML header for
615 # each generated HTML page. If it is left blank doxygen will generate a
620 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
621 # each generated HTML page. If it is left blank doxygen will generate a
626 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
627 # style sheet that is used by each HTML page. It can be used to
628 # fine-tune the look of the HTML output. If the tag is left blank doxygen
629 # will generate a default style sheet. Note that doxygen will try to copy
630 # the style sheet file to the HTML output directory, so don't put your own
631 # stylesheet in the HTML output directory as well, or it will be erased!
635 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
636 # files or namespaces will be aligned in HTML using tables. If set to
637 # NO a bullet list will be used.
639 HTML_ALIGN_MEMBERS = YES
641 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
642 # will be generated that can be used as input for tools like the
643 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
644 # of the generated HTML documentation.
646 GENERATE_HTMLHELP = NO
648 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
649 # be used to specify the file name of the resulting .chm file. You
650 # can add a path in front of the file if the result should not be
651 # written to the html output directory.
655 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
656 # be used to specify the location (absolute path including file name) of
657 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
658 # the HTML help compiler on the generated index.hhp.
662 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
663 # controls if a separate .chi index file is generated (YES) or that
664 # it should be included in the master .chm file (NO).
668 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
669 # controls whether a binary table of contents is generated (YES) or a
670 # normal table of contents (NO) in the .chm file.
674 # The TOC_EXPAND flag can be set to YES to add extra items for group members
675 # to the contents of the HTML help documentation and to the tree view.
679 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
680 # top of each HTML page. The value NO (the default) enables the index and
681 # the value YES disables it.
685 # This tag can be used to set the number of enum values (range [1..20])
686 # that doxygen will group on one line in the generated HTML documentation.
688 ENUM_VALUES_PER_LINE = 4
690 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
691 # generated containing a tree-like index structure (just like the one that
692 # is generated for HTML Help). For this to work a browser that supports
693 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
694 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
695 # probably better off using the HTML help feature.
697 GENERATE_TREEVIEW = YES
699 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
700 # used to set the initial width (in pixels) of the frame in which the tree
705 #---------------------------------------------------------------------------
706 # configuration options related to the LaTeX output
707 #---------------------------------------------------------------------------
709 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
710 # generate Latex output.
714 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
715 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
716 # put in front of it. If left blank `latex' will be used as the default path.
720 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
721 # invoked. If left blank `latex' will be used as the default command name.
723 LATEX_CMD_NAME = latex
725 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
726 # generate index for LaTeX. If left blank `makeindex' will be used as the
727 # default command name.
729 MAKEINDEX_CMD_NAME = makeindex
731 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
732 # LaTeX documents. This may be useful for small projects and may help to
733 # save some trees in general.
737 # The PAPER_TYPE tag can be used to set the paper type that is used
738 # by the printer. Possible values are: a4, a4wide, letter, legal and
739 # executive. If left blank a4wide will be used.
743 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
744 # packages that should be included in the LaTeX output.
748 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
749 # the generated latex document. The header should contain everything until
750 # the first chapter. If it is left blank doxygen will generate a
751 # standard header. Notice: only use this tag if you know what you are doing!
755 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
756 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
757 # contain links (just like the HTML output) instead of page references
758 # This makes the output suitable for online browsing using a pdf viewer.
762 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
763 # plain latex in the generated Makefile. Set this option to YES to get a
764 # higher quality PDF documentation.
768 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
769 # command to the generated LaTeX files. This will instruct LaTeX to keep
770 # running if errors occur, instead of asking the user for help.
771 # This option is also used when generating formulas in HTML.
773 LATEX_BATCHMODE = YES
775 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
776 # include the index chapters (such as File Index, Compound Index, etc.)
779 LATEX_HIDE_INDICES = NO
781 #---------------------------------------------------------------------------
782 # configuration options related to the RTF output
783 #---------------------------------------------------------------------------
785 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
786 # The RTF output is optimized for Word 97 and may not look very pretty with
787 # other RTF readers or editors.
791 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
792 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
793 # put in front of it. If left blank `rtf' will be used as the default path.
797 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
798 # RTF documents. This may be useful for small projects and may help to
799 # save some trees in general.
803 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
804 # will contain hyperlink fields. The RTF file will
805 # contain links (just like the HTML output) instead of page references.
806 # This makes the output suitable for online browsing using WORD or other
807 # programs which support those fields.
808 # Note: wordpad (write) and others do not support links.
812 # Load stylesheet definitions from file. Syntax is similar to doxygen's
813 # config file, i.e. a series of assignments. You only have to provide
814 # replacements, missing definitions are set to their default value.
816 RTF_STYLESHEET_FILE =
818 # Set optional variables used in the generation of an rtf document.
819 # Syntax is similar to doxygen's config file.
821 RTF_EXTENSIONS_FILE =
823 #---------------------------------------------------------------------------
824 # configuration options related to the man page output
825 #---------------------------------------------------------------------------
827 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
832 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
833 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
834 # put in front of it. If left blank `man' will be used as the default path.
838 # The MAN_EXTENSION tag determines the extension that is added to
839 # the generated man pages (default is the subroutine's section .3)
843 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
844 # then it will generate one additional man file for each entity
845 # documented in the real man page(s). These additional files
846 # only source the real man page, but without them the man command
847 # would be unable to find the correct page. The default is NO.
851 #---------------------------------------------------------------------------
852 # configuration options related to the XML output
853 #---------------------------------------------------------------------------
855 # If the GENERATE_XML tag is set to YES Doxygen will
856 # generate an XML file that captures the structure of
857 # the code including all documentation.
861 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
862 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
863 # put in front of it. If left blank `xml' will be used as the default path.
867 # The XML_SCHEMA tag can be used to specify an XML schema,
868 # which can be used by a validating XML parser to check the
869 # syntax of the XML files.
873 # The XML_DTD tag can be used to specify an XML DTD,
874 # which can be used by a validating XML parser to check the
875 # syntax of the XML files.
879 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
880 # dump the program listings (including syntax highlighting
881 # and cross-referencing information) to the XML output. Note that
882 # enabling this will significantly increase the size of the XML output.
884 XML_PROGRAMLISTING = YES
886 #---------------------------------------------------------------------------
887 # configuration options for the AutoGen Definitions output
888 #---------------------------------------------------------------------------
890 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
891 # generate an AutoGen Definitions (see autogen.sf.net) file
892 # that captures the structure of the code including all
893 # documentation. Note that this feature is still experimental
894 # and incomplete at the moment.
896 GENERATE_AUTOGEN_DEF = NO
898 #---------------------------------------------------------------------------
899 # configuration options related to the Perl module output
900 #---------------------------------------------------------------------------
902 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
903 # generate a Perl module file that captures the structure of
904 # the code including all documentation. Note that this
905 # feature is still experimental and incomplete at the
908 GENERATE_PERLMOD = NO
910 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
911 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
912 # to generate PDF and DVI output from the Perl module output.
916 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
917 # nicely formatted so it can be parsed by a human reader. This is useful
918 # if you want to understand what is going on. On the other hand, if this
919 # tag is set to NO the size of the Perl module output will be much smaller
920 # and Perl will parse it just the same.
924 # The names of the make variables in the generated doxyrules.make file
925 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
926 # This is useful so different doxyrules.make files included by the same
927 # Makefile don't overwrite each other's variables.
929 PERLMOD_MAKEVAR_PREFIX =
931 #---------------------------------------------------------------------------
932 # Configuration options related to the preprocessor
933 #---------------------------------------------------------------------------
935 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
936 # evaluate all C-preprocessor directives found in the sources and include
939 ENABLE_PREPROCESSING = YES
941 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
942 # names in the source code. If set to NO (the default) only conditional
943 # compilation will be performed. Macro expansion can be done in a controlled
944 # way by setting EXPAND_ONLY_PREDEF to YES.
946 MACRO_EXPANSION = YES
948 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
949 # then the macro expansion is limited to the macros specified with the
950 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
952 EXPAND_ONLY_PREDEF = YES
954 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
955 # in the INCLUDE_PATH (see below) will be search if a #include is found.
957 SEARCH_INCLUDES = YES
959 # The INCLUDE_PATH tag can be used to specify one or more directories that
960 # contain include files that are not input files but should be processed by
965 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
966 # patterns (like *.h and *.hpp) to filter out the header-files in the
967 # directories. If left blank, the patterns specified with FILE_PATTERNS will
970 INCLUDE_FILE_PATTERNS =
972 # The PREDEFINED tag can be used to specify one or more macro names that
973 # are defined before the preprocessor is started (similar to the -D option of
974 # gcc). The argument of the tag is a list of macros of the form: name
975 # or name=definition (no spaces). If the definition and the = are
976 # omitted =1 is assumed. To prevent a macro definition from being
977 # undefined via #undef or recursively expanded use the := operator
978 # instead of the = operator.
980 PREDEFINED = __linux__ \
985 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
986 # this tag can be used to specify a list of macro names that should be expanded.
987 # The macro definition that is found in the sources will be used.
988 # Use the PREDEFINED tag if you want to use a different macro definition.
992 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
993 # doxygen's preprocessor will remove all function-like macros that are alone
994 # on a line, have an all uppercase name, and do not end with a semicolon. Such
995 # function macros are typically used for boiler-plate code, and will confuse the
996 # parser if not removed.
998 SKIP_FUNCTION_MACROS = YES
1000 #---------------------------------------------------------------------------
1001 # Configuration::additions related to external references
1002 #---------------------------------------------------------------------------
1004 # The TAGFILES option can be used to specify one or more tagfiles.
1005 # Optionally an initial location of the external documentation
1006 # can be added for each tagfile. The format of a tag file without
1007 # this location is as follows:
1008 # TAGFILES = file1 file2 ...
1009 # Adding location for the tag files is done as follows:
1010 # TAGFILES = file1=loc1 "file2 = loc2" ...
1011 # where "loc1" and "loc2" can be relative or absolute paths or
1012 # URLs. If a location is present for each tag, the installdox tool
1013 # does not have to be run to correct the links.
1014 # Note that each tag file must have a unique name
1015 # (where the name does NOT include the path)
1016 # If a tag file is not located in the directory in which doxygen
1017 # is run, you must also specify the path to the tagfile here.
1021 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1022 # a tag file that is based on the input files it reads.
1026 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1027 # in the class index. If set to NO only the inherited external classes
1032 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1033 # in the modules index. If set to NO, only the current project's groups will
1036 EXTERNAL_GROUPS = YES
1038 # The PERL_PATH should be the absolute path and name of the perl script
1039 # interpreter (i.e. the result of `which perl').
1041 PERL_PATH = /usr/bin/perl
1043 #---------------------------------------------------------------------------
1044 # Configuration options related to the dot tool
1045 #---------------------------------------------------------------------------
1047 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1048 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1049 # super classes. Setting the tag to NO turns the diagrams off. Note that this
1050 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1051 # recommended to install and use dot, since it yields more powerful graphs.
1053 CLASS_DIAGRAMS = YES
1055 # If set to YES, the inheritance and collaboration graphs will hide
1056 # inheritance and usage relations if the target is undocumented
1057 # or is not a class.
1059 HIDE_UNDOC_RELATIONS = YES
1061 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1062 # available from the path. This tool is part of Graphviz, a graph visualization
1063 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1064 # have no effect if this option is set to NO (the default)
1068 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1069 # will generate a graph for each documented class showing the direct and
1070 # indirect inheritance relations. Setting this tag to YES will force the
1071 # the CLASS_DIAGRAMS tag to NO.
1075 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1076 # will generate a graph for each documented class showing the direct and
1077 # indirect implementation dependencies (inheritance, containment, and
1078 # class references variables) of the class with other documented classes.
1080 COLLABORATION_GRAPH = YES
1082 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1083 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1088 # If set to YES, the inheritance and collaboration graphs will show the
1089 # relations between templates and their instances.
1091 TEMPLATE_RELATIONS = YES
1093 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1094 # tags are set to YES then doxygen will generate a graph for each documented
1095 # file showing the direct and indirect include dependencies of the file with
1096 # other documented files.
1100 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1101 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1102 # documented header file showing the documented files that directly or
1103 # indirectly include this file.
1105 INCLUDED_BY_GRAPH = YES
1107 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1108 # generate a call dependency graph for every global function or class method.
1109 # Note that enabling this option will significantly increase the time of a run.
1110 # So in most cases it will be better to enable call graphs for selected
1111 # functions only using the \callgraph command.
1115 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1116 # will graphical hierarchy of all classes instead of a textual one.
1118 GRAPHICAL_HIERARCHY = YES
1120 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1121 # generated by dot. Possible values are png, jpg, or gif
1122 # If left blank png will be used.
1124 DOT_IMAGE_FORMAT = png
1126 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1127 # found. If left blank, it is assumed the dot tool can be found on the path.
1131 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1132 # contain dot files that are included in the documentation (see the
1133 # \dotfile command).
1137 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1138 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1139 # this value, doxygen will try to truncate the graph, so that it fits within
1140 # the specified constraint. Beware that most browsers cannot cope with very
1143 MAX_DOT_GRAPH_WIDTH = 1024
1145 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1146 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1147 # this value, doxygen will try to truncate the graph, so that it fits within
1148 # the specified constraint. Beware that most browsers cannot cope with very
1151 MAX_DOT_GRAPH_HEIGHT = 1024
1153 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1154 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1155 # from the root by following a path via at most 3 edges will be shown. Nodes that
1156 # lay further from the root node will be omitted. Note that setting this option to
1157 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1158 # note that a graph may be further truncated if the graph's image dimensions are
1159 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1160 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1162 MAX_DOT_GRAPH_DEPTH = 0
1164 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1165 # generate a legend page explaining the meaning of the various boxes and
1166 # arrows in the dot generated graphs.
1168 GENERATE_LEGEND = YES
1170 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1171 # remove the intermediate dot files that are used to generate
1172 # the various graphs.
1176 #---------------------------------------------------------------------------
1177 # Configuration::additions related to the search engine
1178 #---------------------------------------------------------------------------
1180 # The SEARCHENGINE tag specifies whether or not a search engine should be
1181 # used. If set to NO the values of all tags below this one will be ignored.