ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/REPOS_ERICCA/magic/documentation/docmagic
(Generate patch)

Comparing magic/documentation/docmagic (file contents):
Revision 737 by francois, Thu Sep 24 22:47:31 2015 UTC vs.
Revision 1020 by francois, Wed Jun 5 14:33:14 2019 UTC

# Line 1 | Line 1
1 < # Doxyfile 1.8.6
1 > # Doxyfile 1.8.11
2  
3   # This file describes the settings to be used by the documentation system
4   # doxygen (www.doxygen.org) for a project.
# Line 38 | Line 38 | PROJECT_NAME           = MAGiC
38   # could be handy for archiving the generated documentation or if some version
39   # control system is used.
40  
41 < PROJECT_NUMBER         = 2015
41 > PROJECT_NUMBER         = v4
42  
43   # Using the PROJECT_BRIEF tag one can provide an optional one line description
44   # for a project that appears at the top of each page and should give viewer a
# Line 46 | Line 46 | PROJECT_NUMBER         = 2015
46  
47   PROJECT_BRIEF          =
48  
49 < # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50 < # the documentation. The maximum height of the logo should not exceed 55 pixels
51 < # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52 < # to the output directory.
49 > # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50 > # in the documentation. The maximum height of the logo should not exceed 55
51 > # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52 > # the logo to the output directory.
53  
54   PROJECT_LOGO           =
55  
# Line 60 | Line 60 | PROJECT_LOGO           =
60  
61   OUTPUT_DIRECTORY       = ./
62  
63 < # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
63 > # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64   # directories (in 2 levels) under the output directory of each output format and
65   # will distribute the generated files over these directories. Enabling this
66   # option can be useful when feeding doxygen a huge amount of source files, where
# Line 70 | Line 70 | OUTPUT_DIRECTORY       = ./
70  
71   CREATE_SUBDIRS         = YES
72  
73 + # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 + # characters to appear in the names of generated files. If set to NO, non-ASCII
75 + # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76 + # U+3044.
77 + # The default value is: NO.
78 +
79 + ALLOW_UNICODE_NAMES    = NO
80 +
81   # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82   # documentation generated by doxygen is written. Doxygen will use this
83   # information to generate all constant output in the proper language.
# Line 85 | Line 93 | CREATE_SUBDIRS         = YES
93  
94   OUTPUT_LANGUAGE        = French
95  
96 < # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
96 > # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97   # descriptions after the members that are listed in the file and class
98   # documentation (similar to Javadoc). Set to NO to disable this.
99   # The default value is: YES.
100  
101   BRIEF_MEMBER_DESC      = YES
102  
103 < # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
103 > # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104   # description of a member or function before the detailed description
105   #
106   # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# Line 137 | Line 145 | ALWAYS_DETAILED_SEC    = NO
145  
146   INLINE_INHERITED_MEMB  = NO
147  
148 < # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
148 > # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
149   # before files name in the file list and in the header files. If set to NO the
150   # shortest path that makes the file name unique will be used
151   # The default value is: YES.
# Line 207 | Line 215 | MULTILINE_CPP_IS_BRIEF = NO
215  
216   INHERIT_DOCS           = YES
217  
218 < # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
219 < # new page for each member. If set to NO, the documentation of a member will be
220 < # part of the file/class/namespace that contains it.
218 > # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
219 > # page for each member. If set to NO, the documentation of a member will be part
220 > # of the file/class/namespace that contains it.
221   # The default value is: NO.
222  
223   SEPARATE_MEMBER_PAGES  = NO
# Line 271 | Line 279 | OPTIMIZE_OUTPUT_VHDL   = NO
279   # extension. Doxygen has a built-in mapping, but you can override or extend it
280   # using this tag. The format is ext=language, where ext is a file extension, and
281   # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
282 < # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
283 < # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
284 < # (default is Fortran), use: inc=Fortran f=C.
282 > # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
283 > # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
284 > # Fortran. In the later case the parser tries to guess whether the code is fixed
285 > # or free formatted code, this is the default for Fortran type files), VHDL. For
286 > # instance to make doxygen treat .inc files as Fortran files (default is PHP),
287 > # and .f files as C (default is Fortran), use: inc=Fortran f=C.
288   #
289 < # Note For files without extension you can use no_extension as a placeholder.
289 > # Note: For files without extension you can use no_extension as a placeholder.
290   #
291   # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
292   # the files are not read by doxygen.
# Line 294 | Line 305 | MARKDOWN_SUPPORT       = YES
305  
306   # When enabled doxygen tries to link words that correspond to documented
307   # classes, or namespaces to their corresponding documentation. Such a link can
308 < # be prevented in individual cases by by putting a % sign in front of the word
309 < # or globally by setting AUTOLINK_SUPPORT to NO.
308 > # be prevented in individual cases by putting a % sign in front of the word or
309 > # globally by setting AUTOLINK_SUPPORT to NO.
310   # The default value is: YES.
311  
312   AUTOLINK_SUPPORT       = YES
# Line 335 | Line 346 | SIP_SUPPORT            = NO
346   IDL_PROPERTY_SUPPORT   = YES
347  
348   # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
349 < # tag is set to YES, then doxygen will reuse the documentation of the first
349 > # tag is set to YES then doxygen will reuse the documentation of the first
350   # member in the group (if any) for the other members of the group. By default
351   # all members of a group must be documented explicitly.
352   # The default value is: NO.
353  
354   DISTRIBUTE_GROUP_DOC   = NO
355  
356 + # If one adds a struct or class to a group and this option is enabled, then also
357 + # any nested class or struct is added to the same group. By default this option
358 + # is disabled and one has to add nested compounds explicitly via \ingroup.
359 + # The default value is: NO.
360 +
361 + GROUP_NESTED_COMPOUNDS = NO
362 +
363   # Set the SUBGROUPING tag to YES to allow class member groups of the same type
364   # (for instance a group of public functions) to be put as a subgroup of that
365   # type (e.g. under the Public Functions section). Set it to NO to prevent
# Line 400 | Line 418 | LOOKUP_CACHE_SIZE      = 0
418   # Build related configuration options
419   #---------------------------------------------------------------------------
420  
421 < # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
421 > # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
422   # documentation are documented, even if no documentation was available. Private
423   # class members and static file members will be hidden unless the
424   # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Line 410 | Line 428 | LOOKUP_CACHE_SIZE      = 0
428  
429   EXTRACT_ALL            = YES
430  
431 < # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
431 > # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
432   # be included in the documentation.
433   # The default value is: NO.
434  
435   EXTRACT_PRIVATE        = YES
436  
437 < # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
437 > # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
438   # scope will be included in the documentation.
439   # The default value is: NO.
440  
441   EXTRACT_PACKAGE        = NO
442  
443 < # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
443 > # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
444   # included in the documentation.
445   # The default value is: NO.
446  
447   EXTRACT_STATIC         = YES
448  
449 < # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
450 < # locally in source files will be included in the documentation. If set to NO
449 > # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
450 > # locally in source files will be included in the documentation. If set to NO,
451   # only classes defined in header files are included. Does not have any effect
452   # for Java sources.
453   # The default value is: YES.
454  
455   EXTRACT_LOCAL_CLASSES  = YES
456  
457 < # This flag is only useful for Objective-C code. When set to YES local methods,
457 > # This flag is only useful for Objective-C code. If set to YES, local methods,
458   # which are defined in the implementation section but not in the interface are
459 < # included in the documentation. If set to NO only methods in the interface are
459 > # included in the documentation. If set to NO, only methods in the interface are
460   # included.
461   # The default value is: NO.
462  
# Line 463 | Line 481 | HIDE_UNDOC_MEMBERS     = NO
481  
482   # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
483   # undocumented classes that are normally visible in the class hierarchy. If set
484 < # to NO these classes will be included in the various overviews. This option has
485 < # no effect if EXTRACT_ALL is enabled.
484 > # to NO, these classes will be included in the various overviews. This option
485 > # has no effect if EXTRACT_ALL is enabled.
486   # The default value is: NO.
487  
488   HIDE_UNDOC_CLASSES     = NO
489  
490   # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
491 < # (class|struct|union) declarations. If set to NO these declarations will be
491 > # (class|struct|union) declarations. If set to NO, these declarations will be
492   # included in the documentation.
493   # The default value is: NO.
494  
495   HIDE_FRIEND_COMPOUNDS  = NO
496  
497   # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
498 < # documentation blocks found inside the body of a function. If set to NO these
498 > # documentation blocks found inside the body of a function. If set to NO, these
499   # blocks will be appended to the function's detailed documentation block.
500   # The default value is: NO.
501  
# Line 491 | Line 509 | HIDE_IN_BODY_DOCS      = NO
509   INTERNAL_DOCS          = NO
510  
511   # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
512 < # names in lower-case letters. If set to YES upper-case letters are also
512 > # names in lower-case letters. If set to YES, upper-case letters are also
513   # allowed. This is useful if you have classes or files whose names only differ
514   # in case and if your file system supports case sensitive file names. Windows
515   # and Mac users are advised to set this option to NO.
# Line 500 | Line 518 | INTERNAL_DOCS          = NO
518   CASE_SENSE_NAMES       = NO
519  
520   # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
521 < # their full class and namespace scopes in the documentation. If set to YES the
521 > # their full class and namespace scopes in the documentation. If set to YES, the
522   # scope will be hidden.
523   # The default value is: NO.
524  
525   HIDE_SCOPE_NAMES       = NO
526  
527 + # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
528 + # append additional text to a page's title, such as Class Reference. If set to
529 + # YES the compound reference will be hidden.
530 + # The default value is: NO.
531 +
532 + HIDE_COMPOUND_REFERENCE= NO
533 +
534   # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
535   # the files that are included by a file in the documentation of that file.
536   # The default value is: YES.
# Line 533 | Line 558 | INLINE_INFO            = YES
558  
559   # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
560   # (detailed) documentation of file and class members alphabetically by member
561 < # name. If set to NO the members will appear in declaration order.
561 > # name. If set to NO, the members will appear in declaration order.
562   # The default value is: YES.
563  
564   SORT_MEMBER_DOCS       = YES
565  
566   # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
567   # descriptions of file, namespace and class members alphabetically by member
568 < # name. If set to NO the members will appear in declaration order. Note that
568 > # name. If set to NO, the members will appear in declaration order. Note that
569   # this will also influence the order of the classes in the class list.
570   # The default value is: NO.
571  
# Line 585 | Line 610 | SORT_BY_SCOPE_NAME     = NO
610  
611   STRICT_PROTO_MATCHING  = NO
612  
613 < # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
614 < # todo list. This list is created by putting \todo commands in the
590 < # documentation.
613 > # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
614 > # list. This list is created by putting \todo commands in the documentation.
615   # The default value is: YES.
616  
617   GENERATE_TODOLIST      = YES
618  
619 < # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
620 < # test list. This list is created by putting \test commands in the
597 < # documentation.
619 > # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
620 > # list. This list is created by putting \test commands in the documentation.
621   # The default value is: YES.
622  
623   GENERATE_TESTLIST      = YES
624  
625 < # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
625 > # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
626   # list. This list is created by putting \bug commands in the documentation.
627   # The default value is: YES.
628  
629   GENERATE_BUGLIST       = YES
630  
631 < # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
631 > # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
632   # the deprecated list. This list is created by putting \deprecated commands in
633   # the documentation.
634   # The default value is: YES.
# Line 630 | Line 653 | ENABLED_SECTIONS       =
653   MAX_INITIALIZER_LINES  = 30
654  
655   # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
656 < # the bottom of the documentation of classes and structs. If set to YES the list
657 < # will mention the files that were used to generate the documentation.
656 > # the bottom of the documentation of classes and structs. If set to YES, the
657 > # list will mention the files that were used to generate the documentation.
658   # The default value is: YES.
659  
660   SHOW_USED_FILES        = YES
# Line 679 | Line 702 | LAYOUT_FILE            =
702   # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
703   # For LaTeX the style of the bibliography can be controlled using
704   # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
705 < # search path. Do not use file names with spaces, bibtex cannot handle them. See
683 < # also \cite for info how to create references.
705 > # search path. See also \cite for info how to create references.
706  
707   CITE_BIB_FILES         =
708  
# Line 696 | Line 718 | CITE_BIB_FILES         =
718   QUIET                  = NO
719  
720   # The WARNINGS tag can be used to turn on/off the warning messages that are
721 < # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
721 > # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
722   # this implies that the warnings are on.
723   #
724   # Tip: Turn warnings on while writing the documentation.
# Line 704 | Line 726 | QUIET                  = NO
726  
727   WARNINGS               = YES
728  
729 < # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
729 > # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
730   # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
731   # will automatically be disabled.
732   # The default value is: YES.
# Line 721 | Line 743 | WARN_IF_DOC_ERROR      = YES
743  
744   # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
745   # are documented, but have no documentation for their parameters or return
746 < # value. If set to NO doxygen will only warn about wrong or incomplete parameter
747 < # documentation, but not about the absence of documentation.
746 > # value. If set to NO, doxygen will only warn about wrong or incomplete
747 > # parameter documentation, but not about the absence of documentation.
748   # The default value is: NO.
749  
750   WARN_NO_PARAMDOC       = NO
751  
752 + # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
753 + # a warning is encountered.
754 + # The default value is: NO.
755 +
756 + WARN_AS_ERROR          = NO
757 +
758   # The WARN_FORMAT tag determines the format of the warning messages that doxygen
759   # can produce. The string should contain the $file, $line, and $text tags, which
760   # will be replaced by the file and line number from which the warning originated
# Line 750 | Line 778 | WARN_LOGFILE           =
778   # The INPUT tag is used to specify the files and/or directories that contain
779   # documented source files. You may enter file names like myfile.cpp or
780   # directories like /usr/src/myproject. Separate the files or directories with
781 < # spaces.
781 > # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
782   # Note: If this tag is empty the current directory is searched.
783  
784   INPUT                  = ../lib \
785 <                         ../app/magic_application/src/aide.h
785 >                         ../app/magic_application/src/aide.h \
786 >                         ../outil \
787 >                         ../poly_occ
788  
789   # This tag can be used to specify the character encoding of the source files
790   # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# Line 767 | Line 797 | INPUT_ENCODING         = UTF-8
797  
798   # If the value of the INPUT tag contains directories, you can use the
799   # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
800 < # *.h) to filter out the source-files in the directories. If left blank the
801 < # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
802 < # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
803 < # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
804 < # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
805 < # *.qsf, *.as and *.js.
800 > # *.h) to filter out the source-files in the directories.
801 > #
802 > # Note that for custom extensions or not directly supported extensions you also
803 > # need to set EXTENSION_MAPPING for the extension otherwise the files are not
804 > # read by doxygen.
805 > #
806 > # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
807 > # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
808 > # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
809 > # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
810 > # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
811  
812   FILE_PATTERNS          = *.c \
813                           *.cc \
# Line 815 | Line 850 | RECURSIVE              = YES
850  
851   EXCLUDE                = ../lib/OCC_Fonction \
852                           ../lib/geometrie/Imports \
853 <                         ../lib/diamesh
853 >                         ../lib/diamesh \
854 >                         ../poly_occ/voro++-0.4.6
855  
856   # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
857   # directories that are symbolic links (a Unix file system feature) are excluded
# Line 884 | Line 920 | IMAGE_PATH             =
920   # Note that the filter must not add or remove lines; it is applied before the
921   # code is scanned, but not when the output code is generated. If lines are added
922   # or removed, the anchors will not be placed correctly.
923 + #
924 + # Note that for custom extensions or not directly supported extensions you also
925 + # need to set EXTENSION_MAPPING for the extension otherwise the files are not
926 + # properly processed by doxygen.
927  
928   INPUT_FILTER           =
929  
# Line 893 | Line 933 | INPUT_FILTER           =
933   # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
934   # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
935   # patterns match the file name, INPUT_FILTER is applied.
936 + #
937 + # Note that for custom extensions or not directly supported extensions you also
938 + # need to set EXTENSION_MAPPING for the extension otherwise the files are not
939 + # properly processed by doxygen.
940  
941   FILTER_PATTERNS        =
942  
943   # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
944 < # INPUT_FILTER ) will also be used to filter the input files that are used for
944 > # INPUT_FILTER) will also be used to filter the input files that are used for
945   # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
946   # The default value is: NO.
947  
# Line 957 | Line 1001 | REFERENCED_BY_RELATION = YES
1001   REFERENCES_RELATION    = YES
1002  
1003   # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1004 < # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
1004 > # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1005   # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1006   # link to the documentation.
1007   # The default value is: YES.
# Line 1004 | Line 1048 | USE_HTAGS              = NO
1048  
1049   VERBATIM_HEADERS       = YES
1050  
1051 + # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1052 + # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1053 + # cost of reduced performance. This can be particularly helpful with template
1054 + # rich C++ code for which doxygen's built-in parser lacks the necessary type
1055 + # information.
1056 + # Note: The availability of this option depends on whether or not doxygen was
1057 + # generated with the -Duse-libclang=ON option for CMake.
1058 + # The default value is: NO.
1059 +
1060 + CLANG_ASSISTED_PARSING = NO
1061 +
1062 + # If clang assisted parsing is enabled you can provide the compiler with command
1063 + # line options that you would normally use when invoking the compiler. Note that
1064 + # the include paths will already be set by doxygen for the files and directories
1065 + # specified with INPUT and INCLUDE_PATH.
1066 + # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1067 +
1068 + CLANG_OPTIONS          =
1069 +
1070   #---------------------------------------------------------------------------
1071   # Configuration options related to the alphabetical class index
1072   #---------------------------------------------------------------------------
# Line 1034 | Line 1097 | IGNORE_PREFIX          =
1097   # Configuration options related to the HTML output
1098   #---------------------------------------------------------------------------
1099  
1100 < # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1100 > # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1101   # The default value is: YES.
1102  
1103   GENERATE_HTML          = YES
# Line 1096 | Line 1159 | HTML_FOOTER            =
1159  
1160   HTML_STYLESHEET        =
1161  
1162 < # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1163 < # defined cascading style sheet that is included after the standard style sheets
1162 > # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1163 > # cascading style sheets that are included after the standard style sheets
1164   # created by doxygen. Using this option one can overrule certain style aspects.
1165   # This is preferred over using HTML_STYLESHEET since it does not replace the
1166 < # standard style sheet and is therefor more robust against future updates.
1167 < # Doxygen will copy the style sheet file to the output directory. For an example
1168 < # see the documentation.
1166 > # standard style sheet and is therefore more robust against future updates.
1167 > # Doxygen will copy the style sheet files to the output directory.
1168 > # Note: The order of the extra style sheet files is of importance (e.g. the last
1169 > # style sheet in the list overrules the setting of the previous ones in the
1170 > # list). For an example see the documentation.
1171   # This tag requires that the tag GENERATE_HTML is set to YES.
1172  
1173   HTML_EXTRA_STYLESHEET  =
# Line 1118 | Line 1183 | HTML_EXTRA_STYLESHEET  =
1183   HTML_EXTRA_FILES       =
1184  
1185   # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1186 < # will adjust the colors in the stylesheet and background images according to
1186 > # will adjust the colors in the style sheet and background images according to
1187   # this color. Hue is specified as an angle on a colorwheel, see
1188   # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1189   # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# Line 1149 | Line 1214 | HTML_COLORSTYLE_GAMMA  = 84
1214  
1215   # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1216   # page will contain the date and time when the page was generated. Setting this
1217 < # to NO can help when comparing the output of multiple runs.
1218 < # The default value is: YES.
1217 > # to YES can help to show when doxygen was last run and thus if the
1218 > # documentation is up to date.
1219 > # The default value is: NO.
1220   # This tag requires that the tag GENERATE_HTML is set to YES.
1221  
1222   HTML_TIMESTAMP         = YES
# Line 1246 | Line 1312 | GENERATE_HTMLHELP      = NO
1312   CHM_FILE               =
1313  
1314   # The HHC_LOCATION tag can be used to specify the location (absolute path
1315 < # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1315 > # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1316   # doxygen will try to run the HTML help compiler on the generated index.hhp.
1317   # The file has to be specified with full path.
1318   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1319  
1320   HHC_LOCATION           =
1321  
1322 < # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1323 < # YES) or that it should be included in the master .chm file ( NO).
1322 > # The GENERATE_CHI flag controls if a separate .chi index file is generated
1323 > # (YES) or that it should be included in the master .chm file (NO).
1324   # The default value is: NO.
1325   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1326  
1327   GENERATE_CHI           = NO
1328  
1329 < # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1329 > # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1330   # and project file content.
1331   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1332  
1333   CHM_INDEX_ENCODING     =
1334  
1335 < # The BINARY_TOC flag controls whether a binary table of contents is generated (
1336 < # YES) or a normal table of contents ( NO) in the .chm file.
1335 > # The BINARY_TOC flag controls whether a binary table of contents is generated
1336 > # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1337 > # enables the Previous and Next buttons.
1338   # The default value is: NO.
1339   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1340  
# Line 1380 | Line 1447 | DISABLE_INDEX          = NO
1447   # index structure (just like the one that is generated for HTML Help). For this
1448   # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1449   # (i.e. any modern browser). Windows users are probably better off using the
1450 < # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1450 > # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1451   # further fine-tune the look of the index. As an example, the default style
1452   # sheet generated by doxygen has an example that shows how to put an image at
1453   # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# Line 1408 | Line 1475 | ENUM_VALUES_PER_LINE   = 1
1475  
1476   TREEVIEW_WIDTH         = 250
1477  
1478 < # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1478 > # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1479   # external symbols imported via tag files in a separate window.
1480   # The default value is: NO.
1481   # This tag requires that the tag GENERATE_HTML is set to YES.
# Line 1437 | Line 1504 | FORMULA_TRANSPARENT    = YES
1504  
1505   # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1506   # http://www.mathjax.org) which uses client side Javascript for the rendering
1507 < # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1507 > # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1508   # installed or if you want to formulas look prettier in the HTML output. When
1509   # enabled you may also need to install MathJax separately and configure the path
1510   # to it using the MATHJAX_RELPATH option.
# Line 1507 | Line 1574 | SEARCHENGINE           = YES
1574  
1575   # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1576   # implemented using a web server instead of a web client using Javascript. There
1577 < # are two flavours of web server based searching depending on the
1578 < # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1579 < # searching and an index file used by the script. When EXTERNAL_SEARCH is
1580 < # enabled the indexing and searching needs to be provided by external tools. See
1581 < # the section "External Indexing and Searching" for details.
1577 > # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1578 > # setting. When disabled, doxygen will generate a PHP script for searching and
1579 > # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1580 > # and searching needs to be provided by external tools. See the section
1581 > # "External Indexing and Searching" for details.
1582   # The default value is: NO.
1583   # This tag requires that the tag SEARCHENGINE is set to YES.
1584  
# Line 1523 | Line 1590 | SERVER_BASED_SEARCH    = NO
1590   # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1591   # search results.
1592   #
1593 < # Doxygen ships with an example indexer ( doxyindexer) and search engine
1593 > # Doxygen ships with an example indexer (doxyindexer) and search engine
1594   # (doxysearch.cgi) which are based on the open source search engine library
1595   # Xapian (see: http://xapian.org/).
1596   #
# Line 1536 | Line 1603 | EXTERNAL_SEARCH        = NO
1603   # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1604   # which will return the search results when EXTERNAL_SEARCH is enabled.
1605   #
1606 < # Doxygen ships with an example indexer ( doxyindexer) and search engine
1606 > # Doxygen ships with an example indexer (doxyindexer) and search engine
1607   # (doxysearch.cgi) which are based on the open source search engine library
1608   # Xapian (see: http://xapian.org/). See the section "External Indexing and
1609   # Searching" for details.
# Line 1574 | Line 1641 | EXTRA_SEARCH_MAPPINGS  =
1641   # Configuration options related to the LaTeX output
1642   #---------------------------------------------------------------------------
1643  
1644 < # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1644 > # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1645   # The default value is: YES.
1646  
1647   GENERATE_LATEX         = NO
# Line 1605 | Line 1672 | LATEX_CMD_NAME         = latex
1672  
1673   MAKEINDEX_CMD_NAME     = makeindex
1674  
1675 < # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1675 > # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1676   # documents. This may be useful for small projects and may help to save some
1677   # trees in general.
1678   # The default value is: NO.
# Line 1623 | Line 1690 | COMPACT_LATEX          = NO
1690   PAPER_TYPE             = a4wide
1691  
1692   # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1693 < # that should be included in the LaTeX output. To get the times font for
1694 < # instance you can specify
1695 < # EXTRA_PACKAGES=times
1693 > # that should be included in the LaTeX output. The package can be specified just
1694 > # by its name or with the correct syntax as to be used with the LaTeX
1695 > # \usepackage command. To get the times font for instance you can specify :
1696 > # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1697 > # To use the option intlimits with the amsmath package you can specify:
1698 > # EXTRA_PACKAGES=[intlimits]{amsmath}
1699   # If left blank no extra packages will be included.
1700   # This tag requires that the tag GENERATE_LATEX is set to YES.
1701  
# Line 1639 | Line 1709 | EXTRA_PACKAGES         =
1709   #
1710   # Note: Only use a user-defined header if you know what you are doing! The
1711   # following commands have a special meaning inside the header: $title,
1712 < # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1713 < # replace them by respectively the title of the page, the current date and time,
1714 < # only the current date, the version number of doxygen, the project name (see
1715 < # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1712 > # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1713 > # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1714 > # string, for the replacement values of the other commands the user is referred
1715 > # to HTML_HEADER.
1716   # This tag requires that the tag GENERATE_LATEX is set to YES.
1717  
1718   LATEX_HEADER           =
1719  
1720   # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1721   # generated LaTeX document. The footer should contain everything after the last
1722 < # chapter. If it is left blank doxygen will generate a standard footer.
1722 > # chapter. If it is left blank doxygen will generate a standard footer. See
1723 > # LATEX_HEADER for more information on how to generate a default footer and what
1724 > # special commands can be used inside the footer.
1725   #
1726   # Note: Only use a user-defined footer if you know what you are doing!
1727   # This tag requires that the tag GENERATE_LATEX is set to YES.
1728  
1729   LATEX_FOOTER           =
1730  
1731 + # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1732 + # LaTeX style sheets that are included after the standard style sheets created
1733 + # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1734 + # will copy the style sheet files to the output directory.
1735 + # Note: The order of the extra style sheet files is of importance (e.g. the last
1736 + # style sheet in the list overrules the setting of the previous ones in the
1737 + # list).
1738 + # This tag requires that the tag GENERATE_LATEX is set to YES.
1739 +
1740 + LATEX_EXTRA_STYLESHEET =
1741 +
1742   # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1743   # other source files which should be copied to the LATEX_OUTPUT output
1744   # directory. Note that the files will be copied as-is; there are no commands or
# Line 1673 | Line 1756 | LATEX_EXTRA_FILES      =
1756  
1757   PDF_HYPERLINKS         = NO
1758  
1759 < # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1760 < # the PDF file directly from the LaTeX files. Set this option to YES to get a
1759 > # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1760 > # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1761   # higher quality PDF documentation.
1762   # The default value is: YES.
1763   # This tag requires that the tag GENERATE_LATEX is set to YES.
# Line 1715 | Line 1798 | LATEX_SOURCE_CODE      = NO
1798  
1799   LATEX_BIB_STYLE        = plain
1800  
1801 + # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1802 + # page will contain the date and time when the page was generated. Setting this
1803 + # to NO can help when comparing the output of multiple runs.
1804 + # The default value is: NO.
1805 + # This tag requires that the tag GENERATE_LATEX is set to YES.
1806 +
1807 + LATEX_TIMESTAMP        = NO
1808 +
1809   #---------------------------------------------------------------------------
1810   # Configuration options related to the RTF output
1811   #---------------------------------------------------------------------------
1812  
1813 < # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1813 > # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1814   # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1815   # readers/editors.
1816   # The default value is: NO.
# Line 1734 | Line 1825 | GENERATE_RTF           = NO
1825  
1826   RTF_OUTPUT             = rtf
1827  
1828 < # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1828 > # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1829   # documents. This may be useful for small projects and may help to save some
1830   # trees in general.
1831   # The default value is: NO.
# Line 1771 | Line 1862 | RTF_STYLESHEET_FILE    =
1862  
1863   RTF_EXTENSIONS_FILE    =
1864  
1865 + # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1866 + # with syntax highlighting in the RTF output.
1867 + #
1868 + # Note that which sources are shown also depends on other settings such as
1869 + # SOURCE_BROWSER.
1870 + # The default value is: NO.
1871 + # This tag requires that the tag GENERATE_RTF is set to YES.
1872 +
1873 + RTF_SOURCE_CODE        = NO
1874 +
1875   #---------------------------------------------------------------------------
1876   # Configuration options related to the man page output
1877   #---------------------------------------------------------------------------
1878  
1879 < # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1879 > # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1880   # classes and files.
1881   # The default value is: NO.
1882  
# Line 1799 | Line 1900 | MAN_OUTPUT             = man
1900  
1901   MAN_EXTENSION          = .3
1902  
1903 + # The MAN_SUBDIR tag determines the name of the directory created within
1904 + # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1905 + # MAN_EXTENSION with the initial . removed.
1906 + # This tag requires that the tag GENERATE_MAN is set to YES.
1907 +
1908 + MAN_SUBDIR             =
1909 +
1910   # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1911   # will generate one additional man file for each entity documented in the real
1912   # man page(s). These additional files only source the real man page, but without
# Line 1812 | Line 1920 | MAN_LINKS              = NO
1920   # Configuration options related to the XML output
1921   #---------------------------------------------------------------------------
1922  
1923 < # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1923 > # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1924   # captures the structure of the code including all documentation.
1925   # The default value is: NO.
1926  
# Line 1826 | Line 1934 | GENERATE_XML           = NO
1934  
1935   XML_OUTPUT             = xml
1936  
1937 < # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1830 < # validating XML parser to check the syntax of the XML files.
1831 < # This tag requires that the tag GENERATE_XML is set to YES.
1832 <
1833 < XML_SCHEMA             =
1834 <
1835 < # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1836 < # validating XML parser to check the syntax of the XML files.
1837 < # This tag requires that the tag GENERATE_XML is set to YES.
1838 <
1839 < XML_DTD                =
1840 <
1841 < # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1937 > # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1938   # listings (including syntax highlighting and cross-referencing information) to
1939   # the XML output. Note that enabling this will significantly increase the size
1940   # of the XML output.
# Line 1851 | Line 1947 | XML_PROGRAMLISTING     = YES
1947   # Configuration options related to the DOCBOOK output
1948   #---------------------------------------------------------------------------
1949  
1950 < # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1950 > # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1951   # that can be used to generate PDF.
1952   # The default value is: NO.
1953  
# Line 1865 | Line 1961 | GENERATE_DOCBOOK       = NO
1961  
1962   DOCBOOK_OUTPUT         = docbook
1963  
1964 + # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1965 + # program listings (including syntax highlighting and cross-referencing
1966 + # information) to the DOCBOOK output. Note that enabling this will significantly
1967 + # increase the size of the DOCBOOK output.
1968 + # The default value is: NO.
1969 + # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1970 +
1971 + DOCBOOK_PROGRAMLISTING = NO
1972 +
1973   #---------------------------------------------------------------------------
1974   # Configuration options for the AutoGen Definitions output
1975   #---------------------------------------------------------------------------
1976  
1977 < # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1978 < # Definitions (see http://autogen.sf.net) file that captures the structure of
1979 < # the code including all documentation. Note that this feature is still
1980 < # experimental and incomplete at the moment.
1977 > # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1978 > # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1979 > # structure of the code including all documentation. Note that this feature is
1980 > # still experimental and incomplete at the moment.
1981   # The default value is: NO.
1982  
1983   GENERATE_AUTOGEN_DEF   = NO
# Line 1881 | Line 1986 | GENERATE_AUTOGEN_DEF   = NO
1986   # Configuration options related to the Perl module output
1987   #---------------------------------------------------------------------------
1988  
1989 < # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1989 > # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1990   # file that captures the structure of the code including all documentation.
1991   #
1992   # Note that this feature is still experimental and incomplete at the moment.
# Line 1889 | Line 1994 | GENERATE_AUTOGEN_DEF   = NO
1994  
1995   GENERATE_PERLMOD       = NO
1996  
1997 < # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1997 > # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1998   # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1999   # output from the Perl module output.
2000   # The default value is: NO.
# Line 1897 | Line 2002 | GENERATE_PERLMOD       = NO
2002  
2003   PERLMOD_LATEX          = NO
2004  
2005 < # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
2005 > # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2006   # formatted so it can be parsed by a human reader. This is useful if you want to
2007 < # understand what is going on. On the other hand, if this tag is set to NO the
2007 > # understand what is going on. On the other hand, if this tag is set to NO, the
2008   # size of the Perl module output will be much smaller and Perl will parse it
2009   # just the same.
2010   # The default value is: YES.
# Line 1919 | Line 2024 | PERLMOD_MAKEVAR_PREFIX =
2024   # Configuration options related to the preprocessor
2025   #---------------------------------------------------------------------------
2026  
2027 < # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
2027 > # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2028   # C-preprocessor directives found in the sources and include files.
2029   # The default value is: YES.
2030  
2031   ENABLE_PREPROCESSING   = YES
2032  
2033 < # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
2034 < # in the source code. If set to NO only conditional compilation will be
2033 > # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2034 > # in the source code. If set to NO, only conditional compilation will be
2035   # performed. Macro expansion can be done in a controlled way by setting
2036   # EXPAND_ONLY_PREDEF to YES.
2037   # The default value is: NO.
# Line 1942 | Line 2047 | MACRO_EXPANSION        = NO
2047  
2048   EXPAND_ONLY_PREDEF     = NO
2049  
2050 < # If the SEARCH_INCLUDES tag is set to YES the includes files in the
2050 > # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2051   # INCLUDE_PATH will be searched if a #include is found.
2052   # The default value is: YES.
2053   # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
# Line 1987 | Line 2092 | PREDEFINED             = BREP_SAT \
2092   EXPAND_AS_DEFINED      =
2093  
2094   # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2095 < # remove all refrences to function-like macros that are alone on a line, have an
2096 < # all uppercase name, and do not end with a semicolon. Such function macros are
2097 < # typically used for boiler-plate code, and will confuse the parser if not
2095 > # remove all references to function-like macros that are alone on a line, have
2096 > # an all uppercase name, and do not end with a semicolon. Such function macros
2097 > # are typically used for boiler-plate code, and will confuse the parser if not
2098   # removed.
2099   # The default value is: YES.
2100   # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
# Line 2009 | Line 2114 | SKIP_FUNCTION_MACROS   = NO
2114   # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2115   # section "Linking to external documentation" for more information about the use
2116   # of tag files.
2117 < # Note: Each tag file must have an unique name (where the name does NOT include
2117 > # Note: Each tag file must have a unique name (where the name does NOT include
2118   # the path). If a tag file is not located in the directory in which doxygen is
2119   # run, you must also specify the path to the tagfile here.
2120  
# Line 2021 | Line 2126 | TAGFILES               =
2126  
2127   GENERATE_TAGFILE       =
2128  
2129 < # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2130 < # class index. If set to NO only the inherited external classes will be listed.
2129 > # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2130 > # the class index. If set to NO, only the inherited external classes will be
2131 > # listed.
2132   # The default value is: NO.
2133  
2134   ALLEXTERNALS           = NO
2135  
2136 < # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2137 < # the modules index. If set to NO, only the current project's groups will be
2136 > # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2137 > # in the modules index. If set to NO, only the current project's groups will be
2138   # listed.
2139   # The default value is: YES.
2140  
2141   EXTERNAL_GROUPS        = YES
2142  
2143 < # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2143 > # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2144   # the related pages index. If set to NO, only the current project's pages will
2145   # be listed.
2146   # The default value is: YES.
# Line 2051 | Line 2157 | PERL_PATH              = /usr/bin/perl
2157   # Configuration options related to the dot tool
2158   #---------------------------------------------------------------------------
2159  
2160 < # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2160 > # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2161   # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2162   # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2163   # disabled, but it is recommended to install and use dot, since it yields more
# Line 2076 | Line 2182 | MSCGEN_PATH            =
2182  
2183   DIA_PATH               =
2184  
2185 < # If set to YES, the inheritance and collaboration graphs will hide inheritance
2185 > # If set to YES the inheritance and collaboration graphs will hide inheritance
2186   # and usage relations if the target is undocumented or is not a class.
2187   # The default value is: YES.
2188  
# Line 2087 | Line 2193 | HIDE_UNDOC_RELATIONS   = YES
2193   # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2194   # Bell Labs. The other options in this section have no effect if this option is
2195   # set to NO
2196 < # The default value is: NO.
2196 > # The default value is: YES.
2197  
2198   HAVE_DOT               = YES
2199  
# Line 2101 | Line 2207 | HAVE_DOT               = YES
2207  
2208   DOT_NUM_THREADS        = 0
2209  
2210 < # When you want a differently looking font n the dot files that doxygen
2210 > # When you want a differently looking font in the dot files that doxygen
2211   # generates you can specify the font name using DOT_FONTNAME. You need to make
2212   # sure dot is able to find the font, which can be done by putting it in a
2213   # standard location or by setting the DOTFONTPATH environment variable or by
# Line 2149 | Line 2255 | COLLABORATION_GRAPH    = YES
2255  
2256   GROUP_GRAPHS           = YES
2257  
2258 < # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2258 > # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2259   # collaboration diagrams in a style similar to the OMG's Unified Modeling
2260   # Language.
2261   # The default value is: NO.
# Line 2201 | Line 2307 | INCLUDED_BY_GRAPH      = YES
2307   #
2308   # Note that enabling this option will significantly increase the time of a run.
2309   # So in most cases it will be better to enable call graphs for selected
2310 < # functions only using the \callgraph command.
2310 > # functions only using the \callgraph command. Disabling a call graph can be
2311 > # accomplished by means of the command \hidecallgraph.
2312   # The default value is: NO.
2313   # This tag requires that the tag HAVE_DOT is set to YES.
2314  
# Line 2212 | Line 2319 | CALL_GRAPH             = YES
2319   #
2320   # Note that enabling this option will significantly increase the time of a run.
2321   # So in most cases it will be better to enable caller graphs for selected
2322 < # functions only using the \callergraph command.
2322 > # functions only using the \callergraph command. Disabling a caller graph can be
2323 > # accomplished by means of the command \hidecallergraph.
2324   # The default value is: NO.
2325   # This tag requires that the tag HAVE_DOT is set to YES.
2326  
# Line 2235 | Line 2343 | GRAPHICAL_HIERARCHY    = YES
2343   DIRECTORY_GRAPH        = YES
2344  
2345   # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2346 < # generated by dot.
2346 > # generated by dot. For an explanation of the image formats see the section
2347 > # output formats in the documentation of the dot tool (Graphviz (see:
2348 > # http://www.graphviz.org/)).
2349   # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2350   # to make the SVG files visible in IE 9+ (other browsers do not have this
2351   # requirement).
2352 < # Possible values are: png, jpg, gif and svg.
2352 > # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2353 > # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2354 > # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2355 > # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2356 > # png:gdiplus:gdiplus.
2357   # The default value is: png.
2358   # This tag requires that the tag HAVE_DOT is set to YES.
2359  
# Line 2282 | Line 2396 | MSCFILE_DIRS           =
2396  
2397   DIAFILE_DIRS           =
2398  
2399 + # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2400 + # path where java can find the plantuml.jar file. If left blank, it is assumed
2401 + # PlantUML is not used or called during a preprocessing step. Doxygen will
2402 + # generate a warning when it encounters a \startuml command in this case and
2403 + # will not generate output for the diagram.
2404 +
2405 + PLANTUML_JAR_PATH      =
2406 +
2407 + # When using plantuml, the specified paths are searched for files specified by
2408 + # the !include statement in a plantuml block.
2409 +
2410 + PLANTUML_INCLUDE_PATH  =
2411 +
2412   # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2413   # that will be shown in the graph. If the number of nodes in a graph becomes
2414   # larger than this value, doxygen will truncate the graph, which is visualized
# Line 2318 | Line 2445 | MAX_DOT_GRAPH_DEPTH    = 1000
2445  
2446   DOT_TRANSPARENT        = NO
2447  
2448 < # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2448 > # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2449   # files in one run (i.e. multiple -o and -T options on the command line). This
2450   # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2451   # this, this feature is disabled by default.
# Line 2335 | Line 2462 | DOT_MULTI_TARGETS      = NO
2462  
2463   GENERATE_LEGEND        = YES
2464  
2465 < # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2465 > # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2466   # files that are used to generate the various graphs.
2467   # The default value is: YES.
2468   # This tag requires that the tag HAVE_DOT is set to YES.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines