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 1008 by francois, Mon Mar 25 16:37:35 2019 UTC vs.
Revision 1061 by francois, Thu May 27 18:50:20 2021 UTC

# Line 1 | Line 1
1 < # Doxyfile 1.8.6
1 > # Doxyfile 1.8.13
2  
3   # This file describes the settings to be used by the documentation system
4   # doxygen (www.doxygen.org) for a project.
# Line 46 | Line 46 | PROJECT_NUMBER         = v4
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 292 | Line 303 | EXTENSION_MAPPING      =
303  
304   MARKDOWN_SUPPORT       = YES
305  
306 + # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
307 + # to that level are automatically included in the table of contents, even if
308 + # they do not have an id attribute.
309 + # Note: This feature currently applies only to Markdown headings.
310 + # Minimum value: 0, maximum value: 99, default value: 0.
311 + # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
312 +
313 + TOC_INCLUDE_HEADINGS   = 0
314 +
315   # When enabled doxygen tries to link words that correspond to documented
316   # classes, or namespaces to their corresponding documentation. Such a link can
317 < # be prevented in individual cases by by putting a % sign in front of the word
318 < # or globally by setting AUTOLINK_SUPPORT to NO.
317 > # be prevented in individual cases by putting a % sign in front of the word or
318 > # globally by setting AUTOLINK_SUPPORT to NO.
319   # The default value is: YES.
320  
321   AUTOLINK_SUPPORT       = YES
# Line 335 | Line 355 | SIP_SUPPORT            = NO
355   IDL_PROPERTY_SUPPORT   = YES
356  
357   # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
358 < # tag is set to YES, then doxygen will reuse the documentation of the first
358 > # tag is set to YES then doxygen will reuse the documentation of the first
359   # member in the group (if any) for the other members of the group. By default
360   # all members of a group must be documented explicitly.
361   # The default value is: NO.
362  
363   DISTRIBUTE_GROUP_DOC   = NO
364  
365 + # If one adds a struct or class to a group and this option is enabled, then also
366 + # any nested class or struct is added to the same group. By default this option
367 + # is disabled and one has to add nested compounds explicitly via \ingroup.
368 + # The default value is: NO.
369 +
370 + GROUP_NESTED_COMPOUNDS = NO
371 +
372   # Set the SUBGROUPING tag to YES to allow class member groups of the same type
373   # (for instance a group of public functions) to be put as a subgroup of that
374   # type (e.g. under the Public Functions section). Set it to NO to prevent
# Line 400 | Line 427 | LOOKUP_CACHE_SIZE      = 0
427   # Build related configuration options
428   #---------------------------------------------------------------------------
429  
430 < # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
430 > # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
431   # documentation are documented, even if no documentation was available. Private
432   # class members and static file members will be hidden unless the
433   # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
# Line 410 | Line 437 | LOOKUP_CACHE_SIZE      = 0
437  
438   EXTRACT_ALL            = YES
439  
440 < # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
440 > # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
441   # be included in the documentation.
442   # The default value is: NO.
443  
444   EXTRACT_PRIVATE        = YES
445  
446 < # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
446 > # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
447   # scope will be included in the documentation.
448   # The default value is: NO.
449  
450   EXTRACT_PACKAGE        = NO
451  
452 < # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
452 > # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
453   # included in the documentation.
454   # The default value is: NO.
455  
456   EXTRACT_STATIC         = YES
457  
458 < # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
459 < # locally in source files will be included in the documentation. If set to NO
458 > # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
459 > # locally in source files will be included in the documentation. If set to NO,
460   # only classes defined in header files are included. Does not have any effect
461   # for Java sources.
462   # The default value is: YES.
463  
464   EXTRACT_LOCAL_CLASSES  = YES
465  
466 < # This flag is only useful for Objective-C code. When set to YES local methods,
466 > # This flag is only useful for Objective-C code. If set to YES, local methods,
467   # which are defined in the implementation section but not in the interface are
468 < # included in the documentation. If set to NO only methods in the interface are
468 > # included in the documentation. If set to NO, only methods in the interface are
469   # included.
470   # The default value is: NO.
471  
# Line 463 | Line 490 | HIDE_UNDOC_MEMBERS     = NO
490  
491   # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
492   # undocumented classes that are normally visible in the class hierarchy. If set
493 < # to NO these classes will be included in the various overviews. This option has
494 < # no effect if EXTRACT_ALL is enabled.
493 > # to NO, these classes will be included in the various overviews. This option
494 > # has no effect if EXTRACT_ALL is enabled.
495   # The default value is: NO.
496  
497   HIDE_UNDOC_CLASSES     = NO
498  
499   # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
500 < # (class|struct|union) declarations. If set to NO these declarations will be
500 > # (class|struct|union) declarations. If set to NO, these declarations will be
501   # included in the documentation.
502   # The default value is: NO.
503  
504   HIDE_FRIEND_COMPOUNDS  = NO
505  
506   # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
507 < # documentation blocks found inside the body of a function. If set to NO these
507 > # documentation blocks found inside the body of a function. If set to NO, these
508   # blocks will be appended to the function's detailed documentation block.
509   # The default value is: NO.
510  
# Line 491 | Line 518 | HIDE_IN_BODY_DOCS      = NO
518   INTERNAL_DOCS          = NO
519  
520   # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
521 < # names in lower-case letters. If set to YES upper-case letters are also
521 > # names in lower-case letters. If set to YES, upper-case letters are also
522   # allowed. This is useful if you have classes or files whose names only differ
523   # in case and if your file system supports case sensitive file names. Windows
524   # and Mac users are advised to set this option to NO.
# Line 500 | Line 527 | INTERNAL_DOCS          = NO
527   CASE_SENSE_NAMES       = NO
528  
529   # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
530 < # their full class and namespace scopes in the documentation. If set to YES the
530 > # their full class and namespace scopes in the documentation. If set to YES, the
531   # scope will be hidden.
532   # The default value is: NO.
533  
534   HIDE_SCOPE_NAMES       = NO
535  
536 + # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
537 + # append additional text to a page's title, such as Class Reference. If set to
538 + # YES the compound reference will be hidden.
539 + # The default value is: NO.
540 +
541 + HIDE_COMPOUND_REFERENCE= NO
542 +
543   # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
544   # the files that are included by a file in the documentation of that file.
545   # The default value is: YES.
# Line 533 | Line 567 | INLINE_INFO            = YES
567  
568   # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
569   # (detailed) documentation of file and class members alphabetically by member
570 < # name. If set to NO the members will appear in declaration order.
570 > # name. If set to NO, the members will appear in declaration order.
571   # The default value is: YES.
572  
573   SORT_MEMBER_DOCS       = YES
574  
575   # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
576   # descriptions of file, namespace and class members alphabetically by member
577 < # name. If set to NO the members will appear in declaration order. Note that
577 > # name. If set to NO, the members will appear in declaration order. Note that
578   # this will also influence the order of the classes in the class list.
579   # The default value is: NO.
580  
# Line 585 | Line 619 | SORT_BY_SCOPE_NAME     = NO
619  
620   STRICT_PROTO_MATCHING  = NO
621  
622 < # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
623 < # todo list. This list is created by putting \todo commands in the
590 < # documentation.
622 > # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
623 > # list. This list is created by putting \todo commands in the documentation.
624   # The default value is: YES.
625  
626   GENERATE_TODOLIST      = YES
627  
628 < # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
629 < # test list. This list is created by putting \test commands in the
597 < # documentation.
628 > # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
629 > # list. This list is created by putting \test commands in the documentation.
630   # The default value is: YES.
631  
632   GENERATE_TESTLIST      = YES
633  
634 < # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
634 > # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
635   # list. This list is created by putting \bug commands in the documentation.
636   # The default value is: YES.
637  
638   GENERATE_BUGLIST       = YES
639  
640 < # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
640 > # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
641   # the deprecated list. This list is created by putting \deprecated commands in
642   # the documentation.
643   # The default value is: YES.
# Line 630 | Line 662 | ENABLED_SECTIONS       =
662   MAX_INITIALIZER_LINES  = 30
663  
664   # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
665 < # the bottom of the documentation of classes and structs. If set to YES the list
666 < # will mention the files that were used to generate the documentation.
665 > # the bottom of the documentation of classes and structs. If set to YES, the
666 > # list will mention the files that were used to generate the documentation.
667   # The default value is: YES.
668  
669   SHOW_USED_FILES        = YES
# Line 679 | Line 711 | LAYOUT_FILE            =
711   # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
712   # For LaTeX the style of the bibliography can be controlled using
713   # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
714 < # search path. Do not use file names with spaces, bibtex cannot handle them. See
683 < # also \cite for info how to create references.
714 > # search path. See also \cite for info how to create references.
715  
716   CITE_BIB_FILES         =
717  
# Line 696 | Line 727 | CITE_BIB_FILES         =
727   QUIET                  = NO
728  
729   # The WARNINGS tag can be used to turn on/off the warning messages that are
730 < # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
730 > # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
731   # this implies that the warnings are on.
732   #
733   # Tip: Turn warnings on while writing the documentation.
# Line 704 | Line 735 | QUIET                  = NO
735  
736   WARNINGS               = YES
737  
738 < # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
738 > # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
739   # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
740   # will automatically be disabled.
741   # The default value is: YES.
# Line 721 | Line 752 | WARN_IF_DOC_ERROR      = YES
752  
753   # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
754   # are documented, but have no documentation for their parameters or return
755 < # value. If set to NO doxygen will only warn about wrong or incomplete parameter
756 < # documentation, but not about the absence of documentation.
755 > # value. If set to NO, doxygen will only warn about wrong or incomplete
756 > # parameter documentation, but not about the absence of documentation.
757   # The default value is: NO.
758  
759   WARN_NO_PARAMDOC       = NO
760  
761 + # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
762 + # a warning is encountered.
763 + # The default value is: NO.
764 +
765 + WARN_AS_ERROR          = NO
766 +
767   # The WARN_FORMAT tag determines the format of the warning messages that doxygen
768   # can produce. The string should contain the $file, $line, and $text tags, which
769   # will be replaced by the file and line number from which the warning originated
# Line 750 | Line 787 | WARN_LOGFILE           =
787   # The INPUT tag is used to specify the files and/or directories that contain
788   # documented source files. You may enter file names like myfile.cpp or
789   # directories like /usr/src/myproject. Separate the files or directories with
790 < # spaces.
790 > # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
791   # Note: If this tag is empty the current directory is searched.
792  
793   INPUT                  = ../lib \
794 <                         ../app/magic_application/src/aide.h
794 >                         ../app/magic_application/src/aide.h \
795 >                         ../addin
796  
797   # This tag can be used to specify the character encoding of the source files
798   # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# Line 767 | Line 805 | INPUT_ENCODING         = UTF-8
805  
806   # If the value of the INPUT tag contains directories, you can use the
807   # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
808 < # *.h) to filter out the source-files in the directories. If left blank the
809 < # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
810 < # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
811 < # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
812 < # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
813 < # *.qsf, *.as and *.js.
808 > # *.h) to filter out the source-files in the directories.
809 > #
810 > # Note that for custom extensions or not directly supported extensions you also
811 > # need to set EXTENSION_MAPPING for the extension otherwise the files are not
812 > # read by doxygen.
813 > #
814 > # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
815 > # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
816 > # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
817 > # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
818 > # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
819  
820   FILE_PATTERNS          = *.c \
821                           *.cc \
# Line 815 | Line 858 | RECURSIVE              = YES
858  
859   EXCLUDE                = ../lib/OCC_Fonction \
860                           ../lib/geometrie/Imports \
861 <                         ../lib/diamesh
861 >                         ../lib/diamesh \
862 >                         ../addin/poly_occ/voro++-0.4.6
863  
864   # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
865   # directories that are symbolic links (a Unix file system feature) are excluded
# Line 884 | Line 928 | IMAGE_PATH             =
928   # Note that the filter must not add or remove lines; it is applied before the
929   # code is scanned, but not when the output code is generated. If lines are added
930   # or removed, the anchors will not be placed correctly.
931 + #
932 + # Note that for custom extensions or not directly supported extensions you also
933 + # need to set EXTENSION_MAPPING for the extension otherwise the files are not
934 + # properly processed by doxygen.
935  
936   INPUT_FILTER           =
937  
# Line 893 | Line 941 | INPUT_FILTER           =
941   # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
942   # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
943   # patterns match the file name, INPUT_FILTER is applied.
944 + #
945 + # Note that for custom extensions or not directly supported extensions you also
946 + # need to set EXTENSION_MAPPING for the extension otherwise the files are not
947 + # properly processed by doxygen.
948  
949   FILTER_PATTERNS        =
950  
951   # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
952 < # INPUT_FILTER ) will also be used to filter the input files that are used for
952 > # INPUT_FILTER) will also be used to filter the input files that are used for
953   # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
954   # The default value is: NO.
955  
# Line 957 | Line 1009 | REFERENCED_BY_RELATION = YES
1009   REFERENCES_RELATION    = YES
1010  
1011   # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1012 < # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
1012 > # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1013   # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1014   # link to the documentation.
1015   # The default value is: YES.
# Line 1004 | Line 1056 | USE_HTAGS              = NO
1056  
1057   VERBATIM_HEADERS       = YES
1058  
1059 + # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1060 + # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1061 + # cost of reduced performance. This can be particularly helpful with template
1062 + # rich C++ code for which doxygen's built-in parser lacks the necessary type
1063 + # information.
1064 + # Note: The availability of this option depends on whether or not doxygen was
1065 + # generated with the -Duse-libclang=ON option for CMake.
1066 + # The default value is: NO.
1067 +
1068 + CLANG_ASSISTED_PARSING = NO
1069 +
1070 + # If clang assisted parsing is enabled you can provide the compiler with command
1071 + # line options that you would normally use when invoking the compiler. Note that
1072 + # the include paths will already be set by doxygen for the files and directories
1073 + # specified with INPUT and INCLUDE_PATH.
1074 + # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1075 +
1076 + CLANG_OPTIONS          =
1077 +
1078   #---------------------------------------------------------------------------
1079   # Configuration options related to the alphabetical class index
1080   #---------------------------------------------------------------------------
# Line 1034 | Line 1105 | IGNORE_PREFIX          =
1105   # Configuration options related to the HTML output
1106   #---------------------------------------------------------------------------
1107  
1108 < # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1108 > # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1109   # The default value is: YES.
1110  
1111   GENERATE_HTML          = YES
# Line 1096 | Line 1167 | HTML_FOOTER            =
1167  
1168   HTML_STYLESHEET        =
1169  
1170 < # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1171 < # defined cascading style sheet that is included after the standard style sheets
1170 > # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1171 > # cascading style sheets that are included after the standard style sheets
1172   # created by doxygen. Using this option one can overrule certain style aspects.
1173   # This is preferred over using HTML_STYLESHEET since it does not replace the
1174 < # standard style sheet and is therefor more robust against future updates.
1175 < # Doxygen will copy the style sheet file to the output directory. For an example
1176 < # see the documentation.
1174 > # standard style sheet and is therefore more robust against future updates.
1175 > # Doxygen will copy the style sheet files to the output directory.
1176 > # Note: The order of the extra style sheet files is of importance (e.g. the last
1177 > # style sheet in the list overrules the setting of the previous ones in the
1178 > # list). For an example see the documentation.
1179   # This tag requires that the tag GENERATE_HTML is set to YES.
1180  
1181   HTML_EXTRA_STYLESHEET  =
# Line 1118 | Line 1191 | HTML_EXTRA_STYLESHEET  =
1191   HTML_EXTRA_FILES       =
1192  
1193   # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1194 < # will adjust the colors in the stylesheet and background images according to
1194 > # will adjust the colors in the style sheet and background images according to
1195   # this color. Hue is specified as an angle on a colorwheel, see
1196   # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1197   # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
# Line 1149 | Line 1222 | HTML_COLORSTYLE_GAMMA  = 84
1222  
1223   # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1224   # page will contain the date and time when the page was generated. Setting this
1225 < # to NO can help when comparing the output of multiple runs.
1226 < # The default value is: YES.
1225 > # to YES can help to show when doxygen was last run and thus if the
1226 > # documentation is up to date.
1227 > # The default value is: NO.
1228   # This tag requires that the tag GENERATE_HTML is set to YES.
1229  
1230   HTML_TIMESTAMP         = YES
# Line 1246 | Line 1320 | GENERATE_HTMLHELP      = NO
1320   CHM_FILE               =
1321  
1322   # The HHC_LOCATION tag can be used to specify the location (absolute path
1323 < # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1323 > # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1324   # doxygen will try to run the HTML help compiler on the generated index.hhp.
1325   # The file has to be specified with full path.
1326   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1327  
1328   HHC_LOCATION           =
1329  
1330 < # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1331 < # YES) or that it should be included in the master .chm file ( NO).
1330 > # The GENERATE_CHI flag controls if a separate .chi index file is generated
1331 > # (YES) or that it should be included in the master .chm file (NO).
1332   # The default value is: NO.
1333   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1334  
1335   GENERATE_CHI           = NO
1336  
1337 < # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1337 > # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1338   # and project file content.
1339   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1340  
1341   CHM_INDEX_ENCODING     =
1342  
1343 < # The BINARY_TOC flag controls whether a binary table of contents is generated (
1344 < # YES) or a normal table of contents ( NO) in the .chm file.
1343 > # The BINARY_TOC flag controls whether a binary table of contents is generated
1344 > # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1345 > # enables the Previous and Next buttons.
1346   # The default value is: NO.
1347   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1348  
# Line 1380 | Line 1455 | DISABLE_INDEX          = NO
1455   # index structure (just like the one that is generated for HTML Help). For this
1456   # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1457   # (i.e. any modern browser). Windows users are probably better off using the
1458 < # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1458 > # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1459   # further fine-tune the look of the index. As an example, the default style
1460   # sheet generated by doxygen has an example that shows how to put an image at
1461   # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
# Line 1408 | Line 1483 | ENUM_VALUES_PER_LINE   = 1
1483  
1484   TREEVIEW_WIDTH         = 250
1485  
1486 < # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1486 > # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1487   # external symbols imported via tag files in a separate window.
1488   # The default value is: NO.
1489   # This tag requires that the tag GENERATE_HTML is set to YES.
# Line 1437 | Line 1512 | FORMULA_TRANSPARENT    = YES
1512  
1513   # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1514   # http://www.mathjax.org) which uses client side Javascript for the rendering
1515 < # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1515 > # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1516   # installed or if you want to formulas look prettier in the HTML output. When
1517   # enabled you may also need to install MathJax separately and configure the path
1518   # to it using the MATHJAX_RELPATH option.
# Line 1507 | Line 1582 | SEARCHENGINE           = YES
1582  
1583   # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1584   # implemented using a web server instead of a web client using Javascript. There
1585 < # are two flavours of web server based searching depending on the
1586 < # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1587 < # searching and an index file used by the script. When EXTERNAL_SEARCH is
1588 < # enabled the indexing and searching needs to be provided by external tools. See
1589 < # the section "External Indexing and Searching" for details.
1585 > # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1586 > # setting. When disabled, doxygen will generate a PHP script for searching and
1587 > # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1588 > # and searching needs to be provided by external tools. See the section
1589 > # "External Indexing and Searching" for details.
1590   # The default value is: NO.
1591   # This tag requires that the tag SEARCHENGINE is set to YES.
1592  
# Line 1523 | Line 1598 | SERVER_BASED_SEARCH    = NO
1598   # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1599   # search results.
1600   #
1601 < # Doxygen ships with an example indexer ( doxyindexer) and search engine
1601 > # Doxygen ships with an example indexer (doxyindexer) and search engine
1602   # (doxysearch.cgi) which are based on the open source search engine library
1603   # Xapian (see: http://xapian.org/).
1604   #
# Line 1536 | Line 1611 | EXTERNAL_SEARCH        = NO
1611   # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1612   # which will return the search results when EXTERNAL_SEARCH is enabled.
1613   #
1614 < # Doxygen ships with an example indexer ( doxyindexer) and search engine
1614 > # Doxygen ships with an example indexer (doxyindexer) and search engine
1615   # (doxysearch.cgi) which are based on the open source search engine library
1616   # Xapian (see: http://xapian.org/). See the section "External Indexing and
1617   # Searching" for details.
# Line 1574 | Line 1649 | EXTRA_SEARCH_MAPPINGS  =
1649   # Configuration options related to the LaTeX output
1650   #---------------------------------------------------------------------------
1651  
1652 < # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1652 > # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1653   # The default value is: YES.
1654  
1655   GENERATE_LATEX         = NO
# Line 1605 | Line 1680 | LATEX_CMD_NAME         = latex
1680  
1681   MAKEINDEX_CMD_NAME     = makeindex
1682  
1683 < # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1683 > # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1684   # documents. This may be useful for small projects and may help to save some
1685   # trees in general.
1686   # The default value is: NO.
# Line 1623 | Line 1698 | COMPACT_LATEX          = NO
1698   PAPER_TYPE             = a4wide
1699  
1700   # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1701 < # that should be included in the LaTeX output. To get the times font for
1702 < # instance you can specify
1703 < # EXTRA_PACKAGES=times
1701 > # that should be included in the LaTeX output. The package can be specified just
1702 > # by its name or with the correct syntax as to be used with the LaTeX
1703 > # \usepackage command. To get the times font for instance you can specify :
1704 > # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1705 > # To use the option intlimits with the amsmath package you can specify:
1706 > # EXTRA_PACKAGES=[intlimits]{amsmath}
1707   # If left blank no extra packages will be included.
1708   # This tag requires that the tag GENERATE_LATEX is set to YES.
1709  
# Line 1639 | Line 1717 | EXTRA_PACKAGES         =
1717   #
1718   # Note: Only use a user-defined header if you know what you are doing! The
1719   # following commands have a special meaning inside the header: $title,
1720 < # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1721 < # replace them by respectively the title of the page, the current date and time,
1722 < # only the current date, the version number of doxygen, the project name (see
1723 < # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1720 > # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1721 > # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1722 > # string, for the replacement values of the other commands the user is referred
1723 > # to HTML_HEADER.
1724   # This tag requires that the tag GENERATE_LATEX is set to YES.
1725  
1726   LATEX_HEADER           =
1727  
1728   # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1729   # generated LaTeX document. The footer should contain everything after the last
1730 < # chapter. If it is left blank doxygen will generate a standard footer.
1730 > # chapter. If it is left blank doxygen will generate a standard footer. See
1731 > # LATEX_HEADER for more information on how to generate a default footer and what
1732 > # special commands can be used inside the footer.
1733   #
1734   # Note: Only use a user-defined footer if you know what you are doing!
1735   # This tag requires that the tag GENERATE_LATEX is set to YES.
1736  
1737   LATEX_FOOTER           =
1738  
1739 + # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1740 + # LaTeX style sheets that are included after the standard style sheets created
1741 + # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1742 + # will copy the style sheet files to the output directory.
1743 + # Note: The order of the extra style sheet files is of importance (e.g. the last
1744 + # style sheet in the list overrules the setting of the previous ones in the
1745 + # list).
1746 + # This tag requires that the tag GENERATE_LATEX is set to YES.
1747 +
1748 + LATEX_EXTRA_STYLESHEET =
1749 +
1750   # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1751   # other source files which should be copied to the LATEX_OUTPUT output
1752   # directory. Note that the files will be copied as-is; there are no commands or
# Line 1673 | Line 1764 | LATEX_EXTRA_FILES      =
1764  
1765   PDF_HYPERLINKS         = NO
1766  
1767 < # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1768 < # the PDF file directly from the LaTeX files. Set this option to YES to get a
1767 > # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1768 > # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1769   # higher quality PDF documentation.
1770   # The default value is: YES.
1771   # This tag requires that the tag GENERATE_LATEX is set to YES.
# Line 1715 | Line 1806 | LATEX_SOURCE_CODE      = NO
1806  
1807   LATEX_BIB_STYLE        = plain
1808  
1809 + # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1810 + # page will contain the date and time when the page was generated. Setting this
1811 + # to NO can help when comparing the output of multiple runs.
1812 + # The default value is: NO.
1813 + # This tag requires that the tag GENERATE_LATEX is set to YES.
1814 +
1815 + LATEX_TIMESTAMP        = NO
1816 +
1817   #---------------------------------------------------------------------------
1818   # Configuration options related to the RTF output
1819   #---------------------------------------------------------------------------
1820  
1821 < # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1821 > # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1822   # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1823   # readers/editors.
1824   # The default value is: NO.
# Line 1734 | Line 1833 | GENERATE_RTF           = NO
1833  
1834   RTF_OUTPUT             = rtf
1835  
1836 < # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1836 > # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1837   # documents. This may be useful for small projects and may help to save some
1838   # trees in general.
1839   # The default value is: NO.
# Line 1771 | Line 1870 | RTF_STYLESHEET_FILE    =
1870  
1871   RTF_EXTENSIONS_FILE    =
1872  
1873 + # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1874 + # with syntax highlighting in the RTF output.
1875 + #
1876 + # Note that which sources are shown also depends on other settings such as
1877 + # SOURCE_BROWSER.
1878 + # The default value is: NO.
1879 + # This tag requires that the tag GENERATE_RTF is set to YES.
1880 +
1881 + RTF_SOURCE_CODE        = NO
1882 +
1883   #---------------------------------------------------------------------------
1884   # Configuration options related to the man page output
1885   #---------------------------------------------------------------------------
1886  
1887 < # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1887 > # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1888   # classes and files.
1889   # The default value is: NO.
1890  
# Line 1799 | Line 1908 | MAN_OUTPUT             = man
1908  
1909   MAN_EXTENSION          = .3
1910  
1911 + # The MAN_SUBDIR tag determines the name of the directory created within
1912 + # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1913 + # MAN_EXTENSION with the initial . removed.
1914 + # This tag requires that the tag GENERATE_MAN is set to YES.
1915 +
1916 + MAN_SUBDIR             =
1917 +
1918   # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1919   # will generate one additional man file for each entity documented in the real
1920   # man page(s). These additional files only source the real man page, but without
# Line 1812 | Line 1928 | MAN_LINKS              = NO
1928   # Configuration options related to the XML output
1929   #---------------------------------------------------------------------------
1930  
1931 < # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1931 > # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1932   # captures the structure of the code including all documentation.
1933   # The default value is: NO.
1934  
# Line 1826 | Line 1942 | GENERATE_XML           = NO
1942  
1943   XML_OUTPUT             = xml
1944  
1945 < # 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
1945 > # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1946   # listings (including syntax highlighting and cross-referencing information) to
1947   # the XML output. Note that enabling this will significantly increase the size
1948   # of the XML output.
# Line 1851 | Line 1955 | XML_PROGRAMLISTING     = YES
1955   # Configuration options related to the DOCBOOK output
1956   #---------------------------------------------------------------------------
1957  
1958 < # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1958 > # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1959   # that can be used to generate PDF.
1960   # The default value is: NO.
1961  
# Line 1865 | Line 1969 | GENERATE_DOCBOOK       = NO
1969  
1970   DOCBOOK_OUTPUT         = docbook
1971  
1972 + # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1973 + # program listings (including syntax highlighting and cross-referencing
1974 + # information) to the DOCBOOK output. Note that enabling this will significantly
1975 + # increase the size of the DOCBOOK output.
1976 + # The default value is: NO.
1977 + # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1978 +
1979 + DOCBOOK_PROGRAMLISTING = NO
1980 +
1981   #---------------------------------------------------------------------------
1982   # Configuration options for the AutoGen Definitions output
1983   #---------------------------------------------------------------------------
1984  
1985 < # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1986 < # Definitions (see http://autogen.sf.net) file that captures the structure of
1987 < # the code including all documentation. Note that this feature is still
1988 < # experimental and incomplete at the moment.
1985 > # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1986 > # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1987 > # structure of the code including all documentation. Note that this feature is
1988 > # still experimental and incomplete at the moment.
1989   # The default value is: NO.
1990  
1991   GENERATE_AUTOGEN_DEF   = NO
# Line 1881 | Line 1994 | GENERATE_AUTOGEN_DEF   = NO
1994   # Configuration options related to the Perl module output
1995   #---------------------------------------------------------------------------
1996  
1997 < # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1997 > # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1998   # file that captures the structure of the code including all documentation.
1999   #
2000   # Note that this feature is still experimental and incomplete at the moment.
# Line 1889 | Line 2002 | GENERATE_AUTOGEN_DEF   = NO
2002  
2003   GENERATE_PERLMOD       = NO
2004  
2005 < # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
2005 > # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2006   # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2007   # output from the Perl module output.
2008   # The default value is: NO.
# Line 1897 | Line 2010 | GENERATE_PERLMOD       = NO
2010  
2011   PERLMOD_LATEX          = NO
2012  
2013 < # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
2013 > # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2014   # formatted so it can be parsed by a human reader. This is useful if you want to
2015 < # understand what is going on. On the other hand, if this tag is set to NO the
2015 > # understand what is going on. On the other hand, if this tag is set to NO, the
2016   # size of the Perl module output will be much smaller and Perl will parse it
2017   # just the same.
2018   # The default value is: YES.
# Line 1919 | Line 2032 | PERLMOD_MAKEVAR_PREFIX =
2032   # Configuration options related to the preprocessor
2033   #---------------------------------------------------------------------------
2034  
2035 < # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
2035 > # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2036   # C-preprocessor directives found in the sources and include files.
2037   # The default value is: YES.
2038  
2039   ENABLE_PREPROCESSING   = YES
2040  
2041 < # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
2042 < # in the source code. If set to NO only conditional compilation will be
2041 > # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2042 > # in the source code. If set to NO, only conditional compilation will be
2043   # performed. Macro expansion can be done in a controlled way by setting
2044   # EXPAND_ONLY_PREDEF to YES.
2045   # The default value is: NO.
# Line 1942 | Line 2055 | MACRO_EXPANSION        = NO
2055  
2056   EXPAND_ONLY_PREDEF     = NO
2057  
2058 < # If the SEARCH_INCLUDES tag is set to YES the includes files in the
2058 > # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2059   # INCLUDE_PATH will be searched if a #include is found.
2060   # The default value is: YES.
2061   # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
# Line 1987 | Line 2100 | PREDEFINED             = BREP_SAT \
2100   EXPAND_AS_DEFINED      =
2101  
2102   # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2103 < # remove all refrences to function-like macros that are alone on a line, have an
2104 < # all uppercase name, and do not end with a semicolon. Such function macros are
2105 < # typically used for boiler-plate code, and will confuse the parser if not
2103 > # remove all references to function-like macros that are alone on a line, have
2104 > # an all uppercase name, and do not end with a semicolon. Such function macros
2105 > # are typically used for boiler-plate code, and will confuse the parser if not
2106   # removed.
2107   # The default value is: YES.
2108   # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
# Line 2009 | Line 2122 | SKIP_FUNCTION_MACROS   = NO
2122   # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2123   # section "Linking to external documentation" for more information about the use
2124   # of tag files.
2125 < # Note: Each tag file must have an unique name (where the name does NOT include
2125 > # Note: Each tag file must have a unique name (where the name does NOT include
2126   # the path). If a tag file is not located in the directory in which doxygen is
2127   # run, you must also specify the path to the tagfile here.
2128  
# Line 2021 | Line 2134 | TAGFILES               =
2134  
2135   GENERATE_TAGFILE       =
2136  
2137 < # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2138 < # class index. If set to NO only the inherited external classes will be listed.
2137 > # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2138 > # the class index. If set to NO, only the inherited external classes will be
2139 > # listed.
2140   # The default value is: NO.
2141  
2142   ALLEXTERNALS           = NO
2143  
2144 < # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2145 < # the modules index. If set to NO, only the current project's groups will be
2144 > # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2145 > # in the modules index. If set to NO, only the current project's groups will be
2146   # listed.
2147   # The default value is: YES.
2148  
2149   EXTERNAL_GROUPS        = YES
2150  
2151 < # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2151 > # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2152   # the related pages index. If set to NO, only the current project's pages will
2153   # be listed.
2154   # The default value is: YES.
# Line 2051 | Line 2165 | PERL_PATH              = /usr/bin/perl
2165   # Configuration options related to the dot tool
2166   #---------------------------------------------------------------------------
2167  
2168 < # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2168 > # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2169   # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2170   # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2171   # disabled, but it is recommended to install and use dot, since it yields more
2172   # powerful graphs.
2173   # The default value is: YES.
2174  
2175 < CLASS_DIAGRAMS         = NO
2175 > CLASS_DIAGRAMS         = YES
2176  
2177   # You can define message sequence charts within doxygen comments using the \msc
2178   # command. Doxygen will then run the mscgen tool (see:
# Line 2076 | Line 2190 | MSCGEN_PATH            =
2190  
2191   DIA_PATH               =
2192  
2193 < # If set to YES, the inheritance and collaboration graphs will hide inheritance
2193 > # If set to YES the inheritance and collaboration graphs will hide inheritance
2194   # and usage relations if the target is undocumented or is not a class.
2195   # The default value is: YES.
2196  
# Line 2087 | Line 2201 | HIDE_UNDOC_RELATIONS   = YES
2201   # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2202   # Bell Labs. The other options in this section have no effect if this option is
2203   # set to NO
2204 < # The default value is: NO.
2204 > # The default value is: YES.
2205  
2206   HAVE_DOT               = YES
2207  
# Line 2101 | Line 2215 | HAVE_DOT               = YES
2215  
2216   DOT_NUM_THREADS        = 0
2217  
2218 < # When you want a differently looking font n the dot files that doxygen
2218 > # When you want a differently looking font in the dot files that doxygen
2219   # generates you can specify the font name using DOT_FONTNAME. You need to make
2220   # sure dot is able to find the font, which can be done by putting it in a
2221   # standard location or by setting the DOTFONTPATH environment variable or by
# Line 2149 | Line 2263 | COLLABORATION_GRAPH    = YES
2263  
2264   GROUP_GRAPHS           = YES
2265  
2266 < # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2266 > # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2267   # collaboration diagrams in a style similar to the OMG's Unified Modeling
2268   # Language.
2269   # The default value is: NO.
# Line 2201 | Line 2315 | INCLUDED_BY_GRAPH      = YES
2315   #
2316   # Note that enabling this option will significantly increase the time of a run.
2317   # So in most cases it will be better to enable call graphs for selected
2318 < # functions only using the \callgraph command.
2318 > # functions only using the \callgraph command. Disabling a call graph can be
2319 > # accomplished by means of the command \hidecallgraph.
2320   # The default value is: NO.
2321   # This tag requires that the tag HAVE_DOT is set to YES.
2322  
# Line 2212 | Line 2327 | CALL_GRAPH             = YES
2327   #
2328   # Note that enabling this option will significantly increase the time of a run.
2329   # So in most cases it will be better to enable caller graphs for selected
2330 < # functions only using the \callergraph command.
2330 > # functions only using the \callergraph command. Disabling a caller graph can be
2331 > # accomplished by means of the command \hidecallergraph.
2332   # The default value is: NO.
2333   # This tag requires that the tag HAVE_DOT is set to YES.
2334  
# Line 2235 | Line 2351 | GRAPHICAL_HIERARCHY    = YES
2351   DIRECTORY_GRAPH        = YES
2352  
2353   # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2354 < # generated by dot.
2354 > # generated by dot. For an explanation of the image formats see the section
2355 > # output formats in the documentation of the dot tool (Graphviz (see:
2356 > # http://www.graphviz.org/)).
2357   # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2358   # to make the SVG files visible in IE 9+ (other browsers do not have this
2359   # requirement).
2360 < # Possible values are: png, jpg, gif and svg.
2360 > # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2361 > # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2362 > # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2363 > # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2364 > # png:gdiplus:gdiplus.
2365   # The default value is: png.
2366   # This tag requires that the tag HAVE_DOT is set to YES.
2367  
# Line 2282 | Line 2404 | MSCFILE_DIRS           =
2404  
2405   DIAFILE_DIRS           =
2406  
2407 + # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2408 + # path where java can find the plantuml.jar file. If left blank, it is assumed
2409 + # PlantUML is not used or called during a preprocessing step. Doxygen will
2410 + # generate a warning when it encounters a \startuml command in this case and
2411 + # will not generate output for the diagram.
2412 +
2413 + PLANTUML_JAR_PATH      =
2414 +
2415 + # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2416 + # configuration file for plantuml.
2417 +
2418 + PLANTUML_CFG_FILE      =
2419 +
2420 + # When using plantuml, the specified paths are searched for files specified by
2421 + # the !include statement in a plantuml block.
2422 +
2423 + PLANTUML_INCLUDE_PATH  =
2424 +
2425   # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2426   # that will be shown in the graph. If the number of nodes in a graph becomes
2427   # larger than this value, doxygen will truncate the graph, which is visualized
# Line 2292 | Line 2432 | DIAFILE_DIRS           =
2432   # Minimum value: 0, maximum value: 10000, default value: 50.
2433   # This tag requires that the tag HAVE_DOT is set to YES.
2434  
2435 < DOT_GRAPH_MAX_NODES    = 50
2435 > DOT_GRAPH_MAX_NODES    = 500
2436  
2437   # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2438   # generated by dot. A depth value of 3 means that only nodes reachable from the
# Line 2318 | Line 2458 | MAX_DOT_GRAPH_DEPTH    = 1000
2458  
2459   DOT_TRANSPARENT        = NO
2460  
2461 < # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2461 > # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2462   # files in one run (i.e. multiple -o and -T options on the command line). This
2463   # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2464   # this, this feature is disabled by default.
# Line 2335 | Line 2475 | DOT_MULTI_TARGETS      = NO
2475  
2476   GENERATE_LEGEND        = YES
2477  
2478 < # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2478 > # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2479   # files that are used to generate the various graphs.
2480   # The default value is: YES.
2481   # This tag requires that the tag HAVE_DOT is set to YES.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines