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 # ------------------------------------------------------------------------ */
29 # This file describes the settings to be used by the documentation system
30 # doxygen (www.doxygen.org) for a project
32 # All text after a hash (#) is considered a comment and will be ignored
34 # TAG = value [value, ...]
35 # For lists items can also be appended using:
36 # TAG += value [value, ...]
37 # Values that contain spaces should be placed between quotes (" ")
39 #---------------------------------------------------------------------------
40 # General configuration options
41 #---------------------------------------------------------------------------
43 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
44 # by quotes) that should identify the project.
45 PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
47 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
48 # This could be handy for archiving the generated documentation or
49 # if some version control system is used.
50 PROJECT_NUMBER = @PROJECT_VERSION@
52 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
53 # base path where the generated documentation will be put.
54 # If a relative path is entered, it will be relative to the location
55 # where doxygen was started. If left blank the current directory will be used.
56 OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT@
58 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
59 # documentation generated by doxygen is written. Doxygen will use this
60 # information to generate all constant output in the proper language.
61 # The default language is English, other supported languages are:
62 # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
63 # German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
64 # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
65 OUTPUT_LANGUAGE = English
67 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
68 # documentation are documented, even if no documentation was available.
69 # Private class members and static file members will be hidden unless
70 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
73 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
74 # will be included in the documentation.
77 # If the EXTRACT_STATIC tag is set to YES all static members of a file
78 # will be included in the documentation.
81 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
82 # defined locally in source files will be included in the documentation.
83 # If set to NO only classes defined in header files are included.
84 EXTRACT_LOCAL_CLASSES = YES
86 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
87 # undocumented members of documented classes, files or namespaces.
88 # If set to NO (the default) these members will be included in the
89 # various overviews, but no documentation section is generated.
90 # This option has no effect if EXTRACT_ALL is enabled.
91 HIDE_UNDOC_MEMBERS = NO
93 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
94 # undocumented classes that are normally visible in the class hierarchy.
95 # If set to NO (the default) these class will be included in the various
96 # overviews. This option has no effect if EXTRACT_ALL is enabled.
97 HIDE_UNDOC_CLASSES = NO
99 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
100 # include brief member descriptions after the members that are listed in
101 # the file and class documentation (similar to JavaDoc).
102 # Set to NO to disable this.
103 BRIEF_MEMBER_DESC = YES
105 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
106 # the brief description of a member or function before the detailed description.
107 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
108 # brief descriptions will be completely suppressed.
111 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
112 # Doxygen will generate a detailed section even if there is only a brief
114 ALWAYS_DETAILED_SEC = NO
116 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
117 # members of a class in the documentation of that class as if those members were
118 # ordinary class members. Constructors, destructors and assignment operators of
119 # the base classes will not be shown.
120 INLINE_INHERITED_MEMB = YES
122 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
123 # path before files name in the file list and in the header files. If set
124 # to NO the shortest path that makes the file name unique will be used.
125 FULL_PATH_NAMES = YES
127 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
128 # can be used to strip a user defined part of the path. Stripping is
129 # only done if one of the specified strings matches the left-hand part of
130 # the path. It is allowed to use relative paths in the argument list.
133 # The INTERNAL_DOCS tag determines if documentation
134 # that is typed after a \internal command is included. If the tag is set
135 # to NO (the default) then the documentation will be excluded.
136 # Set it to YES to include the internal documentation.
139 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
140 # doxygen to hide any special comment blocks from generated source code
141 # fragments. Normal C and C++ comments will always remain visible.
142 STRIP_CODE_COMMENTS = YES
144 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
145 # file names in lower case letters. If set to YES upper case letters are also
146 # allowed. This is useful if you have classes or files whose names only differ
147 # in case and if your file system supports case sensitive file names. Windows
148 # users are adviced to set this option to NO.
149 CASE_SENSE_NAMES = YES
151 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
152 # (but less readable) file names. This can be useful is your file systems
153 # doesn't support long names like on DOS, Mac, or CD-ROM.
156 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
157 # will show members with their full class and namespace scopes in the
158 # documentation. If set to YES the scope will be hidden.
159 HIDE_SCOPE_NAMES = NO
161 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
162 # will generate a verbatim copy of the header file for each class for
163 # which an include is specified. Set to NO to disable this.
164 VERBATIM_HEADERS = YES
166 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
167 # will put list of the files that are included by a file in the documentation
169 SHOW_INCLUDE_FILES = YES
171 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
172 # will interpret the first line (until the first dot) of a JavaDoc-style
173 # comment as the brief description. If set to NO, the JavaDoc
174 # comments will behave just like the Qt-style comments (thus requiring an
175 # explict @brief command for a brief description.
176 JAVADOC_AUTOBRIEF = NO
178 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
179 # member inherits the documentation from any documented member that it
183 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
184 # is inserted in the documentation for inline members.
187 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
188 # will sort the (detailed) documentation of file and class members
189 # alphabetically by member name. If set to NO the members will appear in
191 SORT_MEMBER_DOCS = YES
193 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
194 # tag is set to YES, then doxygen will reuse the documentation of the first
195 # member in the group (if any) for the other members of the group. By default
196 # all members of a group must be documented explicitly.
197 DISTRIBUTE_GROUP_DOC = NO
199 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
200 # Doxygen uses this value to replace tabs by spaces in code fragments.
203 # The GENERATE_TODOLIST tag can be used to enable (YES) or
204 # disable (NO) the todo list. This list is created by putting \todo
205 # commands in the documentation.
206 GENERATE_TODOLIST = YES
208 # The GENERATE_TESTLIST tag can be used to enable (YES) or
209 # disable (NO) the test list. This list is created by putting \test
210 # commands in the documentation.
211 GENERATE_TESTLIST = YES
213 # The GENERATE_BUGLIST tag can be used to enable (YES) or
214 # disable (NO) the bug list. This list is created by putting \bug
215 # commands in the documentation.
216 GENERATE_BUGLIST = YES
218 # This tag can be used to specify a number of aliases that acts
219 # as commands in the documentation. An alias has the form "name=value".
220 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
221 # put the command \sideeffect (or @sideeffect) in the documentation, which
222 # will result in a user defined paragraph with heading "Side Effects:".
223 # You can put \n's in the value part of an alias to insert newlines.
226 # The ENABLED_SECTIONS tag can be used to enable conditional
227 # documentation sections, marked by \if sectionname ... \endif.
230 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
231 # the initial value of a variable or define consist of for it to appear in
232 # the documentation. If the initializer consists of more lines than specified
233 # here it will be hidden. Use a value of 0 to hide initializers completely.
234 # The appearance of the initializer of individual variables and defines in the
235 # documentation can be controlled using \showinitializer or \hideinitializer
236 # command in the documentation regardless of this setting.
237 MAX_INITIALIZER_LINES = 30
239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240 # only. Doxygen will then generate output that is more tailored for C.
241 # For instance some of the names that are used will be different. The list
242 # of all members will be omitted, etc.
243 OPTIMIZE_OUTPUT_FOR_C = NO
245 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
246 # at the bottom of the documentation of classes and structs. If set to YES the
247 # list will mention the files that were used to generate the documentation.
248 SHOW_USED_FILES = YES
250 #---------------------------------------------------------------------------
251 # configuration options related to warning and progress messages
252 #---------------------------------------------------------------------------
254 # The QUIET tag can be used to turn on/off the messages that are generated
255 # by doxygen. Possible values are YES and NO. If left blank NO is used.
258 # The WARNINGS tag can be used to turn on/off the warning messages that are
259 # generated by doxygen. Possible values are YES and NO. If left blank
263 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
264 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
265 # automatically be disabled.
266 WARN_IF_UNDOCUMENTED = YES
268 # If WARN_IF_DOC_ERROR is set to YES, then doxygen will generate warnings
269 # for error documented members. If EXTRACT_ALL is set to YES then this flag will
270 # automatically be disabled.
271 WARN_IF_DOC_ERROR = YES
273 # The WARN_FORMAT tag determines the format of the warning messages that
274 # doxygen can produce. The string should contain the $file, $line, and $text
275 # tags, which will be replaced by the file and line number from which the
276 # warning originated and the warning text.
277 WARN_FORMAT = "$file:$line: $text"
279 # The WARN_LOGFILE tag can be used to specify a file to which warning
280 # and error messages should be written. If left blank the output is written
282 WARN_LOGFILE = @DOXYGEN_LOGFILE@
284 #---------------------------------------------------------------------------
285 # configuration options related to the input files
286 #---------------------------------------------------------------------------
288 # The INPUT tag can be used to specify the files and/or directories that contain
289 # documented source files. You may enter file names like "myfile.cpp" or
290 # directories like "/usr/src/myproject". Separate the files or directories
292 INPUT = @DOXYGEN_INPUT@
294 # If the value of the INPUT tag contains directories, you can use the
295 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
296 # and *.h) to filter out the source-files in the directories. If left
297 # blank the following patterns are tested:
298 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
300 FILE_PATTERNS = *.h *.cxx *.txx
302 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
303 # should be searched for input files as well. Possible values are YES and NO.
304 # If left blank NO is used.
307 # The EXCLUDE tag can be used to specify files and/or directories that should
308 # excluded from the INPUT source files. This way you can easily exclude a
309 # subdirectory from a directory tree whose root is specified with the INPUT tag.
310 EXCLUDE = @DOXYGEN_EXCLUDE@
312 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
313 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
314 EXCLUDE_SYMLINKS = NO
316 # If the value of the INPUT tag contains directories, you can use the
317 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
318 # certain files from those directories.
321 # The EXAMPLE_PATH tag can be used to specify one or more files or
322 # directories that contain example code fragments that are included (see
323 # the \include command).
326 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
327 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
328 # and *.h) to filter out the source-files in the directories. If left
329 # blank all files are included.
330 EXAMPLE_PATTERNS = *.cxx
332 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
333 # searched for input files to be used with the \include or \dontinclude
334 # commands irrespective of the value of the RECURSIVE tag.
335 # Possible values are YES and NO. If left blank NO is used.
336 EXAMPLE_RECURSIVE = NO
338 # The IMAGE_PATH tag can be used to specify one or more files or
339 # directories that contain image that are included in the documentation (see
340 # the \image command).
343 # The INPUT_FILTER tag can be used to specify a program that doxygen should
344 # invoke to filter for each input file. Doxygen will invoke the filter program
345 # by executing (via popen()) the command <filter> <input-file>, where <filter>
346 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
347 # input file. Doxygen will then use the output that the filter program writes
348 # to standard output.
351 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
352 # INPUT_FILTER) will be used to filter the input files when producing source
354 FILTER_SOURCE_FILES = NO
356 #---------------------------------------------------------------------------
357 # configuration options related to source browsing
358 #---------------------------------------------------------------------------
360 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
361 # be generated. Documented entities will be cross-referenced with these sources.
364 # Setting the INLINE_SOURCES tag to YES will include the body
365 # of functions and classes directly in the documentation.
368 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
369 # then for each documented function all documented
370 # functions referencing it will be listed.
371 REFERENCED_BY_RELATION = YES
373 # If the REFERENCES_RELATION tag is set to YES (the default)
374 # then for each documented function all documented entities
375 # called/used by that function will be listed.
376 REFERENCES_RELATION = YES
378 #---------------------------------------------------------------------------
379 # configuration options related to the alphabetical class index
380 #---------------------------------------------------------------------------
382 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
383 # of all compounds will be generated. Enable this if the project
384 # contains a lot of classes, structs, unions or interfaces.
385 ALPHABETICAL_INDEX = YES
387 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
388 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
389 # in which this list will be split (can be a number in the range [1..20])
390 COLS_IN_ALPHA_INDEX = 3
392 # In case all classes in a project start with a common prefix, all
393 # classes will be put under the same header in the alphabetical index.
394 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
395 # should be ignored while generating the index headers.
398 #---------------------------------------------------------------------------
399 # configuration options related to the HTML output
400 #---------------------------------------------------------------------------
402 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
403 # generate HTML output.
406 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
407 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
408 # put in front of it. If left blank `html' will be used as the default path.
409 HTML_OUTPUT = @DOXYGEN_HTML_OUTPUT@
411 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
412 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
413 # doxygen will generate files with .html extension.
414 HTML_FILE_EXTENSION = .html
416 # The HTML_HEADER tag can be used to specify a personal HTML header for
417 # each generated HTML page. If it is left blank doxygen will generate a
421 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
422 # each generated HTML page. If it is left blank doxygen will generate a
426 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
427 # style sheet that is used by each HTML page. It can be used to
428 # fine-tune the look of the HTML output. If the tag is left blank doxygen
429 # will generate a default style sheet
432 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
433 # files or namespaces will be aligned in HTML using tables. If set to
434 # NO a bullet list will be used.
435 HTML_ALIGN_MEMBERS = YES
437 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
438 # will be generated that can be used as input for tools like the
439 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
440 # of the generated HTML documentation.
441 GENERATE_HTMLHELP = NO
443 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
444 # controls if a separate .chi index file is generated (YES) or that
445 # it should be included in the master .chm file (NO).
448 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
449 # controls whether a binary table of contents is generated (YES) or a
450 # normal table of contents (NO) in the .chm file.
453 # The TOC_EXPAND flag can be set to YES to add extra items for group members
454 # to the contents of the Html help documentation and to the tree view.
457 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
458 # top of each HTML page. The value NO (the default) enables the index and
459 # the value YES disables it.
462 # This tag can be used to set the number of enum values (range [1..20])
463 # that doxygen will group on one line in the generated HTML documentation.
464 ENUM_VALUES_PER_LINE = 4
466 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
467 # generated containing a tree-like index structure (just like the one that
468 # is generated for HTML Help). For this to work a browser that supports
469 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
470 # or Internet explorer 4.0+). Note that for large projects the tree generation
471 # can take a very long time. In such cases it is better to disable this feature.
472 # Windows users are probably better off using the HTML help feature.
473 GENERATE_TREEVIEW = YES
475 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
476 # used to set the initial width (in pixels) of the frame in which the tree
480 #---------------------------------------------------------------------------
481 # configuration options related to the LaTeX output
482 #---------------------------------------------------------------------------
484 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
485 # generate Latex output.
488 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
489 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
490 # put in front of it. If left blank `latex' will be used as the default path.
493 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
494 # LaTeX documents. This may be useful for small projects and may help to
495 # save some trees in general.
498 # The PAPER_TYPE tag can be used to set the paper type that is used
499 # by the printer. Possible values are: a4, a4wide, letter, legal and
500 # executive. If left blank a4wide will be used.
503 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
504 # packages that should be included in the LaTeX output.
507 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
508 # the generated latex document. The header should contain everything until
509 # the first chapter. If it is left blank doxygen will generate a
510 # standard header. Notice: only use this tag if you know what you are doing!
513 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
514 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
515 # contain links (just like the HTML output) instead of page references
516 # This makes the output suitable for online browsing using a pdf viewer.
519 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
520 # plain latex in the generated Makefile. Set this option to YES to get a
521 # higher quality PDF documentation.
524 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
525 # command to the generated LaTeX files. This will instruct LaTeX to keep
526 # running if errors occur, instead of asking the user for help.
527 # This option is also used when generating formulas in HTML.
530 #---------------------------------------------------------------------------
531 # configuration options related to the RTF output
532 #---------------------------------------------------------------------------
534 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
535 # The RTF output is optimised for Word 97 and may not look very pretty with
536 # other RTF readers or editors.
539 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
540 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
541 # put in front of it. If left blank `rtf' will be used as the default path.
544 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
545 # RTF documents. This may be useful for small projects and may help to
546 # save some trees in general.
549 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
550 # will contain hyperlink fields. The RTF file will
551 # contain links (just like the HTML output) instead of page references.
552 # This makes the output suitable for online browsing using WORD or other
553 # programs which support those fields.
554 # Note: wordpad (write) and others do not support links.
557 # Load stylesheet definitions from file. Syntax is similar to doxygen's
558 # config file, i.e. a series of assigments. You only have to provide
559 # replacements, missing definitions are set to their default value.
560 RTF_STYLESHEET_FILE =
562 # Set optional variables used in the generation of an rtf document.
563 # Syntax is similar to doxygen's config file.
564 RTF_EXTENSIONS_FILE =
566 #---------------------------------------------------------------------------
567 # configuration options related to the man page output
568 #---------------------------------------------------------------------------
570 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
574 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
575 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
576 # put in front of it. If left blank `man' will be used as the default path.
579 # The MAN_EXTENSION tag determines the extension that is added to
580 # the generated man pages (default is the subroutine's section .3)
583 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
584 # then it will generate one additional man file for each entity
585 # documented in the real man page(s). These additional files
586 # only source the real man page, but without them the man command
587 # would be unable to find the correct page. The default is NO.
590 #---------------------------------------------------------------------------
591 # configuration options related to the XML output
592 #---------------------------------------------------------------------------
594 # If the GENERATE_XML tag is set to YES Doxygen will
595 # generate an XML file that captures the structure of
596 # the code including all documentation. Note that this
597 # feature is still experimental and incomplete at the
601 #---------------------------------------------------------------------------
602 # configuration options for the AutoGen Definitions output
603 #---------------------------------------------------------------------------
605 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
606 # generate an AutoGen Definitions (see autogen.sf.net) file
607 # that captures the structure of the code including all
608 # documentation. Note that this feature is still experimental
609 # and incomplete at the moment.
610 GENERATE_AUTOGEN_DEF = NO
612 #---------------------------------------------------------------------------
613 # Configuration options related to the preprocessor
614 #---------------------------------------------------------------------------
616 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
617 # evaluate all C-preprocessor directives found in the sources and include
619 ENABLE_PREPROCESSING = YES
621 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
622 # names in the source code. If set to NO (the default) only conditional
623 # compilation will be performed. Macro expansion can be done in a controlled
624 # way by setting EXPAND_ONLY_PREDEF to YES.
625 MACRO_EXPANSION = YES
627 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
628 # then the macro expansion is limited to the macros specified with the
629 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
630 EXPAND_ONLY_PREDEF = NO
632 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
633 # in the INCLUDE_PATH (see below) will be search if a #include is found.
634 SEARCH_INCLUDES = YES
636 # The INCLUDE_PATH tag can be used to specify one or more directories that
637 # contain include files that are not input files but should be processed by
641 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
642 # patterns (like *.h and *.hpp) to filter out the header-files in the
643 # directories. If left blank, the patterns specified with FILE_PATTERNS will
645 INCLUDE_FILE_PATTERNS =
647 # The PREDEFINED tag can be used to specify one or more macro names that
648 # are defined before the preprocessor is started (similar to the -D option of
649 # gcc). The argument of the tag is a list of macros of the form: name
650 # or name=definition (no spaces). If the definition and the = are
651 # omitted =1 is assumed.
652 PREDEFINED = @DOXYGEN_DOC_PREDEFINED@
655 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
656 # this tag can be used to specify a list of macro names that should be expanded.
657 # The macro definition that is found in the sources will be used.
658 # Use the PREDEFINED tag if you want to use a different macro definition.
661 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
662 # doxygen's preprocessor will remove all function-like macros that are alone
663 # on a line and do not end with a semicolon. Such function macros are typically
664 # used for boiler-plate code, and will confuse the parser if not removed.
665 SKIP_FUNCTION_MACROS = YES
667 #---------------------------------------------------------------------------
668 # Configuration::addtions related to external references
669 #---------------------------------------------------------------------------
671 # The TAGFILES tag can be used to specify one or more tagfiles.
674 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
675 # a tag file that is based on the input files it reads.
678 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
679 # in the class index. If set to NO only the inherited external classes
683 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
684 # in the modules index. If set to NO, only the current project's groups will
686 EXTERNAL_GROUPS = YES
688 # The PERL_PATH should be the absolute path and name of the perl script
689 # interpreter (i.e. the result of `which perl').
690 PERL_PATH = /usr/bin/perl
692 #---------------------------------------------------------------------------
693 # Configuration options related to the dot tool
694 #---------------------------------------------------------------------------
696 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
697 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
698 # super classes. Setting the tag to NO turns the diagrams off. Note that this
699 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
700 # recommended to install and use dot, since it yield more powerful graphs.
703 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
704 # available from the path. This tool is part of Graphviz, a graph visualization
705 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
706 # have no effect if this option is set to NO (the default)
707 HAVE_DOT = @DOXYGEN_HAVE_DOT@
709 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
710 # will generate a graph for each documented class showing the direct and
711 # indirect inheritance relations. Setting this tag to YES will force the
712 # the CLASS_DIAGRAMS tag to NO.
715 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
716 # will generate a graph for each documented class showing the direct and
717 # indirect implementation dependencies (inheritance, containment, and
718 # class references variables) of the class with other documented classes.
719 COLLABORATION_GRAPH = YES
721 # If set to YES, the inheritance and collaboration graphs will show the
722 # relations between templates and their instances.
723 TEMPLATE_RELATIONS = YES
725 # If set to YES, the inheritance and collaboration graphs will hide
726 # inheritance and usage relations if the target is undocumented
728 HIDE_UNDOC_RELATIONS = YES
730 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
731 # tags are set to YES then doxygen will generate a graph for each documented
732 # file showing the direct and indirect include dependencies of the file with
733 # other documented files.
736 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
737 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
738 # documented header file showing the documented files that directly or
739 # indirectly include this file.
740 INCLUDED_BY_GRAPH = YES
742 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
743 # will graphical hierarchy of all classes instead of a textual one.
744 GRAPHICAL_HIERARCHY = YES
746 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
747 # generated by dot. Possible values are gif, jpg, and png
748 # If left blank gif will be used.
749 DOT_IMAGE_FORMAT = png
751 # The tag DOT_PATH can be used to specify the path where the dot tool can be
752 # found. If left blank, it is assumed the dot tool can be found on the path.
753 DOT_PATH = "@DOXYGEN_DOT_PATH@"
755 # The DOTFILE_DIRS tag can be used to specify one or more directories that
756 # contain dot files that are included in the documentation (see the
760 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
761 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
762 # this value, doxygen will try to truncate the graph, so that it fits within
763 # the specified constraint. Beware that most browsers cannot cope with very
765 MAX_DOT_GRAPH_WIDTH = 1024
767 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
768 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
769 # this value, doxygen will try to truncate the graph, so that it fits within
770 # the specified constraint. Beware that most browsers cannot cope with very
772 MAX_DOT_GRAPH_HEIGHT = 1024
774 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
775 # generate a legend page explaining the meaning of the various boxes and
776 # arrows in the dot generated graphs.
777 GENERATE_LEGEND = YES
779 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
780 # remove the intermedate dot files that are used to generate
781 # the various graphs.
784 #---------------------------------------------------------------------------
785 # Configuration::addtions related to the search engine
786 #---------------------------------------------------------------------------
788 # The SEARCHENGINE tag specifies whether or not a search engine should be
789 # used. If set to NO the values of all tags below this one will be ignored.