1 |
< |
# Doxyfile 1.8.6 |
1 |
> |
# Doxyfile 1.8.17 |
2 |
|
|
3 |
|
# This file describes the settings to be used by the documentation system |
4 |
|
# doxygen (www.doxygen.org) for a project. |
17 |
|
# Project related configuration options |
18 |
|
#--------------------------------------------------------------------------- |
19 |
|
|
20 |
< |
# This tag specifies the encoding used for all characters in the config file |
21 |
< |
# that follow. The default is UTF-8 which is also the encoding used for all text |
22 |
< |
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv |
23 |
< |
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv |
24 |
< |
# for the list of possible encodings. |
20 |
> |
# This tag specifies the encoding used for all characters in the configuration |
21 |
> |
# file that follow. The default is UTF-8 which is also the encoding used for all |
22 |
> |
# text before the first occurrence of this tag. Doxygen uses libiconv (or the |
23 |
> |
# iconv built into libc) for the transcoding. See |
24 |
> |
# https://www.gnu.org/software/libiconv/ for the list of possible encodings. |
25 |
|
# The default value is: UTF-8. |
26 |
|
|
27 |
|
DOXYFILE_ENCODING = UTF-8 |
44 |
|
# for a project that appears at the top of each page and should give viewer a |
45 |
|
# quick idea about the purpose of the project. Keep the description short. |
46 |
|
|
47 |
< |
PROJECT_BRIEF = |
47 |
> |
PROJECT_BRIEF = "Mailleurs Automatiques de Géometries intégrés à la Cao" |
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 = |
54 |
> |
PROJECT_LOGO = /home/francois/dev/magic/documentation/logomagic.jpg |
55 |
|
|
56 |
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
57 |
|
# into which the generated documentation will be written. If a relative path is |
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 |
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. |
93 |
|
|
94 |
|
OUTPUT_LANGUAGE = French |
95 |
|
|
96 |
< |
# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member |
96 |
> |
# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all |
97 |
> |
# documentation generated by doxygen is written. Doxygen will use this |
98 |
> |
# information to generate all generated output in the proper direction. |
99 |
> |
# Possible values are: None, LTR, RTL and Context. |
100 |
> |
# The default value is: None. |
101 |
> |
|
102 |
> |
OUTPUT_TEXT_DIRECTION = None |
103 |
> |
|
104 |
> |
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member |
105 |
|
# descriptions after the members that are listed in the file and class |
106 |
|
# documentation (similar to Javadoc). Set to NO to disable this. |
107 |
|
# The default value is: YES. |
108 |
|
|
109 |
|
BRIEF_MEMBER_DESC = YES |
110 |
|
|
111 |
< |
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief |
111 |
> |
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief |
112 |
|
# description of a member or function before the detailed description |
113 |
|
# |
114 |
|
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
153 |
|
|
154 |
|
INLINE_INHERITED_MEMB = NO |
155 |
|
|
156 |
< |
# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path |
156 |
> |
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path |
157 |
|
# before files name in the file list and in the header files. If set to NO the |
158 |
|
# shortest path that makes the file name unique will be used |
159 |
|
# The default value is: YES. |
179 |
|
# specify the list of include paths that are normally passed to the compiler |
180 |
|
# using the -I flag. |
181 |
|
|
182 |
< |
STRIP_FROM_INC_PATH = |
182 |
> |
STRIP_FROM_INC_PATH = |
183 |
|
|
184 |
|
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but |
185 |
|
# less readable) file names. This can be useful is your file systems doesn't |
197 |
|
|
198 |
|
JAVADOC_AUTOBRIEF = NO |
199 |
|
|
200 |
+ |
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line |
201 |
+ |
# such as |
202 |
+ |
# /*************** |
203 |
+ |
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the |
204 |
+ |
# Javadoc-style will behave just like regular comments and it will not be |
205 |
+ |
# interpreted by doxygen. |
206 |
+ |
# The default value is: NO. |
207 |
+ |
|
208 |
+ |
JAVADOC_BANNER = NO |
209 |
+ |
|
210 |
|
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
211 |
|
# line (until the first dot) of a Qt-style comment as the brief description. If |
212 |
|
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
233 |
|
|
234 |
|
INHERIT_DOCS = YES |
235 |
|
|
236 |
< |
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a |
237 |
< |
# new page for each member. If set to NO, the documentation of a member will be |
238 |
< |
# part of the file/class/namespace that contains it. |
236 |
> |
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new |
237 |
> |
# page for each member. If set to NO, the documentation of a member will be part |
238 |
> |
# of the file/class/namespace that contains it. |
239 |
|
# The default value is: NO. |
240 |
|
|
241 |
|
SEPARATE_MEMBER_PAGES = NO |
254 |
|
# will allow you to put the command \sideeffect (or @sideeffect) in the |
255 |
|
# documentation, which will result in a user-defined paragraph with heading |
256 |
|
# "Side Effects:". You can put \n's in the value part of an alias to insert |
257 |
< |
# newlines. |
257 |
> |
# newlines (in the resulting output). You can put ^^ in the value part of an |
258 |
> |
# alias to insert a newline as if a physical newline was in the original file. |
259 |
> |
# When you need a literal { or } or , in the value part of an alias you have to |
260 |
> |
# escape them by means of a backslash (\), this can lead to conflicts with the |
261 |
> |
# commands \{ and \} for these it is advised to use the version @{ and @} or use |
262 |
> |
# a double escape (\\{ and \\}) |
263 |
|
|
264 |
< |
ALIASES = |
264 |
> |
ALIASES = |
265 |
|
|
266 |
|
# This tag can be used to specify a number of word-keyword mappings (TCL only). |
267 |
|
# A mapping has the form "name=value". For example adding "class=itcl::class" |
268 |
|
# will allow you to use the command class in the itcl::class meaning. |
269 |
|
|
270 |
< |
TCL_SUBST = |
270 |
> |
TCL_SUBST = |
271 |
|
|
272 |
|
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
273 |
|
# only. Doxygen will then generate output that is more tailored for C. For |
297 |
|
|
298 |
|
OPTIMIZE_OUTPUT_VHDL = NO |
299 |
|
|
300 |
+ |
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice |
301 |
+ |
# sources only. Doxygen will then generate output that is more tailored for that |
302 |
+ |
# language. For instance, namespaces will be presented as modules, types will be |
303 |
+ |
# separated into more groups, etc. |
304 |
+ |
# The default value is: NO. |
305 |
+ |
|
306 |
+ |
OPTIMIZE_OUTPUT_SLICE = NO |
307 |
+ |
|
308 |
|
# Doxygen selects the parser to use depending on the extension of the files it |
309 |
|
# parses. With this tag you can assign which parser to use for a given |
310 |
|
# extension. Doxygen has a built-in mapping, but you can override or extend it |
311 |
|
# using this tag. The format is ext=language, where ext is a file extension, and |
312 |
< |
# language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
313 |
< |
# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make |
314 |
< |
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C |
315 |
< |
# (default is Fortran), use: inc=Fortran f=C. |
312 |
> |
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, |
313 |
> |
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, |
314 |
> |
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: |
315 |
> |
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser |
316 |
> |
# tries to guess whether the code is fixed or free formatted code, this is the |
317 |
> |
# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat |
318 |
> |
# .inc files as Fortran files (default is PHP), and .f files as C (default is |
319 |
> |
# Fortran), use: inc=Fortran f=C. |
320 |
|
# |
321 |
< |
# Note For files without extension you can use no_extension as a placeholder. |
321 |
> |
# Note: For files without extension you can use no_extension as a placeholder. |
322 |
|
# |
323 |
|
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
324 |
|
# the files are not read by doxygen. |
325 |
|
|
326 |
< |
EXTENSION_MAPPING = |
326 |
> |
EXTENSION_MAPPING = |
327 |
|
|
328 |
|
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
329 |
|
# according to the Markdown format, which allows for more readable |
330 |
< |
# documentation. See http://daringfireball.net/projects/markdown/ for details. |
330 |
> |
# documentation. See https://daringfireball.net/projects/markdown/ for details. |
331 |
|
# The output of markdown processing is further processed by doxygen, so you can |
332 |
|
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
333 |
|
# case of backward compatibilities issues. |
335 |
|
|
336 |
|
MARKDOWN_SUPPORT = YES |
337 |
|
|
338 |
+ |
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up |
339 |
+ |
# to that level are automatically included in the table of contents, even if |
340 |
+ |
# they do not have an id attribute. |
341 |
+ |
# Note: This feature currently applies only to Markdown headings. |
342 |
+ |
# Minimum value: 0, maximum value: 99, default value: 5. |
343 |
+ |
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. |
344 |
+ |
|
345 |
+ |
TOC_INCLUDE_HEADINGS = 0 |
346 |
+ |
|
347 |
|
# When enabled doxygen tries to link words that correspond to documented |
348 |
|
# classes, or namespaces to their corresponding documentation. Such a link can |
349 |
< |
# be prevented in individual cases by by putting a % sign in front of the word |
350 |
< |
# or globally by setting AUTOLINK_SUPPORT to NO. |
349 |
> |
# be prevented in individual cases by putting a % sign in front of the word or |
350 |
> |
# globally by setting AUTOLINK_SUPPORT to NO. |
351 |
|
# The default value is: YES. |
352 |
|
|
353 |
|
AUTOLINK_SUPPORT = YES |
369 |
|
CPP_CLI_SUPPORT = NO |
370 |
|
|
371 |
|
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
372 |
< |
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen |
372 |
> |
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen |
373 |
|
# will parse them like normal C++ but will assume all classes use public instead |
374 |
|
# of private inheritance when no explicit protection keyword is present. |
375 |
|
# The default value is: NO. |
387 |
|
IDL_PROPERTY_SUPPORT = YES |
388 |
|
|
389 |
|
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
390 |
< |
# tag is set to YES, then doxygen will reuse the documentation of the first |
390 |
> |
# tag is set to YES then doxygen will reuse the documentation of the first |
391 |
|
# member in the group (if any) for the other members of the group. By default |
392 |
|
# all members of a group must be documented explicitly. |
393 |
|
# The default value is: NO. |
394 |
|
|
395 |
|
DISTRIBUTE_GROUP_DOC = NO |
396 |
|
|
397 |
+ |
# If one adds a struct or class to a group and this option is enabled, then also |
398 |
+ |
# any nested class or struct is added to the same group. By default this option |
399 |
+ |
# is disabled and one has to add nested compounds explicitly via \ingroup. |
400 |
+ |
# The default value is: NO. |
401 |
+ |
|
402 |
+ |
GROUP_NESTED_COMPOUNDS = NO |
403 |
+ |
|
404 |
|
# Set the SUBGROUPING tag to YES to allow class member groups of the same type |
405 |
|
# (for instance a group of public functions) to be put as a subgroup of that |
406 |
|
# type (e.g. under the Public Functions section). Set it to NO to prevent |
459 |
|
# Build related configuration options |
460 |
|
#--------------------------------------------------------------------------- |
461 |
|
|
462 |
< |
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
462 |
> |
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in |
463 |
|
# documentation are documented, even if no documentation was available. Private |
464 |
|
# class members and static file members will be hidden unless the |
465 |
|
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. |
469 |
|
|
470 |
|
EXTRACT_ALL = YES |
471 |
|
|
472 |
< |
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will |
472 |
> |
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will |
473 |
|
# be included in the documentation. |
474 |
|
# The default value is: NO. |
475 |
|
|
476 |
|
EXTRACT_PRIVATE = YES |
477 |
|
|
478 |
< |
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal |
478 |
> |
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual |
479 |
> |
# methods of a class will be included in the documentation. |
480 |
> |
# The default value is: NO. |
481 |
> |
|
482 |
> |
EXTRACT_PRIV_VIRTUAL = YES |
483 |
> |
|
484 |
> |
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal |
485 |
|
# scope will be included in the documentation. |
486 |
|
# The default value is: NO. |
487 |
|
|
488 |
|
EXTRACT_PACKAGE = NO |
489 |
|
|
490 |
< |
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be |
490 |
> |
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be |
491 |
|
# included in the documentation. |
492 |
|
# The default value is: NO. |
493 |
|
|
494 |
|
EXTRACT_STATIC = YES |
495 |
|
|
496 |
< |
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined |
497 |
< |
# locally in source files will be included in the documentation. If set to NO |
496 |
> |
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined |
497 |
> |
# locally in source files will be included in the documentation. If set to NO, |
498 |
|
# only classes defined in header files are included. Does not have any effect |
499 |
|
# for Java sources. |
500 |
|
# The default value is: YES. |
501 |
|
|
502 |
|
EXTRACT_LOCAL_CLASSES = YES |
503 |
|
|
504 |
< |
# This flag is only useful for Objective-C code. When set to YES local methods, |
504 |
> |
# This flag is only useful for Objective-C code. If set to YES, local methods, |
505 |
|
# which are defined in the implementation section but not in the interface are |
506 |
< |
# included in the documentation. If set to NO only methods in the interface are |
506 |
> |
# included in the documentation. If set to NO, only methods in the interface are |
507 |
|
# included. |
508 |
|
# The default value is: NO. |
509 |
|
|
528 |
|
|
529 |
|
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all |
530 |
|
# undocumented classes that are normally visible in the class hierarchy. If set |
531 |
< |
# to NO these classes will be included in the various overviews. This option has |
532 |
< |
# no effect if EXTRACT_ALL is enabled. |
531 |
> |
# to NO, these classes will be included in the various overviews. This option |
532 |
> |
# has no effect if EXTRACT_ALL is enabled. |
533 |
|
# The default value is: NO. |
534 |
|
|
535 |
|
HIDE_UNDOC_CLASSES = NO |
536 |
|
|
537 |
|
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
538 |
< |
# (class|struct|union) declarations. If set to NO these declarations will be |
539 |
< |
# included in the documentation. |
538 |
> |
# declarations. If set to NO, these declarations will be included in the |
539 |
> |
# documentation. |
540 |
|
# The default value is: NO. |
541 |
|
|
542 |
|
HIDE_FRIEND_COMPOUNDS = NO |
543 |
|
|
544 |
|
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any |
545 |
< |
# documentation blocks found inside the body of a function. If set to NO these |
545 |
> |
# documentation blocks found inside the body of a function. If set to NO, these |
546 |
|
# blocks will be appended to the function's detailed documentation block. |
547 |
|
# The default value is: NO. |
548 |
|
|
556 |
|
INTERNAL_DOCS = NO |
557 |
|
|
558 |
|
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file |
559 |
< |
# names in lower-case letters. If set to YES upper-case letters are also |
559 |
> |
# names in lower-case letters. If set to YES, upper-case letters are also |
560 |
|
# allowed. This is useful if you have classes or files whose names only differ |
561 |
|
# in case and if your file system supports case sensitive file names. Windows |
562 |
< |
# and Mac users are advised to set this option to NO. |
562 |
> |
# (including Cygwin) ands Mac users are advised to set this option to NO. |
563 |
|
# The default value is: system dependent. |
564 |
|
|
565 |
|
CASE_SENSE_NAMES = NO |
566 |
|
|
567 |
|
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with |
568 |
< |
# their full class and namespace scopes in the documentation. If set to YES the |
568 |
> |
# their full class and namespace scopes in the documentation. If set to YES, the |
569 |
|
# scope will be hidden. |
570 |
|
# The default value is: NO. |
571 |
|
|
572 |
|
HIDE_SCOPE_NAMES = NO |
573 |
|
|
574 |
+ |
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will |
575 |
+ |
# append additional text to a page's title, such as Class Reference. If set to |
576 |
+ |
# YES the compound reference will be hidden. |
577 |
+ |
# The default value is: NO. |
578 |
+ |
|
579 |
+ |
HIDE_COMPOUND_REFERENCE= NO |
580 |
+ |
|
581 |
|
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
582 |
|
# the files that are included by a file in the documentation of that file. |
583 |
|
# The default value is: YES. |
605 |
|
|
606 |
|
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the |
607 |
|
# (detailed) documentation of file and class members alphabetically by member |
608 |
< |
# name. If set to NO the members will appear in declaration order. |
608 |
> |
# name. If set to NO, the members will appear in declaration order. |
609 |
|
# The default value is: YES. |
610 |
|
|
611 |
|
SORT_MEMBER_DOCS = YES |
612 |
|
|
613 |
|
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief |
614 |
|
# descriptions of file, namespace and class members alphabetically by member |
615 |
< |
# name. If set to NO the members will appear in declaration order. Note that |
615 |
> |
# name. If set to NO, the members will appear in declaration order. Note that |
616 |
|
# this will also influence the order of the classes in the class list. |
617 |
|
# The default value is: NO. |
618 |
|
|
657 |
|
|
658 |
|
STRICT_PROTO_MATCHING = NO |
659 |
|
|
660 |
< |
# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the |
661 |
< |
# todo list. This list is created by putting \todo commands in the |
590 |
< |
# documentation. |
660 |
> |
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo |
661 |
> |
# list. This list is created by putting \todo commands in the documentation. |
662 |
|
# The default value is: YES. |
663 |
|
|
664 |
|
GENERATE_TODOLIST = YES |
665 |
|
|
666 |
< |
# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the |
667 |
< |
# test list. This list is created by putting \test commands in the |
597 |
< |
# documentation. |
666 |
> |
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test |
667 |
> |
# list. This list is created by putting \test commands in the documentation. |
668 |
|
# The default value is: YES. |
669 |
|
|
670 |
|
GENERATE_TESTLIST = YES |
671 |
|
|
672 |
< |
# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug |
672 |
> |
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug |
673 |
|
# list. This list is created by putting \bug commands in the documentation. |
674 |
|
# The default value is: YES. |
675 |
|
|
676 |
|
GENERATE_BUGLIST = YES |
677 |
|
|
678 |
< |
# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) |
678 |
> |
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) |
679 |
|
# the deprecated list. This list is created by putting \deprecated commands in |
680 |
|
# the documentation. |
681 |
|
# The default value is: YES. |
686 |
|
# sections, marked by \if <section_label> ... \endif and \cond <section_label> |
687 |
|
# ... \endcond blocks. |
688 |
|
|
689 |
< |
ENABLED_SECTIONS = |
689 |
> |
ENABLED_SECTIONS = |
690 |
|
|
691 |
|
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the |
692 |
|
# initial value of a variable or macro / define can have for it to appear in the |
700 |
|
MAX_INITIALIZER_LINES = 30 |
701 |
|
|
702 |
|
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at |
703 |
< |
# the bottom of the documentation of classes and structs. If set to YES the list |
704 |
< |
# will mention the files that were used to generate the documentation. |
703 |
> |
# the bottom of the documentation of classes and structs. If set to YES, the |
704 |
> |
# list will mention the files that were used to generate the documentation. |
705 |
|
# The default value is: YES. |
706 |
|
|
707 |
|
SHOW_USED_FILES = YES |
728 |
|
# by doxygen. Whatever the program writes to standard output is used as the file |
729 |
|
# version. For an example see the documentation. |
730 |
|
|
731 |
< |
FILE_VERSION_FILTER = |
731 |
> |
FILE_VERSION_FILTER = |
732 |
|
|
733 |
|
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
734 |
|
# by doxygen. The layout file controls the global structure of the generated |
741 |
|
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
742 |
|
# tag is left empty. |
743 |
|
|
744 |
< |
LAYOUT_FILE = |
744 |
> |
LAYOUT_FILE = |
745 |
|
|
746 |
|
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
747 |
|
# the reference definitions. This must be a list of .bib files. The .bib |
748 |
|
# extension is automatically appended if omitted. This requires the bibtex tool |
749 |
< |
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. |
749 |
> |
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. |
750 |
|
# For LaTeX the style of the bibliography can be controlled using |
751 |
|
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
752 |
< |
# search path. Do not use file names with spaces, bibtex cannot handle them. See |
683 |
< |
# also \cite for info how to create references. |
752 |
> |
# search path. See also \cite for info how to create references. |
753 |
|
|
754 |
< |
CITE_BIB_FILES = |
754 |
> |
CITE_BIB_FILES = |
755 |
|
|
756 |
|
#--------------------------------------------------------------------------- |
757 |
|
# Configuration options related to warning and progress messages |
765 |
|
QUIET = NO |
766 |
|
|
767 |
|
# The WARNINGS tag can be used to turn on/off the warning messages that are |
768 |
< |
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES |
768 |
> |
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES |
769 |
|
# this implies that the warnings are on. |
770 |
|
# |
771 |
|
# Tip: Turn warnings on while writing the documentation. |
773 |
|
|
774 |
|
WARNINGS = YES |
775 |
|
|
776 |
< |
# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate |
776 |
> |
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate |
777 |
|
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag |
778 |
|
# will automatically be disabled. |
779 |
|
# The default value is: YES. |
790 |
|
|
791 |
|
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
792 |
|
# are documented, but have no documentation for their parameters or return |
793 |
< |
# value. If set to NO doxygen will only warn about wrong or incomplete parameter |
794 |
< |
# documentation, but not about the absence of documentation. |
793 |
> |
# value. If set to NO, doxygen will only warn about wrong or incomplete |
794 |
> |
# parameter documentation, but not about the absence of documentation. If |
795 |
> |
# EXTRACT_ALL is set to YES then this flag will automatically be disabled. |
796 |
|
# The default value is: NO. |
797 |
|
|
798 |
|
WARN_NO_PARAMDOC = NO |
799 |
|
|
800 |
+ |
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when |
801 |
+ |
# a warning is encountered. |
802 |
+ |
# The default value is: NO. |
803 |
+ |
|
804 |
+ |
WARN_AS_ERROR = NO |
805 |
+ |
|
806 |
|
# The WARN_FORMAT tag determines the format of the warning messages that doxygen |
807 |
|
# can produce. The string should contain the $file, $line, and $text tags, which |
808 |
|
# will be replaced by the file and line number from which the warning originated |
817 |
|
# messages should be written. If left blank the output is written to standard |
818 |
|
# error (stderr). |
819 |
|
|
820 |
< |
WARN_LOGFILE = |
820 |
> |
WARN_LOGFILE = |
821 |
|
|
822 |
|
#--------------------------------------------------------------------------- |
823 |
|
# Configuration options related to the input files |
826 |
|
# The INPUT tag is used to specify the files and/or directories that contain |
827 |
|
# documented source files. You may enter file names like myfile.cpp or |
828 |
|
# directories like /usr/src/myproject. Separate the files or directories with |
829 |
< |
# spaces. |
829 |
> |
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING |
830 |
|
# Note: If this tag is empty the current directory is searched. |
831 |
|
|
832 |
< |
INPUT = ../lib \ |
833 |
< |
../app/magic_application/src/aide.h |
832 |
> |
INPUT = . \ |
833 |
> |
../addin \ |
834 |
> |
../app/aide \ |
835 |
> |
../lib |
836 |
|
|
837 |
|
# This tag can be used to specify the character encoding of the source files |
838 |
|
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
839 |
|
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
840 |
< |
# documentation (see: http://www.gnu.org/software/libiconv) for the list of |
840 |
> |
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of |
841 |
|
# possible encodings. |
842 |
|
# The default value is: UTF-8. |
843 |
|
|
845 |
|
|
846 |
|
# If the value of the INPUT tag contains directories, you can use the |
847 |
|
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and |
848 |
< |
# *.h) to filter out the source-files in the directories. If left blank the |
849 |
< |
# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, |
850 |
< |
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, |
851 |
< |
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, |
852 |
< |
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, |
853 |
< |
# *.qsf, *.as and *.js. |
848 |
> |
# *.h) to filter out the source-files in the directories. |
849 |
> |
# |
850 |
> |
# Note that for custom extensions or not directly supported extensions you also |
851 |
> |
# need to set EXTENSION_MAPPING for the extension otherwise the files are not |
852 |
> |
# read by doxygen. |
853 |
> |
# |
854 |
> |
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, |
855 |
> |
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, |
856 |
> |
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, |
857 |
> |
# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), |
858 |
> |
# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen |
859 |
> |
# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, |
860 |
> |
# *.vhdl, *.ucf, *.qsf and *.ice. |
861 |
|
|
862 |
|
FILE_PATTERNS = *.c \ |
863 |
|
*.cc \ |
900 |
|
|
901 |
|
EXCLUDE = ../lib/OCC_Fonction \ |
902 |
|
../lib/geometrie/Imports \ |
903 |
< |
../lib/diamesh |
903 |
> |
../lib/diamesh \ |
904 |
> |
../addin/poly_occ/voro++-0.4.6 \ |
905 |
> |
../addin/vtkdisplay \ |
906 |
> |
../lib/solveur |
907 |
|
|
908 |
|
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or |
909 |
|
# directories that are symbolic links (a Unix file system feature) are excluded |
919 |
|
# Note that the wildcards are matched against the file with absolute path, so to |
920 |
|
# exclude all test directories for example use the pattern */test/* |
921 |
|
|
922 |
< |
EXCLUDE_PATTERNS = |
922 |
> |
EXCLUDE_PATTERNS = |
923 |
|
|
924 |
|
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
925 |
|
# (namespaces, classes, functions, etc.) that should be excluded from the |
930 |
|
# Note that the wildcards are matched against the file with absolute path, so to |
931 |
|
# exclude all test directories use the pattern */test/* |
932 |
|
|
933 |
< |
EXCLUDE_SYMBOLS = |
933 |
> |
EXCLUDE_SYMBOLS = |
934 |
|
|
935 |
|
# The EXAMPLE_PATH tag can be used to specify one or more files or directories |
936 |
|
# that contain example code fragments that are included (see the \include |
937 |
|
# command). |
938 |
|
|
939 |
< |
EXAMPLE_PATH = |
939 |
> |
EXAMPLE_PATH = |
940 |
|
|
941 |
|
# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
942 |
|
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and |
956 |
|
# that contain images that are to be included in the documentation (see the |
957 |
|
# \image command). |
958 |
|
|
959 |
< |
IMAGE_PATH = |
959 |
> |
IMAGE_PATH = ./ |
960 |
|
|
961 |
|
# The INPUT_FILTER tag can be used to specify a program that doxygen should |
962 |
|
# invoke to filter for each input file. Doxygen will invoke the filter program |
972 |
|
# Note that the filter must not add or remove lines; it is applied before the |
973 |
|
# code is scanned, but not when the output code is generated. If lines are added |
974 |
|
# or removed, the anchors will not be placed correctly. |
975 |
+ |
# |
976 |
+ |
# Note that for custom extensions or not directly supported extensions you also |
977 |
+ |
# need to set EXTENSION_MAPPING for the extension otherwise the files are not |
978 |
+ |
# properly processed by doxygen. |
979 |
|
|
980 |
< |
INPUT_FILTER = |
980 |
> |
INPUT_FILTER = |
981 |
|
|
982 |
|
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
983 |
|
# basis. Doxygen will compare the file name with each pattern and apply the |
985 |
|
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how |
986 |
|
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the |
987 |
|
# patterns match the file name, INPUT_FILTER is applied. |
988 |
+ |
# |
989 |
+ |
# Note that for custom extensions or not directly supported extensions you also |
990 |
+ |
# need to set EXTENSION_MAPPING for the extension otherwise the files are not |
991 |
+ |
# properly processed by doxygen. |
992 |
|
|
993 |
< |
FILTER_PATTERNS = |
993 |
> |
FILTER_PATTERNS = |
994 |
|
|
995 |
|
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
996 |
< |
# INPUT_FILTER ) will also be used to filter the input files that are used for |
996 |
> |
# INPUT_FILTER) will also be used to filter the input files that are used for |
997 |
|
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). |
998 |
|
# The default value is: NO. |
999 |
|
|
1005 |
|
# *.ext= (so without naming a filter). |
1006 |
|
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. |
1007 |
|
|
1008 |
< |
FILTER_SOURCE_PATTERNS = |
1008 |
> |
FILTER_SOURCE_PATTERNS = |
1009 |
|
|
1010 |
|
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that |
1011 |
|
# is part of the input, its contents will be placed on the main page |
1012 |
|
# (index.html). This can be useful if you have a project on for instance GitHub |
1013 |
|
# and want to reuse the introduction page also for the doxygen output. |
1014 |
|
|
1015 |
< |
USE_MDFILE_AS_MAINPAGE = |
1015 |
> |
USE_MDFILE_AS_MAINPAGE = |
1016 |
|
|
1017 |
|
#--------------------------------------------------------------------------- |
1018 |
|
# Configuration options related to source browsing |
1041 |
|
STRIP_CODE_COMMENTS = YES |
1042 |
|
|
1043 |
|
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
1044 |
< |
# function all documented functions referencing it will be listed. |
1044 |
> |
# entity all documented functions referencing it will be listed. |
1045 |
|
# The default value is: NO. |
1046 |
|
|
1047 |
|
REFERENCED_BY_RELATION = YES |
1053 |
|
REFERENCES_RELATION = YES |
1054 |
|
|
1055 |
|
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set |
1056 |
< |
# to YES, then the hyperlinks from functions in REFERENCES_RELATION and |
1056 |
> |
# to YES then the hyperlinks from functions in REFERENCES_RELATION and |
1057 |
|
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will |
1058 |
|
# link to the documentation. |
1059 |
|
# The default value is: YES. |
1073 |
|
# If the USE_HTAGS tag is set to YES then the references to source code will |
1074 |
|
# point to the HTML generated by the htags(1) tool instead of doxygen built-in |
1075 |
|
# source browser. The htags tool is part of GNU's global source tagging system |
1076 |
< |
# (see http://www.gnu.org/software/global/global.html). You will need version |
1076 |
> |
# (see https://www.gnu.org/software/global/global.html). You will need version |
1077 |
|
# 4.8.6 or higher. |
1078 |
|
# |
1079 |
|
# To use it do the following: |
1080 |
|
# - Install the latest version of global |
1081 |
< |
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file |
1081 |
> |
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file |
1082 |
|
# - Make sure the INPUT points to the root of the source tree |
1083 |
|
# - Run doxygen as normal |
1084 |
|
# |
1100 |
|
|
1101 |
|
VERBATIM_HEADERS = YES |
1102 |
|
|
1103 |
+ |
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the |
1104 |
+ |
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the |
1105 |
+ |
# cost of reduced performance. This can be particularly helpful with template |
1106 |
+ |
# rich C++ code for which doxygen's built-in parser lacks the necessary type |
1107 |
+ |
# information. |
1108 |
+ |
# Note: The availability of this option depends on whether or not doxygen was |
1109 |
+ |
# generated with the -Duse_libclang=ON option for CMake. |
1110 |
+ |
# The default value is: NO. |
1111 |
+ |
|
1112 |
+ |
CLANG_ASSISTED_PARSING = NO |
1113 |
+ |
|
1114 |
+ |
# If clang assisted parsing is enabled you can provide the compiler with command |
1115 |
+ |
# line options that you would normally use when invoking the compiler. Note that |
1116 |
+ |
# the include paths will already be set by doxygen for the files and directories |
1117 |
+ |
# specified with INPUT and INCLUDE_PATH. |
1118 |
+ |
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
1119 |
+ |
|
1120 |
+ |
CLANG_OPTIONS = |
1121 |
+ |
|
1122 |
+ |
# If clang assisted parsing is enabled you can provide the clang parser with the |
1123 |
+ |
# path to the compilation database (see: |
1124 |
+ |
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files |
1125 |
+ |
# were built. This is equivalent to specifying the "-p" option to a clang tool, |
1126 |
+ |
# such as clang-check. These options will then be passed to the parser. |
1127 |
+ |
# Note: The availability of this option depends on whether or not doxygen was |
1128 |
+ |
# generated with the -Duse_libclang=ON option for CMake. |
1129 |
+ |
|
1130 |
+ |
CLANG_DATABASE_PATH = |
1131 |
+ |
|
1132 |
|
#--------------------------------------------------------------------------- |
1133 |
|
# Configuration options related to the alphabetical class index |
1134 |
|
#--------------------------------------------------------------------------- |
1153 |
|
# while generating the index headers. |
1154 |
|
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
1155 |
|
|
1156 |
< |
IGNORE_PREFIX = |
1156 |
> |
IGNORE_PREFIX = |
1157 |
|
|
1158 |
|
#--------------------------------------------------------------------------- |
1159 |
|
# Configuration options related to the HTML output |
1160 |
|
#--------------------------------------------------------------------------- |
1161 |
|
|
1162 |
< |
# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output |
1162 |
> |
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output |
1163 |
|
# The default value is: YES. |
1164 |
|
|
1165 |
|
GENERATE_HTML = YES |
1197 |
|
# of the possible markers and block names see the documentation. |
1198 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1199 |
|
|
1200 |
< |
HTML_HEADER = |
1200 |
> |
HTML_HEADER = |
1201 |
|
|
1202 |
|
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each |
1203 |
|
# generated HTML page. If the tag is left blank doxygen will generate a standard |
1207 |
|
# that doxygen normally uses. |
1208 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1209 |
|
|
1210 |
< |
HTML_FOOTER = |
1210 |
> |
HTML_FOOTER = |
1211 |
|
|
1212 |
|
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style |
1213 |
|
# sheet that is used by each HTML page. It can be used to fine-tune the look of |
1219 |
|
# obsolete. |
1220 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1221 |
|
|
1222 |
< |
HTML_STYLESHEET = |
1222 |
> |
HTML_STYLESHEET = |
1223 |
|
|
1224 |
< |
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- |
1225 |
< |
# defined cascading style sheet that is included after the standard style sheets |
1224 |
> |
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
1225 |
> |
# cascading style sheets that are included after the standard style sheets |
1226 |
|
# created by doxygen. Using this option one can overrule certain style aspects. |
1227 |
|
# This is preferred over using HTML_STYLESHEET since it does not replace the |
1228 |
< |
# standard style sheet and is therefor more robust against future updates. |
1229 |
< |
# Doxygen will copy the style sheet file to the output directory. For an example |
1230 |
< |
# see the documentation. |
1228 |
> |
# standard style sheet and is therefore more robust against future updates. |
1229 |
> |
# Doxygen will copy the style sheet files to the output directory. |
1230 |
> |
# Note: The order of the extra style sheet files is of importance (e.g. the last |
1231 |
> |
# style sheet in the list overrules the setting of the previous ones in the |
1232 |
> |
# list). For an example see the documentation. |
1233 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1234 |
|
|
1235 |
< |
HTML_EXTRA_STYLESHEET = |
1235 |
> |
HTML_EXTRA_STYLESHEET = |
1236 |
|
|
1237 |
|
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
1238 |
|
# other source files which should be copied to the HTML output directory. Note |
1242 |
|
# files will be copied as-is; there are no commands or markers available. |
1243 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1244 |
|
|
1245 |
< |
HTML_EXTRA_FILES = |
1245 |
> |
HTML_EXTRA_FILES = ./logoericca.jpg |
1246 |
|
|
1247 |
|
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
1248 |
< |
# will adjust the colors in the stylesheet and background images according to |
1248 |
> |
# will adjust the colors in the style sheet and background images according to |
1249 |
|
# this color. Hue is specified as an angle on a colorwheel, see |
1250 |
< |
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value |
1250 |
> |
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value |
1251 |
|
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
1252 |
|
# purple, and 360 is red again. |
1253 |
|
# Minimum value: 0, maximum value: 359, default value: 220. |
1254 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1255 |
|
|
1256 |
< |
HTML_COLORSTYLE_HUE = 220 |
1256 |
> |
HTML_COLORSTYLE_HUE = 131 |
1257 |
|
|
1258 |
|
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors |
1259 |
|
# in the HTML output. For a value of 0 the output will use grayscales only. A |
1276 |
|
|
1277 |
|
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
1278 |
|
# page will contain the date and time when the page was generated. Setting this |
1279 |
< |
# to NO can help when comparing the output of multiple runs. |
1280 |
< |
# The default value is: YES. |
1279 |
> |
# to YES can help to show when doxygen was last run and thus if the |
1280 |
> |
# documentation is up to date. |
1281 |
> |
# The default value is: NO. |
1282 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1283 |
|
|
1284 |
|
HTML_TIMESTAMP = YES |
1285 |
|
|
1286 |
+ |
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML |
1287 |
+ |
# documentation will contain a main index with vertical navigation menus that |
1288 |
+ |
# are dynamically created via JavaScript. If disabled, the navigation index will |
1289 |
+ |
# consists of multiple levels of tabs that are statically embedded in every HTML |
1290 |
+ |
# page. Disable this option to support browsers that do not have JavaScript, |
1291 |
+ |
# like the Qt help browser. |
1292 |
+ |
# The default value is: YES. |
1293 |
+ |
# This tag requires that the tag GENERATE_HTML is set to YES. |
1294 |
+ |
|
1295 |
+ |
HTML_DYNAMIC_MENUS = YES |
1296 |
+ |
|
1297 |
|
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
1298 |
|
# documentation will contain sections that can be hidden and shown after the |
1299 |
|
# page has loaded. |
1317 |
|
|
1318 |
|
# If the GENERATE_DOCSET tag is set to YES, additional index files will be |
1319 |
|
# generated that can be used as input for Apple's Xcode 3 integrated development |
1320 |
< |
# environment (see: http://developer.apple.com/tools/xcode/), introduced with |
1321 |
< |
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a |
1320 |
> |
# environment (see: https://developer.apple.com/xcode/), introduced with OSX |
1321 |
> |
# 10.5 (Leopard). To create a documentation set, doxygen will generate a |
1322 |
|
# Makefile in the HTML output directory. Running make will produce the docset in |
1323 |
|
# that directory and running make install will install the docset in |
1324 |
|
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
1325 |
< |
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
1326 |
< |
# for more information. |
1325 |
> |
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy |
1326 |
> |
# genXcode/_index.html for more information. |
1327 |
|
# The default value is: NO. |
1328 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1329 |
|
|
1362 |
|
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
1363 |
|
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
1364 |
|
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
1365 |
< |
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
1365 |
> |
# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
1366 |
|
# Windows. |
1367 |
|
# |
1368 |
|
# The HTML Help Workshop contains a compiler that can convert all HTML output |
1382 |
|
# written to the html output directory. |
1383 |
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1384 |
|
|
1385 |
< |
CHM_FILE = |
1385 |
> |
CHM_FILE = |
1386 |
|
|
1387 |
|
# The HHC_LOCATION tag can be used to specify the location (absolute path |
1388 |
< |
# including file name) of the HTML help compiler ( hhc.exe). If non-empty |
1388 |
> |
# including file name) of the HTML help compiler (hhc.exe). If non-empty, |
1389 |
|
# doxygen will try to run the HTML help compiler on the generated index.hhp. |
1390 |
|
# The file has to be specified with full path. |
1391 |
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1392 |
|
|
1393 |
< |
HHC_LOCATION = |
1393 |
> |
HHC_LOCATION = |
1394 |
|
|
1395 |
< |
# The GENERATE_CHI flag controls if a separate .chi index file is generated ( |
1396 |
< |
# YES) or that it should be included in the master .chm file ( NO). |
1395 |
> |
# The GENERATE_CHI flag controls if a separate .chi index file is generated |
1396 |
> |
# (YES) or that it should be included in the master .chm file (NO). |
1397 |
|
# The default value is: NO. |
1398 |
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1399 |
|
|
1400 |
|
GENERATE_CHI = NO |
1401 |
|
|
1402 |
< |
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) |
1402 |
> |
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) |
1403 |
|
# and project file content. |
1404 |
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1405 |
|
|
1406 |
< |
CHM_INDEX_ENCODING = |
1406 |
> |
CHM_INDEX_ENCODING = |
1407 |
|
|
1408 |
< |
# The BINARY_TOC flag controls whether a binary table of contents is generated ( |
1409 |
< |
# YES) or a normal table of contents ( NO) in the .chm file. |
1408 |
> |
# The BINARY_TOC flag controls whether a binary table of contents is generated |
1409 |
> |
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it |
1410 |
> |
# enables the Previous and Next buttons. |
1411 |
|
# The default value is: NO. |
1412 |
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1413 |
|
|
1434 |
|
# the HTML output folder. |
1435 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
1436 |
|
|
1437 |
< |
QCH_FILE = |
1437 |
> |
QCH_FILE = |
1438 |
|
|
1439 |
|
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
1440 |
|
# Project output. For more information please see Qt Help Project / Namespace |
1441 |
< |
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). |
1441 |
> |
# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). |
1442 |
|
# The default value is: org.doxygen.Project. |
1443 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
1444 |
|
|
1446 |
|
|
1447 |
|
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
1448 |
|
# Help Project output. For more information please see Qt Help Project / Virtual |
1449 |
< |
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- |
1449 |
> |
# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- |
1450 |
|
# folders). |
1451 |
|
# The default value is: doc. |
1452 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
1455 |
|
|
1456 |
|
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
1457 |
|
# filter to add. For more information please see Qt Help Project / Custom |
1458 |
< |
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
1458 |
> |
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- |
1459 |
|
# filters). |
1460 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
1461 |
|
|
1462 |
< |
QHP_CUST_FILTER_NAME = |
1462 |
> |
QHP_CUST_FILTER_NAME = |
1463 |
|
|
1464 |
|
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
1465 |
|
# custom filter to add. For more information please see Qt Help Project / Custom |
1466 |
< |
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
1466 |
> |
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- |
1467 |
|
# filters). |
1468 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
1469 |
|
|
1470 |
< |
QHP_CUST_FILTER_ATTRS = |
1470 |
> |
QHP_CUST_FILTER_ATTRS = |
1471 |
|
|
1472 |
|
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
1473 |
|
# project's filter section matches. Qt Help Project / Filter Attributes (see: |
1474 |
< |
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
1474 |
> |
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). |
1475 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
1476 |
|
|
1477 |
< |
QHP_SECT_FILTER_ATTRS = |
1477 |
> |
QHP_SECT_FILTER_ATTRS = |
1478 |
|
|
1479 |
|
# The QHG_LOCATION tag can be used to specify the location of Qt's |
1480 |
|
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the |
1481 |
|
# generated .qhp file. |
1482 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
1483 |
|
|
1484 |
< |
QHG_LOCATION = |
1484 |
> |
QHG_LOCATION = |
1485 |
|
|
1486 |
|
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be |
1487 |
|
# generated, together with the HTML files, they form an Eclipse help plugin. To |
1520 |
|
# index structure (just like the one that is generated for HTML Help). For this |
1521 |
|
# to work a browser that supports JavaScript, DHTML, CSS and frames is required |
1522 |
|
# (i.e. any modern browser). Windows users are probably better off using the |
1523 |
< |
# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can |
1523 |
> |
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can |
1524 |
|
# further fine-tune the look of the index. As an example, the default style |
1525 |
|
# sheet generated by doxygen has an example that shows how to put an image at |
1526 |
|
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has |
1548 |
|
|
1549 |
|
TREEVIEW_WIDTH = 250 |
1550 |
|
|
1551 |
< |
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to |
1551 |
> |
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to |
1552 |
|
# external symbols imported via tag files in a separate window. |
1553 |
|
# The default value is: NO. |
1554 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1564 |
|
|
1565 |
|
FORMULA_FONTSIZE = 10 |
1566 |
|
|
1567 |
< |
# Use the FORMULA_TRANPARENT tag to determine whether or not the images |
1567 |
> |
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images |
1568 |
|
# generated for formulas are transparent PNGs. Transparent PNGs are not |
1569 |
|
# supported properly for IE 6.0, but are supported on all modern browsers. |
1570 |
|
# |
1575 |
|
|
1576 |
|
FORMULA_TRANSPARENT = YES |
1577 |
|
|
1578 |
+ |
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands |
1579 |
+ |
# to create new LaTeX commands to be used in formulas as building blocks. See |
1580 |
+ |
# the section "Including formulas" for details. |
1581 |
+ |
|
1582 |
+ |
FORMULA_MACROFILE = |
1583 |
+ |
|
1584 |
|
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
1585 |
< |
# http://www.mathjax.org) which uses client side Javascript for the rendering |
1586 |
< |
# instead of using prerendered bitmaps. Use this if you do not have LaTeX |
1585 |
> |
# https://www.mathjax.org) which uses client side JavaScript for the rendering |
1586 |
> |
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX |
1587 |
|
# installed or if you want to formulas look prettier in the HTML output. When |
1588 |
|
# enabled you may also need to install MathJax separately and configure the path |
1589 |
|
# to it using the MATHJAX_RELPATH option. |
1609 |
|
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
1610 |
|
# Content Delivery Network so you can quickly see the result without installing |
1611 |
|
# MathJax. However, it is strongly recommended to install a local copy of |
1612 |
< |
# MathJax from http://www.mathjax.org before deployment. |
1613 |
< |
# The default value is: http://cdn.mathjax.org/mathjax/latest. |
1612 |
> |
# MathJax from https://www.mathjax.org before deployment. |
1613 |
> |
# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. |
1614 |
|
# This tag requires that the tag USE_MATHJAX is set to YES. |
1615 |
|
|
1616 |
|
MATHJAX_RELPATH = http://www.mathjax.org/mathjax |
1620 |
|
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
1621 |
|
# This tag requires that the tag USE_MATHJAX is set to YES. |
1622 |
|
|
1623 |
< |
MATHJAX_EXTENSIONS = |
1623 |
> |
MATHJAX_EXTENSIONS = |
1624 |
|
|
1625 |
|
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
1626 |
|
# of code that will be used on startup of the MathJax code. See the MathJax site |
1628 |
|
# example see the documentation. |
1629 |
|
# This tag requires that the tag USE_MATHJAX is set to YES. |
1630 |
|
|
1631 |
< |
MATHJAX_CODEFILE = |
1631 |
> |
MATHJAX_CODEFILE = |
1632 |
|
|
1633 |
|
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for |
1634 |
|
# the HTML output. The underlying search engine uses javascript and DHTML and |
1652 |
|
SEARCHENGINE = YES |
1653 |
|
|
1654 |
|
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
1655 |
< |
# implemented using a web server instead of a web client using Javascript. There |
1656 |
< |
# are two flavours of web server based searching depending on the |
1657 |
< |
# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for |
1658 |
< |
# searching and an index file used by the script. When EXTERNAL_SEARCH is |
1659 |
< |
# enabled the indexing and searching needs to be provided by external tools. See |
1660 |
< |
# the section "External Indexing and Searching" for details. |
1655 |
> |
# implemented using a web server instead of a web client using JavaScript. There |
1656 |
> |
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH |
1657 |
> |
# setting. When disabled, doxygen will generate a PHP script for searching and |
1658 |
> |
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing |
1659 |
> |
# and searching needs to be provided by external tools. See the section |
1660 |
> |
# "External Indexing and Searching" for details. |
1661 |
|
# The default value is: NO. |
1662 |
|
# This tag requires that the tag SEARCHENGINE is set to YES. |
1663 |
|
|
1669 |
|
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the |
1670 |
|
# search results. |
1671 |
|
# |
1672 |
< |
# Doxygen ships with an example indexer ( doxyindexer) and search engine |
1672 |
> |
# Doxygen ships with an example indexer (doxyindexer) and search engine |
1673 |
|
# (doxysearch.cgi) which are based on the open source search engine library |
1674 |
< |
# Xapian (see: http://xapian.org/). |
1674 |
> |
# Xapian (see: https://xapian.org/). |
1675 |
|
# |
1676 |
|
# See the section "External Indexing and Searching" for details. |
1677 |
|
# The default value is: NO. |
1682 |
|
# The SEARCHENGINE_URL should point to a search engine hosted by a web server |
1683 |
|
# which will return the search results when EXTERNAL_SEARCH is enabled. |
1684 |
|
# |
1685 |
< |
# Doxygen ships with an example indexer ( doxyindexer) and search engine |
1685 |
> |
# Doxygen ships with an example indexer (doxyindexer) and search engine |
1686 |
|
# (doxysearch.cgi) which are based on the open source search engine library |
1687 |
< |
# Xapian (see: http://xapian.org/). See the section "External Indexing and |
1687 |
> |
# Xapian (see: https://xapian.org/). See the section "External Indexing and |
1688 |
|
# Searching" for details. |
1689 |
|
# This tag requires that the tag SEARCHENGINE is set to YES. |
1690 |
|
|
1691 |
< |
SEARCHENGINE_URL = |
1691 |
> |
SEARCHENGINE_URL = |
1692 |
|
|
1693 |
|
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed |
1694 |
|
# search data is written to a file for indexing by an external tool. With the |
1704 |
|
# projects and redirect the results back to the right project. |
1705 |
|
# This tag requires that the tag SEARCHENGINE is set to YES. |
1706 |
|
|
1707 |
< |
EXTERNAL_SEARCH_ID = |
1707 |
> |
EXTERNAL_SEARCH_ID = |
1708 |
|
|
1709 |
|
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen |
1710 |
|
# projects other than the one defined by this configuration file, but that are |
1714 |
|
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... |
1715 |
|
# This tag requires that the tag SEARCHENGINE is set to YES. |
1716 |
|
|
1717 |
< |
EXTRA_SEARCH_MAPPINGS = |
1717 |
> |
EXTRA_SEARCH_MAPPINGS = |
1718 |
|
|
1719 |
|
#--------------------------------------------------------------------------- |
1720 |
|
# Configuration options related to the LaTeX output |
1721 |
|
#--------------------------------------------------------------------------- |
1722 |
|
|
1723 |
< |
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. |
1723 |
> |
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. |
1724 |
|
# The default value is: YES. |
1725 |
|
|
1726 |
|
GENERATE_LATEX = NO |
1736 |
|
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
1737 |
|
# invoked. |
1738 |
|
# |
1739 |
< |
# Note that when enabling USE_PDFLATEX this option is only used for generating |
1740 |
< |
# bitmaps for formulas in the HTML output, but not in the Makefile that is |
1741 |
< |
# written to the output directory. |
1742 |
< |
# The default file is: latex. |
1739 |
> |
# Note that when not enabling USE_PDFLATEX the default is latex when enabling |
1740 |
> |
# USE_PDFLATEX the default is pdflatex and when in the later case latex is |
1741 |
> |
# chosen this is overwritten by pdflatex. For specific output languages the |
1742 |
> |
# default can have been set differently, this depends on the implementation of |
1743 |
> |
# the output language. |
1744 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1745 |
|
|
1746 |
|
LATEX_CMD_NAME = latex |
1747 |
|
|
1748 |
|
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
1749 |
|
# index for LaTeX. |
1750 |
+ |
# Note: This tag is used in the Makefile / make.bat. |
1751 |
+ |
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file |
1752 |
+ |
# (.tex). |
1753 |
|
# The default file is: makeindex. |
1754 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1755 |
|
|
1756 |
|
MAKEINDEX_CMD_NAME = makeindex |
1757 |
|
|
1758 |
< |
# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX |
1758 |
> |
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to |
1759 |
> |
# generate index for LaTeX. In case there is no backslash (\) as first character |
1760 |
> |
# it will be automatically added in the LaTeX code. |
1761 |
> |
# Note: This tag is used in the generated output file (.tex). |
1762 |
> |
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. |
1763 |
> |
# The default value is: makeindex. |
1764 |
> |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1765 |
> |
|
1766 |
> |
LATEX_MAKEINDEX_CMD = makeindex |
1767 |
> |
|
1768 |
> |
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX |
1769 |
|
# documents. This may be useful for small projects and may help to save some |
1770 |
|
# trees in general. |
1771 |
|
# The default value is: NO. |
1783 |
|
PAPER_TYPE = a4wide |
1784 |
|
|
1785 |
|
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names |
1786 |
< |
# that should be included in the LaTeX output. To get the times font for |
1787 |
< |
# instance you can specify |
1788 |
< |
# EXTRA_PACKAGES=times |
1786 |
> |
# that should be included in the LaTeX output. The package can be specified just |
1787 |
> |
# by its name or with the correct syntax as to be used with the LaTeX |
1788 |
> |
# \usepackage command. To get the times font for instance you can specify : |
1789 |
> |
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} |
1790 |
> |
# To use the option intlimits with the amsmath package you can specify: |
1791 |
> |
# EXTRA_PACKAGES=[intlimits]{amsmath} |
1792 |
|
# If left blank no extra packages will be included. |
1793 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1794 |
|
|
1795 |
< |
EXTRA_PACKAGES = |
1795 |
> |
EXTRA_PACKAGES = |
1796 |
|
|
1797 |
|
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the |
1798 |
|
# generated LaTeX document. The header should contain everything until the first |
1802 |
|
# |
1803 |
|
# Note: Only use a user-defined header if you know what you are doing! The |
1804 |
|
# following commands have a special meaning inside the header: $title, |
1805 |
< |
# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will |
1806 |
< |
# replace them by respectively the title of the page, the current date and time, |
1807 |
< |
# only the current date, the version number of doxygen, the project name (see |
1808 |
< |
# PROJECT_NAME), or the project number (see PROJECT_NUMBER). |
1805 |
> |
# $datetime, $date, $doxygenversion, $projectname, $projectnumber, |
1806 |
> |
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty |
1807 |
> |
# string, for the replacement values of the other commands the user is referred |
1808 |
> |
# to HTML_HEADER. |
1809 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1810 |
|
|
1811 |
< |
LATEX_HEADER = |
1811 |
> |
LATEX_HEADER = |
1812 |
|
|
1813 |
|
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the |
1814 |
|
# generated LaTeX document. The footer should contain everything after the last |
1815 |
< |
# chapter. If it is left blank doxygen will generate a standard footer. |
1815 |
> |
# chapter. If it is left blank doxygen will generate a standard footer. See |
1816 |
> |
# LATEX_HEADER for more information on how to generate a default footer and what |
1817 |
> |
# special commands can be used inside the footer. |
1818 |
|
# |
1819 |
|
# Note: Only use a user-defined footer if you know what you are doing! |
1820 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1821 |
|
|
1822 |
< |
LATEX_FOOTER = |
1822 |
> |
LATEX_FOOTER = |
1823 |
> |
|
1824 |
> |
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
1825 |
> |
# LaTeX style sheets that are included after the standard style sheets created |
1826 |
> |
# by doxygen. Using this option one can overrule certain style aspects. Doxygen |
1827 |
> |
# will copy the style sheet files to the output directory. |
1828 |
> |
# Note: The order of the extra style sheet files is of importance (e.g. the last |
1829 |
> |
# style sheet in the list overrules the setting of the previous ones in the |
1830 |
> |
# list). |
1831 |
> |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1832 |
> |
|
1833 |
> |
LATEX_EXTRA_STYLESHEET = |
1834 |
|
|
1835 |
|
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
1836 |
|
# other source files which should be copied to the LATEX_OUTPUT output |
1838 |
|
# markers available. |
1839 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1840 |
|
|
1841 |
< |
LATEX_EXTRA_FILES = |
1841 |
> |
LATEX_EXTRA_FILES = |
1842 |
|
|
1843 |
|
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is |
1844 |
|
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will |
1849 |
|
|
1850 |
|
PDF_HYPERLINKS = NO |
1851 |
|
|
1852 |
< |
# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
1853 |
< |
# the PDF file directly from the LaTeX files. Set this option to YES to get a |
1852 |
> |
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
1853 |
> |
# the PDF file directly from the LaTeX files. Set this option to YES, to get a |
1854 |
|
# higher quality PDF documentation. |
1855 |
|
# The default value is: YES. |
1856 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1885 |
|
|
1886 |
|
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
1887 |
|
# bibliography, e.g. plainnat, or ieeetr. See |
1888 |
< |
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
1888 |
> |
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
1889 |
|
# The default value is: plain. |
1890 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1891 |
|
|
1892 |
|
LATEX_BIB_STYLE = plain |
1893 |
|
|
1894 |
+ |
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated |
1895 |
+ |
# page will contain the date and time when the page was generated. Setting this |
1896 |
+ |
# to NO can help when comparing the output of multiple runs. |
1897 |
+ |
# The default value is: NO. |
1898 |
+ |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1899 |
+ |
|
1900 |
+ |
LATEX_TIMESTAMP = NO |
1901 |
+ |
|
1902 |
+ |
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) |
1903 |
+ |
# path from which the emoji images will be read. If a relative path is entered, |
1904 |
+ |
# it will be relative to the LATEX_OUTPUT directory. If left blank the |
1905 |
+ |
# LATEX_OUTPUT directory will be used. |
1906 |
+ |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1907 |
+ |
|
1908 |
+ |
LATEX_EMOJI_DIRECTORY = |
1909 |
+ |
|
1910 |
|
#--------------------------------------------------------------------------- |
1911 |
|
# Configuration options related to the RTF output |
1912 |
|
#--------------------------------------------------------------------------- |
1913 |
|
|
1914 |
< |
# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The |
1914 |
> |
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The |
1915 |
|
# RTF output is optimized for Word 97 and may not look too pretty with other RTF |
1916 |
|
# readers/editors. |
1917 |
|
# The default value is: NO. |
1926 |
|
|
1927 |
|
RTF_OUTPUT = rtf |
1928 |
|
|
1929 |
< |
# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF |
1929 |
> |
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF |
1930 |
|
# documents. This may be useful for small projects and may help to save some |
1931 |
|
# trees in general. |
1932 |
|
# The default value is: NO. |
1946 |
|
|
1947 |
|
RTF_HYPERLINKS = NO |
1948 |
|
|
1949 |
< |
# Load stylesheet definitions from file. Syntax is similar to doxygen's config |
1950 |
< |
# file, i.e. a series of assignments. You only have to provide replacements, |
1951 |
< |
# missing definitions are set to their default value. |
1949 |
> |
# Load stylesheet definitions from file. Syntax is similar to doxygen's |
1950 |
> |
# configuration file, i.e. a series of assignments. You only have to provide |
1951 |
> |
# replacements, missing definitions are set to their default value. |
1952 |
|
# |
1953 |
|
# See also section "Doxygen usage" for information on how to generate the |
1954 |
|
# default style sheet that doxygen normally uses. |
1955 |
|
# This tag requires that the tag GENERATE_RTF is set to YES. |
1956 |
|
|
1957 |
< |
RTF_STYLESHEET_FILE = |
1957 |
> |
RTF_STYLESHEET_FILE = |
1958 |
|
|
1959 |
|
# Set optional variables used in the generation of an RTF document. Syntax is |
1960 |
< |
# similar to doxygen's config file. A template extensions file can be generated |
1961 |
< |
# using doxygen -e rtf extensionFile. |
1960 |
> |
# similar to doxygen's configuration file. A template extensions file can be |
1961 |
> |
# generated using doxygen -e rtf extensionFile. |
1962 |
> |
# This tag requires that the tag GENERATE_RTF is set to YES. |
1963 |
> |
|
1964 |
> |
RTF_EXTENSIONS_FILE = |
1965 |
> |
|
1966 |
> |
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code |
1967 |
> |
# with syntax highlighting in the RTF output. |
1968 |
> |
# |
1969 |
> |
# Note that which sources are shown also depends on other settings such as |
1970 |
> |
# SOURCE_BROWSER. |
1971 |
> |
# The default value is: NO. |
1972 |
|
# This tag requires that the tag GENERATE_RTF is set to YES. |
1973 |
|
|
1974 |
< |
RTF_EXTENSIONS_FILE = |
1974 |
> |
RTF_SOURCE_CODE = NO |
1975 |
|
|
1976 |
|
#--------------------------------------------------------------------------- |
1977 |
|
# Configuration options related to the man page output |
1978 |
|
#--------------------------------------------------------------------------- |
1979 |
|
|
1980 |
< |
# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for |
1980 |
> |
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for |
1981 |
|
# classes and files. |
1982 |
|
# The default value is: NO. |
1983 |
|
|
2001 |
|
|
2002 |
|
MAN_EXTENSION = .3 |
2003 |
|
|
2004 |
+ |
# The MAN_SUBDIR tag determines the name of the directory created within |
2005 |
+ |
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by |
2006 |
+ |
# MAN_EXTENSION with the initial . removed. |
2007 |
+ |
# This tag requires that the tag GENERATE_MAN is set to YES. |
2008 |
+ |
|
2009 |
+ |
MAN_SUBDIR = |
2010 |
+ |
|
2011 |
|
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it |
2012 |
|
# will generate one additional man file for each entity documented in the real |
2013 |
|
# man page(s). These additional files only source the real man page, but without |
2021 |
|
# Configuration options related to the XML output |
2022 |
|
#--------------------------------------------------------------------------- |
2023 |
|
|
2024 |
< |
# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that |
2024 |
> |
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that |
2025 |
|
# captures the structure of the code including all documentation. |
2026 |
|
# The default value is: NO. |
2027 |
|
|
2035 |
|
|
2036 |
|
XML_OUTPUT = xml |
2037 |
|
|
2038 |
< |
# 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 |
2038 |
> |
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program |
2039 |
|
# listings (including syntax highlighting and cross-referencing information) to |
2040 |
|
# the XML output. Note that enabling this will significantly increase the size |
2041 |
|
# of the XML output. |
2044 |
|
|
2045 |
|
XML_PROGRAMLISTING = YES |
2046 |
|
|
2047 |
+ |
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include |
2048 |
+ |
# namespace members in file scope as well, matching the HTML output. |
2049 |
+ |
# The default value is: NO. |
2050 |
+ |
# This tag requires that the tag GENERATE_XML is set to YES. |
2051 |
+ |
|
2052 |
+ |
XML_NS_MEMB_FILE_SCOPE = NO |
2053 |
+ |
|
2054 |
|
#--------------------------------------------------------------------------- |
2055 |
|
# Configuration options related to the DOCBOOK output |
2056 |
|
#--------------------------------------------------------------------------- |
2057 |
|
|
2058 |
< |
# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files |
2058 |
> |
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files |
2059 |
|
# that can be used to generate PDF. |
2060 |
|
# The default value is: NO. |
2061 |
|
|
2069 |
|
|
2070 |
|
DOCBOOK_OUTPUT = docbook |
2071 |
|
|
2072 |
+ |
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the |
2073 |
+ |
# program listings (including syntax highlighting and cross-referencing |
2074 |
+ |
# information) to the DOCBOOK output. Note that enabling this will significantly |
2075 |
+ |
# increase the size of the DOCBOOK output. |
2076 |
+ |
# The default value is: NO. |
2077 |
+ |
# This tag requires that the tag GENERATE_DOCBOOK is set to YES. |
2078 |
+ |
|
2079 |
+ |
DOCBOOK_PROGRAMLISTING = NO |
2080 |
+ |
|
2081 |
|
#--------------------------------------------------------------------------- |
2082 |
|
# Configuration options for the AutoGen Definitions output |
2083 |
|
#--------------------------------------------------------------------------- |
2084 |
|
|
2085 |
< |
# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen |
2086 |
< |
# Definitions (see http://autogen.sf.net) file that captures the structure of |
2087 |
< |
# the code including all documentation. Note that this feature is still |
2088 |
< |
# experimental and incomplete at the moment. |
2085 |
> |
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
2086 |
> |
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures |
2087 |
> |
# the structure of the code including all documentation. Note that this feature |
2088 |
> |
# is still experimental and incomplete at the moment. |
2089 |
|
# The default value is: NO. |
2090 |
|
|
2091 |
|
GENERATE_AUTOGEN_DEF = NO |
2094 |
|
# Configuration options related to the Perl module output |
2095 |
|
#--------------------------------------------------------------------------- |
2096 |
|
|
2097 |
< |
# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module |
2097 |
> |
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module |
2098 |
|
# file that captures the structure of the code including all documentation. |
2099 |
|
# |
2100 |
|
# Note that this feature is still experimental and incomplete at the moment. |
2102 |
|
|
2103 |
|
GENERATE_PERLMOD = NO |
2104 |
|
|
2105 |
< |
# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary |
2105 |
> |
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary |
2106 |
|
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI |
2107 |
|
# output from the Perl module output. |
2108 |
|
# The default value is: NO. |
2110 |
|
|
2111 |
|
PERLMOD_LATEX = NO |
2112 |
|
|
2113 |
< |
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely |
2113 |
> |
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely |
2114 |
|
# formatted so it can be parsed by a human reader. This is useful if you want to |
2115 |
< |
# understand what is going on. On the other hand, if this tag is set to NO the |
2115 |
> |
# understand what is going on. On the other hand, if this tag is set to NO, the |
2116 |
|
# size of the Perl module output will be much smaller and Perl will parse it |
2117 |
|
# just the same. |
2118 |
|
# The default value is: YES. |
2126 |
|
# overwrite each other's variables. |
2127 |
|
# This tag requires that the tag GENERATE_PERLMOD is set to YES. |
2128 |
|
|
2129 |
< |
PERLMOD_MAKEVAR_PREFIX = |
2129 |
> |
PERLMOD_MAKEVAR_PREFIX = |
2130 |
|
|
2131 |
|
#--------------------------------------------------------------------------- |
2132 |
|
# Configuration options related to the preprocessor |
2133 |
|
#--------------------------------------------------------------------------- |
2134 |
|
|
2135 |
< |
# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all |
2135 |
> |
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all |
2136 |
|
# C-preprocessor directives found in the sources and include files. |
2137 |
|
# The default value is: YES. |
2138 |
|
|
2139 |
|
ENABLE_PREPROCESSING = YES |
2140 |
|
|
2141 |
< |
# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names |
2142 |
< |
# in the source code. If set to NO only conditional compilation will be |
2141 |
> |
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names |
2142 |
> |
# in the source code. If set to NO, only conditional compilation will be |
2143 |
|
# performed. Macro expansion can be done in a controlled way by setting |
2144 |
|
# EXPAND_ONLY_PREDEF to YES. |
2145 |
|
# The default value is: NO. |
2155 |
|
|
2156 |
|
EXPAND_ONLY_PREDEF = NO |
2157 |
|
|
2158 |
< |
# If the SEARCH_INCLUDES tag is set to YES the includes files in the |
2158 |
> |
# If the SEARCH_INCLUDES tag is set to YES, the include files in the |
2159 |
|
# INCLUDE_PATH will be searched if a #include is found. |
2160 |
|
# The default value is: YES. |
2161 |
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2167 |
|
# preprocessor. |
2168 |
|
# This tag requires that the tag SEARCH_INCLUDES is set to YES. |
2169 |
|
|
2170 |
< |
INCLUDE_PATH = |
2170 |
> |
INCLUDE_PATH = |
2171 |
|
|
2172 |
|
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
2173 |
|
# patterns (like *.h and *.hpp) to filter out the header-files in the |
2175 |
|
# used. |
2176 |
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2177 |
|
|
2178 |
< |
INCLUDE_FILE_PATTERNS = |
2178 |
> |
INCLUDE_FILE_PATTERNS = |
2179 |
|
|
2180 |
|
# The PREDEFINED tag can be used to specify one or more macro names that are |
2181 |
|
# defined before the preprocessor is started (similar to the -D option of e.g. |
2188 |
|
PREDEFINED = BREP_SAT \ |
2189 |
|
BREP_STEP \ |
2190 |
|
BREP_SLD \ |
2191 |
< |
BREP_OCC |
2191 |
> |
BREP_OCC \ |
2192 |
> |
ALL_OCC |
2193 |
|
|
2194 |
|
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this |
2195 |
|
# tag can be used to specify a list of macro names that should be expanded. The |
2198 |
|
# definition found in the source code. |
2199 |
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2200 |
|
|
2201 |
< |
EXPAND_AS_DEFINED = |
2201 |
> |
EXPAND_AS_DEFINED = |
2202 |
|
|
2203 |
|
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will |
2204 |
< |
# remove all refrences to function-like macros that are alone on a line, have an |
2205 |
< |
# all uppercase name, and do not end with a semicolon. Such function macros are |
2206 |
< |
# typically used for boiler-plate code, and will confuse the parser if not |
2204 |
> |
# remove all references to function-like macros that are alone on a line, have |
2205 |
> |
# an all uppercase name, and do not end with a semicolon. Such function macros |
2206 |
> |
# are typically used for boiler-plate code, and will confuse the parser if not |
2207 |
|
# removed. |
2208 |
|
# The default value is: YES. |
2209 |
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
2223 |
|
# where loc1 and loc2 can be relative or absolute paths or URLs. See the |
2224 |
|
# section "Linking to external documentation" for more information about the use |
2225 |
|
# of tag files. |
2226 |
< |
# Note: Each tag file must have an unique name (where the name does NOT include |
2226 |
> |
# Note: Each tag file must have a unique name (where the name does NOT include |
2227 |
|
# the path). If a tag file is not located in the directory in which doxygen is |
2228 |
|
# run, you must also specify the path to the tagfile here. |
2229 |
|
|
2230 |
< |
TAGFILES = |
2230 |
> |
TAGFILES = |
2231 |
|
|
2232 |
|
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a |
2233 |
|
# tag file that is based on the input files it reads. See section "Linking to |
2234 |
|
# external documentation" for more information about the usage of tag files. |
2235 |
|
|
2236 |
< |
GENERATE_TAGFILE = |
2236 |
> |
GENERATE_TAGFILE = |
2237 |
|
|
2238 |
< |
# If the ALLEXTERNALS tag is set to YES all external class will be listed in the |
2239 |
< |
# class index. If set to NO only the inherited external classes will be listed. |
2238 |
> |
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in |
2239 |
> |
# the class index. If set to NO, only the inherited external classes will be |
2240 |
> |
# listed. |
2241 |
|
# The default value is: NO. |
2242 |
|
|
2243 |
|
ALLEXTERNALS = NO |
2244 |
|
|
2245 |
< |
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in |
2246 |
< |
# the modules index. If set to NO, only the current project's groups will be |
2245 |
> |
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed |
2246 |
> |
# in the modules index. If set to NO, only the current project's groups will be |
2247 |
|
# listed. |
2248 |
|
# The default value is: YES. |
2249 |
|
|
2250 |
|
EXTERNAL_GROUPS = YES |
2251 |
|
|
2252 |
< |
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in |
2252 |
> |
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in |
2253 |
|
# the related pages index. If set to NO, only the current project's pages will |
2254 |
|
# be listed. |
2255 |
|
# The default value is: YES. |
2256 |
|
|
2257 |
|
EXTERNAL_PAGES = YES |
2258 |
|
|
2044 |
– |
# The PERL_PATH should be the absolute path and name of the perl script |
2045 |
– |
# interpreter (i.e. the result of 'which perl'). |
2046 |
– |
# The default file (with absolute path) is: /usr/bin/perl. |
2047 |
– |
|
2048 |
– |
PERL_PATH = /usr/bin/perl |
2049 |
– |
|
2259 |
|
#--------------------------------------------------------------------------- |
2260 |
|
# Configuration options related to the dot tool |
2261 |
|
#--------------------------------------------------------------------------- |
2262 |
|
|
2263 |
< |
# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram |
2263 |
> |
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram |
2264 |
|
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to |
2265 |
|
# NO turns the diagrams off. Note that this option also works with HAVE_DOT |
2266 |
|
# disabled, but it is recommended to install and use dot, since it yields more |
2267 |
|
# powerful graphs. |
2268 |
|
# The default value is: YES. |
2269 |
|
|
2270 |
< |
CLASS_DIAGRAMS = NO |
2062 |
< |
|
2063 |
< |
# You can define message sequence charts within doxygen comments using the \msc |
2064 |
< |
# command. Doxygen will then run the mscgen tool (see: |
2065 |
< |
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the |
2066 |
< |
# documentation. The MSCGEN_PATH tag allows you to specify the directory where |
2067 |
< |
# the mscgen tool resides. If left empty the tool is assumed to be found in the |
2068 |
< |
# default search path. |
2069 |
< |
|
2070 |
< |
MSCGEN_PATH = |
2270 |
> |
CLASS_DIAGRAMS = YES |
2271 |
|
|
2272 |
|
# You can include diagrams made with dia in doxygen documentation. Doxygen will |
2273 |
|
# then run dia to produce the diagram and insert it in the documentation. The |
2274 |
|
# DIA_PATH tag allows you to specify the directory where the dia binary resides. |
2275 |
|
# If left empty dia is assumed to be found in the default search path. |
2276 |
|
|
2277 |
< |
DIA_PATH = |
2277 |
> |
DIA_PATH = |
2278 |
|
|
2279 |
< |
# If set to YES, the inheritance and collaboration graphs will hide inheritance |
2279 |
> |
# If set to YES the inheritance and collaboration graphs will hide inheritance |
2280 |
|
# and usage relations if the target is undocumented or is not a class. |
2281 |
|
# The default value is: YES. |
2282 |
|
|
2287 |
|
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
2288 |
|
# Bell Labs. The other options in this section have no effect if this option is |
2289 |
|
# set to NO |
2290 |
< |
# The default value is: NO. |
2290 |
> |
# The default value is: YES. |
2291 |
|
|
2292 |
|
HAVE_DOT = YES |
2293 |
|
|
2301 |
|
|
2302 |
|
DOT_NUM_THREADS = 0 |
2303 |
|
|
2304 |
< |
# When you want a differently looking font n the dot files that doxygen |
2304 |
> |
# When you want a differently looking font in the dot files that doxygen |
2305 |
|
# generates you can specify the font name using DOT_FONTNAME. You need to make |
2306 |
|
# sure dot is able to find the font, which can be done by putting it in a |
2307 |
|
# standard location or by setting the DOTFONTPATH environment variable or by |
2323 |
|
# the path where dot can find it using this tag. |
2324 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
2325 |
|
|
2326 |
< |
DOT_FONTPATH = |
2326 |
> |
DOT_FONTPATH = |
2327 |
|
|
2328 |
|
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for |
2329 |
|
# each documented class showing the direct and indirect inheritance relations. |
2349 |
|
|
2350 |
|
GROUP_GRAPHS = YES |
2351 |
|
|
2352 |
< |
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
2352 |
> |
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and |
2353 |
|
# collaboration diagrams in a style similar to the OMG's Unified Modeling |
2354 |
|
# Language. |
2355 |
|
# The default value is: NO. |
2401 |
|
# |
2402 |
|
# Note that enabling this option will significantly increase the time of a run. |
2403 |
|
# So in most cases it will be better to enable call graphs for selected |
2404 |
< |
# functions only using the \callgraph command. |
2404 |
> |
# functions only using the \callgraph command. Disabling a call graph can be |
2405 |
> |
# accomplished by means of the command \hidecallgraph. |
2406 |
|
# The default value is: NO. |
2407 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
2408 |
|
|
2413 |
|
# |
2414 |
|
# Note that enabling this option will significantly increase the time of a run. |
2415 |
|
# So in most cases it will be better to enable caller graphs for selected |
2416 |
< |
# functions only using the \callergraph command. |
2416 |
> |
# functions only using the \callergraph command. Disabling a caller graph can be |
2417 |
> |
# accomplished by means of the command \hidecallergraph. |
2418 |
|
# The default value is: NO. |
2419 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
2420 |
|
|
2437 |
|
DIRECTORY_GRAPH = YES |
2438 |
|
|
2439 |
|
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
2440 |
< |
# generated by dot. |
2440 |
> |
# generated by dot. For an explanation of the image formats see the section |
2441 |
> |
# output formats in the documentation of the dot tool (Graphviz (see: |
2442 |
> |
# http://www.graphviz.org/)). |
2443 |
|
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
2444 |
|
# to make the SVG files visible in IE 9+ (other browsers do not have this |
2445 |
|
# requirement). |
2446 |
< |
# Possible values are: png, jpg, gif and svg. |
2446 |
> |
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, |
2447 |
> |
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, |
2448 |
> |
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo, |
2449 |
> |
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and |
2450 |
> |
# png:gdiplus:gdiplus. |
2451 |
|
# The default value is: png. |
2452 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
2453 |
|
|
2469 |
|
# found. If left blank, it is assumed the dot tool can be found in the path. |
2470 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
2471 |
|
|
2472 |
< |
DOT_PATH = |
2472 |
> |
DOT_PATH = |
2473 |
|
|
2474 |
|
# The DOTFILE_DIRS tag can be used to specify one or more directories that |
2475 |
|
# contain dot files that are included in the documentation (see the \dotfile |
2476 |
|
# command). |
2477 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
2478 |
|
|
2479 |
< |
DOTFILE_DIRS = |
2479 |
> |
DOTFILE_DIRS = |
2480 |
|
|
2481 |
|
# The MSCFILE_DIRS tag can be used to specify one or more directories that |
2482 |
|
# contain msc files that are included in the documentation (see the \mscfile |
2483 |
|
# command). |
2484 |
|
|
2485 |
< |
MSCFILE_DIRS = |
2485 |
> |
MSCFILE_DIRS = |
2486 |
|
|
2487 |
|
# The DIAFILE_DIRS tag can be used to specify one or more directories that |
2488 |
|
# contain dia files that are included in the documentation (see the \diafile |
2489 |
|
# command). |
2490 |
|
|
2491 |
< |
DIAFILE_DIRS = |
2491 |
> |
DIAFILE_DIRS = |
2492 |
> |
|
2493 |
> |
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the |
2494 |
> |
# path where java can find the plantuml.jar file. If left blank, it is assumed |
2495 |
> |
# PlantUML is not used or called during a preprocessing step. Doxygen will |
2496 |
> |
# generate a warning when it encounters a \startuml command in this case and |
2497 |
> |
# will not generate output for the diagram. |
2498 |
> |
|
2499 |
> |
PLANTUML_JAR_PATH = |
2500 |
> |
|
2501 |
> |
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a |
2502 |
> |
# configuration file for plantuml. |
2503 |
> |
|
2504 |
> |
PLANTUML_CFG_FILE = |
2505 |
> |
|
2506 |
> |
# When using plantuml, the specified paths are searched for files specified by |
2507 |
> |
# the !include statement in a plantuml block. |
2508 |
> |
|
2509 |
> |
PLANTUML_INCLUDE_PATH = |
2510 |
|
|
2511 |
|
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
2512 |
|
# that will be shown in the graph. If the number of nodes in a graph becomes |
2518 |
|
# Minimum value: 0, maximum value: 10000, default value: 50. |
2519 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
2520 |
|
|
2521 |
< |
DOT_GRAPH_MAX_NODES = 50 |
2521 |
> |
DOT_GRAPH_MAX_NODES = 500 |
2522 |
|
|
2523 |
|
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs |
2524 |
|
# generated by dot. A depth value of 3 means that only nodes reachable from the |
2544 |
|
|
2545 |
|
DOT_TRANSPARENT = NO |
2546 |
|
|
2547 |
< |
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
2547 |
> |
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output |
2548 |
|
# files in one run (i.e. multiple -o and -T options on the command line). This |
2549 |
|
# makes dot run faster, but since only newer versions of dot (>1.8.10) support |
2550 |
|
# this, this feature is disabled by default. |
2561 |
|
|
2562 |
|
GENERATE_LEGEND = YES |
2563 |
|
|
2564 |
< |
# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot |
2564 |
> |
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot |
2565 |
|
# files that are used to generate the various graphs. |
2566 |
|
# The default value is: YES. |
2567 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |