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 # General 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.
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.
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.
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
36 # documentation generated by doxygen is written. Doxygen will use this
37 # information to generate all constant output in the proper language.
38 # The default language is English, other supported languages are:
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
44 OUTPUT_LANGUAGE = English
46 # This tag can be used to specify the encoding used in the generated output.
47 # The encoding is not always determined by the language that is chosen,
48 # but also whether or not the output is meant for Windows or non-Windows users.
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50 # forces the Windows encoding (this is the default for the Windows binary),
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
52 # all platforms other than Windows).
54 USE_WINDOWS_ENCODING = NO
56 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
57 # documentation are documented, even if no documentation was available.
58 # Private class members and static file members will be hidden unless
59 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
63 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
64 # will be included in the documentation.
68 # If the EXTRACT_STATIC tag is set to YES all static members of a file
69 # will be included in the documentation.
73 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
74 # defined locally in source files will be included in the documentation.
75 # If set to NO only classes defined in header files are included.
77 EXTRACT_LOCAL_CLASSES = YES
79 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
80 # undocumented members of documented classes, files or namespaces.
81 # If set to NO (the default) these members will be included in the
82 # various overviews, but no documentation section is generated.
83 # This option has no effect if EXTRACT_ALL is enabled.
85 HIDE_UNDOC_MEMBERS = NO
87 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
88 # undocumented classes that are normally visible in the class hierarchy.
89 # If set to NO (the default) these class will be included in the various
90 # overviews. This option has no effect if EXTRACT_ALL is enabled.
92 HIDE_UNDOC_CLASSES = NO
94 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
95 # friend (class|struct|union) declarations.
96 # If set to NO (the default) these declarations will be included in the
99 HIDE_FRIEND_COMPOUNDS = NO
101 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
102 # documentation blocks found inside the body of a function.
103 # If set to NO (the default) these blocks will be appended to the
104 # function's detailed documentation block.
106 HIDE_IN_BODY_DOCS = NO
108 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
109 # include brief member descriptions after the members that are listed in
110 # the file and class documentation (similar to JavaDoc).
111 # Set to NO to disable this.
113 BRIEF_MEMBER_DESC = YES
115 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
116 # the brief description of a member or function before the detailed description.
117 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
118 # brief descriptions will be completely suppressed.
122 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
123 # Doxygen will generate a detailed section even if there is only a brief
126 ALWAYS_DETAILED_SEC = NO
128 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
129 # members of a class in the documentation of that class as if those members were
130 # ordinary class members. Constructors, destructors and assignment operators of
131 # the base classes will not be shown.
133 INLINE_INHERITED_MEMB = YES
135 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
136 # path before files name in the file list and in the header files. If set
137 # to NO the shortest path that makes the file name unique will be used.
139 FULL_PATH_NAMES = YES
141 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
142 # can be used to strip a user defined part of the path. Stripping is
143 # only done if one of the specified strings matches the left-hand part of
144 # the path. It is allowed to use relative paths in the argument list.
148 # The INTERNAL_DOCS tag determines if documentation
149 # that is typed after a \internal command is included. If the tag is set
150 # to NO (the default) then the documentation will be excluded.
151 # Set it to YES to include the internal documentation.
155 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
156 # doxygen to hide any special comment blocks from generated source code
157 # fragments. Normal C and C++ comments will always remain visible.
159 STRIP_CODE_COMMENTS = YES
161 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
162 # file names in lower case letters. If set to YES upper case letters are also
163 # allowed. This is useful if you have classes or files whose names only differ
164 # in case and if your file system supports case sensitive file names. Windows
165 # users are adviced to set this option to NO.
167 CASE_SENSE_NAMES = YES
169 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
170 # (but less readable) file names. This can be useful is your file systems
171 # doesn't support long names like on DOS, Mac, or CD-ROM.
175 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
176 # will show members with their full class and namespace scopes in the
177 # documentation. If set to YES the scope will be hidden.
179 HIDE_SCOPE_NAMES = NO
181 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
182 # will generate a verbatim copy of the header file for each class for
183 # which an include is specified. Set to NO to disable this.
185 VERBATIM_HEADERS = YES
187 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
188 # will put list of the files that are included by a file in the documentation
191 SHOW_INCLUDE_FILES = YES
193 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
194 # will interpret the first line (until the first dot) of a JavaDoc-style
195 # comment as the brief description. If set to NO, the JavaDoc
196 # comments will behave just like the Qt-style comments (thus requiring an
197 # explict @brief command for a brief description.
199 JAVADOC_AUTOBRIEF = NO
201 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
202 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
203 # comments) as a brief description. This used to be the default behaviour.
204 # The new default is to treat a multi-line C++ comment block as a detailed
205 # description. Set this tag to YES if you prefer the old behaviour instead.
207 MULTILINE_CPP_IS_BRIEF = NO
209 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
210 # will output the detailed description near the top, like JavaDoc.
211 # If set to NO, the detailed description appears after the member
216 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
217 # member inherits the documentation from any documented member that it
222 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
223 # is inserted in the documentation for inline members.
227 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
228 # will sort the (detailed) documentation of file and class members
229 # alphabetically by member name. If set to NO the members will appear in
232 SORT_MEMBER_DOCS = YES
234 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
235 # tag is set to YES, then doxygen will reuse the documentation of the first
236 # member in the group (if any) for the other members of the group. By default
237 # all members of a group must be documented explicitly.
239 DISTRIBUTE_GROUP_DOC = NO
241 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
242 # Doxygen uses this value to replace tabs by spaces in code fragments.
246 # The GENERATE_TODOLIST tag can be used to enable (YES) or
247 # disable (NO) the todo list. This list is created by putting \todo
248 # commands in the documentation.
250 GENERATE_TODOLIST = YES
252 # The GENERATE_TESTLIST tag can be used to enable (YES) or
253 # disable (NO) the test list. This list is created by putting \test
254 # commands in the documentation.
256 GENERATE_TESTLIST = YES
258 # The GENERATE_BUGLIST tag can be used to enable (YES) or
259 # disable (NO) the bug list. This list is created by putting \bug
260 # commands in the documentation.
262 GENERATE_BUGLIST = YES
264 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
265 # disable (NO) the deprecated list. This list is created by putting
266 # \deprecated commands in the documentation.
268 GENERATE_DEPRECATEDLIST= YES
270 # This tag can be used to specify a number of aliases that acts
271 # as commands in the documentation. An alias has the form "name=value".
272 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
273 # put the command \sideeffect (or @sideeffect) in the documentation, which
274 # will result in a user defined paragraph with heading "Side Effects:".
275 # You can put \n's in the value part of an alias to insert newlines.
279 # The ENABLED_SECTIONS tag can be used to enable conditional
280 # documentation sections, marked by \if sectionname ... \endif.
284 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
285 # the initial value of a variable or define consist of for it to appear in
286 # the documentation. If the initializer consists of more lines than specified
287 # here it will be hidden. Use a value of 0 to hide initializers completely.
288 # The appearance of the initializer of individual variables and defines in the
289 # documentation can be controlled using \showinitializer or \hideinitializer
290 # command in the documentation regardless of this setting.
292 MAX_INITIALIZER_LINES = 30
294 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
295 # only. Doxygen will then generate output that is more tailored for C.
296 # For instance some of the names that are used will be different. The list
297 # of all members will be omitted, etc.
299 OPTIMIZE_OUTPUT_FOR_C = NO
301 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
302 # only. Doxygen will then generate output that is more tailored for Java.
303 # For instance, namespaces will be presented as packages, qualified scopes
304 # will look different, etc.
306 OPTIMIZE_OUTPUT_JAVA = NO
308 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
309 # at the bottom of the documentation of classes and structs. If set to YES the
310 # list will mention the files that were used to generate the documentation.
312 SHOW_USED_FILES = YES
314 #---------------------------------------------------------------------------
315 # configuration options related to warning and progress messages
316 #---------------------------------------------------------------------------
318 # The QUIET tag can be used to turn on/off the messages that are generated
319 # by doxygen. Possible values are YES and NO. If left blank NO is used.
323 # The WARNINGS tag can be used to turn on/off the warning messages that are
324 # generated by doxygen. Possible values are YES and NO. If left blank
329 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
330 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
331 # automatically be disabled.
333 WARN_IF_UNDOCUMENTED = YES
335 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
336 # potential errors in the documentation, such as not documenting some
337 # parameters in a documented function, or documenting parameters that
338 # don't exist or using markup commands wrongly.
340 WARN_IF_DOC_ERROR = YES
342 # The WARN_FORMAT tag determines the format of the warning messages that
343 # doxygen can produce. The string should contain the $file, $line, and $text
344 # tags, which will be replaced by the file and line number from which the
345 # warning originated and the warning text.
347 WARN_FORMAT = "$file:$line: $text"
349 # The WARN_LOGFILE tag can be used to specify a file to which warning
350 # and error messages should be written. If left blank the output is written
355 #---------------------------------------------------------------------------
356 # configuration options related to the input files
357 #---------------------------------------------------------------------------
359 # The INPUT tag can be used to specify the files and/or directories that contain
360 # documented source files. You may enter file names like "myfile.cpp" or
361 # directories like "/usr/src/myproject". Separate the files or directories
364 INPUT = ../src DoxyPython.txt DoxyMainPage.txt \
365 DoxyInstallation.txt DoxyDevelInstal.txt \
366 DoxyPython.txt DoxyIntroduction.txt
368 # If the value of the INPUT tag contains directories, you can use the
369 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
370 # and *.h) to filter out the source-files in the directories. If left
371 # blank the following patterns are tested:
372 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
375 FILE_PATTERNS = *.cxx *.h
377 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
378 # should be searched for input files as well. Possible values are YES and NO.
379 # If left blank NO is used.
383 # The EXCLUDE tag can be used to specify files and/or directories that should
384 # excluded from the INPUT source files. This way you can easily exclude a
385 # subdirectory from a directory tree whose root is specified with the INPUT tag.
387 EXCLUDE = ../src/iddcmjpeg.h ../src/gdcmJpeg.cxx
389 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
390 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
392 EXCLUDE_SYMLINKS = NO
394 # If the value of the INPUT tag contains directories, you can use the
395 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
396 # certain files from those directories.
400 # The EXAMPLE_PATH tag can be used to specify one or more files or
401 # directories that contain example code fragments that are included (see
402 # the \include command).
404 EXAMPLE_PATH = ../gdcmPython/demo
406 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
407 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
408 # and *.h) to filter out the source-files in the directories. If left
409 # blank all files are included.
413 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
414 # searched for input files to be used with the \include or \dontinclude
415 # commands irrespective of the value of the RECURSIVE tag.
416 # Possible values are YES and NO. If left blank NO is used.
418 EXAMPLE_RECURSIVE = NO
420 # The IMAGE_PATH tag can be used to specify one or more files or
421 # directories that contain image that are included in the documentation (see
422 # the \image command).
426 # The INPUT_FILTER tag can be used to specify a program that doxygen should
427 # invoke to filter for each input file. Doxygen will invoke the filter program
428 # by executing (via popen()) the command <filter> <input-file>, where <filter>
429 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
430 # input file. Doxygen will then use the output that the filter program writes
431 # to standard output.
435 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
436 # INPUT_FILTER) will be used to filter the input files when producing source
439 FILTER_SOURCE_FILES = NO
441 #---------------------------------------------------------------------------
442 # configuration options related to source browsing
443 #---------------------------------------------------------------------------
445 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
446 # be generated. Documented entities will be cross-referenced with these sources.
450 # Setting the INLINE_SOURCES tag to YES will include the body
451 # of functions and classes directly in the documentation.
455 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
456 # doxygen to hide any special comment blocks from generated source code
457 # fragments. Normal C and C++ comments will always remain visible.
459 STRIP_CODE_COMMENTS = YES
461 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
462 # then for each documented function all documented
463 # functions referencing it will be listed.
465 REFERENCED_BY_RELATION = YES
467 # If the REFERENCES_RELATION tag is set to YES (the default)
468 # then for each documented function all documented entities
469 # called/used by that function will be listed.
471 REFERENCES_RELATION = YES
473 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
474 # will generate a verbatim copy of the header file for each class for
475 # which an include is specified. Set to NO to disable this.
477 VERBATIM_HEADERS = YES
479 #---------------------------------------------------------------------------
480 # configuration options related to the alphabetical class index
481 #---------------------------------------------------------------------------
483 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
484 # of all compounds will be generated. Enable this if the project
485 # contains a lot of classes, structs, unions or interfaces.
487 ALPHABETICAL_INDEX = YES
489 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
490 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
491 # in which this list will be split (can be a number in the range [1..20])
493 COLS_IN_ALPHA_INDEX = 5
495 # In case all classes in a project start with a common prefix, all
496 # classes will be put under the same header in the alphabetical index.
497 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
498 # should be ignored while generating the index headers.
502 #---------------------------------------------------------------------------
503 # configuration options related to the HTML output
504 #---------------------------------------------------------------------------
506 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
507 # generate HTML output.
511 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
512 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
513 # put in front of it. If left blank `html' will be used as the default path.
515 HTML_OUTPUT = html.developper
517 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
518 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
519 # doxygen will generate files with .html extension.
521 HTML_FILE_EXTENSION = .html
523 # The HTML_HEADER tag can be used to specify a personal HTML header for
524 # each generated HTML page. If it is left blank doxygen will generate a
529 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
530 # each generated HTML page. If it is left blank doxygen will generate a
535 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
536 # style sheet that is used by each HTML page. It can be used to
537 # fine-tune the look of the HTML output. If the tag is left blank doxygen
538 # will generate a default style sheet
542 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
543 # files or namespaces will be aligned in HTML using tables. If set to
544 # NO a bullet list will be used.
546 HTML_ALIGN_MEMBERS = YES
548 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
549 # will be generated that can be used as input for tools like the
550 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
551 # of the generated HTML documentation.
553 GENERATE_HTMLHELP = NO
555 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
556 # controls if a separate .chi index file is generated (YES) or that
557 # it should be included in the master .chm file (NO).
561 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
562 # be used to specify the file name of the resulting .chm file. You
563 # can add a path in front of the file if the result should not be
564 # written to the html output dir.
568 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
569 # be used to specify the location (absolute path including file name) of
570 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
571 # the HTML help compiler on the generated index.hhp.
575 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
576 # controls whether a binary table of contents is generated (YES) or a
577 # normal table of contents (NO) in the .chm file.
581 # The TOC_EXPAND flag can be set to YES to add extra items for group members
582 # to the contents of the Html help documentation and to the tree view.
586 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
587 # top of each HTML page. The value NO (the default) enables the index and
588 # the value YES disables it.
592 # This tag can be used to set the number of enum values (range [1..20])
593 # that doxygen will group on one line in the generated HTML documentation.
595 ENUM_VALUES_PER_LINE = 4
597 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
598 # generated containing a tree-like index structure (just like the one that
599 # is generated for HTML Help). For this to work a browser that supports
600 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
601 # or Internet explorer 4.0+). Note that for large projects the tree generation
602 # can take a very long time. In such cases it is better to disable this feature.
603 # Windows users are probably better off using the HTML help feature.
605 GENERATE_TREEVIEW = NO
607 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
608 # used to set the initial width (in pixels) of the frame in which the tree
613 #---------------------------------------------------------------------------
614 # configuration options related to the LaTeX output
615 #---------------------------------------------------------------------------
617 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
618 # generate Latex output.
622 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
623 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
624 # put in front of it. If left blank `latex' will be used as the default path.
628 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
629 # invoked. If left blank `latex' will be used as the default command name.
631 LATEX_CMD_NAME = latex
633 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
634 # generate index for LaTeX. If left blank `makeindex' will be used as the
635 # default command name.
637 MAKEINDEX_CMD_NAME = makeindex
639 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
640 # LaTeX documents. This may be useful for small projects and may help to
641 # save some trees in general.
645 # The PAPER_TYPE tag can be used to set the paper type that is used
646 # by the printer. Possible values are: a4, a4wide, letter, legal and
647 # executive. If left blank a4wide will be used.
651 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
652 # packages that should be included in the LaTeX output.
656 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
657 # the generated latex document. The header should contain everything until
658 # the first chapter. If it is left blank doxygen will generate a
659 # standard header. Notice: only use this tag if you know what you are doing!
663 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
664 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
665 # contain links (just like the HTML output) instead of page references
666 # This makes the output suitable for online browsing using a pdf viewer.
670 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
671 # plain latex in the generated Makefile. Set this option to YES to get a
672 # higher quality PDF documentation.
676 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
677 # command to the generated LaTeX files. This will instruct LaTeX to keep
678 # running if errors occur, instead of asking the user for help.
679 # This option is also used when generating formulas in HTML.
683 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
684 # include the index chapters (such as File Index, Compound Index, etc.)
687 LATEX_HIDE_INDICES = NO
689 #---------------------------------------------------------------------------
690 # configuration options related to the RTF output
691 #---------------------------------------------------------------------------
693 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
694 # The RTF output is optimised for Word 97 and may not look very pretty with
695 # other RTF readers or editors.
699 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
700 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
701 # put in front of it. If left blank `rtf' will be used as the default path.
705 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
706 # RTF documents. This may be useful for small projects and may help to
707 # save some trees in general.
711 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
712 # will contain hyperlink fields. The RTF file will
713 # contain links (just like the HTML output) instead of page references.
714 # This makes the output suitable for online browsing using WORD or other
715 # programs which support those fields.
716 # Note: wordpad (write) and others do not support links.
720 # Load stylesheet definitions from file. Syntax is similar to doxygen's
721 # config file, i.e. a series of assigments. You only have to provide
722 # replacements, missing definitions are set to their default value.
724 RTF_STYLESHEET_FILE =
726 # Set optional variables used in the generation of an rtf document.
727 # Syntax is similar to doxygen's config file.
729 RTF_EXTENSIONS_FILE =
731 #---------------------------------------------------------------------------
732 # configuration options related to the man page output
733 #---------------------------------------------------------------------------
735 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
740 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
741 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
742 # put in front of it. If left blank `man' will be used as the default path.
746 # The MAN_EXTENSION tag determines the extension that is added to
747 # the generated man pages (default is the subroutine's section .3)
751 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
752 # then it will generate one additional man file for each entity
753 # documented in the real man page(s). These additional files
754 # only source the real man page, but without them the man command
755 # would be unable to find the correct page. The default is NO.
759 #---------------------------------------------------------------------------
760 # configuration options related to the XML output
761 #---------------------------------------------------------------------------
763 # If the GENERATE_XML tag is set to YES Doxygen will
764 # generate an XML file that captures the structure of
765 # the code including all documentation. Note that this
766 # feature is still experimental and incomplete at the
771 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
772 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
773 # put in front of it. If left blank `xml' will be used as the default path.
777 # The XML_SCHEMA tag can be used to specify an XML schema,
778 # which can be used by a validating XML parser to check the
779 # syntax of the XML files.
783 # The XML_DTD tag can be used to specify an XML DTD,
784 # which can be used by a validating XML parser to check the
785 # syntax of the XML files.
790 #---------------------------------------------------------------------------
791 # configuration options for the AutoGen Definitions output
792 #---------------------------------------------------------------------------
794 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
795 # generate an AutoGen Definitions (see autogen.sf.net) file
796 # that captures the structure of the code including all
797 # documentation. Note that this feature is still experimental
798 # and incomplete at the moment.
800 GENERATE_AUTOGEN_DEF = NO
802 #---------------------------------------------------------------------------
803 # configuration options related to the Perl module output
804 #---------------------------------------------------------------------------
806 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
807 # generate a Perl module file that captures the structure of
808 # the code including all documentation. Note that this
809 # feature is still experimental and incomplete at the
812 GENERATE_PERLMOD = NO
814 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
815 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
816 # to generate PDF and DVI output from the Perl module output.
820 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
821 # nicely formatted so it can be parsed by a human reader. This is useful
822 # if you want to understand what is going on. On the other hand, if this
823 # tag is set to NO the size of the Perl module output will be much smaller
824 # and Perl will parse it just the same.
828 # The names of the make variables in the generated doxyrules.make file
829 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
830 # This is useful so different doxyrules.make files included by the same
831 # Makefile don't overwrite each other's variables.
833 PERLMOD_MAKEVAR_PREFIX =
835 #---------------------------------------------------------------------------
836 # Configuration options related to the preprocessor
837 #---------------------------------------------------------------------------
839 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
840 # evaluate all C-preprocessor directives found in the sources and include
843 ENABLE_PREPROCESSING = YES
845 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
846 # names in the source code. If set to NO (the default) only conditional
847 # compilation will be performed. Macro expansion can be done in a controlled
848 # way by setting EXPAND_ONLY_PREDEF to YES.
852 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
853 # then the macro expansion is limited to the macros specified with the
854 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
856 EXPAND_ONLY_PREDEF = NO
858 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
859 # in the INCLUDE_PATH (see below) will be search if a #include is found.
861 SEARCH_INCLUDES = YES
863 # The INCLUDE_PATH tag can be used to specify one or more directories that
864 # contain include files that are not input files but should be processed by
869 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
870 # patterns (like *.h and *.hpp) to filter out the header-files in the
871 # directories. If left blank, the patterns specified with FILE_PATTERNS will
874 INCLUDE_FILE_PATTERNS =
876 # The PREDEFINED tag can be used to specify one or more macro names that
877 # are defined before the preprocessor is started (similar to the -D option of
878 # gcc). The argument of the tag is a list of macros of the form: name
879 # or name=definition (no spaces). If the definition and the = are
880 # omitted =1 is assumed.
884 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
885 # this tag can be used to specify a list of macro names that should be expanded.
886 # The macro definition that is found in the sources will be used.
887 # Use the PREDEFINED tag if you want to use a different macro definition.
891 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
892 # doxygen's preprocessor will remove all function-like macros that are alone
893 # on a line and do not end with a semicolon. Such function macros are typically
894 # used for boiler-plate code, and will confuse the parser if not removed.
896 SKIP_FUNCTION_MACROS = YES
898 #---------------------------------------------------------------------------
899 # Configuration::addtions related to external references
900 #---------------------------------------------------------------------------
902 # The TAGFILES tag can be used to specify one or more tagfiles.
906 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
907 # a tag file that is based on the input files it reads.
911 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
912 # in the class index. If set to NO only the inherited external classes
917 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
918 # in the modules index. If set to NO, only the current project's groups will
921 EXTERNAL_GROUPS = YES
923 # The PERL_PATH should be the absolute path and name of the perl script
924 # interpreter (i.e. the result of `which perl').
926 PERL_PATH = /usr/bin/perl
928 #---------------------------------------------------------------------------
929 # Configuration options related to the dot tool
930 #---------------------------------------------------------------------------
932 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
933 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
934 # super classes. Setting the tag to NO turns the diagrams off. Note that this
935 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
936 # recommended to install and use dot, since it yield more powerful graphs.
940 # If set to YES, the inheritance and collaboration graphs will hide
941 # inheritance and usage relations if the target is undocumented
944 HIDE_UNDOC_RELATIONS = YES
946 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
947 # available from the path. This tool is part of Graphviz, a graph visualization
948 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
949 # have no effect if this option is set to NO (the default)
953 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
954 # will generate a graph for each documented class showing the direct and
955 # indirect inheritance relations. Setting this tag to YES will force the
956 # the CLASS_DIAGRAMS tag to NO.
960 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
961 # will generate a graph for each documented class showing the direct and
962 # indirect implementation dependencies (inheritance, containment, and
963 # class references variables) of the class with other documented classes.
965 COLLABORATION_GRAPH = YES
967 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
968 # collaboration diagrams in a style similiar to the OMG's Unified Modeling
972 # If set to YES, the inheritance and collaboration graphs will show the
973 # relations between templates and their instances.
975 TEMPLATE_RELATIONS = YES
977 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
978 # tags are set to YES then doxygen will generate a graph for each documented
979 # file showing the direct and indirect include dependencies of the file with
980 # other documented files.
984 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
985 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
986 # documented header file showing the documented files that directly or
987 # indirectly include this file.
989 INCLUDED_BY_GRAPH = YES
991 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
992 # generate a call dependency graph for every global function or class method.
993 # Note that enabling this option will significantly increase the time of a run.
994 # So in most cases it will be better to enable call graphs for selected
995 # functions only using the \callgraph command.
999 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1000 # will graphical hierarchy of all classes instead of a textual one.
1002 GRAPHICAL_HIERARCHY = YES
1004 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1005 # generated by dot. Possible values are gif, jpg, and png
1006 # If left blank gif will be used.
1008 DOT_IMAGE_FORMAT = png
1010 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1011 # found. If left blank, it is assumed the dot tool can be found on the path.
1015 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1016 # contain dot files that are included in the documentation (see the
1017 # \dotfile command).
1021 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1022 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1023 # this value, doxygen will try to truncate the graph, so that it fits within
1024 # the specified constraint. Beware that most browsers cannot cope with very
1027 MAX_DOT_GRAPH_WIDTH = 1024
1029 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1030 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1031 # this value, doxygen will try to truncate the graph, so that it fits within
1032 # the specified constraint. Beware that most browsers cannot cope with very
1035 MAX_DOT_GRAPH_HEIGHT = 1024
1037 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1038 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1039 # from the root by following a path via at most 3 edges will be shown. Nodes that
1040 # lay further from the root node will be omitted. Note that setting this option to
1041 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1042 # note that a graph may be further truncated if the graph's image dimensions are
1043 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1044 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1046 MAX_DOT_GRAPH_DEPTH = 0
1048 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1049 # generate a legend page explaining the meaning of the various boxes and
1050 # arrows in the dot generated graphs.
1052 GENERATE_LEGEND = YES
1054 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1055 # remove the intermedate dot files that are used to generate
1056 # the various graphs.
1060 #---------------------------------------------------------------------------
1061 # Configuration::addtions related to the search engine
1062 #---------------------------------------------------------------------------
1064 # The SEARCHENGINE tag specifies whether or not a search engine should be
1065 # used. If set to NO the values of all tags below this one will be ignored.
1069 # The CGI_NAME tag should be the name of the CGI script that
1070 # starts the search engine (doxysearch) with the correct parameters.
1071 # A script with this name will be generated by doxygen.
1073 CGI_NAME = search.cgi
1075 # The CGI_URL tag should be the absolute URL to the directory where the
1076 # cgi binaries are located. See the documentation of your http daemon for
1081 # The DOC_URL tag should be the absolute URL to the directory where the
1082 # documentation is located. If left blank the absolute path to the
1083 # documentation, with file:// prepended to it, will be used.
1087 # The DOC_ABSPATH tag should be the absolute path to the directory where the
1088 # documentation is located. If left blank the directory on the local machine
1093 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1096 BIN_ABSPATH = /usr/local/bin/
1098 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
1099 # documentation generated for other projects. This allows doxysearch to search
1100 # the documentation for these projects as well.