1 # ---------------------------------------------------------------------
3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7 # This software is governed by the CeCILL-B license under French law and
8 # abiding by the rules of distribution of free software. You can use,
9 # modify and/ or redistribute the software under the terms of the CeCILL-B
10 # license as circulated by CEA, CNRS and INRIA at the following URL
11 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
12 # or in the file LICENSE.txt.
14 # As a counterpart to the access to the source code and rights to copy,
15 # modify and redistribute granted by the license, users are provided only
16 # with a limited warranty and the software's author, the holder of the
17 # economic rights, and the successive licensors have only limited
20 # The fact that you are presently reading this means that you have had
21 # knowledge of the CeCILL-B license and that you accept its terms.
22 # ------------------------------------------------------------------------
26 # This file describes the settings to be used by the documentation system
27 # doxygen (www.doxygen.org) for a project
29 # All text after a hash (#) is considered a comment and will be ignored
31 # TAG = value [value, ...]
32 # For lists items can also be appended using:
33 # TAG += value [value, ...]
34 # Values that contain spaces should be placed between quotes (" ")
36 #---------------------------------------------------------------------------
37 # General configuration options
38 #---------------------------------------------------------------------------
40 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
41 # by quotes) that should identify the project.
42 PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
44 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
45 # This could be handy for archiving the generated documentation or
46 # if some version control system is used.
47 PROJECT_NUMBER = @PROJECT_VERSION@
49 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
50 # base path where the generated documentation will be put.
51 # If a relative path is entered, it will be relative to the location
52 # where doxygen was started. If left blank the current directory will be used.
53 OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT@
55 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
56 # documentation generated by doxygen is written. Doxygen will use this
57 # information to generate all constant output in the proper language.
58 # The default language is English, other supported languages are:
59 # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
60 # German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
61 # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
62 OUTPUT_LANGUAGE = English
64 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
65 # documentation are documented, even if no documentation was available.
66 # Private class members and static file members will be hidden unless
67 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
70 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
71 # will be included in the documentation.
74 # If the EXTRACT_STATIC tag is set to YES all static members of a file
75 # will be included in the documentation.
78 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
79 # defined locally in source files will be included in the documentation.
80 # If set to NO only classes defined in header files are included.
81 EXTRACT_LOCAL_CLASSES = YES
83 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
84 # undocumented members of documented classes, files or namespaces.
85 # If set to NO (the default) these members will be included in the
86 # various overviews, but no documentation section is generated.
87 # This option has no effect if EXTRACT_ALL is enabled.
88 HIDE_UNDOC_MEMBERS = NO
90 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
91 # undocumented classes that are normally visible in the class hierarchy.
92 # If set to NO (the default) these class will be included in the various
93 # overviews. This option has no effect if EXTRACT_ALL is enabled.
94 HIDE_UNDOC_CLASSES = NO
96 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
97 # include brief member descriptions after the members that are listed in
98 # the file and class documentation (similar to JavaDoc).
99 # Set to NO to disable this.
100 BRIEF_MEMBER_DESC = YES
102 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
103 # the brief description of a member or function before the detailed description.
104 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
105 # brief descriptions will be completely suppressed.
108 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
109 # Doxygen will generate a detailed section even if there is only a brief
111 ALWAYS_DETAILED_SEC = NO
113 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
114 # members of a class in the documentation of that class as if those members were
115 # ordinary class members. Constructors, destructors and assignment operators of
116 # the base classes will not be shown.
117 INLINE_INHERITED_MEMB = YES
119 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
120 # path before files name in the file list and in the header files. If set
121 # to NO the shortest path that makes the file name unique will be used.
122 FULL_PATH_NAMES = YES
124 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125 # can be used to strip a user defined part of the path. Stripping is
126 # only done if one of the specified strings matches the left-hand part of
127 # the path. It is allowed to use relative paths in the argument list.
130 # The INTERNAL_DOCS tag determines if documentation
131 # that is typed after a \internal command is included. If the tag is set
132 # to NO (the default) then the documentation will be excluded.
133 # Set it to YES to include the internal documentation.
136 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
137 # doxygen to hide any special comment blocks from generated source code
138 # fragments. Normal C and C++ comments will always remain visible.
139 STRIP_CODE_COMMENTS = YES
141 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
142 # file names in lower case letters. If set to YES upper case letters are also
143 # allowed. This is useful if you have classes or files whose names only differ
144 # in case and if your file system supports case sensitive file names. Windows
145 # users are adviced to set this option to NO.
146 CASE_SENSE_NAMES = YES
148 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
149 # (but less readable) file names. This can be useful is your file systems
150 # doesn't support long names like on DOS, Mac, or CD-ROM.
153 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
154 # will show members with their full class and namespace scopes in the
155 # documentation. If set to YES the scope will be hidden.
156 HIDE_SCOPE_NAMES = NO
158 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
159 # will generate a verbatim copy of the header file for each class for
160 # which an include is specified. Set to NO to disable this.
161 VERBATIM_HEADERS = YES
163 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
164 # will put list of the files that are included by a file in the documentation
166 SHOW_INCLUDE_FILES = YES
168 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
169 # will interpret the first line (until the first dot) of a JavaDoc-style
170 # comment as the brief description. If set to NO, the JavaDoc
171 # comments will behave just like the Qt-style comments (thus requiring an
172 # explict @brief command for a brief description.
173 JAVADOC_AUTOBRIEF = NO
175 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
176 # member inherits the documentation from any documented member that it
180 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
181 # is inserted in the documentation for inline members.
184 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
185 # will sort the (detailed) documentation of file and class members
186 # alphabetically by member name. If set to NO the members will appear in
188 SORT_MEMBER_DOCS = YES
190 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
191 # tag is set to YES, then doxygen will reuse the documentation of the first
192 # member in the group (if any) for the other members of the group. By default
193 # all members of a group must be documented explicitly.
194 DISTRIBUTE_GROUP_DOC = NO
196 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
197 # Doxygen uses this value to replace tabs by spaces in code fragments.
200 # The GENERATE_TODOLIST tag can be used to enable (YES) or
201 # disable (NO) the todo list. This list is created by putting \todo
202 # commands in the documentation.
203 GENERATE_TODOLIST = YES
205 # The GENERATE_TESTLIST tag can be used to enable (YES) or
206 # disable (NO) the test list. This list is created by putting \test
207 # commands in the documentation.
208 GENERATE_TESTLIST = YES
210 # The GENERATE_BUGLIST tag can be used to enable (YES) or
211 # disable (NO) the bug list. This list is created by putting \bug
212 # commands in the documentation.
213 GENERATE_BUGLIST = YES
215 # This tag can be used to specify a number of aliases that acts
216 # as commands in the documentation. An alias has the form "name=value".
217 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
218 # put the command \sideeffect (or @sideeffect) in the documentation, which
219 # will result in a user defined paragraph with heading "Side Effects:".
220 # You can put \n's in the value part of an alias to insert newlines.
223 # The ENABLED_SECTIONS tag can be used to enable conditional
224 # documentation sections, marked by \if sectionname ... \endif.
227 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
228 # the initial value of a variable or define consist of for it to appear in
229 # the documentation. If the initializer consists of more lines than specified
230 # here it will be hidden. Use a value of 0 to hide initializers completely.
231 # The appearance of the initializer of individual variables and defines in the
232 # documentation can be controlled using \showinitializer or \hideinitializer
233 # command in the documentation regardless of this setting.
234 MAX_INITIALIZER_LINES = 30
236 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
237 # only. Doxygen will then generate output that is more tailored for C.
238 # For instance some of the names that are used will be different. The list
239 # of all members will be omitted, etc.
240 OPTIMIZE_OUTPUT_FOR_C = NO
242 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
243 # at the bottom of the documentation of classes and structs. If set to YES the
244 # list will mention the files that were used to generate the documentation.
245 SHOW_USED_FILES = YES
247 #---------------------------------------------------------------------------
248 # configuration options related to warning and progress messages
249 #---------------------------------------------------------------------------
251 # The QUIET tag can be used to turn on/off the messages that are generated
252 # by doxygen. Possible values are YES and NO. If left blank NO is used.
255 # The WARNINGS tag can be used to turn on/off the warning messages that are
256 # generated by doxygen. Possible values are YES and NO. If left blank
260 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
261 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
262 # automatically be disabled.
263 WARN_IF_UNDOCUMENTED = YES
265 # If WARN_IF_DOC_ERROR is set to YES, then doxygen will generate warnings
266 # for error documented members. If EXTRACT_ALL is set to YES then this flag will
267 # automatically be disabled.
268 WARN_IF_DOC_ERROR = YES
270 # The WARN_FORMAT tag determines the format of the warning messages that
271 # doxygen can produce. The string should contain the $file, $line, and $text
272 # tags, which will be replaced by the file and line number from which the
273 # warning originated and the warning text.
274 WARN_FORMAT = "$file:$line: $text"
276 # The WARN_LOGFILE tag can be used to specify a file to which warning
277 # and error messages should be written. If left blank the output is written
279 WARN_LOGFILE = @DOXYGEN_LOGFILE@
281 #---------------------------------------------------------------------------
282 # configuration options related to the input files
283 #---------------------------------------------------------------------------
285 # The INPUT tag can be used to specify the files and/or directories that contain
286 # documented source files. You may enter file names like "myfile.cpp" or
287 # directories like "/usr/src/myproject". Separate the files or directories
289 INPUT = @DOXYGEN_INPUT@
291 # If the value of the INPUT tag contains directories, you can use the
292 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
293 # and *.h) to filter out the source-files in the directories. If left
294 # blank the following patterns are tested:
295 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
297 FILE_PATTERNS = *.h *.cxx *.txx
299 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
300 # should be searched for input files as well. Possible values are YES and NO.
301 # If left blank NO is used.
304 # The EXCLUDE tag can be used to specify files and/or directories that should
305 # excluded from the INPUT source files. This way you can easily exclude a
306 # subdirectory from a directory tree whose root is specified with the INPUT tag.
307 EXCLUDE = @DOXYGEN_EXCLUDE@
309 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
310 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
311 EXCLUDE_SYMLINKS = NO
313 # If the value of the INPUT tag contains directories, you can use the
314 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
315 # certain files from those directories.
318 # The EXAMPLE_PATH tag can be used to specify one or more files or
319 # directories that contain example code fragments that are included (see
320 # the \include command).
323 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
324 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
325 # and *.h) to filter out the source-files in the directories. If left
326 # blank all files are included.
327 EXAMPLE_PATTERNS = *.cxx
329 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
330 # searched for input files to be used with the \include or \dontinclude
331 # commands irrespective of the value of the RECURSIVE tag.
332 # Possible values are YES and NO. If left blank NO is used.
333 EXAMPLE_RECURSIVE = NO
335 # The IMAGE_PATH tag can be used to specify one or more files or
336 # directories that contain image that are included in the documentation (see
337 # the \image command).
340 # The INPUT_FILTER tag can be used to specify a program that doxygen should
341 # invoke to filter for each input file. Doxygen will invoke the filter program
342 # by executing (via popen()) the command <filter> <input-file>, where <filter>
343 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
344 # input file. Doxygen will then use the output that the filter program writes
345 # to standard output.
348 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
349 # INPUT_FILTER) will be used to filter the input files when producing source
351 FILTER_SOURCE_FILES = NO
353 #---------------------------------------------------------------------------
354 # configuration options related to source browsing
355 #---------------------------------------------------------------------------
357 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
358 # be generated. Documented entities will be cross-referenced with these sources.
361 # Setting the INLINE_SOURCES tag to YES will include the body
362 # of functions and classes directly in the documentation.
365 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
366 # then for each documented function all documented
367 # functions referencing it will be listed.
368 REFERENCED_BY_RELATION = YES
370 # If the REFERENCES_RELATION tag is set to YES (the default)
371 # then for each documented function all documented entities
372 # called/used by that function will be listed.
373 REFERENCES_RELATION = YES
375 #---------------------------------------------------------------------------
376 # configuration options related to the alphabetical class index
377 #---------------------------------------------------------------------------
379 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
380 # of all compounds will be generated. Enable this if the project
381 # contains a lot of classes, structs, unions or interfaces.
382 ALPHABETICAL_INDEX = YES
384 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
385 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
386 # in which this list will be split (can be a number in the range [1..20])
387 COLS_IN_ALPHA_INDEX = 3
389 # In case all classes in a project start with a common prefix, all
390 # classes will be put under the same header in the alphabetical index.
391 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
392 # should be ignored while generating the index headers.
395 #---------------------------------------------------------------------------
396 # configuration options related to the HTML output
397 #---------------------------------------------------------------------------
399 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
400 # generate HTML output.
403 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
404 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
405 # put in front of it. If left blank `html' will be used as the default path.
406 HTML_OUTPUT = @DOXYGEN_HTML_OUTPUT@
408 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
409 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
410 # doxygen will generate files with .html extension.
411 HTML_FILE_EXTENSION = .html
413 # The HTML_HEADER tag can be used to specify a personal HTML header for
414 # each generated HTML page. If it is left blank doxygen will generate a
418 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
419 # each generated HTML page. If it is left blank doxygen will generate a
423 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
424 # style sheet that is used by each HTML page. It can be used to
425 # fine-tune the look of the HTML output. If the tag is left blank doxygen
426 # will generate a default style sheet
429 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
430 # files or namespaces will be aligned in HTML using tables. If set to
431 # NO a bullet list will be used.
432 HTML_ALIGN_MEMBERS = YES
434 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
435 # will be generated that can be used as input for tools like the
436 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
437 # of the generated HTML documentation.
438 GENERATE_HTMLHELP = NO
440 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
441 # controls if a separate .chi index file is generated (YES) or that
442 # it should be included in the master .chm file (NO).
445 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
446 # controls whether a binary table of contents is generated (YES) or a
447 # normal table of contents (NO) in the .chm file.
450 # The TOC_EXPAND flag can be set to YES to add extra items for group members
451 # to the contents of the Html help documentation and to the tree view.
454 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
455 # top of each HTML page. The value NO (the default) enables the index and
456 # the value YES disables it.
459 # This tag can be used to set the number of enum values (range [1..20])
460 # that doxygen will group on one line in the generated HTML documentation.
461 ENUM_VALUES_PER_LINE = 4
463 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
464 # generated containing a tree-like index structure (just like the one that
465 # is generated for HTML Help). For this to work a browser that supports
466 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
467 # or Internet explorer 4.0+). Note that for large projects the tree generation
468 # can take a very long time. In such cases it is better to disable this feature.
469 # Windows users are probably better off using the HTML help feature.
470 GENERATE_TREEVIEW = YES
472 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
473 # used to set the initial width (in pixels) of the frame in which the tree
477 #---------------------------------------------------------------------------
478 # configuration options related to the LaTeX output
479 #---------------------------------------------------------------------------
481 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
482 # generate Latex output.
485 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
486 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
487 # put in front of it. If left blank `latex' will be used as the default path.
490 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
491 # LaTeX documents. This may be useful for small projects and may help to
492 # save some trees in general.
495 # The PAPER_TYPE tag can be used to set the paper type that is used
496 # by the printer. Possible values are: a4, a4wide, letter, legal and
497 # executive. If left blank a4wide will be used.
500 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
501 # packages that should be included in the LaTeX output.
504 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
505 # the generated latex document. The header should contain everything until
506 # the first chapter. If it is left blank doxygen will generate a
507 # standard header. Notice: only use this tag if you know what you are doing!
510 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
511 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
512 # contain links (just like the HTML output) instead of page references
513 # This makes the output suitable for online browsing using a pdf viewer.
516 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
517 # plain latex in the generated Makefile. Set this option to YES to get a
518 # higher quality PDF documentation.
521 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
522 # command to the generated LaTeX files. This will instruct LaTeX to keep
523 # running if errors occur, instead of asking the user for help.
524 # This option is also used when generating formulas in HTML.
527 #---------------------------------------------------------------------------
528 # configuration options related to the RTF output
529 #---------------------------------------------------------------------------
531 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
532 # The RTF output is optimised for Word 97 and may not look very pretty with
533 # other RTF readers or editors.
536 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
537 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
538 # put in front of it. If left blank `rtf' will be used as the default path.
541 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
542 # RTF documents. This may be useful for small projects and may help to
543 # save some trees in general.
546 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
547 # will contain hyperlink fields. The RTF file will
548 # contain links (just like the HTML output) instead of page references.
549 # This makes the output suitable for online browsing using WORD or other
550 # programs which support those fields.
551 # Note: wordpad (write) and others do not support links.
554 # Load stylesheet definitions from file. Syntax is similar to doxygen's
555 # config file, i.e. a series of assigments. You only have to provide
556 # replacements, missing definitions are set to their default value.
557 RTF_STYLESHEET_FILE =
559 # Set optional variables used in the generation of an rtf document.
560 # Syntax is similar to doxygen's config file.
561 RTF_EXTENSIONS_FILE =
563 #---------------------------------------------------------------------------
564 # configuration options related to the man page output
565 #---------------------------------------------------------------------------
567 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
571 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
572 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
573 # put in front of it. If left blank `man' will be used as the default path.
576 # The MAN_EXTENSION tag determines the extension that is added to
577 # the generated man pages (default is the subroutine's section .3)
580 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
581 # then it will generate one additional man file for each entity
582 # documented in the real man page(s). These additional files
583 # only source the real man page, but without them the man command
584 # would be unable to find the correct page. The default is NO.
587 #---------------------------------------------------------------------------
588 # configuration options related to the XML output
589 #---------------------------------------------------------------------------
591 # If the GENERATE_XML tag is set to YES Doxygen will
592 # generate an XML file that captures the structure of
593 # the code including all documentation. Note that this
594 # feature is still experimental and incomplete at the
598 #---------------------------------------------------------------------------
599 # configuration options for the AutoGen Definitions output
600 #---------------------------------------------------------------------------
602 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
603 # generate an AutoGen Definitions (see autogen.sf.net) file
604 # that captures the structure of the code including all
605 # documentation. Note that this feature is still experimental
606 # and incomplete at the moment.
607 GENERATE_AUTOGEN_DEF = NO
609 #---------------------------------------------------------------------------
610 # Configuration options related to the preprocessor
611 #---------------------------------------------------------------------------
613 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
614 # evaluate all C-preprocessor directives found in the sources and include
616 ENABLE_PREPROCESSING = YES
618 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
619 # names in the source code. If set to NO (the default) only conditional
620 # compilation will be performed. Macro expansion can be done in a controlled
621 # way by setting EXPAND_ONLY_PREDEF to YES.
622 MACRO_EXPANSION = YES
624 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
625 # then the macro expansion is limited to the macros specified with the
626 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
627 EXPAND_ONLY_PREDEF = NO
629 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
630 # in the INCLUDE_PATH (see below) will be search if a #include is found.
631 SEARCH_INCLUDES = YES
633 # The INCLUDE_PATH tag can be used to specify one or more directories that
634 # contain include files that are not input files but should be processed by
638 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
639 # patterns (like *.h and *.hpp) to filter out the header-files in the
640 # directories. If left blank, the patterns specified with FILE_PATTERNS will
642 INCLUDE_FILE_PATTERNS =
644 # The PREDEFINED tag can be used to specify one or more macro names that
645 # are defined before the preprocessor is started (similar to the -D option of
646 # gcc). The argument of the tag is a list of macros of the form: name
647 # or name=definition (no spaces). If the definition and the = are
648 # omitted =1 is assumed.
649 PREDEFINED = @DOXYGEN_DOC_PREDEFINED@
652 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
653 # this tag can be used to specify a list of macro names that should be expanded.
654 # The macro definition that is found in the sources will be used.
655 # Use the PREDEFINED tag if you want to use a different macro definition.
658 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
659 # doxygen's preprocessor will remove all function-like macros that are alone
660 # on a line and do not end with a semicolon. Such function macros are typically
661 # used for boiler-plate code, and will confuse the parser if not removed.
662 SKIP_FUNCTION_MACROS = YES
664 #---------------------------------------------------------------------------
665 # Configuration::addtions related to external references
666 #---------------------------------------------------------------------------
668 # The TAGFILES tag can be used to specify one or more tagfiles.
671 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
672 # a tag file that is based on the input files it reads.
675 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
676 # in the class index. If set to NO only the inherited external classes
680 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
681 # in the modules index. If set to NO, only the current project's groups will
683 EXTERNAL_GROUPS = YES
685 # The PERL_PATH should be the absolute path and name of the perl script
686 # interpreter (i.e. the result of `which perl').
687 PERL_PATH = /usr/bin/perl
689 #---------------------------------------------------------------------------
690 # Configuration options related to the dot tool
691 #---------------------------------------------------------------------------
693 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
694 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
695 # super classes. Setting the tag to NO turns the diagrams off. Note that this
696 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
697 # recommended to install and use dot, since it yield more powerful graphs.
700 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
701 # available from the path. This tool is part of Graphviz, a graph visualization
702 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
703 # have no effect if this option is set to NO (the default)
704 HAVE_DOT = @DOXYGEN_HAVE_DOT@
706 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
707 # will generate a graph for each documented class showing the direct and
708 # indirect inheritance relations. Setting this tag to YES will force the
709 # the CLASS_DIAGRAMS tag to NO.
712 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
713 # will generate a graph for each documented class showing the direct and
714 # indirect implementation dependencies (inheritance, containment, and
715 # class references variables) of the class with other documented classes.
716 COLLABORATION_GRAPH = YES
718 # If set to YES, the inheritance and collaboration graphs will show the
719 # relations between templates and their instances.
720 TEMPLATE_RELATIONS = YES
722 # If set to YES, the inheritance and collaboration graphs will hide
723 # inheritance and usage relations if the target is undocumented
725 HIDE_UNDOC_RELATIONS = YES
727 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
728 # tags are set to YES then doxygen will generate a graph for each documented
729 # file showing the direct and indirect include dependencies of the file with
730 # other documented files.
733 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
734 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
735 # documented header file showing the documented files that directly or
736 # indirectly include this file.
737 INCLUDED_BY_GRAPH = YES
739 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
740 # will graphical hierarchy of all classes instead of a textual one.
741 GRAPHICAL_HIERARCHY = YES
743 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
744 # generated by dot. Possible values are gif, jpg, and png
745 # If left blank gif will be used.
746 DOT_IMAGE_FORMAT = png
748 # The tag DOT_PATH can be used to specify the path where the dot tool can be
749 # found. If left blank, it is assumed the dot tool can be found on the path.
750 DOT_PATH = "@DOXYGEN_DOT_PATH@"
752 # The DOTFILE_DIRS tag can be used to specify one or more directories that
753 # contain dot files that are included in the documentation (see the
757 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
758 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
759 # this value, doxygen will try to truncate the graph, so that it fits within
760 # the specified constraint. Beware that most browsers cannot cope with very
762 MAX_DOT_GRAPH_WIDTH = 1024
764 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
765 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
766 # this value, doxygen will try to truncate the graph, so that it fits within
767 # the specified constraint. Beware that most browsers cannot cope with very
769 MAX_DOT_GRAPH_HEIGHT = 1024
771 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
772 # generate a legend page explaining the meaning of the various boxes and
773 # arrows in the dot generated graphs.
774 GENERATE_LEGEND = YES
776 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
777 # remove the intermedate dot files that are used to generate
778 # the various graphs.
781 #---------------------------------------------------------------------------
782 # Configuration::addtions related to the search engine
783 #---------------------------------------------------------------------------
785 # The SEARCHENGINE tag specifies whether or not a search engine should be
786 # used. If set to NO the values of all tags below this one will be ignored.