1 # ---------------------------------------------------------------------
3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9 # This software is governed by the CeCILL-B license under French law and
10 # abiding by the rules of distribution of free software. You can use,
11 # modify and/ or redistribute the software under the terms of the CeCILL-B
12 # license as circulated by CEA, CNRS and INRIA at the following URL
13 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
14 # or in the file LICENSE.txt.
16 # As a counterpart to the access to the source code and rights to copy,
17 # modify and redistribute granted by the license, users are provided only
18 # with a limited warranty and the software's author, the holder of the
19 # economic rights, and the successive licensors have only limited
22 # The fact that you are presently reading this means that you have had
23 # knowledge of the CeCILL-B license and that you accept its terms.
24 # ------------------------------------------------------------------------ */
28 # This file describes the settings to be used by the documentation system
29 # doxygen (www.doxygen.org) for a project
31 # All text after a hash (#) is considered a comment and will be ignored
33 # TAG = value [value, ...]
34 # For lists items can also be appended using:
35 # TAG += value [value, ...]
36 # Values that contain spaces should be placed between quotes (" ")
38 #---------------------------------------------------------------------------
39 # General configuration options
40 #---------------------------------------------------------------------------
42 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
43 # by quotes) that should identify the project.
44 PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
46 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
47 # This could be handy for archiving the generated documentation or
48 # if some version control system is used.
49 PROJECT_NUMBER = @PROJECT_VERSION@
51 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
52 # base path where the generated documentation will be put.
53 # If a relative path is entered, it will be relative to the location
54 # where doxygen was started. If left blank the current directory will be used.
55 OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT@
57 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
58 # documentation generated by doxygen is written. Doxygen will use this
59 # information to generate all constant output in the proper language.
60 # The default language is English, other supported languages are:
61 # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
62 # German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
63 # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
64 OUTPUT_LANGUAGE = English
66 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
67 # documentation are documented, even if no documentation was available.
68 # Private class members and static file members will be hidden unless
69 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
72 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
73 # will be included in the documentation.
76 # If the EXTRACT_STATIC tag is set to YES all static members of a file
77 # will be included in the documentation.
80 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
81 # defined locally in source files will be included in the documentation.
82 # If set to NO only classes defined in header files are included.
83 EXTRACT_LOCAL_CLASSES = YES
85 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
86 # undocumented members of documented classes, files or namespaces.
87 # If set to NO (the default) these members will be included in the
88 # various overviews, but no documentation section is generated.
89 # This option has no effect if EXTRACT_ALL is enabled.
90 HIDE_UNDOC_MEMBERS = NO
92 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
93 # undocumented classes that are normally visible in the class hierarchy.
94 # If set to NO (the default) these class will be included in the various
95 # overviews. This option has no effect if EXTRACT_ALL is enabled.
96 HIDE_UNDOC_CLASSES = NO
98 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
99 # include brief member descriptions after the members that are listed in
100 # the file and class documentation (similar to JavaDoc).
101 # Set to NO to disable this.
102 BRIEF_MEMBER_DESC = YES
104 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
105 # the brief description of a member or function before the detailed description.
106 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107 # brief descriptions will be completely suppressed.
110 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
111 # Doxygen will generate a detailed section even if there is only a brief
113 ALWAYS_DETAILED_SEC = NO
115 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
116 # members of a class in the documentation of that class as if those members were
117 # ordinary class members. Constructors, destructors and assignment operators of
118 # the base classes will not be shown.
119 INLINE_INHERITED_MEMB = YES
121 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
122 # path before files name in the file list and in the header files. If set
123 # to NO the shortest path that makes the file name unique will be used.
124 FULL_PATH_NAMES = YES
126 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
127 # can be used to strip a user defined part of the path. Stripping is
128 # only done if one of the specified strings matches the left-hand part of
129 # the path. It is allowed to use relative paths in the argument list.
132 # The INTERNAL_DOCS tag determines if documentation
133 # that is typed after a \internal command is included. If the tag is set
134 # to NO (the default) then the documentation will be excluded.
135 # Set it to YES to include the internal documentation.
138 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
139 # doxygen to hide any special comment blocks from generated source code
140 # fragments. Normal C and C++ comments will always remain visible.
141 STRIP_CODE_COMMENTS = YES
143 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
144 # file names in lower case letters. If set to YES upper case letters are also
145 # allowed. This is useful if you have classes or files whose names only differ
146 # in case and if your file system supports case sensitive file names. Windows
147 # users are adviced to set this option to NO.
148 CASE_SENSE_NAMES = YES
150 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
151 # (but less readable) file names. This can be useful is your file systems
152 # doesn't support long names like on DOS, Mac, or CD-ROM.
155 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
156 # will show members with their full class and namespace scopes in the
157 # documentation. If set to YES the scope will be hidden.
158 HIDE_SCOPE_NAMES = NO
160 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
161 # will generate a verbatim copy of the header file for each class for
162 # which an include is specified. Set to NO to disable this.
163 VERBATIM_HEADERS = YES
165 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
166 # will put list of the files that are included by a file in the documentation
168 SHOW_INCLUDE_FILES = YES
170 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
171 # will interpret the first line (until the first dot) of a JavaDoc-style
172 # comment as the brief description. If set to NO, the JavaDoc
173 # comments will behave just like the Qt-style comments (thus requiring an
174 # explict @brief command for a brief description.
175 JAVADOC_AUTOBRIEF = NO
177 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
178 # member inherits the documentation from any documented member that it
182 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
183 # is inserted in the documentation for inline members.
186 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
187 # will sort the (detailed) documentation of file and class members
188 # alphabetically by member name. If set to NO the members will appear in
190 SORT_MEMBER_DOCS = YES
192 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
193 # tag is set to YES, then doxygen will reuse the documentation of the first
194 # member in the group (if any) for the other members of the group. By default
195 # all members of a group must be documented explicitly.
196 DISTRIBUTE_GROUP_DOC = NO
198 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
199 # Doxygen uses this value to replace tabs by spaces in code fragments.
202 # The GENERATE_TODOLIST tag can be used to enable (YES) or
203 # disable (NO) the todo list. This list is created by putting \todo
204 # commands in the documentation.
205 GENERATE_TODOLIST = YES
207 # The GENERATE_TESTLIST tag can be used to enable (YES) or
208 # disable (NO) the test list. This list is created by putting \test
209 # commands in the documentation.
210 GENERATE_TESTLIST = YES
212 # The GENERATE_BUGLIST tag can be used to enable (YES) or
213 # disable (NO) the bug list. This list is created by putting \bug
214 # commands in the documentation.
215 GENERATE_BUGLIST = YES
217 # This tag can be used to specify a number of aliases that acts
218 # as commands in the documentation. An alias has the form "name=value".
219 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
220 # put the command \sideeffect (or @sideeffect) in the documentation, which
221 # will result in a user defined paragraph with heading "Side Effects:".
222 # You can put \n's in the value part of an alias to insert newlines.
225 # The ENABLED_SECTIONS tag can be used to enable conditional
226 # documentation sections, marked by \if sectionname ... \endif.
229 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
230 # the initial value of a variable or define consist of for it to appear in
231 # the documentation. If the initializer consists of more lines than specified
232 # here it will be hidden. Use a value of 0 to hide initializers completely.
233 # The appearance of the initializer of individual variables and defines in the
234 # documentation can be controlled using \showinitializer or \hideinitializer
235 # command in the documentation regardless of this setting.
236 MAX_INITIALIZER_LINES = 30
238 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
239 # only. Doxygen will then generate output that is more tailored for C.
240 # For instance some of the names that are used will be different. The list
241 # of all members will be omitted, etc.
242 OPTIMIZE_OUTPUT_FOR_C = NO
244 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
245 # at the bottom of the documentation of classes and structs. If set to YES the
246 # list will mention the files that were used to generate the documentation.
247 SHOW_USED_FILES = YES
249 #---------------------------------------------------------------------------
250 # configuration options related to warning and progress messages
251 #---------------------------------------------------------------------------
253 # The QUIET tag can be used to turn on/off the messages that are generated
254 # by doxygen. Possible values are YES and NO. If left blank NO is used.
257 # The WARNINGS tag can be used to turn on/off the warning messages that are
258 # generated by doxygen. Possible values are YES and NO. If left blank
262 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
263 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
264 # automatically be disabled.
265 WARN_IF_UNDOCUMENTED = YES
267 # If WARN_IF_DOC_ERROR is set to YES, then doxygen will generate warnings
268 # for error documented members. If EXTRACT_ALL is set to YES then this flag will
269 # automatically be disabled.
270 WARN_IF_DOC_ERROR = YES
272 # The WARN_FORMAT tag determines the format of the warning messages that
273 # doxygen can produce. The string should contain the $file, $line, and $text
274 # tags, which will be replaced by the file and line number from which the
275 # warning originated and the warning text.
276 WARN_FORMAT = "$file:$line: $text"
278 # The WARN_LOGFILE tag can be used to specify a file to which warning
279 # and error messages should be written. If left blank the output is written
281 WARN_LOGFILE = @DOXYGEN_LOGFILE@
283 #---------------------------------------------------------------------------
284 # configuration options related to the input files
285 #---------------------------------------------------------------------------
287 # The INPUT tag can be used to specify the files and/or directories that contain
288 # documented source files. You may enter file names like "myfile.cpp" or
289 # directories like "/usr/src/myproject". Separate the files or directories
291 INPUT = @DOXYGEN_INPUT@
293 # If the value of the INPUT tag contains directories, you can use the
294 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
295 # and *.h) to filter out the source-files in the directories. If left
296 # blank the following patterns are tested:
297 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
299 FILE_PATTERNS = *.h *.cxx *.txx
301 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
302 # should be searched for input files as well. Possible values are YES and NO.
303 # If left blank NO is used.
306 # The EXCLUDE tag can be used to specify files and/or directories that should
307 # excluded from the INPUT source files. This way you can easily exclude a
308 # subdirectory from a directory tree whose root is specified with the INPUT tag.
309 EXCLUDE = @DOXYGEN_EXCLUDE@
311 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
312 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
313 EXCLUDE_SYMLINKS = NO
315 # If the value of the INPUT tag contains directories, you can use the
316 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
317 # certain files from those directories.
320 # The EXAMPLE_PATH tag can be used to specify one or more files or
321 # directories that contain example code fragments that are included (see
322 # the \include command).
325 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
326 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
327 # and *.h) to filter out the source-files in the directories. If left
328 # blank all files are included.
329 EXAMPLE_PATTERNS = *.cxx
331 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
332 # searched for input files to be used with the \include or \dontinclude
333 # commands irrespective of the value of the RECURSIVE tag.
334 # Possible values are YES and NO. If left blank NO is used.
335 EXAMPLE_RECURSIVE = NO
337 # The IMAGE_PATH tag can be used to specify one or more files or
338 # directories that contain image that are included in the documentation (see
339 # the \image command).
342 # The INPUT_FILTER tag can be used to specify a program that doxygen should
343 # invoke to filter for each input file. Doxygen will invoke the filter program
344 # by executing (via popen()) the command <filter> <input-file>, where <filter>
345 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
346 # input file. Doxygen will then use the output that the filter program writes
347 # to standard output.
350 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
351 # INPUT_FILTER) will be used to filter the input files when producing source
353 FILTER_SOURCE_FILES = NO
355 #---------------------------------------------------------------------------
356 # configuration options related to source browsing
357 #---------------------------------------------------------------------------
359 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
360 # be generated. Documented entities will be cross-referenced with these sources.
363 # Setting the INLINE_SOURCES tag to YES will include the body
364 # of functions and classes directly in the documentation.
367 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
368 # then for each documented function all documented
369 # functions referencing it will be listed.
370 REFERENCED_BY_RELATION = YES
372 # If the REFERENCES_RELATION tag is set to YES (the default)
373 # then for each documented function all documented entities
374 # called/used by that function will be listed.
375 REFERENCES_RELATION = YES
377 #---------------------------------------------------------------------------
378 # configuration options related to the alphabetical class index
379 #---------------------------------------------------------------------------
381 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
382 # of all compounds will be generated. Enable this if the project
383 # contains a lot of classes, structs, unions or interfaces.
384 ALPHABETICAL_INDEX = YES
386 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
387 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
388 # in which this list will be split (can be a number in the range [1..20])
389 COLS_IN_ALPHA_INDEX = 3
391 # In case all classes in a project start with a common prefix, all
392 # classes will be put under the same header in the alphabetical index.
393 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
394 # should be ignored while generating the index headers.
397 #---------------------------------------------------------------------------
398 # configuration options related to the HTML output
399 #---------------------------------------------------------------------------
401 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
402 # generate HTML output.
405 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
406 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
407 # put in front of it. If left blank `html' will be used as the default path.
408 HTML_OUTPUT = @DOXYGEN_HTML_OUTPUT@
410 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
411 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
412 # doxygen will generate files with .html extension.
413 HTML_FILE_EXTENSION = .html
415 # The HTML_HEADER tag can be used to specify a personal HTML header for
416 # each generated HTML page. If it is left blank doxygen will generate a
420 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
421 # each generated HTML page. If it is left blank doxygen will generate a
425 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
426 # style sheet that is used by each HTML page. It can be used to
427 # fine-tune the look of the HTML output. If the tag is left blank doxygen
428 # will generate a default style sheet
431 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
432 # files or namespaces will be aligned in HTML using tables. If set to
433 # NO a bullet list will be used.
434 HTML_ALIGN_MEMBERS = YES
436 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
437 # will be generated that can be used as input for tools like the
438 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
439 # of the generated HTML documentation.
440 GENERATE_HTMLHELP = NO
442 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
443 # controls if a separate .chi index file is generated (YES) or that
444 # it should be included in the master .chm file (NO).
447 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
448 # controls whether a binary table of contents is generated (YES) or a
449 # normal table of contents (NO) in the .chm file.
452 # The TOC_EXPAND flag can be set to YES to add extra items for group members
453 # to the contents of the Html help documentation and to the tree view.
456 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
457 # top of each HTML page. The value NO (the default) enables the index and
458 # the value YES disables it.
461 # This tag can be used to set the number of enum values (range [1..20])
462 # that doxygen will group on one line in the generated HTML documentation.
463 ENUM_VALUES_PER_LINE = 4
465 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
466 # generated containing a tree-like index structure (just like the one that
467 # is generated for HTML Help). For this to work a browser that supports
468 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
469 # or Internet explorer 4.0+). Note that for large projects the tree generation
470 # can take a very long time. In such cases it is better to disable this feature.
471 # Windows users are probably better off using the HTML help feature.
472 GENERATE_TREEVIEW = YES
474 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
475 # used to set the initial width (in pixels) of the frame in which the tree
479 #---------------------------------------------------------------------------
480 # configuration options related to the LaTeX output
481 #---------------------------------------------------------------------------
483 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
484 # generate Latex output.
487 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
488 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
489 # put in front of it. If left blank `latex' will be used as the default path.
492 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
493 # LaTeX documents. This may be useful for small projects and may help to
494 # save some trees in general.
497 # The PAPER_TYPE tag can be used to set the paper type that is used
498 # by the printer. Possible values are: a4, a4wide, letter, legal and
499 # executive. If left blank a4wide will be used.
502 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
503 # packages that should be included in the LaTeX output.
506 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
507 # the generated latex document. The header should contain everything until
508 # the first chapter. If it is left blank doxygen will generate a
509 # standard header. Notice: only use this tag if you know what you are doing!
512 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
513 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
514 # contain links (just like the HTML output) instead of page references
515 # This makes the output suitable for online browsing using a pdf viewer.
518 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
519 # plain latex in the generated Makefile. Set this option to YES to get a
520 # higher quality PDF documentation.
523 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
524 # command to the generated LaTeX files. This will instruct LaTeX to keep
525 # running if errors occur, instead of asking the user for help.
526 # This option is also used when generating formulas in HTML.
529 #---------------------------------------------------------------------------
530 # configuration options related to the RTF output
531 #---------------------------------------------------------------------------
533 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
534 # The RTF output is optimised for Word 97 and may not look very pretty with
535 # other RTF readers or editors.
538 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
539 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
540 # put in front of it. If left blank `rtf' will be used as the default path.
543 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
544 # RTF documents. This may be useful for small projects and may help to
545 # save some trees in general.
548 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
549 # will contain hyperlink fields. The RTF file will
550 # contain links (just like the HTML output) instead of page references.
551 # This makes the output suitable for online browsing using WORD or other
552 # programs which support those fields.
553 # Note: wordpad (write) and others do not support links.
556 # Load stylesheet definitions from file. Syntax is similar to doxygen's
557 # config file, i.e. a series of assigments. You only have to provide
558 # replacements, missing definitions are set to their default value.
559 RTF_STYLESHEET_FILE =
561 # Set optional variables used in the generation of an rtf document.
562 # Syntax is similar to doxygen's config file.
563 RTF_EXTENSIONS_FILE =
565 #---------------------------------------------------------------------------
566 # configuration options related to the man page output
567 #---------------------------------------------------------------------------
569 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
573 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
574 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
575 # put in front of it. If left blank `man' will be used as the default path.
578 # The MAN_EXTENSION tag determines the extension that is added to
579 # the generated man pages (default is the subroutine's section .3)
582 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
583 # then it will generate one additional man file for each entity
584 # documented in the real man page(s). These additional files
585 # only source the real man page, but without them the man command
586 # would be unable to find the correct page. The default is NO.
589 #---------------------------------------------------------------------------
590 # configuration options related to the XML output
591 #---------------------------------------------------------------------------
593 # If the GENERATE_XML tag is set to YES Doxygen will
594 # generate an XML file that captures the structure of
595 # the code including all documentation. Note that this
596 # feature is still experimental and incomplete at the
600 #---------------------------------------------------------------------------
601 # configuration options for the AutoGen Definitions output
602 #---------------------------------------------------------------------------
604 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
605 # generate an AutoGen Definitions (see autogen.sf.net) file
606 # that captures the structure of the code including all
607 # documentation. Note that this feature is still experimental
608 # and incomplete at the moment.
609 GENERATE_AUTOGEN_DEF = NO
611 #---------------------------------------------------------------------------
612 # Configuration options related to the preprocessor
613 #---------------------------------------------------------------------------
615 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
616 # evaluate all C-preprocessor directives found in the sources and include
618 ENABLE_PREPROCESSING = YES
620 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
621 # names in the source code. If set to NO (the default) only conditional
622 # compilation will be performed. Macro expansion can be done in a controlled
623 # way by setting EXPAND_ONLY_PREDEF to YES.
624 MACRO_EXPANSION = YES
626 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
627 # then the macro expansion is limited to the macros specified with the
628 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
629 EXPAND_ONLY_PREDEF = NO
631 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
632 # in the INCLUDE_PATH (see below) will be search if a #include is found.
633 SEARCH_INCLUDES = YES
635 # The INCLUDE_PATH tag can be used to specify one or more directories that
636 # contain include files that are not input files but should be processed by
640 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
641 # patterns (like *.h and *.hpp) to filter out the header-files in the
642 # directories. If left blank, the patterns specified with FILE_PATTERNS will
644 INCLUDE_FILE_PATTERNS =
646 # The PREDEFINED tag can be used to specify one or more macro names that
647 # are defined before the preprocessor is started (similar to the -D option of
648 # gcc). The argument of the tag is a list of macros of the form: name
649 # or name=definition (no spaces). If the definition and the = are
650 # omitted =1 is assumed.
651 PREDEFINED = @DOXYGEN_DOC_PREDEFINED@
654 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
655 # this tag can be used to specify a list of macro names that should be expanded.
656 # The macro definition that is found in the sources will be used.
657 # Use the PREDEFINED tag if you want to use a different macro definition.
660 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
661 # doxygen's preprocessor will remove all function-like macros that are alone
662 # on a line and do not end with a semicolon. Such function macros are typically
663 # used for boiler-plate code, and will confuse the parser if not removed.
664 SKIP_FUNCTION_MACROS = YES
666 #---------------------------------------------------------------------------
667 # Configuration::addtions related to external references
668 #---------------------------------------------------------------------------
670 # The TAGFILES tag can be used to specify one or more tagfiles.
673 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
674 # a tag file that is based on the input files it reads.
677 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
678 # in the class index. If set to NO only the inherited external classes
682 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
683 # in the modules index. If set to NO, only the current project's groups will
685 EXTERNAL_GROUPS = YES
687 # The PERL_PATH should be the absolute path and name of the perl script
688 # interpreter (i.e. the result of `which perl').
689 PERL_PATH = /usr/bin/perl
691 #---------------------------------------------------------------------------
692 # Configuration options related to the dot tool
693 #---------------------------------------------------------------------------
695 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
696 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
697 # super classes. Setting the tag to NO turns the diagrams off. Note that this
698 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
699 # recommended to install and use dot, since it yield more powerful graphs.
702 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
703 # available from the path. This tool is part of Graphviz, a graph visualization
704 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
705 # have no effect if this option is set to NO (the default)
706 HAVE_DOT = @DOXYGEN_HAVE_DOT@
708 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
709 # will generate a graph for each documented class showing the direct and
710 # indirect inheritance relations. Setting this tag to YES will force the
711 # the CLASS_DIAGRAMS tag to NO.
714 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
715 # will generate a graph for each documented class showing the direct and
716 # indirect implementation dependencies (inheritance, containment, and
717 # class references variables) of the class with other documented classes.
718 COLLABORATION_GRAPH = YES
720 # If set to YES, the inheritance and collaboration graphs will show the
721 # relations between templates and their instances.
722 TEMPLATE_RELATIONS = YES
724 # If set to YES, the inheritance and collaboration graphs will hide
725 # inheritance and usage relations if the target is undocumented
727 HIDE_UNDOC_RELATIONS = YES
729 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
730 # tags are set to YES then doxygen will generate a graph for each documented
731 # file showing the direct and indirect include dependencies of the file with
732 # other documented files.
735 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
736 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
737 # documented header file showing the documented files that directly or
738 # indirectly include this file.
739 INCLUDED_BY_GRAPH = YES
741 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
742 # will graphical hierarchy of all classes instead of a textual one.
743 GRAPHICAL_HIERARCHY = YES
745 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
746 # generated by dot. Possible values are gif, jpg, and png
747 # If left blank gif will be used.
748 DOT_IMAGE_FORMAT = png
750 # The tag DOT_PATH can be used to specify the path where the dot tool can be
751 # found. If left blank, it is assumed the dot tool can be found on the path.
752 DOT_PATH = "@DOXYGEN_DOT_PATH@"
754 # The DOTFILE_DIRS tag can be used to specify one or more directories that
755 # contain dot files that are included in the documentation (see the
759 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
760 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
761 # this value, doxygen will try to truncate the graph, so that it fits within
762 # the specified constraint. Beware that most browsers cannot cope with very
764 MAX_DOT_GRAPH_WIDTH = 1024
766 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
767 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
768 # this value, doxygen will try to truncate the graph, so that it fits within
769 # the specified constraint. Beware that most browsers cannot cope with very
771 MAX_DOT_GRAPH_HEIGHT = 1024
773 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
774 # generate a legend page explaining the meaning of the various boxes and
775 # arrows in the dot generated graphs.
776 GENERATE_LEGEND = YES
778 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
779 # remove the intermedate dot files that are used to generate
780 # the various graphs.
783 #---------------------------------------------------------------------------
784 # Configuration::addtions related to the search engine
785 #---------------------------------------------------------------------------
787 # The SEARCHENGINE tag specifies whether or not a search engine should be
788 # used. If set to NO the values of all tags below this one will be ignored.