3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
6 # All text after a hash (#) is considered a comment and will be ignored
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
20 PROJECT_NAME = @PACKAGE@
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or
24 # if some version control system is used.
26 PROJECT_NUMBER = @PACKAGE_VERSION@
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
33 OUTPUT_DIRECTORY = ./doc/codeDoc
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
36 # documentation generated by doxygen is written. Doxygen will use this
37 # information to generate all constant output in the proper language.
38 # The default language is English, other supported languages are:
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
44 OUTPUT_LANGUAGE = English
46 # This tag can be used to specify the encoding used in the generated output.
47 # The encoding is not always determined by the language that is chosen,
48 # but also whether or not the output is meant for Windows or non-Windows users.
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50 # forces the Windows encoding (this is the default for the Windows binary),
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
52 # all platforms other than Windows).
54 USE_WINDOWS_ENCODING = NO
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57 # include brief member descriptions after the members that are listed in
58 # the file and class documentation (similar to JavaDoc).
59 # Set to NO to disable this.
61 BRIEF_MEMBER_DESC = YES
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64 # the brief description of a member or function before the detailed description.
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66 # brief descriptions will be completely suppressed.
70 # This tag implements a quasi-intelligent brief description abbreviator
71 # that is used to form the text in various listings. Each string
72 # in this list, if found as the leading text of the brief description, will be
73 # stripped from the text and the result after processing the whole list, is used
74 # as the annotated text. Otherwise, the brief description is used as-is. If left
75 # blank, the following values are used ("$name" is automatically replaced with the
76 # name of the entity): "The $name class" "The $name widget" "The $name file"
77 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
81 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82 # Doxygen will generate a detailed section even if there is only a brief
85 ALWAYS_DETAILED_SEC = NO
87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88 # members of a class in the documentation of that class as if those members were
89 # ordinary class members. Constructors, destructors and assignment operators of
90 # the base classes will not be shown.
92 INLINE_INHERITED_MEMB = NO
94 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
95 # path before files name in the file list and in the header files. If set
96 # to NO the shortest path that makes the file name unique will be used.
100 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101 # can be used to strip a user-defined part of the path. Stripping is
102 # only done if one of the specified strings matches the left-hand part of
103 # the path. It is allowed to use relative paths in the argument list.
107 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
108 # (but less readable) file names. This can be useful is your file systems
109 # doesn't support long names like on DOS, Mac, or CD-ROM.
113 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
114 # will interpret the first line (until the first dot) of a JavaDoc-style
115 # comment as the brief description. If set to NO, the JavaDoc
116 # comments will behave just like the Qt-style comments (thus requiring an
117 # explicit @brief command for a brief description.
119 JAVADOC_AUTOBRIEF = YES
121 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
122 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
123 # comments) as a brief description. This used to be the default behaviour.
124 # The new default is to treat a multi-line C++ comment block as a detailed
125 # description. Set this tag to YES if you prefer the old behaviour instead.
127 MULTILINE_CPP_IS_BRIEF = NO
129 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
130 # will output the detailed description near the top, like JavaDoc.
131 # If set to NO, the detailed description appears after the member
136 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
137 # member inherits the documentation from any documented member that it
142 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
143 # tag is set to YES, then doxygen will reuse the documentation of the first
144 # member in the group (if any) for the other members of the group. By default
145 # all members of a group must be documented explicitly.
147 DISTRIBUTE_GROUP_DOC = NO
149 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
150 # Doxygen uses this value to replace tabs by spaces in code fragments.
154 # This tag can be used to specify a number of aliases that acts
155 # as commands in the documentation. An alias has the form "name=value".
156 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
157 # put the command \sideeffect (or @sideeffect) in the documentation, which
158 # will result in a user-defined paragraph with heading "Side Effects:".
159 # You can put \n's in the value part of an alias to insert newlines.
163 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
164 # only. Doxygen will then generate output that is more tailored for C.
165 # For instance, some of the names that are used will be different. The list
166 # of all members will be omitted, etc.
168 OPTIMIZE_OUTPUT_FOR_C = NO
170 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
171 # only. Doxygen will then generate output that is more tailored for Java.
172 # For instance, namespaces will be presented as packages, qualified scopes
173 # will look different, etc.
175 OPTIMIZE_OUTPUT_JAVA = NO
177 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
178 # the same type (for instance a group of public functions) to be put as a
179 # subgroup of that type (e.g. under the Public Functions section). Set it to
180 # NO to prevent subgrouping. Alternatively, this can be done per class using
181 # the \nosubgrouping command.
185 #---------------------------------------------------------------------------
186 # Build related configuration options
187 #---------------------------------------------------------------------------
189 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
190 # documentation are documented, even if no documentation was available.
191 # Private class members and static file members will be hidden unless
192 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
196 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
197 # will be included in the documentation.
201 # If the EXTRACT_STATIC tag is set to YES all static members of a file
202 # will be included in the documentation.
206 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
207 # defined locally in source files will be included in the documentation.
208 # If set to NO only classes defined in header files are included.
210 EXTRACT_LOCAL_CLASSES = YES
212 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
213 # undocumented members of documented classes, files or namespaces.
214 # If set to NO (the default) these members will be included in the
215 # various overviews, but no documentation section is generated.
216 # This option has no effect if EXTRACT_ALL is enabled.
218 HIDE_UNDOC_MEMBERS = NO
220 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
221 # undocumented classes that are normally visible in the class hierarchy.
222 # If set to NO (the default) these classes will be included in the various
223 # overviews. This option has no effect if EXTRACT_ALL is enabled.
225 HIDE_UNDOC_CLASSES = NO
227 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
228 # friend (class|struct|union) declarations.
229 # If set to NO (the default) these declarations will be included in the
232 HIDE_FRIEND_COMPOUNDS = NO
234 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
235 # documentation blocks found inside the body of a function.
236 # If set to NO (the default) these blocks will be appended to the
237 # function's detailed documentation block.
239 HIDE_IN_BODY_DOCS = NO
241 # The INTERNAL_DOCS tag determines if documentation
242 # that is typed after a \internal command is included. If the tag is set
243 # to NO (the default) then the documentation will be excluded.
244 # Set it to YES to include the internal documentation.
248 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
249 # file names in lower-case letters. If set to YES upper-case letters are also
250 # allowed. This is useful if you have classes or files whose names only differ
251 # in case and if your file system supports case sensitive file names. Windows
252 # users are advised to set this option to NO.
254 CASE_SENSE_NAMES = YES
256 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
257 # will show members with their full class and namespace scopes in the
258 # documentation. If set to YES the scope will be hidden.
260 HIDE_SCOPE_NAMES = NO
262 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
263 # will put a list of the files that are included by a file in the documentation
266 SHOW_INCLUDE_FILES = YES
268 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
269 # is inserted in the documentation for inline members.
273 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
274 # will sort the (detailed) documentation of file and class members
275 # alphabetically by member name. If set to NO the members will appear in
278 SORT_MEMBER_DOCS = YES
280 # The GENERATE_TODOLIST tag can be used to enable (YES) or
281 # disable (NO) the todo list. This list is created by putting \todo
282 # commands in the documentation.
284 GENERATE_TODOLIST = YES
286 # The GENERATE_TESTLIST tag can be used to enable (YES) or
287 # disable (NO) the test list. This list is created by putting \test
288 # commands in the documentation.
290 GENERATE_TESTLIST = YES
292 # The GENERATE_BUGLIST tag can be used to enable (YES) or
293 # disable (NO) the bug list. This list is created by putting \bug
294 # commands in the documentation.
296 GENERATE_BUGLIST = YES
298 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
299 # disable (NO) the deprecated list. This list is created by putting
300 # \deprecated commands in the documentation.
302 GENERATE_DEPRECATEDLIST= YES
304 # The ENABLED_SECTIONS tag can be used to enable conditional
305 # documentation sections, marked by \if sectionname ... \endif.
309 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
310 # the initial value of a variable or define consists of for it to appear in
311 # the documentation. If the initializer consists of more lines than specified
312 # here it will be hidden. Use a value of 0 to hide initializers completely.
313 # The appearance of the initializer of individual variables and defines in the
314 # documentation can be controlled using \showinitializer or \hideinitializer
315 # command in the documentation regardless of this setting.
317 MAX_INITIALIZER_LINES = 30
319 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
320 # at the bottom of the documentation of classes and structs. If set to YES the
321 # list will mention the files that were used to generate the documentation.
323 SHOW_USED_FILES = YES
325 #---------------------------------------------------------------------------
326 # configuration options related to warning and progress messages
327 #---------------------------------------------------------------------------
329 # The QUIET tag can be used to turn on/off the messages that are generated
330 # by doxygen. Possible values are YES and NO. If left blank NO is used.
334 # The WARNINGS tag can be used to turn on/off the warning messages that are
335 # generated by doxygen. Possible values are YES and NO. If left blank
340 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
341 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
342 # automatically be disabled.
344 WARN_IF_UNDOCUMENTED = YES
346 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
347 # potential errors in the documentation, such as not documenting some
348 # parameters in a documented function, or documenting parameters that
349 # don't exist or using markup commands wrongly.
351 WARN_IF_DOC_ERROR = YES
353 # The WARN_FORMAT tag determines the format of the warning messages that
354 # doxygen can produce. The string should contain the $file, $line, and $text
355 # tags, which will be replaced by the file and line number from which the
356 # warning originated and the warning text.
360 # The WARN_LOGFILE tag can be used to specify a file to which warning
361 # and error messages should be written. If left blank the output is written
366 #---------------------------------------------------------------------------
367 # configuration options related to the input files
368 #---------------------------------------------------------------------------
370 # The INPUT tag can be used to specify the files and/or directories that contain
371 # documented source files. You may enter file names like "myfile.cpp" or
372 # directories like "/usr/src/myproject". Separate the files or directories
375 INPUT = @srcdir@/source/kernel \
376 @srcdir@/source/arith \
377 @srcdir@/source/ehrhart \
378 @srcdir@/applications \
379 @srcdir@/include/polylib
381 # If the value of the INPUT tag contains directories, you can use the
382 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
383 # and *.h) to filter out the source-files in the directories. If left
384 # blank the following patterns are tested:
385 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
386 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
390 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
391 # should be searched for input files as well. Possible values are YES and NO.
392 # If left blank NO is used.
396 # The EXCLUDE tag can be used to specify files and/or directories that should
397 # excluded from the INPUT source files. This way you can easily exclude a
398 # subdirectory from a directory tree whose root is specified with the INPUT tag.
402 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
403 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
405 EXCLUDE_SYMLINKS = NO
407 # If the value of the INPUT tag contains directories, you can use the
408 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
409 # certain files from those directories.
413 # The EXAMPLE_PATH tag can be used to specify one or more files or
414 # directories that contain example code fragments that are included (see
415 # the \include command).
419 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
420 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
421 # and *.h) to filter out the source-files in the directories. If left
422 # blank all files are included.
426 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
427 # searched for input files to be used with the \include or \dontinclude
428 # commands irrespective of the value of the RECURSIVE tag.
429 # Possible values are YES and NO. If left blank NO is used.
431 EXAMPLE_RECURSIVE = NO
433 # The IMAGE_PATH tag can be used to specify one or more files or
434 # directories that contain image that are included in the documentation (see
435 # the \image command).
439 # The INPUT_FILTER tag can be used to specify a program that doxygen should
440 # invoke to filter for each input file. Doxygen will invoke the filter program
441 # by executing (via popen()) the command <filter> <input-file>, where <filter>
442 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
443 # input file. Doxygen will then use the output that the filter program writes
444 # to standard output.
448 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
449 # INPUT_FILTER) will be used to filter the input files when producing source
450 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
452 FILTER_SOURCE_FILES = NO
454 #---------------------------------------------------------------------------
455 # configuration options related to source browsing
456 #---------------------------------------------------------------------------
458 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
459 # be generated. Documented entities will be cross-referenced with these sources.
460 # Note: To get rid of all source code in the generated output, make sure also
461 # VERBATIM_HEADERS is set to NO.
465 # Setting the INLINE_SOURCES tag to YES will include the body
466 # of functions and classes directly in the documentation.
470 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
471 # doxygen to hide any special comment blocks from generated source code
472 # fragments. Normal C and C++ comments will always remain visible.
474 STRIP_CODE_COMMENTS = NO
476 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
477 # then for each documented function all documented
478 # functions referencing it will be listed.
480 REFERENCED_BY_RELATION = YES
482 # If the REFERENCES_RELATION tag is set to YES (the default)
483 # then for each documented function all documented entities
484 # called/used by that function will be listed.
486 REFERENCES_RELATION = YES
488 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
489 # will generate a verbatim copy of the header file for each class for
490 # which an include is specified. Set to NO to disable this.
492 VERBATIM_HEADERS = YES
494 #---------------------------------------------------------------------------
495 # configuration options related to the alphabetical class index
496 #---------------------------------------------------------------------------
498 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
499 # of all compounds will be generated. Enable this if the project
500 # contains a lot of classes, structs, unions or interfaces.
502 ALPHABETICAL_INDEX = NO
504 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
505 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
506 # in which this list will be split (can be a number in the range [1..20])
508 COLS_IN_ALPHA_INDEX = 5
510 # In case all classes in a project start with a common prefix, all
511 # classes will be put under the same header in the alphabetical index.
512 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
513 # should be ignored while generating the index headers.
517 #---------------------------------------------------------------------------
518 # configuration options related to the HTML output
519 #---------------------------------------------------------------------------
521 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
522 # generate HTML output.
526 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
527 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
528 # put in front of it. If left blank `html' will be used as the default path.
532 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
533 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
534 # doxygen will generate files with .html extension.
536 HTML_FILE_EXTENSION = .html
538 # The HTML_HEADER tag can be used to specify a personal HTML header for
539 # each generated HTML page. If it is left blank doxygen will generate a
544 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
545 # each generated HTML page. If it is left blank doxygen will generate a
550 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
551 # style sheet that is used by each HTML page. It can be used to
552 # fine-tune the look of the HTML output. If the tag is left blank doxygen
553 # will generate a default style sheet. Note that doxygen will try to copy
554 # the style sheet file to the HTML output directory, so don't put your own
555 # stylesheet in the HTML output directory as well, or it will be erased!
559 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
560 # files or namespaces will be aligned in HTML using tables. If set to
561 # NO a bullet list will be used.
563 HTML_ALIGN_MEMBERS = YES
565 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
566 # will be generated that can be used as input for tools like the
567 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
568 # of the generated HTML documentation.
570 GENERATE_HTMLHELP = NO
572 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
573 # be used to specify the file name of the resulting .chm file. You
574 # can add a path in front of the file if the result should not be
575 # written to the html output directory.
579 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
580 # be used to specify the location (absolute path including file name) of
581 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
582 # the HTML help compiler on the generated index.hhp.
586 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
587 # controls if a separate .chi index file is generated (YES) or that
588 # it should be included in the master .chm file (NO).
592 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
593 # controls whether a binary table of contents is generated (YES) or a
594 # normal table of contents (NO) in the .chm file.
598 # The TOC_EXPAND flag can be set to YES to add extra items for group members
599 # to the contents of the HTML help documentation and to the tree view.
603 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
604 # top of each HTML page. The value NO (the default) enables the index and
605 # the value YES disables it.
609 # This tag can be used to set the number of enum values (range [1..20])
610 # that doxygen will group on one line in the generated HTML documentation.
612 ENUM_VALUES_PER_LINE = 4
614 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
615 # generated containing a tree-like index structure (just like the one that
616 # is generated for HTML Help). For this to work a browser that supports
617 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
618 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
619 # probably better off using the HTML help feature.
621 GENERATE_TREEVIEW = YES
623 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
624 # used to set the initial width (in pixels) of the frame in which the tree
629 #---------------------------------------------------------------------------
630 # configuration options related to the LaTeX output
631 #---------------------------------------------------------------------------
633 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
634 # generate Latex output.
638 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
639 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
640 # put in front of it. If left blank `latex' will be used as the default path.
644 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
645 # invoked. If left blank `latex' will be used as the default command name.
647 LATEX_CMD_NAME = latex
649 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
650 # generate index for LaTeX. If left blank `makeindex' will be used as the
651 # default command name.
653 MAKEINDEX_CMD_NAME = makeindex
655 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
656 # LaTeX documents. This may be useful for small projects and may help to
657 # save some trees in general.
661 # The PAPER_TYPE tag can be used to set the paper type that is used
662 # by the printer. Possible values are: a4, a4wide, letter, legal and
663 # executive. If left blank a4wide will be used.
667 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
668 # packages that should be included in the LaTeX output.
672 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
673 # the generated latex document. The header should contain everything until
674 # the first chapter. If it is left blank doxygen will generate a
675 # standard header. Notice: only use this tag if you know what you are doing!
679 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
680 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
681 # contain links (just like the HTML output) instead of page references
682 # This makes the output suitable for online browsing using a pdf viewer.
686 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
687 # plain latex in the generated Makefile. Set this option to YES to get a
688 # higher quality PDF documentation.
692 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
693 # command to the generated LaTeX files. This will instruct LaTeX to keep
694 # running if errors occur, instead of asking the user for help.
695 # This option is also used when generating formulas in HTML.
699 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
700 # include the index chapters (such as File Index, Compound Index, etc.)
703 LATEX_HIDE_INDICES = NO
705 #---------------------------------------------------------------------------
706 # configuration options related to the RTF output
707 #---------------------------------------------------------------------------
709 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
710 # The RTF output is optimized for Word 97 and may not look very pretty with
711 # other RTF readers or editors.
715 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
716 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
717 # put in front of it. If left blank `rtf' will be used as the default path.
721 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
722 # RTF documents. This may be useful for small projects and may help to
723 # save some trees in general.
727 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
728 # will contain hyperlink fields. The RTF file will
729 # contain links (just like the HTML output) instead of page references.
730 # This makes the output suitable for online browsing using WORD or other
731 # programs which support those fields.
732 # Note: wordpad (write) and others do not support links.
736 # Load stylesheet definitions from file. Syntax is similar to doxygen's
737 # config file, i.e. a series of assignments. You only have to provide
738 # replacements, missing definitions are set to their default value.
740 RTF_STYLESHEET_FILE =
742 # Set optional variables used in the generation of an rtf document.
743 # Syntax is similar to doxygen's config file.
745 RTF_EXTENSIONS_FILE =
747 #---------------------------------------------------------------------------
748 # configuration options related to the man page output
749 #---------------------------------------------------------------------------
751 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
756 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
757 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
758 # put in front of it. If left blank `man' will be used as the default path.
762 # The MAN_EXTENSION tag determines the extension that is added to
763 # the generated man pages (default is the subroutine's section .3)
767 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
768 # then it will generate one additional man file for each entity
769 # documented in the real man page(s). These additional files
770 # only source the real man page, but without them the man command
771 # would be unable to find the correct page. The default is NO.
775 #---------------------------------------------------------------------------
776 # configuration options related to the XML output
777 #---------------------------------------------------------------------------
779 # If the GENERATE_XML tag is set to YES Doxygen will
780 # generate an XML file that captures the structure of
781 # the code including all documentation.
785 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
786 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
787 # put in front of it. If left blank `xml' will be used as the default path.
791 # The XML_SCHEMA tag can be used to specify an XML schema,
792 # which can be used by a validating XML parser to check the
793 # syntax of the XML files.
797 # The XML_DTD tag can be used to specify an XML DTD,
798 # which can be used by a validating XML parser to check the
799 # syntax of the XML files.
803 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
804 # dump the program listings (including syntax highlighting
805 # and cross-referencing information) to the XML output. Note that
806 # enabling this will significantly increase the size of the XML output.
808 XML_PROGRAMLISTING = YES
810 #---------------------------------------------------------------------------
811 # configuration options for the AutoGen Definitions output
812 #---------------------------------------------------------------------------
814 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
815 # generate an AutoGen Definitions (see autogen.sf.net) file
816 # that captures the structure of the code including all
817 # documentation. Note that this feature is still experimental
818 # and incomplete at the moment.
820 GENERATE_AUTOGEN_DEF = NO
822 #---------------------------------------------------------------------------
823 # configuration options related to the Perl module output
824 #---------------------------------------------------------------------------
826 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
827 # generate a Perl module file that captures the structure of
828 # the code including all documentation. Note that this
829 # feature is still experimental and incomplete at the
832 GENERATE_PERLMOD = NO
834 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
835 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
836 # to generate PDF and DVI output from the Perl module output.
840 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
841 # nicely formatted so it can be parsed by a human reader. This is useful
842 # if you want to understand what is going on. On the other hand, if this
843 # tag is set to NO the size of the Perl module output will be much smaller
844 # and Perl will parse it just the same.
848 # The names of the make variables in the generated doxyrules.make file
849 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
850 # This is useful so different doxyrules.make files included by the same
851 # Makefile don't overwrite each other's variables.
853 PERLMOD_MAKEVAR_PREFIX =
855 #---------------------------------------------------------------------------
856 # Configuration options related to the preprocessor
857 #---------------------------------------------------------------------------
859 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
860 # evaluate all C-preprocessor directives found in the sources and include
863 ENABLE_PREPROCESSING = YES
865 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
866 # names in the source code. If set to NO (the default) only conditional
867 # compilation will be performed. Macro expansion can be done in a controlled
868 # way by setting EXPAND_ONLY_PREDEF to YES.
872 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
873 # then the macro expansion is limited to the macros specified with the
874 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
876 EXPAND_ONLY_PREDEF = NO
878 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
879 # in the INCLUDE_PATH (see below) will be search if a #include is found.
881 SEARCH_INCLUDES = YES
883 # The INCLUDE_PATH tag can be used to specify one or more directories that
884 # contain include files that are not input files but should be processed by
887 INCLUDE_PATH = @srcdir@/include \
888 @srcdir@/include/polylib
890 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
891 # patterns (like *.h and *.hpp) to filter out the header-files in the
892 # directories. If left blank, the patterns specified with FILE_PATTERNS will
895 INCLUDE_FILE_PATTERNS =
897 # The PREDEFINED tag can be used to specify one or more macro names that
898 # are defined before the preprocessor is started (similar to the -D option of
899 # gcc). The argument of the tag is a list of macros of the form: name
900 # or name=definition (no spaces). If the definition and the = are
901 # omitted =1 is assumed.
905 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
906 # this tag can be used to specify a list of macro names that should be expanded.
907 # The macro definition that is found in the sources will be used.
908 # Use the PREDEFINED tag if you want to use a different macro definition.
912 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
913 # doxygen's preprocessor will remove all function-like macros that are alone
914 # on a line, have an all uppercase name, and do not end with a semicolon. Such
915 # function macros are typically used for boiler-plate code, and will confuse the
916 # parser if not removed.
918 SKIP_FUNCTION_MACROS = YES
920 #---------------------------------------------------------------------------
921 # Configuration::addtions related to external references
922 #---------------------------------------------------------------------------
924 # The TAGFILES option can be used to specify one or more tagfiles.
925 # Optionally an initial location of the external documentation
926 # can be added for each tagfile. The format of a tag file without
927 # this location is as follows:
928 # TAGFILES = file1 file2 ...
929 # Adding location for the tag files is done as follows:
930 # TAGFILES = file1=loc1 "file2 = loc2" ...
931 # where "loc1" and "loc2" can be relative or absolute paths or
932 # URLs. If a location is present for each tag, the installdox tool
933 # does not have to be run to correct the links.
934 # Note that each tag file must have a unique name
935 # (where the name does NOT include the path)
936 # If a tag file is not located in the directory in which doxygen
937 # is run, you must also specify the path to the tagfile here.
941 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
942 # a tag file that is based on the input files it reads.
946 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
947 # in the class index. If set to NO only the inherited external classes
952 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
953 # in the modules index. If set to NO, only the current project's groups will
956 EXTERNAL_GROUPS = YES
958 # The PERL_PATH should be the absolute path and name of the perl script
959 # interpreter (i.e. the result of `which perl').
963 #---------------------------------------------------------------------------
964 # Configuration options related to the dot tool
965 #---------------------------------------------------------------------------
967 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
968 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
969 # super classes. Setting the tag to NO turns the diagrams off. Note that this
970 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
971 # recommended to install and use dot, since it yields more powerful graphs.
975 # If set to YES, the inheritance and collaboration graphs will hide
976 # inheritance and usage relations if the target is undocumented
979 HIDE_UNDOC_RELATIONS = YES
981 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
982 # available from the path. This tool is part of Graphviz, a graph visualization
983 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
984 # have no effect if this option is set to NO (the default)
988 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
989 # will generate a graph for each documented class showing the direct and
990 # indirect inheritance relations. Setting this tag to YES will force the
991 # the CLASS_DIAGRAMS tag to NO.
995 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
996 # will generate a graph for each documented class showing the direct and
997 # indirect implementation dependencies (inheritance, containment, and
998 # class references variables) of the class with other documented classes.
1000 COLLABORATION_GRAPH = YES
1002 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1003 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1008 # If set to YES, the inheritance and collaboration graphs will show the
1009 # relations between templates and their instances.
1011 TEMPLATE_RELATIONS = YES
1013 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1014 # tags are set to YES then doxygen will generate a graph for each documented
1015 # file showing the direct and indirect include dependencies of the file with
1016 # other documented files.
1020 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1021 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1022 # documented header file showing the documented files that directly or
1023 # indirectly include this file.
1025 INCLUDED_BY_GRAPH = YES
1027 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1028 # generate a call dependency graph for every global function or class method.
1029 # Note that enabling this option will significantly increase the time of a run.
1030 # So in most cases it will be better to enable call graphs for selected
1031 # functions only using the \callgraph command.
1035 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1036 # will graphical hierarchy of all classes instead of a textual one.
1038 GRAPHICAL_HIERARCHY = YES
1040 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1041 # generated by dot. Possible values are png, jpg, or gif
1042 # If left blank png will be used.
1044 DOT_IMAGE_FORMAT = png
1046 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1047 # found. If left blank, it is assumed the dot tool can be found on the path.
1051 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1052 # contain dot files that are included in the documentation (see the
1053 # \dotfile command).
1057 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1058 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1059 # this value, doxygen will try to truncate the graph, so that it fits within
1060 # the specified constraint. Beware that most browsers cannot cope with very
1063 MAX_DOT_GRAPH_WIDTH = 1024
1065 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1066 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1067 # this value, doxygen will try to truncate the graph, so that it fits within
1068 # the specified constraint. Beware that most browsers cannot cope with very
1071 MAX_DOT_GRAPH_HEIGHT = 1024
1073 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1074 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1075 # from the root by following a path via at most 3 edges will be shown. Nodes that
1076 # lay further from the root node will be omitted. Note that setting this option to
1077 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1078 # note that a graph may be further truncated if the graph's image dimensions are
1079 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1080 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1082 MAX_DOT_GRAPH_DEPTH = 0
1084 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1085 # generate a legend page explaining the meaning of the various boxes and
1086 # arrows in the dot generated graphs.
1088 GENERATE_LEGEND = YES
1090 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1091 # remove the intermediate dot files that are used to generate
1092 # the various graphs.
1096 #---------------------------------------------------------------------------
1097 # Configuration::addtions related to the search engine
1098 #---------------------------------------------------------------------------
1100 # The SEARCHENGINE tag specifies whether or not a search engine should be
1101 # used. If set to NO the values of all tags below this one will be ignored.