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 284 by francois, Thu Sep 15 20:50:01 2011 UTC vs.
Revision 357 by francois, Wed Aug 15 19:33:45 2012 UTC

# Line 1 | Line 1
1 < # Doxyfile 1.6.3
1 > # Doxyfile 1.7.6.1
2  
3   # This file describes the settings to be used by the documentation system
4   # doxygen (www.doxygen.org) for a project
# Line 22 | Line 22
22  
23   DOXYFILE_ENCODING      = UTF-8
24  
25 < # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 < # by quotes) that should identify the project.
25 > # The PROJECT_NAME tag is a single word (or sequence of words) that should
26 > # identify the project. Note that if you do not use Doxywizard you need
27 > # to put quotes around the project name if it contains spaces.
28  
29   PROJECT_NAME           = MAGiC
30  
# Line 31 | Line 32 | PROJECT_NAME           = MAGiC
32   # This could be handy for archiving the generated documentation or
33   # if some version control system is used.
34  
35 < PROJECT_NUMBER         = 2011
35 > PROJECT_NUMBER         = 2012
36 >
37 > # Using the PROJECT_BRIEF tag one can provide an optional one line description
38 > # for a project that appears at the top of each page and should give viewer
39 > # a quick idea about the purpose of the project. Keep the description short.
40 >
41 > PROJECT_BRIEF          =
42 >
43 > # With the PROJECT_LOGO tag one can specify an logo or icon that is
44 > # included in the documentation. The maximum height of the logo should not
45 > # exceed 55 pixels and the maximum width should not exceed 200 pixels.
46 > # Doxygen will copy the logo to the output directory.
47 >
48 > PROJECT_LOGO           =
49  
50   # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51   # base path where the generated documentation will be put.
# Line 57 | Line 71 | CREATE_SUBDIRS         = YES
71   # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72   # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73   # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74 < # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
74 > # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75   # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76  
77   OUTPUT_LANGUAGE        = French
# Line 136 | Line 150 | STRIP_FROM_PATH        = "C:/Documents a
150   STRIP_FROM_INC_PATH    =
151  
152   # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
153 < # (but less readable) file names. This can be useful is your file systems
153 > # (but less readable) file names. This can be useful if your file system
154   # doesn't support long names like on DOS, Mac, or CD-ROM.
155  
156   SHORT_NAMES            = NO
# Line 191 | Line 205 | TAB_SIZE               = 8
205  
206   ALIASES                =
207  
208 + # This tag can be used to specify a number of word-keyword mappings (TCL only).
209 + # A mapping has the form "name=value". For example adding
210 + # "class=itcl::class" will allow you to use the command class in the
211 + # itcl::class meaning.
212 +
213 + TCL_SUBST              =
214 +
215   # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
216   # sources only. Doxygen will then generate output that is more tailored for C.
217   # For instance, some of the names that are used will be different. The list
# Line 217 | Line 238 | OPTIMIZE_FOR_FORTRAN   = NO
238  
239   OPTIMIZE_OUTPUT_VHDL   = NO
240  
241 < # Doxygen selects the parser to use depending on the extension of the files it parses.
242 < # With this tag you can assign which parser to use for a given extension.
243 < # Doxygen has a built-in mapping, but you can override or extend it using this tag.
244 < # The format is ext=language, where ext is a file extension, and language is one of
245 < # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
246 < # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
247 < # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
248 < # use: inc=Fortran f=C. Note that for custom extensions you also need to set
249 < # FILE_PATTERNS otherwise the files are not read by doxygen.
241 > # Doxygen selects the parser to use depending on the extension of the files it
242 > # parses. With this tag you can assign which parser to use for a given extension.
243 > # Doxygen has a built-in mapping, but you can override or extend it using this
244 > # tag. The format is ext=language, where ext is a file extension, and language
245 > # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
246 > # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
247 > # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
248 > # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
249 > # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
250  
251   EXTENSION_MAPPING      =
252  
# Line 233 | Line 254 | EXTENSION_MAPPING      =
254   # to include (a tag file for) the STL sources as input, then you should
255   # set this tag to YES in order to let doxygen match functions declarations and
256   # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
257 < # func(std::string) {}). This also make the inheritance and collaboration
257 > # func(std::string) {}). This also makes the inheritance and collaboration
258   # diagrams that involve STL classes more complete and accurate.
259  
260   BUILTIN_STL_SUPPORT    = NO
# Line 251 | Line 272 | SIP_SUPPORT            = NO
272  
273   # For Microsoft's IDL there are propget and propput attributes to indicate getter
274   # and setter methods for a property. Setting this option to YES (the default)
275 < # will make doxygen to replace the get and set methods by a property in the
275 > # will make doxygen replace the get and set methods by a property in the
276   # documentation. This will only work if the methods are indeed getting or
277   # setting a simple type. If this is not the case, or you want to show the
278   # methods anyway, you should set this option to NO.
# Line 273 | Line 294 | DISTRIBUTE_GROUP_DOC   = NO
294  
295   SUBGROUPING            = YES
296  
297 + # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
298 + # unions are shown inside the group in which they are included (e.g. using
299 + # @ingroup) instead of on a separate page (for HTML and Man pages) or
300 + # section (for LaTeX and RTF).
301 +
302 + INLINE_GROUPED_CLASSES = NO
303 +
304 + # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
305 + # unions with only public data fields will be shown inline in the documentation
306 + # of the scope in which they are defined (i.e. file, namespace, or group
307 + # documentation), provided this scope is documented. If set to NO (the default),
308 + # structs, classes, and unions are shown on a separate page (for HTML and Man
309 + # pages) or section (for LaTeX and RTF).
310 +
311 + INLINE_SIMPLE_STRUCTS  = NO
312 +
313   # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
314   # is documented as struct, union, or enum with the name of the typedef. So
315   # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# Line 289 | Line 326 | TYPEDEF_HIDES_STRUCT   = NO
326   # For small to medium size projects (<1000 input files) the default value is
327   # probably good enough. For larger projects a too small cache size can cause
328   # doxygen to be busy swapping symbols to and from disk most of the time
329 < # causing a significant performance penality.
329 > # causing a significant performance penalty.
330   # If the system has enough physical memory increasing the cache will improve the
331   # performance by keeping more symbols in memory. Note that the value works on
332 < # a logarithmic scale so increasing the size by one will rougly double the
332 > # a logarithmic scale so increasing the size by one will roughly double the
333   # memory usage. The cache size is given by this formula:
334   # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
335 < # corresponding to a cache size of 2^16 = 65536 symbols
335 > # corresponding to a cache size of 2^16 = 65536 symbols.
336  
337   SYMBOL_CACHE_SIZE      = 0
338  
339 + # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
340 + # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
341 + # their name and scope. Since this can be an expensive process and often the
342 + # same symbol appear multiple times in the code, doxygen keeps a cache of
343 + # pre-resolved symbols. If the cache is too small doxygen will become slower.
344 + # If the cache is too large, memory is wasted. The cache size is given by this
345 + # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
346 + # corresponding to a cache size of 2^16 = 65536 symbols.
347 +
348 + LOOKUP_CACHE_SIZE      = 0
349 +
350   #---------------------------------------------------------------------------
351   # Build related configuration options
352   #---------------------------------------------------------------------------
# Line 331 | Line 379 | EXTRACT_LOCAL_CLASSES  = YES
379   # the interface are included in the documentation.
380   # If set to NO (the default) only methods in the interface are included.
381  
382 < EXTRACT_LOCAL_METHODS  = NO
382 > EXTRACT_LOCAL_METHODS  = YES
383  
384   # If this flag is set to YES, the members of anonymous namespaces will be
385   # extracted and appear in the documentation as a namespace called
386   # 'anonymous_namespace{file}', where file will be replaced with the base
387   # name of the file that contains the anonymous namespace. By default
388 < # anonymous namespace are hidden.
388 > # anonymous namespaces are hidden.
389  
390   EXTRACT_ANON_NSPACES   = NO
391  
# Line 422 | Line 470 | SORT_MEMBER_DOCS       = YES
470  
471   SORT_BRIEF_DOCS        = NO
472  
473 < # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
474 < # will sort the (brief and detailed) documentation of class members so that
475 < # constructors and destructors are listed first. If set to NO (the default)
476 < # the constructors will appear in the respective orders defined by
477 < # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
478 < # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
473 > # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
474 > # will sort the (brief and detailed) documentation of class members so that
475 > # constructors and destructors are listed first. If set to NO (the default)
476 > # the constructors will appear in the respective orders defined by
477 > # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
478 > # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
479   # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
480  
481   SORT_MEMBERS_CTORS_1ST = NO
# Line 448 | Line 496 | SORT_GROUP_NAMES       = NO
496  
497   SORT_BY_SCOPE_NAME     = NO
498  
499 + # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
500 + # do proper type resolution of all parameters of a function it will reject a
501 + # match between the prototype and the implementation of a member function even
502 + # if there is only one candidate or it is obvious which candidate to choose
503 + # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
504 + # will still accept a match between prototype and implementation in such cases.
505 +
506 + STRICT_PROTO_MATCHING  = NO
507 +
508   # The GENERATE_TODOLIST tag can be used to enable (YES) or
509   # disable (NO) the todo list. This list is created by putting \todo
510   # commands in the documentation.
# Line 478 | Line 535 | GENERATE_DEPRECATEDLIST= YES
535   ENABLED_SECTIONS       =
536  
537   # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
538 < # the initial value of a variable or define consists of for it to appear in
538 > # the initial value of a variable or macro consists of for it to appear in
539   # the documentation. If the initializer consists of more lines than specified
540   # here it will be hidden. Use a value of 0 to hide initializers completely.
541 < # The appearance of the initializer of individual variables and defines in the
541 > # The appearance of the initializer of individual variables and macros in the
542   # documentation can be controlled using \showinitializer or \hideinitializer
543   # command in the documentation regardless of this setting.
544  
# Line 521 | Line 578 | SHOW_NAMESPACES        = YES
578  
579   FILE_VERSION_FILTER    =
580  
581 < # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
582 < # doxygen. The layout file controls the global structure of the generated output files
583 < # in an output format independent way. The create the layout file that represents
584 < # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
585 < # file name after the option, if omitted DoxygenLayout.xml will be used as the name
586 < # of the layout file.
581 > # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
582 > # by doxygen. The layout file controls the global structure of the generated
583 > # output files in an output format independent way. The create the layout file
584 > # that represents doxygen's defaults, run doxygen with the -l option.
585 > # You can optionally specify a file name after the option, if omitted
586 > # DoxygenLayout.xml will be used as the name of the layout file.
587  
588   LAYOUT_FILE            =
589  
590 + # The CITE_BIB_FILES tag can be used to specify one or more bib files
591 + # containing the references data. This must be a list of .bib files. The
592 + # .bib extension is automatically appended if omitted. Using this command
593 + # requires the bibtex tool to be installed. See also
594 + # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
595 + # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
596 + # feature you need bibtex and perl available in the search path.
597 +
598 + CITE_BIB_FILES         =
599 +
600   #---------------------------------------------------------------------------
601   # configuration options related to warning and progress messages
602   #---------------------------------------------------------------------------
# Line 558 | Line 625 | WARN_IF_UNDOCUMENTED   = YES
625  
626   WARN_IF_DOC_ERROR      = YES
627  
628 < # This WARN_NO_PARAMDOC option can be abled to get warnings for
628 > # The WARN_NO_PARAMDOC option can be enabled to get warnings for
629   # functions that are documented, but have no documentation for their parameters
630   # or return value. If set to NO (the default) doxygen will only warn about
631   # wrong or incomplete parameter documentation, but not about the absence of
# Line 590 | Line 657 | WARN_LOGFILE           =
657   # directories like "/usr/src/myproject". Separate the files or directories
658   # with spaces.
659  
660 < INPUT                  = ../lib \
594 <                         ../IBrep/src
660 > INPUT                  = ../lib
661  
662   # This tag can be used to specify the character encoding of the source files
663   # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# Line 605 | Line 671 | INPUT_ENCODING         = UTF-8
671   # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
672   # and *.h) to filter out the source-files in the directories. If left
673   # blank the following patterns are tested:
674 < # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
675 < # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
674 > # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
675 > # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
676 > # *.f90 *.f *.for *.vhd *.vhdl
677  
678   FILE_PATTERNS          = *.c \
679                           *.cc \
# Line 640 | Line 707 | FILE_PATTERNS          = *.c \
707  
708   RECURSIVE              = YES
709  
710 < # The EXCLUDE tag can be used to specify files and/or directories that should
710 > # The EXCLUDE tag can be used to specify files and/or directories that should be
711   # excluded from the INPUT source files. This way you can easily exclude a
712 < # subdirectory from a directory tree whose root is specified with the INPUT tag.
712 > # subdirectory from a directory tree whose root is specified with the INPUT tag.
713 > # Note that relative paths are relative to the directory from which doxygen is
714 > # run.
715  
716   EXCLUDE                = ../lib/OCC_Fonction \
717 <                         ../lib/geometrie/Imports
717 >                         ../lib/geometrie/Imports \
718 >                         ../lib/diamesh
719  
720 < # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
721 < # directories that are symbolic links (a Unix filesystem feature) are excluded
720 > # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
721 > # directories that are symbolic links (a Unix file system feature) are excluded
722   # from the input.
723  
724   EXCLUDE_SYMLINKS       = NO
# Line 709 | Line 779 | INPUT_FILTER           =
779   # basis.  Doxygen will compare the file name with each pattern and apply the
780   # filter if there is a match.  The filters are a list of the form:
781   # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
782 < # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
783 < # is applied to all files.
782 > # info on how filters are used. If FILTER_PATTERNS is empty or if
783 > # non of the patterns match the file name, INPUT_FILTER is applied.
784  
785   FILTER_PATTERNS        =
786  
# Line 720 | Line 790 | FILTER_PATTERNS        =
790  
791   FILTER_SOURCE_FILES    = NO
792  
793 + # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
794 + # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
795 + # and it is also possible to disable source filtering for a specific pattern
796 + # using *.ext= (so without naming a filter). This option only has effect when
797 + # FILTER_SOURCE_FILES is enabled.
798 +
799 + FILTER_SOURCE_PATTERNS =
800 +
801   #---------------------------------------------------------------------------
802   # configuration options related to source browsing
803   #---------------------------------------------------------------------------
# Line 783 | Line 861 | VERBATIM_HEADERS       = YES
861   # of all compounds will be generated. Enable this if the project
862   # contains a lot of classes, structs, unions or interfaces.
863  
864 < ALPHABETICAL_INDEX     = NO
864 > ALPHABETICAL_INDEX     = YES
865  
866   # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
867   # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
# Line 821 | Line 899 | HTML_FILE_EXTENSION    = .html
899  
900   # The HTML_HEADER tag can be used to specify a personal HTML header for
901   # each generated HTML page. If it is left blank doxygen will generate a
902 < # standard header.
902 > # standard header. Note that when using a custom header you are responsible  
903 > # for the proper inclusion of any scripts and style sheets that doxygen
904 > # needs, which is dependent on the configuration options used.
905 > # It is advised to generate a default header using "doxygen -w html
906 > # header.html footer.html stylesheet.css YourConfigFile" and then modify
907 > # that header. Note that the header is subject to change so you typically
908 > # have to redo this when upgrading to a newer version of doxygen or when
909 > # changing the value of configuration settings such as GENERATE_TREEVIEW!
910  
911   HTML_HEADER            =
912  
# Line 836 | Line 921 | HTML_FOOTER            =
921   # fine-tune the look of the HTML output. If the tag is left blank doxygen
922   # will generate a default style sheet. Note that doxygen will try to copy
923   # the style sheet file to the HTML output directory, so don't put your own
924 < # stylesheet in the HTML output directory as well, or it will be erased!
924 > # style sheet in the HTML output directory as well, or it will be erased!
925  
926   HTML_STYLESHEET        =
927  
928 + # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
929 + # other source files which should be copied to the HTML output directory. Note
930 + # that these files will be copied to the base HTML output directory. Use the
931 + # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
932 + # files. In the HTML_STYLESHEET file, use the file name only. Also note that
933 + # the files will be copied as-is; there are no commands or markers available.
934 +
935 + HTML_EXTRA_FILES       =
936 +
937 + # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
938 + # Doxygen will adjust the colors in the style sheet and background images
939 + # according to this color. Hue is specified as an angle on a colorwheel,
940 + # see http://en.wikipedia.org/wiki/Hue for more information.
941 + # For instance the value 0 represents red, 60 is yellow, 120 is green,
942 + # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
943 + # The allowed range is 0 to 359.
944 +
945 + HTML_COLORSTYLE_HUE    = 220
946 +
947 + # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
948 + # the colors in the HTML output. For a value of 0 the output will use
949 + # grayscales only. A value of 255 will produce the most vivid colors.
950 +
951 + HTML_COLORSTYLE_SAT    = 100
952 +
953 + # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
954 + # the luminance component of the colors in the HTML output. Values below
955 + # 100 gradually make the output lighter, whereas values above 100 make
956 + # the output darker. The value divided by 100 is the actual gamma applied,
957 + # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
958 + # and 100 does not change the gamma.
959 +
960 + HTML_COLORSTYLE_GAMMA  = 84
961 +
962   # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
963   # page will contain the date and time when the page was generated. Setting
964   # this to NO can help when comparing the output of multiple runs.
# Line 868 | Line 987 | HTML_DYNAMIC_SECTIONS  = NO
987   # directory and running "make install" will install the docset in
988   # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
989   # it at startup.
990 < # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
990 > # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
991 > # for more information.
992  
993   GENERATE_DOCSET        = NO
994  
# Line 886 | Line 1006 | DOCSET_FEEDNAME        = "Doxygen genera
1006  
1007   DOCSET_BUNDLE_ID       = org.doxygen.Project
1008  
1009 + # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1010 + # the documentation publisher. This should be a reverse domain-name style
1011 + # string, e.g. com.mycompany.MyDocSet.documentation.
1012 +
1013 + DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1014 +
1015 + # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1016 +
1017 + DOCSET_PUBLISHER_NAME  = Publisher
1018 +
1019   # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1020   # will be generated that can be used as input for tools like the
1021   # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# Line 930 | Line 1060 | BINARY_TOC             = NO
1060  
1061   TOC_EXPAND             = NO
1062  
1063 < # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
1064 < # are set, an additional index file will be generated that can be used as input for
1065 < # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
1066 < # HTML documentation.
1063 > # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1064 > # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1065 > # that can be used as input for Qt's qhelpgenerator to generate a
1066 > # Qt Compressed Help (.qch) of the generated HTML documentation.
1067  
1068   GENERATE_QHP           = NO
1069  
# Line 955 | Line 1085 | QHP_NAMESPACE          = org.doxygen.Pro
1085  
1086   QHP_VIRTUAL_FOLDER     = doc
1087  
1088 < # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
1089 < # For more information please see
1088 > # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1089 > # add. For more information please see
1090   # http://doc.trolltech.com/qthelpproject.html#custom-filters
1091  
1092   QHP_CUST_FILTER_NAME   =
1093  
1094 < # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
1095 < # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
1094 > # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1095 > # custom filter to add. For more information please see
1096 > # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1097 > # Qt Help Project / Custom Filters</a>.
1098  
1099   QHP_CUST_FILTER_ATTRS  =
1100  
1101 < # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
1101 > # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1102 > # project's
1103   # filter section matches.
1104 < # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
1104 > # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1105 > # Qt Help Project / Filter Attributes</a>.
1106  
1107   QHP_SECT_FILTER_ATTRS  =
1108  
# Line 980 | Line 1114 | QHP_SECT_FILTER_ATTRS  =
1114   QHG_LOCATION           =
1115  
1116   # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  
1117 < # will be generated, which together with the HTML files, form an Eclipse help  
1117 > # will be generated, which together with the HTML files, form an Eclipse help
1118   # plugin. To install this plugin and make it available under the help contents
1119   # menu in Eclipse, the contents of the directory containing the HTML and XML
1120   # files needs to be copied into the plugins directory of eclipse. The name of
1121   # the directory within the plugins directory should be the same as
1122 < # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1122 > # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1123   # the help appears.
1124  
1125   GENERATE_ECLIPSEHELP   = NO
# Line 996 | Line 1130 | GENERATE_ECLIPSEHELP   = NO
1130  
1131   ECLIPSE_DOC_ID         = org.doxygen.Project
1132  
1133 < # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1134 < # top of each HTML page. The value NO (the default) enables the index and
1135 < # the value YES disables it.
1133 > # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1134 > # at top of each HTML page. The value NO (the default) enables the index and
1135 > # the value YES disables it. Since the tabs have the same information as the
1136 > # navigation tree you can set this option to NO if you already set
1137 > # GENERATE_TREEVIEW to YES.
1138  
1139   DISABLE_INDEX          = NO
1140  
1005 # This tag can be used to set the number of enum values (range [1..20])
1006 # that doxygen will group on one line in the generated HTML documentation.
1007
1008 ENUM_VALUES_PER_LINE   = 1
1009
1141   # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1142   # structure should be generated to display hierarchical information.
1143   # If the tag value is set to YES, a side panel will be generated
1144   # containing a tree-like index structure (just like the one that
1145   # is generated for HTML Help). For this to work a browser that supports
1146   # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1147 < # Windows users are probably better off using the HTML help feature.
1147 > # Windows users are probably better off using the HTML help feature.
1148 > # Since the tree basically has the same information as the tab index you
1149 > # could consider to set DISABLE_INDEX to NO when enabling this option.
1150  
1151   GENERATE_TREEVIEW      = YES
1152  
1153 + # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1154 + # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1155 + # documentation. Note that a value of 0 will completely suppress the enum
1156 + # values from appearing in the overview section.
1157 +
1158 + ENUM_VALUES_PER_LINE   = 1
1159 +
1160   # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1161   # and Class Hierarchy pages using a tree view instead of an ordered list.
1162  
# Line 1028 | Line 1168 | USE_INLINE_TREES       = NO
1168  
1169   TREEVIEW_WIDTH         = 250
1170  
1171 + # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1172 + # links to external symbols imported via tag files in a separate window.
1173 +
1174 + EXT_LINKS_IN_WINDOW    = NO
1175 +
1176   # Use this tag to change the font size of Latex formulas included
1177   # as images in the HTML documentation. The default is 10. Note that
1178   # when you change the font size after a successful doxygen run you need
# Line 1036 | Line 1181 | TREEVIEW_WIDTH         = 250
1181  
1182   FORMULA_FONTSIZE       = 10
1183  
1184 < # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1184 > # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1185 > # generated for formulas are transparent PNGs. Transparent PNGs are
1186 > # not supported properly for IE 6.0, but are supported on all modern browsers.
1187 > # Note that when changing this option you need to delete any form_*.png files
1188 > # in the HTML output before the changes have effect.
1189 >
1190 > FORMULA_TRANSPARENT    = YES
1191 >
1192 > # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1193 > # (see http://www.mathjax.org) which uses client side Javascript for the
1194 > # rendering instead of using prerendered bitmaps. Use this if you do not
1195 > # have LaTeX installed or if you want to formulas look prettier in the HTML
1196 > # output. When enabled you also need to install MathJax separately and
1197 > # configure the path to it using the MATHJAX_RELPATH option.
1198 >
1199 > USE_MATHJAX            = NO
1200 >
1201 > # When MathJax is enabled you need to specify the location relative to the
1202 > # HTML output directory using the MATHJAX_RELPATH option. The destination
1203 > # directory should contain the MathJax.js script. For instance, if the mathjax
1204 > # directory is located at the same level as the HTML output directory, then
1205 > # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1206 > # mathjax.org site, so you can quickly see the result without installing
1207 > # MathJax, but it is strongly recommended to install a local copy of MathJax
1208 > # before deployment.
1209 >
1210 > MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1211 >
1212 > # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1213 > # names that should be enabled during MathJax rendering.
1214 >
1215 > MATHJAX_EXTENSIONS     =
1216 >
1217 > # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1218   # for the HTML output. The underlying search engine uses javascript
1219 < # and DHTML and should work on any modern browser. Note that when using
1220 < # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1219 > # and DHTML and should work on any modern browser. Note that when using
1220 > # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1221   # (GENERATE_DOCSET) there is already a search function so this one should
1222   # typically be disabled. For large projects the javascript based search engine
1223   # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1224  
1225 < SEARCHENGINE           = NO
1225 > SEARCHENGINE           = YES
1226  
1227 < # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1228 < # implemented using a PHP enabled web server instead of at the web client
1227 > # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1228 > # implemented using a PHP enabled web server instead of at the web client
1229   # using Javascript. Doxygen will generate the search PHP script and index
1230 < # file to put on the web server. The advantage of the server
1231 < # based approach is that it scales better to large projects and allows
1232 < # full text search. The disadvances is that it is more difficult to setup
1230 > # file to put on the web server. The advantage of the server
1231 > # based approach is that it scales better to large projects and allows
1232 > # full text search. The disadvantages are that it is more difficult to setup
1233   # and does not have live searching capabilities.
1234  
1235   SERVER_BASED_SEARCH    = NO
# Line 1092 | Line 1270 | MAKEINDEX_CMD_NAME     = makeindex
1270   COMPACT_LATEX          = NO
1271  
1272   # The PAPER_TYPE tag can be used to set the paper type that is used
1273 < # by the printer. Possible values are: a4, a4wide, letter, legal and
1273 > # by the printer. Possible values are: a4, letter, legal and
1274   # executive. If left blank a4wide will be used.
1275  
1276   PAPER_TYPE             = a4wide
# Line 1109 | Line 1287 | EXTRA_PACKAGES         =
1287  
1288   LATEX_HEADER           =
1289  
1290 + # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1291 + # the generated latex document. The footer should contain everything after
1292 + # the last chapter. If it is left blank doxygen will generate a
1293 + # standard footer. Notice: only use this tag if you know what you are doing!
1294 +
1295 + LATEX_FOOTER           =
1296 +
1297   # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1298   # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1299   # contain links (just like the HTML output) instead of page references
# Line 1135 | Line 1320 | LATEX_BATCHMODE        = NO
1320  
1321   LATEX_HIDE_INDICES     = NO
1322  
1323 < # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1324 < # source code with syntax highlighting in the LaTeX output.
1325 < # Note that which sources are shown also depends on other settings
1323 > # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1324 > # source code with syntax highlighting in the LaTeX output.
1325 > # Note that which sources are shown also depends on other settings
1326   # such as SOURCE_BROWSER.
1327  
1328   LATEX_SOURCE_CODE      = NO
1329  
1330 + # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1331 + # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1332 + # http://en.wikipedia.org/wiki/BibTeX for more info.
1333 +
1334 + LATEX_BIB_STYLE        = plain
1335 +
1336   #---------------------------------------------------------------------------
1337   # configuration options related to the RTF output
1338   #---------------------------------------------------------------------------
# Line 1173 | Line 1364 | COMPACT_RTF            = NO
1364  
1365   RTF_HYPERLINKS         = NO
1366  
1367 < # Load stylesheet definitions from file. Syntax is similar to doxygen's
1367 > # Load style sheet definitions from file. Syntax is similar to doxygen's
1368   # config file, i.e. a series of assignments. You only have to provide
1369   # replacements, missing definitions are set to their default value.
1370  
# Line 1316 | Line 1507 | MACRO_EXPANSION        = NO
1507   EXPAND_ONLY_PREDEF     = NO
1508  
1509   # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1510 < # in the INCLUDE_PATH (see below) will be search if a #include is found.
1510 > # pointed to by INCLUDE_PATH will be searched when a #include is found.
1511  
1512   SEARCH_INCLUDES        = YES
1513  
# Line 1349 | Line 1540 | PREDEFINED             = BREP_SAT \
1540   # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1541   # this tag can be used to specify a list of macro names that should be expanded.
1542   # The macro definition that is found in the sources will be used.
1543 < # Use the PREDEFINED tag if you want to use a different macro definition.
1543 > # Use the PREDEFINED tag if you want to use a different macro definition that
1544 > # overrules the definition found in the source code.
1545  
1546   EXPAND_AS_DEFINED      =
1547  
1548   # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1549 < # doxygen's preprocessor will remove all function-like macros that are alone
1550 < # on a line, have an all uppercase name, and do not end with a semicolon. Such
1551 < # function macros are typically used for boiler-plate code, and will confuse
1360 < # the parser if not removed.
1549 > # doxygen's preprocessor will remove all references to function-like macros
1550 > # that are alone on a line, have an all uppercase name, and do not end with a
1551 > # semicolon, because these will confuse the parser if not removed.
1552  
1553   SKIP_FUNCTION_MACROS   = YES
1554  
# Line 1411 | Line 1602 | PERL_PATH              = /usr/bin/perl
1602   # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1603   # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1604   # or super classes. Setting the tag to NO turns the diagrams off. Note that
1605 < # this option is superseded by the HAVE_DOT option below. This is only a
1606 < # fallback. It is recommended to install and use dot, since it yields more
1416 < # powerful graphs.
1605 > # this option also works with HAVE_DOT disabled, but it is recommended to
1606 > # install and use dot, since it yields more powerful graphs.
1607  
1608   CLASS_DIAGRAMS         = NO
1609  
# Line 1439 | Line 1629 | HIDE_UNDOC_RELATIONS   = YES
1629  
1630   HAVE_DOT               = YES
1631  
1632 < # By default doxygen will write a font called FreeSans.ttf to the output
1633 < # directory and reference it in all dot files that doxygen generates. This
1634 < # font does not include all possible unicode characters however, so when you need
1635 < # these (or just want a differently looking font) you can specify the font name
1636 < # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1637 < # which can be done by putting it in a standard location or by setting the
1638 < # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1639 < # containing the font.
1632 > # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1633 > # allowed to run in parallel. When set to 0 (the default) doxygen will
1634 > # base this on the number of processors available in the system. You can set it
1635 > # explicitly to a value larger than 0 to get control over the balance
1636 > # between CPU load and processing speed.
1637 >
1638 > DOT_NUM_THREADS        = 0
1639 >
1640 > # By default doxygen will use the Helvetica font for all dot files that
1641 > # doxygen generates. When you want a differently looking font you can specify
1642 > # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1643 > # the font, which can be done by putting it in a standard location or by setting
1644 > # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1645 > # directory containing the font.
1646  
1647   DOT_FONTNAME           = FreeSans
1648  
# Line 1455 | Line 1651 | DOT_FONTNAME           = FreeSans
1651  
1652   DOT_FONTSIZE           = 10
1653  
1654 < # By default doxygen will tell dot to use the output directory to look for the
1655 < # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1656 < # different font using DOT_FONTNAME you can set the path where dot
1461 < # can find it using this tag.
1654 > # By default doxygen will tell dot to use the Helvetica font.
1655 > # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1656 > # set the path where dot can find it.
1657  
1658   DOT_FONTPATH           =
1659  
1660   # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1661   # will generate a graph for each documented class showing the direct and
1662   # indirect inheritance relations. Setting this tag to YES will force the
1663 < # the CLASS_DIAGRAMS tag to NO.
1663 > # CLASS_DIAGRAMS tag to NO.
1664  
1665   CLASS_GRAPH            = YES
1666  
# Line 1523 | Line 1718 | CALL_GRAPH             = YES
1718   CALLER_GRAPH           = YES
1719  
1720   # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1721 < # will graphical hierarchy of all classes instead of a textual one.
1721 > # will generate a graphical hierarchy of all classes instead of a textual one.
1722  
1723   GRAPHICAL_HIERARCHY    = YES
1724  
# Line 1535 | Line 1730 | GRAPHICAL_HIERARCHY    = YES
1730   DIRECTORY_GRAPH        = YES
1731  
1732   # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1733 < # generated by dot. Possible values are png, jpg, or gif
1734 < # If left blank png will be used.
1733 > # generated by dot. Possible values are svg, png, jpg, or gif.
1734 > # If left blank png will be used. If you choose svg you need to set
1735 > # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1736 > # visible in IE 9+ (other browsers do not have this requirement).
1737  
1738   DOT_IMAGE_FORMAT       = png
1739  
1740 + # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1741 + # enable generation of interactive SVG images that allow zooming and panning.
1742 + # Note that this requires a modern browser other than Internet Explorer.
1743 + # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1744 + # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1745 + # visible. Older versions of IE do not have SVG support.
1746 +
1747 + INTERACTIVE_SVG        = NO
1748 +
1749   # The tag DOT_PATH can be used to specify the path where the dot tool can be
1750   # found. If left blank, it is assumed the dot tool can be found in the path.
1751  
# Line 1551 | Line 1757 | DOT_PATH               =
1757  
1758   DOTFILE_DIRS           =
1759  
1760 + # The MSCFILE_DIRS tag can be used to specify one or more directories that
1761 + # contain msc files that are included in the documentation (see the
1762 + # \mscfile command).
1763 +
1764 + MSCFILE_DIRS           =
1765 +
1766   # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1767   # nodes that will be shown in the graph. If the number of nodes in a graph
1768   # becomes larger than this value, doxygen will truncate the graph, which is

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines