4 # Doxyfile 1.3.6-20040222
6 # This file describes the settings to be used by the documentation system
7 # doxygen (www.doxygen.org) for a project
9 # All text after a hash (#) is considered a comment and will be ignored
11 # TAG = value [value, ...]
12 # For lists items can also be appended using:
13 # TAG += value [value, ...]
14 # Values that contain spaces should be placed between quotes (" ")
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
20 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
21 # by quotes) that should identify the project.
23 PROJECT_NAME = SimGrid
25 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
26 # This could be handy for archiving the generated documentation or
27 # if some version control system is used.
31 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
32 # base path where the generated documentation will be put.
33 # If a relative path is entered, it will be relative to the location
34 # where doxygen was started. If left blank the current directory will be used.
38 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
39 # documentation generated by doxygen is written. Doxygen will use this
40 # information to generate all constant output in the proper language.
41 # The default language is English, other supported languages are:
42 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
43 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
44 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese,
45 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
47 OUTPUT_LANGUAGE = English
49 # This tag can be used to specify the encoding used in the generated output.
50 # The encoding is not always determined by the language that is chosen,
51 # but also whether or not the output is meant for Windows or non-Windows users.
52 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
53 # forces the Windows encoding (this is the default for the Windows binary),
54 # whereas setting the tag to NO uses a Unix-style encoding (the default for
55 # all platforms other than Windows).
57 USE_WINDOWS_ENCODING = NO
59 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
60 # include brief member descriptions after the members that are listed in
61 # the file and class documentation (similar to JavaDoc).
62 # Set to NO to disable this.
64 BRIEF_MEMBER_DESC = YES
66 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
67 # the brief description of a member or function before the detailed description.
68 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
69 # brief descriptions will be completely suppressed.
73 # This tag implements a quasi-intelligent brief description abbreviator
74 # that is used to form the text in various listings. Each string
75 # in this list, if found as the leading text of the brief description, will be
76 # stripped from the text and the result after processing the whole list, is used
77 # as the annotated text. Otherwise, the brief description is used as-is. If left
78 # blank, the following values are used ("$name" is automatically replaced with the
79 # name of the entity): "The $name class" "The $name widget" "The $name file"
80 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
84 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
85 # Doxygen will generate a detailed section even if there is only a brief
88 ALWAYS_DETAILED_SEC = NO
90 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
91 # members of a class in the documentation of that class as if those members were
92 # ordinary class members. Constructors, destructors and assignment operators of
93 # the base classes will not be shown.
95 INLINE_INHERITED_MEMB = YES
97 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
98 # path before files name in the file list and in the header files. If set
99 # to NO the shortest path that makes the file name unique will be used.
101 FULL_PATH_NAMES = YES
103 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
104 # can be used to strip a user-defined part of the path. Stripping is
105 # only done if one of the specified strings matches the left-hand part of
106 # the path. It is allowed to use relative paths in the argument list.
107 # If left blank the directory from which doxygen is run is used as the
110 STRIP_FROM_PATH = @srcdir@
112 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
113 # (but less readable) file names. This can be useful is your file systems
114 # doesn't support long names like on DOS, Mac, or CD-ROM.
118 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
119 # will interpret the first line (until the first dot) of a JavaDoc-style
120 # comment as the brief description. If set to NO, the JavaDoc
121 # comments will behave just like the Qt-style comments (thus requiring an
122 # explicit @brief command for a brief description.
124 JAVADOC_AUTOBRIEF = NO
126 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
127 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
128 # comments) as a brief description. This used to be the default behaviour.
129 # The new default is to treat a multi-line C++ comment block as a detailed
130 # description. Set this tag to YES if you prefer the old behaviour instead.
132 MULTILINE_CPP_IS_BRIEF = NO
134 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
135 # will output the detailed description near the top, like JavaDoc.
136 # If set to NO, the detailed description appears after the member
141 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
142 # member inherits the documentation from any documented member that it
147 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
148 # tag is set to YES, then doxygen will reuse the documentation of the first
149 # member in the group (if any) for the other members of the group. By default
150 # all members of a group must be documented explicitly.
152 DISTRIBUTE_GROUP_DOC = NO
154 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
155 # Doxygen uses this value to replace tabs by spaces in code fragments.
159 # This tag can be used to specify a number of aliases that acts
160 # as commands in the documentation. An alias has the form "name=value".
161 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
162 # put the command \sideeffect (or @sideeffect) in the documentation, which
163 # will result in a user-defined paragraph with heading "Side Effects:".
164 # You can put \n's in the value part of an alias to insert newlines.
168 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
169 # only. Doxygen will then generate output that is more tailored for C.
170 # For instance, some of the names that are used will be different. The list
171 # of all members will be omitted, etc.
173 OPTIMIZE_OUTPUT_FOR_C = YES
175 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
176 # only. Doxygen will then generate output that is more tailored for Java.
177 # For instance, namespaces will be presented as packages, qualified scopes
178 # will look different, etc.
180 OPTIMIZE_OUTPUT_JAVA = NO
182 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
183 # the same type (for instance a group of public functions) to be put as a
184 # subgroup of that type (e.g. under the Public Functions section). Set it to
185 # NO to prevent subgrouping. Alternatively, this can be done per class using
186 # the \nosubgrouping command.
190 #---------------------------------------------------------------------------
191 # Build related configuration options
192 #---------------------------------------------------------------------------
194 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
195 # documentation are documented, even if no documentation was available.
196 # Private class members and static file members will be hidden unless
197 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
201 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
202 # will be included in the documentation.
206 # If the EXTRACT_STATIC tag is set to YES all static members of a file
207 # will be included in the documentation.
211 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
212 # defined locally in source files will be included in the documentation.
213 # If set to NO only classes defined in header files are included.
215 EXTRACT_LOCAL_CLASSES = YES
217 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
218 # undocumented members of documented classes, files or namespaces.
219 # If set to NO (the default) these members will be included in the
220 # various overviews, but no documentation section is generated.
221 # This option has no effect if EXTRACT_ALL is enabled.
223 HIDE_UNDOC_MEMBERS = YES
225 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
226 # undocumented classes that are normally visible in the class hierarchy.
227 # If set to NO (the default) these classes will be included in the various
228 # overviews. This option has no effect if EXTRACT_ALL is enabled.
230 HIDE_UNDOC_CLASSES = YES
232 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
233 # friend (class|struct|union) declarations.
234 # If set to NO (the default) these declarations will be included in the
237 HIDE_FRIEND_COMPOUNDS = NO
239 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
240 # documentation blocks found inside the body of a function.
241 # If set to NO (the default) these blocks will be appended to the
242 # function's detailed documentation block.
244 HIDE_IN_BODY_DOCS = NO
246 # The INTERNAL_DOCS tag determines if documentation
247 # that is typed after a \internal command is included. If the tag is set
248 # to NO (the default) then the documentation will be excluded.
249 # Set it to YES to include the internal documentation.
253 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
254 # file names in lower-case letters. If set to YES upper-case letters are also
255 # allowed. This is useful if you have classes or files whose names only differ
256 # in case and if your file system supports case sensitive file names. Windows
257 # users are advised to set this option to NO.
259 CASE_SENSE_NAMES = YES
261 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
262 # will show members with their full class and namespace scopes in the
263 # documentation. If set to YES the scope will be hidden.
265 HIDE_SCOPE_NAMES = NO
267 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
268 # will put a list of the files that are included by a file in the documentation
271 SHOW_INCLUDE_FILES = YES
273 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
274 # is inserted in the documentation for inline members.
278 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
279 # will sort the (detailed) documentation of file and class members
280 # alphabetically by member name. If set to NO the members will appear in
283 SORT_MEMBER_DOCS = NO
285 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
286 # brief documentation of file, namespace and class members alphabetically
287 # by member name. If set to NO (the default) the members will appear in
292 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
293 # sorted by fully-qualified names, including namespaces. If set to
294 # NO (the default), the class list will be sorted only by class name,
295 # not including the namespace part.
296 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
297 # Note: This option applies only to the class list, not to the
300 SORT_BY_SCOPE_NAME = NO
302 # The GENERATE_TODOLIST tag can be used to enable (YES) or
303 # disable (NO) the todo list. This list is created by putting \todo
304 # commands in the documentation.
306 GENERATE_TODOLIST = YES
308 # The GENERATE_TESTLIST tag can be used to enable (YES) or
309 # disable (NO) the test list. This list is created by putting \test
310 # commands in the documentation.
312 GENERATE_TESTLIST = YES
314 # The GENERATE_BUGLIST tag can be used to enable (YES) or
315 # disable (NO) the bug list. This list is created by putting \bug
316 # commands in the documentation.
318 GENERATE_BUGLIST = YES
320 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
321 # disable (NO) the deprecated list. This list is created by putting
322 # \deprecated commands in the documentation.
324 GENERATE_DEPRECATEDLIST= YES
326 # The ENABLED_SECTIONS tag can be used to enable conditional
327 # documentation sections, marked by \if sectionname ... \endif.
331 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
332 # the initial value of a variable or define consists of for it to appear in
333 # the documentation. If the initializer consists of more lines than specified
334 # here it will be hidden. Use a value of 0 to hide initializers completely.
335 # The appearance of the initializer of individual variables and defines in the
336 # documentation can be controlled using \showinitializer or \hideinitializer
337 # command in the documentation regardless of this setting.
339 MAX_INITIALIZER_LINES = 30
341 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
342 # at the bottom of the documentation of classes and structs. If set to YES the
343 # list will mention the files that were used to generate the documentation.
345 SHOW_USED_FILES = YES
347 #---------------------------------------------------------------------------
348 # configuration options related to warning and progress messages
349 #---------------------------------------------------------------------------
351 # The QUIET tag can be used to turn on/off the messages that are generated
352 # by doxygen. Possible values are YES and NO. If left blank NO is used.
356 # The WARNINGS tag can be used to turn on/off the warning messages that are
357 # generated by doxygen. Possible values are YES and NO. If left blank
362 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
363 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
364 # automatically be disabled.
366 WARN_IF_UNDOCUMENTED = YES
368 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
369 # potential errors in the documentation, such as not documenting some
370 # parameters in a documented function, or documenting parameters that
371 # don't exist or using markup commands wrongly.
373 WARN_IF_DOC_ERROR = YES
375 # The WARN_FORMAT tag determines the format of the warning messages that
376 # doxygen can produce. The string should contain the $file, $line, and $text
377 # tags, which will be replaced by the file and line number from which the
378 # warning originated and the warning text.
380 WARN_FORMAT = "$file:$line: $text"
382 # The WARN_LOGFILE tag can be used to specify a file to which warning
383 # and error messages should be written. If left blank the output is written
388 #---------------------------------------------------------------------------
389 # configuration options related to the input files
390 #---------------------------------------------------------------------------
392 # The INPUT tag can be used to specify the files and/or directories that contain
393 # documented source files. You may enter file names like "myfile.cpp" or
394 # directories like "/usr/src/myproject". Separate the files or directories
397 INPUT = @srcdir@/index.doc \
400 @srcdir@/modules.doc \
401 @srcdir@/module-gras.doc \
402 @srcdir@/module-xbt.doc \
403 @srcdir@/module-msg.doc \
406 ./logcategories.doc \
408 @top_srcdir@/include/ \
409 @top_srcdir@/include/msg \
410 @top_srcdir@/include/gras \
411 @top_srcdir@/include/xbt \
412 @top_srcdir@/src/surf/ \
413 @top_srcdir@/src/msg/ \
414 @top_srcdir@/src/gras \
415 @top_srcdir@/src/gras/DataDesc \
416 @top_srcdir@/src/gras/Msg \
417 @top_srcdir@/src/gras/Transport \
418 @top_srcdir@/src/gras/Virtu \
419 @top_srcdir@/src/xbt/
421 # If the value of the INPUT tag contains directories, you can use the
422 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
423 # and *.h) to filter out the source-files in the directories. If left
424 # blank the following patterns are tested:
425 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
426 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
430 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
431 # should be searched for input files as well. Possible values are YES and NO.
432 # If left blank NO is used.
436 # The EXCLUDE tag can be used to specify files and/or directories that should
437 # excluded from the INPUT source files. This way you can easily exclude a
438 # subdirectory from a directory tree whose root is specified with the INPUT tag.
442 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
443 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
445 EXCLUDE_SYMLINKS = NO
447 # If the value of the INPUT tag contains directories, you can use the
448 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
449 # certain files from those directories.
453 # The EXAMPLE_PATH tag can be used to specify one or more files or
454 # directories that contain example code fragments that are included (see
455 # the \include command).
458 @top_srcdir@/src/surf/ \
459 @top_srcdir@/examples \
460 @top_srcdir@/testsuite
462 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
463 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
464 # and *.h) to filter out the source-files in the directories. If left
465 # blank all files are included.
469 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
470 # searched for input files to be used with the \include or \dontinclude
471 # commands irrespective of the value of the RECURSIVE tag.
472 # Possible values are YES and NO. If left blank NO is used.
474 EXAMPLE_RECURSIVE = YES
476 # The IMAGE_PATH tag can be used to specify one or more files or
477 # directories that contain image that are included in the documentation (see
478 # the \image command).
480 IMAGE_PATH = @top_srcdir@/doc
482 # The INPUT_FILTER tag can be used to specify a program that doxygen should
483 # invoke to filter for each input file. Doxygen will invoke the filter program
484 # by executing (via popen()) the command <filter> <input-file>, where <filter>
485 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
486 # input file. Doxygen will then use the output that the filter program writes
487 # to standard output.
491 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
492 # INPUT_FILTER) will be used to filter the input files when producing source
493 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
495 FILTER_SOURCE_FILES = NO
497 #---------------------------------------------------------------------------
498 # configuration options related to source browsing
499 #---------------------------------------------------------------------------
501 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
502 # be generated. Documented entities will be cross-referenced with these sources.
503 # Note: To get rid of all source code in the generated output, make sure also
504 # VERBATIM_HEADERS is set to NO.
508 # Setting the INLINE_SOURCES tag to YES will include the body
509 # of functions and classes directly in the documentation.
513 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
514 # doxygen to hide any special comment blocks from generated source code
515 # fragments. Normal C and C++ comments will always remain visible.
517 STRIP_CODE_COMMENTS = YES
519 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
520 # then for each documented function all documented
521 # functions referencing it will be listed.
523 REFERENCED_BY_RELATION = NO
525 # If the REFERENCES_RELATION tag is set to YES (the default)
526 # then for each documented function all documented entities
527 # called/used by that function will be listed.
529 REFERENCES_RELATION = NO
531 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
532 # will generate a verbatim copy of the header file for each class for
533 # which an include is specified. Set to NO to disable this.
535 VERBATIM_HEADERS = NO
537 #---------------------------------------------------------------------------
538 # configuration options related to the alphabetical class index
539 #---------------------------------------------------------------------------
541 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
542 # of all compounds will be generated. Enable this if the project
543 # contains a lot of classes, structs, unions or interfaces.
545 ALPHABETICAL_INDEX = NO
547 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
548 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
549 # in which this list will be split (can be a number in the range [1..20])
551 COLS_IN_ALPHA_INDEX = 5
553 # In case all classes in a project start with a common prefix, all
554 # classes will be put under the same header in the alphabetical index.
555 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
556 # should be ignored while generating the index headers.
560 #---------------------------------------------------------------------------
561 # configuration options related to the HTML output
562 #---------------------------------------------------------------------------
564 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
565 # generate HTML output.
569 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
570 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
571 # put in front of it. If left blank `html' will be used as the default path.
575 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
576 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
577 # doxygen will generate files with .html extension.
579 HTML_FILE_EXTENSION = .html
581 # The HTML_HEADER tag can be used to specify a personal HTML header for
582 # each generated HTML page. If it is left blank doxygen will generate a
587 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
588 # each generated HTML page. If it is left blank doxygen will generate a
591 HTML_FOOTER = @srcdir@/footer.html
593 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
594 # style sheet that is used by each HTML page. It can be used to
595 # fine-tune the look of the HTML output. If the tag is left blank doxygen
596 # will generate a default style sheet. Note that doxygen will try to copy
597 # the style sheet file to the HTML output directory, so don't put your own
598 # stylesheet in the HTML output directory as well, or it will be erased!
602 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
603 # files or namespaces will be aligned in HTML using tables. If set to
604 # NO a bullet list will be used.
606 HTML_ALIGN_MEMBERS = YES
608 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
609 # will be generated that can be used as input for tools like the
610 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
611 # of the generated HTML documentation.
613 GENERATE_HTMLHELP = NO
615 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
616 # be used to specify the file name of the resulting .chm file. You
617 # can add a path in front of the file if the result should not be
618 # written to the html output directory.
622 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
623 # be used to specify the location (absolute path including file name) of
624 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
625 # the HTML help compiler on the generated index.hhp.
629 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
630 # controls if a separate .chi index file is generated (YES) or that
631 # it should be included in the master .chm file (NO).
635 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
636 # controls whether a binary table of contents is generated (YES) or a
637 # normal table of contents (NO) in the .chm file.
641 # The TOC_EXPAND flag can be set to YES to add extra items for group members
642 # to the contents of the HTML help documentation and to the tree view.
646 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
647 # top of each HTML page. The value NO (the default) enables the index and
648 # the value YES disables it.
652 # This tag can be used to set the number of enum values (range [1..20])
653 # that doxygen will group on one line in the generated HTML documentation.
655 ENUM_VALUES_PER_LINE = 4
657 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
658 # generated containing a tree-like index structure (just like the one that
659 # is generated for HTML Help). For this to work a browser that supports
660 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
661 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
662 # probably better off using the HTML help feature.
664 GENERATE_TREEVIEW = NO
666 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
667 # used to set the initial width (in pixels) of the frame in which the tree
672 #---------------------------------------------------------------------------
673 # configuration options related to the LaTeX output
674 #---------------------------------------------------------------------------
676 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
677 # generate Latex output.
681 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
682 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
683 # put in front of it. If left blank `latex' will be used as the default path.
687 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
688 # invoked. If left blank `latex' will be used as the default command name.
690 LATEX_CMD_NAME = latex
692 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
693 # generate index for LaTeX. If left blank `makeindex' will be used as the
694 # default command name.
696 MAKEINDEX_CMD_NAME = makeindex
698 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
699 # LaTeX documents. This may be useful for small projects and may help to
700 # save some trees in general.
704 # The PAPER_TYPE tag can be used to set the paper type that is used
705 # by the printer. Possible values are: a4, a4wide, letter, legal and
706 # executive. If left blank a4wide will be used.
710 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
711 # packages that should be included in the LaTeX output.
715 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
716 # the generated latex document. The header should contain everything until
717 # the first chapter. If it is left blank doxygen will generate a
718 # standard header. Notice: only use this tag if you know what you are doing!
722 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
723 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
724 # contain links (just like the HTML output) instead of page references
725 # This makes the output suitable for online browsing using a pdf viewer.
729 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
730 # plain latex in the generated Makefile. Set this option to YES to get a
731 # higher quality PDF documentation.
735 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
736 # command to the generated LaTeX files. This will instruct LaTeX to keep
737 # running if errors occur, instead of asking the user for help.
738 # This option is also used when generating formulas in HTML.
742 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
743 # include the index chapters (such as File Index, Compound Index, etc.)
746 LATEX_HIDE_INDICES = NO
748 #---------------------------------------------------------------------------
749 # configuration options related to the RTF output
750 #---------------------------------------------------------------------------
752 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
753 # The RTF output is optimized for Word 97 and may not look very pretty with
754 # other RTF readers or editors.
758 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
759 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
760 # put in front of it. If left blank `rtf' will be used as the default path.
764 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
765 # RTF documents. This may be useful for small projects and may help to
766 # save some trees in general.
770 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
771 # will contain hyperlink fields. The RTF file will
772 # contain links (just like the HTML output) instead of page references.
773 # This makes the output suitable for online browsing using WORD or other
774 # programs which support those fields.
775 # Note: wordpad (write) and others do not support links.
779 # Load stylesheet definitions from file. Syntax is similar to doxygen's
780 # config file, i.e. a series of assignments. You only have to provide
781 # replacements, missing definitions are set to their default value.
783 RTF_STYLESHEET_FILE =
785 # Set optional variables used in the generation of an rtf document.
786 # Syntax is similar to doxygen's config file.
788 RTF_EXTENSIONS_FILE =
790 #---------------------------------------------------------------------------
791 # configuration options related to the man page output
792 #---------------------------------------------------------------------------
794 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
799 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
800 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
801 # put in front of it. If left blank `man' will be used as the default path.
805 # The MAN_EXTENSION tag determines the extension that is added to
806 # the generated man pages (default is the subroutine's section .3)
810 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
811 # then it will generate one additional man file for each entity
812 # documented in the real man page(s). These additional files
813 # only source the real man page, but without them the man command
814 # would be unable to find the correct page. The default is NO.
818 #---------------------------------------------------------------------------
819 # configuration options related to the XML output
820 #---------------------------------------------------------------------------
822 # If the GENERATE_XML tag is set to YES Doxygen will
823 # generate an XML file that captures the structure of
824 # the code including all documentation.
828 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
829 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
830 # put in front of it. If left blank `xml' will be used as the default path.
834 # The XML_SCHEMA tag can be used to specify an XML schema,
835 # which can be used by a validating XML parser to check the
836 # syntax of the XML files.
840 # The XML_DTD tag can be used to specify an XML DTD,
841 # which can be used by a validating XML parser to check the
842 # syntax of the XML files.
846 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
847 # dump the program listings (including syntax highlighting
848 # and cross-referencing information) to the XML output. Note that
849 # enabling this will significantly increase the size of the XML output.
851 XML_PROGRAMLISTING = YES
853 #---------------------------------------------------------------------------
854 # configuration options for the AutoGen Definitions output
855 #---------------------------------------------------------------------------
857 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
858 # generate an AutoGen Definitions (see autogen.sf.net) file
859 # that captures the structure of the code including all
860 # documentation. Note that this feature is still experimental
861 # and incomplete at the moment.
863 GENERATE_AUTOGEN_DEF = NO
865 #---------------------------------------------------------------------------
866 # configuration options related to the Perl module output
867 #---------------------------------------------------------------------------
869 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
870 # generate a Perl module file that captures the structure of
871 # the code including all documentation. Note that this
872 # feature is still experimental and incomplete at the
875 GENERATE_PERLMOD = NO
877 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
878 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
879 # to generate PDF and DVI output from the Perl module output.
883 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
884 # nicely formatted so it can be parsed by a human reader. This is useful
885 # if you want to understand what is going on. On the other hand, if this
886 # tag is set to NO the size of the Perl module output will be much smaller
887 # and Perl will parse it just the same.
891 # The names of the make variables in the generated doxyrules.make file
892 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
893 # This is useful so different doxyrules.make files included by the same
894 # Makefile don't overwrite each other's variables.
896 PERLMOD_MAKEVAR_PREFIX =
898 #---------------------------------------------------------------------------
899 # Configuration options related to the preprocessor
900 #---------------------------------------------------------------------------
902 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
903 # evaluate all C-preprocessor directives found in the sources and include
906 ENABLE_PREPROCESSING = YES
908 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
909 # names in the source code. If set to NO (the default) only conditional
910 # compilation will be performed. Macro expansion can be done in a controlled
911 # way by setting EXPAND_ONLY_PREDEF to YES.
913 MACRO_EXPANSION = YES
915 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
916 # then the macro expansion is limited to the macros specified with the
917 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
919 EXPAND_ONLY_PREDEF = YES
921 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
922 # in the INCLUDE_PATH (see below) will be search if a #include is found.
924 SEARCH_INCLUDES = YES
926 # The INCLUDE_PATH tag can be used to specify one or more directories that
927 # contain include files that are not input files but should be processed by
932 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
933 # patterns (like *.h and *.hpp) to filter out the header-files in the
934 # directories. If left blank, the patterns specified with FILE_PATTERNS will
937 INCLUDE_FILE_PATTERNS =
939 # The PREDEFINED tag can be used to specify one or more macro names that
940 # are defined before the preprocessor is started (similar to the -D option of
941 # gcc). The argument of the tag is a list of macros of the form: name
942 # or name=definition (no spaces). If the definition and the = are
943 # omitted =1 is assumed.
947 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
948 # this tag can be used to specify a list of macro names that should be expanded.
949 # The macro definition that is found in the sources will be used.
950 # Use the PREDEFINED tag if you want to use a different macro definition.
954 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
955 # doxygen's preprocessor will remove all function-like macros that are alone
956 # on a line, have an all uppercase name, and do not end with a semicolon. Such
957 # function macros are typically used for boiler-plate code, and will confuse the
958 # parser if not removed.
960 SKIP_FUNCTION_MACROS = YES
962 #---------------------------------------------------------------------------
963 # Configuration::additions related to external references
964 #---------------------------------------------------------------------------
966 # The TAGFILES option can be used to specify one or more tagfiles.
967 # Optionally an initial location of the external documentation
968 # can be added for each tagfile. The format of a tag file without
969 # this location is as follows:
970 # TAGFILES = file1 file2 ...
971 # Adding location for the tag files is done as follows:
972 # TAGFILES = file1=loc1 "file2 = loc2" ...
973 # where "loc1" and "loc2" can be relative or absolute paths or
974 # URLs. If a location is present for each tag, the installdox tool
975 # does not have to be run to correct the links.
976 # Note that each tag file must have a unique name
977 # (where the name does NOT include the path)
978 # If a tag file is not located in the directory in which doxygen
979 # is run, you must also specify the path to the tagfile here.
983 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
984 # a tag file that is based on the input files it reads.
988 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
989 # in the class index. If set to NO only the inherited external classes
994 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
995 # in the modules index. If set to NO, only the current project's groups will
1000 # The PERL_PATH should be the absolute path and name of the perl script
1001 # interpreter (i.e. the result of `which perl').
1003 PERL_PATH = /usr/bin/perl
1005 #---------------------------------------------------------------------------
1006 # Configuration options related to the dot tool
1007 #---------------------------------------------------------------------------
1009 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1010 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1011 # super classes. Setting the tag to NO turns the diagrams off. Note that this
1012 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1013 # recommended to install and use dot, since it yields more powerful graphs.
1015 CLASS_DIAGRAMS = YES
1017 # If set to YES, the inheritance and collaboration graphs will hide
1018 # inheritance and usage relations if the target is undocumented
1019 # or is not a class.
1021 HIDE_UNDOC_RELATIONS = YES
1023 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1024 # available from the path. This tool is part of Graphviz, a graph visualization
1025 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1026 # have no effect if this option is set to NO (the default)
1030 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1031 # will generate a graph for each documented class showing the direct and
1032 # indirect inheritance relations. Setting this tag to YES will force the
1033 # the CLASS_DIAGRAMS tag to NO.
1037 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1038 # will generate a graph for each documented class showing the direct and
1039 # indirect implementation dependencies (inheritance, containment, and
1040 # class references variables) of the class with other documented classes.
1042 COLLABORATION_GRAPH = YES
1044 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1045 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1050 # If set to YES, the inheritance and collaboration graphs will show the
1051 # relations between templates and their instances.
1053 TEMPLATE_RELATIONS = YES
1055 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1056 # tags are set to YES then doxygen will generate a graph for each documented
1057 # file showing the direct and indirect include dependencies of the file with
1058 # other documented files.
1062 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1063 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1064 # documented header file showing the documented files that directly or
1065 # indirectly include this file.
1067 INCLUDED_BY_GRAPH = YES
1069 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1070 # generate a call dependency graph for every global function or class method.
1071 # Note that enabling this option will significantly increase the time of a run.
1072 # So in most cases it will be better to enable call graphs for selected
1073 # functions only using the \callgraph command.
1077 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1078 # will graphical hierarchy of all classes instead of a textual one.
1080 GRAPHICAL_HIERARCHY = YES
1082 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1083 # generated by dot. Possible values are png, jpg, or gif
1084 # If left blank png will be used.
1086 DOT_IMAGE_FORMAT = png
1088 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1089 # found. If left blank, it is assumed the dot tool can be found on the path.
1093 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1094 # contain dot files that are included in the documentation (see the
1095 # \dotfile command).
1099 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1100 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1101 # this value, doxygen will try to truncate the graph, so that it fits within
1102 # the specified constraint. Beware that most browsers cannot cope with very
1105 MAX_DOT_GRAPH_WIDTH = 1024
1107 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1108 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1109 # this value, doxygen will try to truncate the graph, so that it fits within
1110 # the specified constraint. Beware that most browsers cannot cope with very
1113 MAX_DOT_GRAPH_HEIGHT = 1024
1115 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1116 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1117 # from the root by following a path via at most 3 edges will be shown. Nodes that
1118 # lay further from the root node will be omitted. Note that setting this option to
1119 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1120 # note that a graph may be further truncated if the graph's image dimensions are
1121 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1122 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1124 MAX_DOT_GRAPH_DEPTH = 0
1126 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1127 # generate a legend page explaining the meaning of the various boxes and
1128 # arrows in the dot generated graphs.
1130 GENERATE_LEGEND = YES
1132 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1133 # remove the intermediate dot files that are used to generate
1134 # the various graphs.
1138 #---------------------------------------------------------------------------
1139 # Configuration::additions related to the search engine
1140 #---------------------------------------------------------------------------
1142 # The SEARCHENGINE tag specifies whether or not a search engine should be
1143 # used. If set to NO the values of all tags below this one will be ignored.