ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/REPOS_ERICCA/magic/documentation/docmagic.in
Revision: 1197
Committed: Wed Aug 6 20:48:48 2025 UTC (8 weeks ago) by francois
File size: 112727 byte(s)
Log Message:
bug dans la documentation suite au commit d'hier

File Contents

# User Rev Content
1 francois 1081 # Doxyfile 1.8.17
2 francois 97
3 francois 284 # This file describes the settings to be used by the documentation system
4 francois 737 # doxygen (www.doxygen.org) for a project.
5 francois 284 #
6 francois 737 # All text after a double hash (##) is considered a comment and is placed in
7     # front of the TAG it is preceding.
8     #
9     # All text after a single hash (#) is considered a comment and will be ignored.
10 francois 284 # The format is:
11 francois 737 # TAG = value [value, ...]
12     # For lists, items can also be appended using:
13     # TAG += value [value, ...]
14     # Values that contain spaces should be placed between quotes (\" \").
15 francois 284
16 6 #---------------------------------------------------------------------------
17     # Project related configuration options
18     #---------------------------------------------------------------------------
19 francois 284
20 francois 1081 # 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 francois 737 # The default value is: UTF-8.
26 francois 284
27     DOXYFILE_ENCODING = UTF-8
28    
29 francois 737 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30     # double-quotes, unless you are using Doxywizard) that should identify the
31     # project for which the documentation is generated. This name is used in the
32     # title of most generated pages and in a few other places.
33     # The default value is: My Project.
34 francois 284
35     PROJECT_NAME = MAGiC
36    
37 francois 737 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38     # could be handy for archiving the generated documentation or if some version
39     # control system is used.
40 francois 284
41 francois 1171 PROJECT_NUMBER = V@MAGIC_MAJOR_VERSION@.@MAGIC_MINOR_VERSION@
42 francois 284
43 francois 737 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44     # for a project that appears at the top of each page and should give viewer a
45     # quick idea about the purpose of the project. Keep the description short.
46 francois 357
47 francois 1086 PROJECT_BRIEF = "Mailleurs Automatiques de Géometries intégrés à la Cao"
48 francois 357
49 francois 1020 # 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 francois 357
54 francois 1086 PROJECT_LOGO = /home/francois/dev/magic/documentation/logomagic.jpg
55 francois 357
56 francois 737 # 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
58     # entered, it will be relative to the location where doxygen was started. If
59     # left blank the current directory will be used.
60 francois 284
61 francois 400 OUTPUT_DIRECTORY = ./
62 francois 284
63 francois 1020 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64 francois 737 # 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
67     # putting all generated files in the same directory would otherwise causes
68     # performance problems for the file system.
69     # The default value is: NO.
70 francois 284
71 6 CREATE_SUBDIRS = YES
72 francois 284
73 francois 1020 # 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 francois 737 # 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.
84     # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85     # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86     # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87     # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88     # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89     # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90     # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91     # Ukrainian and Vietnamese.
92     # The default value is: English.
93 francois 284
94     OUTPUT_LANGUAGE = French
95    
96 francois 1081 # 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 francois 1020 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
105 francois 737 # 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 francois 284
109 6 BRIEF_MEMBER_DESC = YES
110 francois 284
111 francois 1020 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
112 francois 737 # 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
115 francois 284 # brief descriptions will be completely suppressed.
116 francois 737 # The default value is: YES.
117 francois 284
118 6 REPEAT_BRIEF = YES
119 francois 284
120 francois 737 # This tag implements a quasi-intelligent brief description abbreviator that is
121     # used to form the text in various listings. Each string in this list, if found
122     # as the leading text of the brief description, will be stripped from the text
123     # and the result, after processing the whole list, is used as the annotated
124     # text. Otherwise, the brief description is used as-is. If left blank, the
125     # following values are used ($name is automatically replaced with the name of
126     # the entity):The $name class, The $name widget, The $name file, is, provides,
127     # specifies, contains, represents, a, an and the.
128 francois 284
129 6 ABBREVIATE_BRIEF = "The $name class" \
130     "The $name widget" \
131     "The $name file" \
132     is \
133     provides \
134     specifies \
135     contains \
136     represents \
137     a \
138     an \
139     the
140 francois 284
141 francois 737 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
142     # doxygen will generate a detailed section even if there is only a brief
143 francois 284 # description.
144 francois 737 # The default value is: NO.
145 francois 284
146 6 ALWAYS_DETAILED_SEC = NO
147 francois 284
148 francois 737 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
149     # inherited members of a class in the documentation of that class as if those
150     # members were ordinary class members. Constructors, destructors and assignment
151 francois 284 # operators of the base classes will not be shown.
152 francois 737 # The default value is: NO.
153 francois 284
154 6 INLINE_INHERITED_MEMB = NO
155 francois 284
156 francois 1020 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
157 francois 737 # 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.
160 francois 284
161 6 FULL_PATH_NAMES = NO
162 francois 284
163 francois 737 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
164     # Stripping is only done if one of the specified strings matches the left-hand
165     # part of the path. The tag can be used to show relative paths in the file list.
166     # If left blank the directory from which doxygen is run is used as the path to
167     # strip.
168     #
169     # Note that you can specify absolute paths here, but also relative paths, which
170     # will be relative from the directory where doxygen is started.
171     # This tag requires that the tag FULL_PATH_NAMES is set to YES.
172 francois 284
173 6 STRIP_FROM_PATH = "C:/Documents and Settings/francois/"
174 francois 284
175 francois 737 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
176     # path mentioned in the documentation of a class, which tells the reader which
177     # header file to include in order to use a class. If left blank only the name of
178     # the header file containing the class definition is used. Otherwise one should
179     # specify the list of include paths that are normally passed to the compiler
180     # using the -I flag.
181 francois 284
182 francois 1081 STRIP_FROM_INC_PATH =
183 francois 284
184 francois 737 # 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
186     # support long names like on DOS, Mac, or CD-ROM.
187     # The default value is: NO.
188 francois 284
189 6 SHORT_NAMES = NO
190 francois 284
191 francois 737 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
192     # first line (until the first dot) of a Javadoc-style comment as the brief
193     # description. If set to NO, the Javadoc-style will behave just like regular Qt-
194     # style comments (thus requiring an explicit @brief command for a brief
195     # description.)
196     # The default value is: NO.
197 francois 284
198 6 JAVADOC_AUTOBRIEF = NO
199 francois 284
200 francois 1081 # 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 francois 737 # 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
213     # requiring an explicit \brief command for a brief description.)
214     # The default value is: NO.
215 francois 284
216     QT_AUTOBRIEF = NO
217    
218 francois 737 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
219     # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
220     # a brief description. This used to be the default behavior. The new default is
221     # to treat a multi-line C++ comment block as a detailed description. Set this
222     # tag to YES if you prefer the old behavior instead.
223     #
224     # Note that setting this tag to YES also means that rational rose comments are
225     # not recognized any more.
226     # The default value is: NO.
227 francois 284
228 6 MULTILINE_CPP_IS_BRIEF = NO
229 francois 284
230 francois 737 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
231     # documentation from any documented member that it re-implements.
232     # The default value is: YES.
233 francois 284
234 6 INHERIT_DOCS = YES
235 francois 284
236 francois 1020 # 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 francois 737 # The default value is: NO.
240 francois 284
241     SEPARATE_MEMBER_PAGES = NO
242    
243 francois 737 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
244     # uses this value to replace tabs by spaces in code fragments.
245     # Minimum value: 1, maximum value: 16, default value: 4.
246 francois 284
247 6 TAB_SIZE = 8
248 francois 284
249 francois 737 # This tag can be used to specify a number of aliases that act as commands in
250     # the documentation. An alias has the form:
251     # name=value
252     # For example adding
253     # "sideeffect=@par Side Effects:\n"
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 francois 1081 # 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 francois 284
264 francois 1081 ALIASES =
265 francois 284
266 francois 737 # 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 francois 357
270 francois 1081 TCL_SUBST =
271 francois 357
272 francois 737 # 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
274     # instance, some of the names that are used will be different. The list of all
275     # members will be omitted, etc.
276     # The default value is: NO.
277 francois 284
278 6 OPTIMIZE_OUTPUT_FOR_C = NO
279 francois 284
280 francois 737 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
281     # Python sources only. Doxygen will then generate output that is more tailored
282     # for that language. For instance, namespaces will be presented as packages,
283     # qualified scopes will look different, etc.
284     # The default value is: NO.
285 francois 284
286 6 OPTIMIZE_OUTPUT_JAVA = NO
287 francois 284
288 francois 737 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
289     # sources. Doxygen will then generate output that is tailored for Fortran.
290     # The default value is: NO.
291 francois 284
292     OPTIMIZE_FOR_FORTRAN = NO
293    
294 francois 737 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
295     # sources. Doxygen will then generate output that is tailored for VHDL.
296     # The default value is: NO.
297 francois 284
298     OPTIMIZE_OUTPUT_VHDL = NO
299    
300 francois 1081 # 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 francois 737 # 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 francois 1081 # 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 francois 737 #
321 francois 1020 # Note: For files without extension you can use no_extension as a placeholder.
322 francois 737 #
323     # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
324     # the files are not read by doxygen.
325 francois 284
326 francois 1081 EXTENSION_MAPPING =
327 francois 284
328 francois 737 # 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 francois 1081 # documentation. See https://daringfireball.net/projects/markdown/ for details.
331 francois 737 # 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.
334     # The default value is: YES.
335    
336     MARKDOWN_SUPPORT = YES
337    
338 francois 1057 # 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 francois 1081 # Minimum value: 0, maximum value: 99, default value: 5.
343 francois 1057 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
344    
345     TOC_INCLUDE_HEADINGS = 0
346    
347 francois 737 # When enabled doxygen tries to link words that correspond to documented
348     # classes, or namespaces to their corresponding documentation. Such a link can
349 francois 1020 # be prevented in individual cases by putting a % sign in front of the word or
350     # globally by setting AUTOLINK_SUPPORT to NO.
351 francois 737 # The default value is: YES.
352    
353     AUTOLINK_SUPPORT = YES
354    
355     # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
356     # to include (a tag file for) the STL sources as input, then you should set this
357     # tag to YES in order to let doxygen match functions declarations and
358     # definitions whose arguments contain STL classes (e.g. func(std::string);
359     # versus func(std::string) {}). This also make the inheritance and collaboration
360 francois 284 # diagrams that involve STL classes more complete and accurate.
361 francois 737 # The default value is: NO.
362 francois 284
363     BUILTIN_STL_SUPPORT = NO
364    
365 francois 737 # If you use Microsoft's C++/CLI language, you should set this option to YES to
366 francois 284 # enable parsing support.
367 francois 737 # The default value is: NO.
368 francois 284
369     CPP_CLI_SUPPORT = NO
370    
371 francois 737 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
372 francois 1081 # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
373 francois 737 # 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.
376 francois 284
377     SIP_SUPPORT = NO
378    
379 francois 737 # For Microsoft's IDL there are propget and propput attributes to indicate
380     # getter and setter methods for a property. Setting this option to YES will make
381     # doxygen to replace the get and set methods by a property in the documentation.
382     # This will only work if the methods are indeed getting or setting a simple
383     # type. If this is not the case, or you want to show the methods anyway, you
384     # should set this option to NO.
385     # The default value is: YES.
386 francois 284
387     IDL_PROPERTY_SUPPORT = YES
388    
389 francois 737 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
390 francois 1020 # tag is set to YES then doxygen will reuse the documentation of the first
391 francois 737 # member in the group (if any) for the other members of the group. By default
392 francois 284 # all members of a group must be documented explicitly.
393 francois 737 # The default value is: NO.
394 francois 284
395     DISTRIBUTE_GROUP_DOC = NO
396    
397 francois 1020 # 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 francois 737 # 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
407     # subgrouping. Alternatively, this can be done per class using the
408     # \nosubgrouping command.
409     # The default value is: YES.
410 francois 284
411 6 SUBGROUPING = YES
412 francois 284
413 francois 737 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
414     # are shown inside the group in which they are included (e.g. using \ingroup)
415     # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
416     # and RTF).
417     #
418     # Note that this feature does not work in combination with
419     # SEPARATE_MEMBER_PAGES.
420     # The default value is: NO.
421 francois 357
422     INLINE_GROUPED_CLASSES = NO
423    
424 francois 737 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
425     # with only public data fields or simple typedef fields will be shown inline in
426     # the documentation of the scope in which they are defined (i.e. file,
427     # namespace, or group documentation), provided this scope is documented. If set
428     # to NO, structs, classes, and unions are shown on a separate page (for HTML and
429     # Man pages) or section (for LaTeX and RTF).
430     # The default value is: NO.
431 francois 357
432     INLINE_SIMPLE_STRUCTS = NO
433    
434 francois 737 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
435     # enum is documented as struct, union, or enum with the name of the typedef. So
436     # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
437     # with name TypeT. When disabled the typedef will appear as a member of a file,
438     # namespace, or class. And the struct will be named TypeS. This can typically be
439     # useful for C code in case the coding convention dictates that all compound
440 francois 284 # types are typedef'ed and only the typedef is referenced, never the tag name.
441 francois 737 # The default value is: NO.
442 francois 284
443     TYPEDEF_HIDES_STRUCT = NO
444    
445 francois 737 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
446     # cache is used to resolve symbols given their name and scope. Since this can be
447     # an expensive process and often the same symbol appears multiple times in the
448     # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
449     # doxygen will become slower. If the cache is too large, memory is wasted. The
450     # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
451     # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
452     # symbols. At the end of a run doxygen will report the cache usage and suggest
453     # the optimal cache size from a speed point of view.
454     # Minimum value: 0, maximum value: 9, default value: 0.
455 francois 284
456 francois 357 LOOKUP_CACHE_SIZE = 0
457    
458 6 #---------------------------------------------------------------------------
459     # Build related configuration options
460     #---------------------------------------------------------------------------
461 francois 284
462 francois 1020 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
463 francois 737 # 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.
466     # Note: This will also disable the warnings about undocumented members that are
467     # normally produced when WARNINGS is set to YES.
468     # The default value is: NO.
469 francois 284
470 6 EXTRACT_ALL = YES
471 francois 284
472 francois 1020 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
473 francois 737 # be included in the documentation.
474     # The default value is: NO.
475 francois 284
476 francois 175 EXTRACT_PRIVATE = YES
477 francois 284
478 francois 1081 # 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 francois 1086 EXTRACT_PRIV_VIRTUAL = YES
483 francois 1081
484 francois 1020 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
485 francois 737 # scope will be included in the documentation.
486     # The default value is: NO.
487 francois 284
488 francois 737 EXTRACT_PACKAGE = NO
489    
490 francois 1020 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
491 francois 737 # included in the documentation.
492     # The default value is: NO.
493    
494 francois 175 EXTRACT_STATIC = YES
495 francois 284
496 francois 1020 # 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 francois 737 # only classes defined in header files are included. Does not have any effect
499     # for Java sources.
500     # The default value is: YES.
501 francois 284
502 6 EXTRACT_LOCAL_CLASSES = YES
503 francois 284
504 francois 1020 # This flag is only useful for Objective-C code. If set to YES, local methods,
505 francois 737 # which are defined in the implementation section but not in the interface are
506 francois 1020 # included in the documentation. If set to NO, only methods in the interface are
507 francois 737 # included.
508     # The default value is: NO.
509 francois 284
510 francois 357 EXTRACT_LOCAL_METHODS = YES
511 francois 284
512 francois 737 # If this flag is set to YES, the members of anonymous namespaces will be
513     # extracted and appear in the documentation as a namespace called
514     # 'anonymous_namespace{file}', where file will be replaced with the base name of
515     # the file that contains the anonymous namespace. By default anonymous namespace
516     # are hidden.
517     # The default value is: NO.
518 francois 284
519     EXTRACT_ANON_NSPACES = NO
520    
521 francois 737 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
522     # undocumented members inside documented classes or files. If set to NO these
523     # members will be included in the various overviews, but no documentation
524     # section is generated. This option has no effect if EXTRACT_ALL is enabled.
525     # The default value is: NO.
526 francois 284
527 francois 175 HIDE_UNDOC_MEMBERS = NO
528 francois 284
529 francois 737 # 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 francois 1020 # to NO, these classes will be included in the various overviews. This option
532     # has no effect if EXTRACT_ALL is enabled.
533 francois 737 # The default value is: NO.
534 francois 284
535 francois 175 HIDE_UNDOC_CLASSES = NO
536 francois 284
537 francois 737 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
538 francois 1081 # declarations. If set to NO, these declarations will be included in the
539     # documentation.
540 francois 737 # The default value is: NO.
541 francois 284
542 6 HIDE_FRIEND_COMPOUNDS = NO
543 francois 284
544 francois 737 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
545 francois 1020 # documentation blocks found inside the body of a function. If set to NO, these
546 francois 737 # blocks will be appended to the function's detailed documentation block.
547     # The default value is: NO.
548 francois 284
549 6 HIDE_IN_BODY_DOCS = NO
550 francois 284
551 francois 737 # The INTERNAL_DOCS tag determines if documentation that is typed after a
552     # \internal command is included. If the tag is set to NO then the documentation
553     # will be excluded. Set it to YES to include the internal documentation.
554     # The default value is: NO.
555 francois 284
556 6 INTERNAL_DOCS = NO
557 francois 284
558 francois 737 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
559 francois 1020 # names in lower-case letters. If set to YES, upper-case letters are also
560 francois 737 # 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 francois 1081 # (including Cygwin) ands Mac users are advised to set this option to NO.
563 francois 737 # The default value is: system dependent.
564 francois 284
565 6 CASE_SENSE_NAMES = NO
566 francois 284
567 francois 737 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
568 francois 1020 # their full class and namespace scopes in the documentation. If set to YES, the
569 francois 737 # scope will be hidden.
570     # The default value is: NO.
571 francois 284
572 6 HIDE_SCOPE_NAMES = NO
573 francois 284
574 francois 1020 # 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 francois 737 # 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.
584 francois 284
585 6 SHOW_INCLUDE_FILES = YES
586 francois 284
587 francois 737 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
588     # grouped member an include statement to the documentation, telling the reader
589     # which file to include in order to use the member.
590     # The default value is: NO.
591 francois 284
592 francois 737 SHOW_GROUPED_MEMB_INC = NO
593    
594     # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
595     # files with double quotes in the documentation rather than with sharp brackets.
596     # The default value is: NO.
597    
598 francois 284 FORCE_LOCAL_INCLUDES = NO
599    
600 francois 737 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
601     # documentation for inline members.
602     # The default value is: YES.
603 francois 284
604 6 INLINE_INFO = YES
605 francois 284
606 francois 737 # 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 francois 1020 # name. If set to NO, the members will appear in declaration order.
609 francois 737 # The default value is: YES.
610 francois 284
611 6 SORT_MEMBER_DOCS = YES
612 francois 284
613 francois 737 # 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 francois 1020 # name. If set to NO, the members will appear in declaration order. Note that
616 francois 737 # this will also influence the order of the classes in the class list.
617     # The default value is: NO.
618 francois 284
619 6 SORT_BRIEF_DOCS = NO
620 francois 284
621 francois 737 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
622     # (brief and detailed) documentation of class members so that constructors and
623     # destructors are listed first. If set to NO the constructors will appear in the
624     # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
625     # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
626     # member documentation.
627     # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
628     # detailed member documentation.
629     # The default value is: NO.
630 francois 284
631     SORT_MEMBERS_CTORS_1ST = NO
632    
633 francois 737 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
634     # of group names into alphabetical order. If set to NO the group names will
635     # appear in their defined order.
636     # The default value is: NO.
637 francois 284
638     SORT_GROUP_NAMES = NO
639    
640 francois 737 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
641     # fully-qualified names, including namespaces. If set to NO, the class list will
642     # be sorted only by class name, not including the namespace part.
643     # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
644     # Note: This option applies only to the class list, not to the alphabetical
645     # list.
646     # The default value is: NO.
647 francois 284
648 6 SORT_BY_SCOPE_NAME = NO
649 francois 284
650 francois 737 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
651     # type resolution of all parameters of a function it will reject a match between
652     # the prototype and the implementation of a member function even if there is
653     # only one candidate or it is obvious which candidate to choose by doing a
654     # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
655     # accept a match between prototype and implementation in such cases.
656     # The default value is: NO.
657 francois 357
658     STRICT_PROTO_MATCHING = NO
659    
660 francois 1020 # 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 francois 737 # The default value is: YES.
663 francois 284
664 6 GENERATE_TODOLIST = YES
665 francois 284
666 francois 1020 # 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 francois 737 # The default value is: YES.
669 francois 284
670 6 GENERATE_TESTLIST = YES
671 francois 284
672 francois 1020 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
673 francois 737 # list. This list is created by putting \bug commands in the documentation.
674     # The default value is: YES.
675 francois 284
676 6 GENERATE_BUGLIST = YES
677 francois 284
678 francois 1020 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
679 francois 737 # the deprecated list. This list is created by putting \deprecated commands in
680     # the documentation.
681     # The default value is: YES.
682 francois 284
683 6 GENERATE_DEPRECATEDLIST= YES
684 francois 284
685 francois 737 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
686     # sections, marked by \if <section_label> ... \endif and \cond <section_label>
687     # ... \endcond blocks.
688 francois 284
689 francois 1081 ENABLED_SECTIONS =
690 francois 284
691 francois 737 # 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
693     # documentation. If the initializer consists of more lines than specified here
694     # it will be hidden. Use a value of 0 to hide initializers completely. The
695     # appearance of the value of individual variables and macros / defines can be
696     # controlled using \showinitializer or \hideinitializer command in the
697     # documentation regardless of this setting.
698     # Minimum value: 0, maximum value: 10000, default value: 30.
699 francois 284
700 6 MAX_INITIALIZER_LINES = 30
701 francois 284
702 francois 737 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
703 francois 1020 # 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 francois 737 # The default value is: YES.
706 francois 284
707 6 SHOW_USED_FILES = YES
708 francois 284
709 francois 737 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
710     # will remove the Files entry from the Quick Index and from the Folder Tree View
711     # (if specified).
712     # The default value is: YES.
713 francois 284
714     SHOW_FILES = YES
715    
716 francois 737 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
717     # page. This will remove the Namespaces entry from the Quick Index and from the
718     # Folder Tree View (if specified).
719     # The default value is: YES.
720 francois 284
721     SHOW_NAMESPACES = YES
722    
723 francois 737 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
724     # doxygen should invoke to get the current version for each file (typically from
725     # the version control system). Doxygen will invoke the program by executing (via
726     # popen()) the command command input-file, where command is the value of the
727     # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
728     # by doxygen. Whatever the program writes to standard output is used as the file
729     # version. For an example see the documentation.
730 francois 284
731 francois 1081 FILE_VERSION_FILTER =
732 francois 284
733 francois 737 # 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
735     # output files in an output format independent way. To create the layout file
736     # that represents doxygen's defaults, run doxygen with the -l option. You can
737     # optionally specify a file name after the option, if omitted DoxygenLayout.xml
738     # will be used as the name of the layout file.
739     #
740     # Note that if you run doxygen from a directory containing a file called
741     # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
742     # tag is left empty.
743 francois 284
744 francois 1081 LAYOUT_FILE =
745 francois 284
746 francois 737 # 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 francois 1081 # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
750 francois 737 # 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 francois 1020 # search path. See also \cite for info how to create references.
753 francois 357
754 francois 1081 CITE_BIB_FILES =
755 francois 357
756 6 #---------------------------------------------------------------------------
757 francois 737 # Configuration options related to warning and progress messages
758 6 #---------------------------------------------------------------------------
759 francois 284
760 francois 737 # The QUIET tag can be used to turn on/off the messages that are generated to
761     # standard output by doxygen. If QUIET is set to YES this implies that the
762     # messages are off.
763     # The default value is: NO.
764 francois 284
765 6 QUIET = NO
766 francois 284
767 francois 737 # The WARNINGS tag can be used to turn on/off the warning messages that are
768 francois 1020 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
769 francois 737 # this implies that the warnings are on.
770     #
771     # Tip: Turn warnings on while writing the documentation.
772     # The default value is: YES.
773 francois 284
774 6 WARNINGS = YES
775 francois 284
776 francois 1020 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
777 francois 737 # 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.
780 francois 284
781 6 WARN_IF_UNDOCUMENTED = YES
782 francois 284
783 francois 737 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
784     # potential errors in the documentation, such as not documenting some parameters
785     # in a documented function, or documenting parameters that don't exist or using
786     # markup commands wrongly.
787     # The default value is: YES.
788 francois 284
789 6 WARN_IF_DOC_ERROR = YES
790 francois 284
791 francois 737 # 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 francois 1020 # value. If set to NO, doxygen will only warn about wrong or incomplete
794 francois 1081 # 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 francois 737 # The default value is: NO.
797 francois 284
798 6 WARN_NO_PARAMDOC = NO
799 francois 284
800 francois 1020 # 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 francois 737 # 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
809     # and the warning text. Optionally the format may contain $version, which will
810     # be replaced by the version of the file (if it could be obtained via
811     # FILE_VERSION_FILTER)
812     # The default value is: $file:$line: $text.
813 francois 284
814 6 WARN_FORMAT = "$file:$line: $text"
815 francois 284
816 francois 737 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
817     # messages should be written. If left blank the output is written to standard
818     # error (stderr).
819 francois 284
820 francois 1081 WARN_LOGFILE =
821 francois 284
822 6 #---------------------------------------------------------------------------
823 francois 737 # Configuration options related to the input files
824 6 #---------------------------------------------------------------------------
825 francois 284
826 francois 737 # 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 francois 1020 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
830 francois 737 # Note: If this tag is empty the current directory is searched.
831 francois 284
832 francois 1086 INPUT = . \
833 francois 1069 ../addin \
834 francois 1086 ../app/aide \
835     ../lib
836 francois 284
837 francois 737 # 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 francois 1081 # documentation (see: https://www.gnu.org/software/libiconv/) for the list of
841 francois 737 # possible encodings.
842     # The default value is: UTF-8.
843 francois 284
844     INPUT_ENCODING = UTF-8
845    
846 francois 737 # 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 francois 1020 # *.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 francois 1081 # *.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 francois 284
862 6 FILE_PATTERNS = *.c \
863     *.cc \
864     *.cxx \
865     *.cpp \
866     *.c++ \
867     *.java \
868     *.ii \
869     *.ixx \
870     *.ipp \
871     *.i++ \
872     *.inl \
873     *.h \
874     *.hh \
875     *.hxx \
876     *.hpp \
877     *.h++ \
878     *.idl \
879     *.odl \
880     *.cs \
881     *.php \
882     *.php3 \
883     *.inc \
884     *.m \
885     *.mm \
886     *.dox
887 francois 284
888 francois 737 # The RECURSIVE tag can be used to specify whether or not subdirectories should
889     # be searched for input files as well.
890     # The default value is: NO.
891 francois 284
892 6 RECURSIVE = YES
893 francois 284
894 francois 737 # The EXCLUDE tag can be used to specify files and/or directories that should be
895     # excluded from the INPUT source files. This way you can easily exclude a
896     # subdirectory from a directory tree whose root is specified with the INPUT tag.
897     #
898     # Note that relative paths are relative to the directory from which doxygen is
899 francois 357 # run.
900 francois 284
901     EXCLUDE = ../lib/OCC_Fonction \
902 francois 357 ../lib/geometrie/Imports \
903 francois 1020 ../lib/diamesh \
904 francois 1086 ../addin/poly_occ/voro++-0.4.6 \
905     ../addin/vtkdisplay \
906 francois 1197 ../lib/solveur \
907     ../addin/icp
908    
909 francois 737 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
910     # directories that are symbolic links (a Unix file system feature) are excluded
911 francois 284 # from the input.
912 francois 737 # The default value is: NO.
913 francois 284
914 6 EXCLUDE_SYMLINKS = NO
915 francois 284
916 francois 737 # If the value of the INPUT tag contains directories, you can use the
917     # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
918     # certain files from those directories.
919     #
920     # Note that the wildcards are matched against the file with absolute path, so to
921     # exclude all test directories for example use the pattern */test/*
922 francois 284
923 francois 1081 EXCLUDE_PATTERNS =
924 francois 284
925 francois 737 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
926     # (namespaces, classes, functions, etc.) that should be excluded from the
927     # output. The symbol name can be a fully qualified name, a word, or if the
928     # wildcard * is used, a substring. Examples: ANamespace, AClass,
929 francois 284 # AClass::ANamespace, ANamespace::*Test
930 francois 737 #
931     # Note that the wildcards are matched against the file with absolute path, so to
932     # exclude all test directories use the pattern */test/*
933 francois 284
934 francois 1081 EXCLUDE_SYMBOLS =
935 francois 284
936 francois 737 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
937     # that contain example code fragments that are included (see the \include
938     # command).
939 francois 284
940 francois 1081 EXAMPLE_PATH =
941 francois 284
942 francois 737 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
943     # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
944     # *.h) to filter out the source-files in the directories. If left blank all
945     # files are included.
946 francois 284
947 6 EXAMPLE_PATTERNS = *
948 francois 284
949 francois 737 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
950     # searched for input files to be used with the \include or \dontinclude commands
951     # irrespective of the value of the RECURSIVE tag.
952     # The default value is: NO.
953 francois 284
954 6 EXAMPLE_RECURSIVE = NO
955 francois 284
956 francois 737 # The IMAGE_PATH tag can be used to specify one or more files or directories
957     # that contain images that are to be included in the documentation (see the
958     # \image command).
959 francois 284
960 francois 1087 IMAGE_PATH = ../documentation
961 francois 284
962 francois 737 # The INPUT_FILTER tag can be used to specify a program that doxygen should
963     # invoke to filter for each input file. Doxygen will invoke the filter program
964     # by executing (via popen()) the command:
965     #
966     # <filter> <input-file>
967     #
968     # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
969     # name of an input file. Doxygen will then use the output that the filter
970     # program writes to standard output. If FILTER_PATTERNS is specified, this tag
971     # will be ignored.
972     #
973     # Note that the filter must not add or remove lines; it is applied before the
974     # code is scanned, but not when the output code is generated. If lines are added
975     # or removed, the anchors will not be placed correctly.
976 francois 1020 #
977     # Note that for custom extensions or not directly supported extensions you also
978     # need to set EXTENSION_MAPPING for the extension otherwise the files are not
979     # properly processed by doxygen.
980 francois 284
981 francois 1081 INPUT_FILTER =
982 francois 284
983 francois 737 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
984     # basis. Doxygen will compare the file name with each pattern and apply the
985     # filter if there is a match. The filters are a list of the form: pattern=filter
986     # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
987     # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
988     # patterns match the file name, INPUT_FILTER is applied.
989 francois 1020 #
990     # Note that for custom extensions or not directly supported extensions you also
991     # need to set EXTENSION_MAPPING for the extension otherwise the files are not
992     # properly processed by doxygen.
993 francois 284
994 francois 1081 FILTER_PATTERNS =
995 francois 284
996 francois 737 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
997 francois 1020 # INPUT_FILTER) will also be used to filter the input files that are used for
998 francois 737 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
999     # The default value is: NO.
1000 francois 284
1001 6 FILTER_SOURCE_FILES = NO
1002 francois 284
1003 francois 737 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1004     # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1005     # it is also possible to disable source filtering for a specific pattern using
1006     # *.ext= (so without naming a filter).
1007     # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1008 francois 357
1009 francois 1081 FILTER_SOURCE_PATTERNS =
1010 francois 357
1011 francois 737 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1012     # is part of the input, its contents will be placed on the main page
1013     # (index.html). This can be useful if you have a project on for instance GitHub
1014     # and want to reuse the introduction page also for the doxygen output.
1015    
1016 francois 1081 USE_MDFILE_AS_MAINPAGE =
1017 francois 737
1018 6 #---------------------------------------------------------------------------
1019 francois 737 # Configuration options related to source browsing
1020 6 #---------------------------------------------------------------------------
1021 francois 284
1022 francois 737 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1023     # generated. Documented entities will be cross-referenced with these sources.
1024     #
1025     # Note: To get rid of all source code in the generated output, make sure that
1026     # also VERBATIM_HEADERS is set to NO.
1027     # The default value is: NO.
1028 francois 284
1029 francois 175 SOURCE_BROWSER = YES
1030 francois 284
1031 francois 737 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1032     # classes and enums directly into the documentation.
1033     # The default value is: NO.
1034 francois 284
1035 6 INLINE_SOURCES = NO
1036 francois 284
1037 francois 737 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1038     # special comment blocks from generated source code fragments. Normal C, C++ and
1039     # Fortran comments will always remain visible.
1040     # The default value is: YES.
1041 francois 284
1042 6 STRIP_CODE_COMMENTS = YES
1043 francois 284
1044 francois 737 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1045 francois 1081 # entity all documented functions referencing it will be listed.
1046 francois 737 # The default value is: NO.
1047 francois 284
1048 6 REFERENCED_BY_RELATION = YES
1049 francois 284
1050 francois 737 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1051     # all documented entities called/used by that function will be listed.
1052     # The default value is: NO.
1053 francois 284
1054 6 REFERENCES_RELATION = YES
1055 francois 284
1056 francois 737 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1057 francois 1020 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1058 francois 737 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1059     # link to the documentation.
1060     # The default value is: YES.
1061 francois 284
1062     REFERENCES_LINK_SOURCE = YES
1063    
1064 francois 737 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1065     # source code will show a tooltip with additional information such as prototype,
1066     # brief description and links to the definition and documentation. Since this
1067     # will make the HTML file larger and loading of large files a bit slower, you
1068     # can opt to disable this feature.
1069     # The default value is: YES.
1070     # This tag requires that the tag SOURCE_BROWSER is set to YES.
1071 francois 284
1072 francois 737 SOURCE_TOOLTIPS = YES
1073    
1074     # If the USE_HTAGS tag is set to YES then the references to source code will
1075     # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1076     # source browser. The htags tool is part of GNU's global source tagging system
1077 francois 1081 # (see https://www.gnu.org/software/global/global.html). You will need version
1078 francois 737 # 4.8.6 or higher.
1079     #
1080     # To use it do the following:
1081     # - Install the latest version of global
1082 francois 1081 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1083 francois 737 # - Make sure the INPUT points to the root of the source tree
1084     # - Run doxygen as normal
1085     #
1086     # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1087     # tools must be available from the command line (i.e. in the search path).
1088     #
1089     # The result: instead of the source browser generated by doxygen, the links to
1090     # source code will now point to the output of htags.
1091     # The default value is: NO.
1092     # This tag requires that the tag SOURCE_BROWSER is set to YES.
1093    
1094 francois 284 USE_HTAGS = NO
1095    
1096 francois 737 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1097     # verbatim copy of the header file for each class for which an include is
1098     # specified. Set to NO to disable this.
1099     # See also: Section \class.
1100     # The default value is: YES.
1101 francois 284
1102 6 VERBATIM_HEADERS = YES
1103 francois 284
1104 francois 1020 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1105     # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1106     # cost of reduced performance. This can be particularly helpful with template
1107     # rich C++ code for which doxygen's built-in parser lacks the necessary type
1108     # information.
1109     # Note: The availability of this option depends on whether or not doxygen was
1110 francois 1081 # generated with the -Duse_libclang=ON option for CMake.
1111 francois 1020 # The default value is: NO.
1112    
1113     CLANG_ASSISTED_PARSING = NO
1114    
1115     # If clang assisted parsing is enabled you can provide the compiler with command
1116     # line options that you would normally use when invoking the compiler. Note that
1117     # the include paths will already be set by doxygen for the files and directories
1118     # specified with INPUT and INCLUDE_PATH.
1119     # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1120    
1121 francois 1081 CLANG_OPTIONS =
1122 francois 1020
1123 francois 1081 # If clang assisted parsing is enabled you can provide the clang parser with the
1124     # path to the compilation database (see:
1125     # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1126     # were built. This is equivalent to specifying the "-p" option to a clang tool,
1127     # such as clang-check. These options will then be passed to the parser.
1128     # Note: The availability of this option depends on whether or not doxygen was
1129     # generated with the -Duse_libclang=ON option for CMake.
1130    
1131     CLANG_DATABASE_PATH =
1132    
1133 6 #---------------------------------------------------------------------------
1134 francois 737 # Configuration options related to the alphabetical class index
1135 6 #---------------------------------------------------------------------------
1136 francois 284
1137 francois 737 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1138     # compounds will be generated. Enable this if the project contains a lot of
1139     # classes, structs, unions or interfaces.
1140     # The default value is: YES.
1141 francois 284
1142 francois 357 ALPHABETICAL_INDEX = YES
1143 francois 284
1144 francois 737 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1145     # which the alphabetical index list will be split.
1146     # Minimum value: 1, maximum value: 20, default value: 5.
1147     # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1148 francois 284
1149 6 COLS_IN_ALPHA_INDEX = 5
1150 francois 284
1151 francois 737 # In case all classes in a project start with a common prefix, all classes will
1152     # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1153     # can be used to specify a prefix (or a list of prefixes) that should be ignored
1154     # while generating the index headers.
1155     # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1156 francois 284
1157 francois 1081 IGNORE_PREFIX =
1158 francois 284
1159 6 #---------------------------------------------------------------------------
1160 francois 737 # Configuration options related to the HTML output
1161 6 #---------------------------------------------------------------------------
1162 francois 284
1163 francois 1020 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1164 francois 737 # The default value is: YES.
1165 francois 284
1166 6 GENERATE_HTML = YES
1167 francois 284
1168 francois 737 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1169     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1170     # it.
1171     # The default directory is: html.
1172     # This tag requires that the tag GENERATE_HTML is set to YES.
1173 francois 284
1174 francois 400 HTML_OUTPUT = ./
1175 francois 284
1176 francois 737 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1177     # generated HTML page (for example: .htm, .php, .asp).
1178     # The default value is: .html.
1179     # This tag requires that the tag GENERATE_HTML is set to YES.
1180 francois 284
1181 6 HTML_FILE_EXTENSION = .html
1182 francois 284
1183 francois 737 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1184     # each generated HTML page. If the tag is left blank doxygen will generate a
1185     # standard header.
1186     #
1187     # To get valid HTML the header file that includes any scripts and style sheets
1188     # that doxygen needs, which is dependent on the configuration options used (e.g.
1189     # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1190     # default header using
1191     # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1192     # YourConfigFile
1193     # and then modify the file new_header.html. See also section "Doxygen usage"
1194     # for information on how to generate the default header that doxygen normally
1195     # uses.
1196     # Note: The header is subject to change so you typically have to regenerate the
1197     # default header when upgrading to a newer version of doxygen. For a description
1198     # of the possible markers and block names see the documentation.
1199     # This tag requires that the tag GENERATE_HTML is set to YES.
1200 francois 284
1201 francois 1081 HTML_HEADER =
1202 francois 284
1203 francois 737 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1204     # generated HTML page. If the tag is left blank doxygen will generate a standard
1205     # footer. See HTML_HEADER for more information on how to generate a default
1206     # footer and what special commands can be used inside the footer. See also
1207     # section "Doxygen usage" for information on how to generate the default footer
1208     # that doxygen normally uses.
1209     # This tag requires that the tag GENERATE_HTML is set to YES.
1210 francois 284
1211 francois 1081 HTML_FOOTER =
1212 francois 284
1213 francois 737 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1214     # sheet that is used by each HTML page. It can be used to fine-tune the look of
1215     # the HTML output. If left blank doxygen will generate a default style sheet.
1216     # See also section "Doxygen usage" for information on how to generate the style
1217     # sheet that doxygen normally uses.
1218     # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1219     # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1220     # obsolete.
1221     # This tag requires that the tag GENERATE_HTML is set to YES.
1222 francois 284
1223 francois 1081 HTML_STYLESHEET =
1224 francois 284
1225 francois 1020 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1226     # cascading style sheets that are included after the standard style sheets
1227 francois 737 # created by doxygen. Using this option one can overrule certain style aspects.
1228     # This is preferred over using HTML_STYLESHEET since it does not replace the
1229 francois 1020 # standard style sheet and is therefore more robust against future updates.
1230     # Doxygen will copy the style sheet files to the output directory.
1231     # Note: The order of the extra style sheet files is of importance (e.g. the last
1232     # style sheet in the list overrules the setting of the previous ones in the
1233     # list). For an example see the documentation.
1234 francois 737 # This tag requires that the tag GENERATE_HTML is set to YES.
1235 francois 357
1236 francois 1081 HTML_EXTRA_STYLESHEET =
1237 francois 737
1238     # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1239     # other source files which should be copied to the HTML output directory. Note
1240     # that these files will be copied to the base HTML output directory. Use the
1241     # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1242     # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1243     # files will be copied as-is; there are no commands or markers available.
1244     # This tag requires that the tag GENERATE_HTML is set to YES.
1245    
1246 francois 1088 HTML_EXTRA_FILES = ../documentation/logoericca.jpg \
1247     ../documentation/logomagic.jpg
1248 francois 357
1249 francois 737 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1250 francois 1020 # will adjust the colors in the style sheet and background images according to
1251 francois 737 # this color. Hue is specified as an angle on a colorwheel, see
1252 francois 1081 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1253 francois 737 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1254     # purple, and 360 is red again.
1255     # Minimum value: 0, maximum value: 359, default value: 220.
1256     # This tag requires that the tag GENERATE_HTML is set to YES.
1257 francois 357
1258 francois 1086 HTML_COLORSTYLE_HUE = 131
1259 francois 357
1260 francois 737 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1261     # in the HTML output. For a value of 0 the output will use grayscales only. A
1262     # value of 255 will produce the most vivid colors.
1263     # Minimum value: 0, maximum value: 255, default value: 100.
1264     # This tag requires that the tag GENERATE_HTML is set to YES.
1265 francois 357
1266     HTML_COLORSTYLE_SAT = 100
1267    
1268 francois 737 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1269     # luminance component of the colors in the HTML output. Values below 100
1270     # gradually make the output lighter, whereas values above 100 make the output
1271     # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1272     # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1273     # change the gamma.
1274     # Minimum value: 40, maximum value: 240, default value: 80.
1275     # This tag requires that the tag GENERATE_HTML is set to YES.
1276 francois 357
1277     HTML_COLORSTYLE_GAMMA = 84
1278    
1279 francois 737 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1280     # page will contain the date and time when the page was generated. Setting this
1281 francois 1020 # to YES can help to show when doxygen was last run and thus if the
1282     # documentation is up to date.
1283     # The default value is: NO.
1284 francois 737 # This tag requires that the tag GENERATE_HTML is set to YES.
1285 francois 284
1286     HTML_TIMESTAMP = YES
1287    
1288 francois 1081 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1289     # documentation will contain a main index with vertical navigation menus that
1290     # are dynamically created via JavaScript. If disabled, the navigation index will
1291     # consists of multiple levels of tabs that are statically embedded in every HTML
1292     # page. Disable this option to support browsers that do not have JavaScript,
1293     # like the Qt help browser.
1294     # The default value is: YES.
1295     # This tag requires that the tag GENERATE_HTML is set to YES.
1296    
1297     HTML_DYNAMIC_MENUS = YES
1298    
1299 francois 737 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1300     # documentation will contain sections that can be hidden and shown after the
1301     # page has loaded.
1302     # The default value is: NO.
1303     # This tag requires that the tag GENERATE_HTML is set to YES.
1304 francois 284
1305 francois 737 HTML_DYNAMIC_SECTIONS = NO
1306 francois 284
1307 francois 737 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1308     # shown in the various tree structured indices initially; the user can expand
1309     # and collapse entries dynamically later on. Doxygen will expand the tree to
1310     # such a level that at most the specified number of entries are visible (unless
1311     # a fully collapsed tree already exceeds this amount). So setting the number of
1312     # entries 1 will produce a full collapsed tree by default. 0 is a special value
1313     # representing an infinite number of entries and will result in a full expanded
1314     # tree by default.
1315     # Minimum value: 0, maximum value: 9999, default value: 100.
1316     # This tag requires that the tag GENERATE_HTML is set to YES.
1317 francois 284
1318 francois 737 HTML_INDEX_NUM_ENTRIES = 100
1319 francois 284
1320 francois 737 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1321     # generated that can be used as input for Apple's Xcode 3 integrated development
1322 francois 1081 # environment (see: https://developer.apple.com/xcode/), introduced with OSX
1323     # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1324 francois 737 # Makefile in the HTML output directory. Running make will produce the docset in
1325     # that directory and running make install will install the docset in
1326     # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1327 francois 1081 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1328     # genXcode/_index.html for more information.
1329 francois 737 # The default value is: NO.
1330     # This tag requires that the tag GENERATE_HTML is set to YES.
1331 francois 284
1332     GENERATE_DOCSET = NO
1333    
1334 francois 737 # This tag determines the name of the docset feed. A documentation feed provides
1335     # an umbrella under which multiple documentation sets from a single provider
1336     # (such as a company or product suite) can be grouped.
1337     # The default value is: Doxygen generated docs.
1338     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1339 francois 284
1340     DOCSET_FEEDNAME = "Doxygen generated docs"
1341    
1342 francois 737 # This tag specifies a string that should uniquely identify the documentation
1343     # set bundle. This should be a reverse domain-name style string, e.g.
1344     # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1345     # The default value is: org.doxygen.Project.
1346     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1347 francois 284
1348     DOCSET_BUNDLE_ID = org.doxygen.Project
1349    
1350 francois 737 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1351     # the documentation publisher. This should be a reverse domain-name style
1352 francois 357 # string, e.g. com.mycompany.MyDocSet.documentation.
1353 francois 737 # The default value is: org.doxygen.Publisher.
1354     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1355 francois 357
1356     DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1357    
1358 francois 737 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1359     # The default value is: Publisher.
1360     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1361 francois 357
1362     DOCSET_PUBLISHER_NAME = Publisher
1363    
1364 francois 737 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1365     # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1366     # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1367 francois 1081 # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1368 francois 737 # Windows.
1369     #
1370     # The HTML Help Workshop contains a compiler that can convert all HTML output
1371     # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1372     # files are now used as the Windows 98 help format, and will replace the old
1373     # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1374     # HTML files also contain an index, a table of contents, and you can search for
1375     # words in the documentation. The HTML workshop also contains a viewer for
1376     # compressed HTML files.
1377     # The default value is: NO.
1378     # This tag requires that the tag GENERATE_HTML is set to YES.
1379 francois 284
1380 6 GENERATE_HTMLHELP = NO
1381 francois 284
1382 francois 737 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1383     # file. You can add a path in front of the file if the result should not be
1384 francois 284 # written to the html output directory.
1385 francois 737 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1386 francois 284
1387 francois 1081 CHM_FILE =
1388 francois 284
1389 francois 737 # The HHC_LOCATION tag can be used to specify the location (absolute path
1390 francois 1020 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1391 francois 737 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1392     # The file has to be specified with full path.
1393     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1394 francois 284
1395 francois 1081 HHC_LOCATION =
1396 francois 284
1397 francois 1020 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1398     # (YES) or that it should be included in the master .chm file (NO).
1399 francois 737 # The default value is: NO.
1400     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1401 francois 284
1402 6 GENERATE_CHI = NO
1403 francois 284
1404 francois 1020 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1405 francois 737 # and project file content.
1406     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1407 francois 284
1408 francois 1081 CHM_INDEX_ENCODING =
1409 francois 284
1410 francois 1020 # The BINARY_TOC flag controls whether a binary table of contents is generated
1411     # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1412     # enables the Previous and Next buttons.
1413 francois 737 # The default value is: NO.
1414     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1415 francois 284
1416 6 BINARY_TOC = NO
1417 francois 284
1418 francois 737 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1419     # the table of contents of the HTML help documentation and to the tree view.
1420     # The default value is: NO.
1421     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1422 francois 284
1423 6 TOC_EXPAND = NO
1424 francois 284
1425 francois 737 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1426     # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1427     # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1428     # (.qch) of the generated HTML documentation.
1429     # The default value is: NO.
1430     # This tag requires that the tag GENERATE_HTML is set to YES.
1431 francois 284
1432     GENERATE_QHP = NO
1433    
1434 francois 737 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1435     # the file name of the resulting .qch file. The path specified is relative to
1436     # the HTML output folder.
1437     # This tag requires that the tag GENERATE_QHP is set to YES.
1438 francois 284
1439 francois 1081 QCH_FILE =
1440 francois 284
1441 francois 737 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1442     # Project output. For more information please see Qt Help Project / Namespace
1443 francois 1081 # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1444 francois 737 # The default value is: org.doxygen.Project.
1445     # This tag requires that the tag GENERATE_QHP is set to YES.
1446 francois 284
1447     QHP_NAMESPACE = org.doxygen.Project
1448    
1449 francois 737 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1450     # Help Project output. For more information please see Qt Help Project / Virtual
1451 francois 1081 # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1452 francois 737 # folders).
1453     # The default value is: doc.
1454     # This tag requires that the tag GENERATE_QHP is set to YES.
1455 francois 284
1456     QHP_VIRTUAL_FOLDER = doc
1457    
1458 francois 737 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1459     # filter to add. For more information please see Qt Help Project / Custom
1460 francois 1081 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1461 francois 737 # filters).
1462     # This tag requires that the tag GENERATE_QHP is set to YES.
1463 francois 284
1464 francois 1081 QHP_CUST_FILTER_NAME =
1465 francois 284
1466 francois 737 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1467     # custom filter to add. For more information please see Qt Help Project / Custom
1468 francois 1081 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1469 francois 737 # filters).
1470     # This tag requires that the tag GENERATE_QHP is set to YES.
1471 francois 284
1472 francois 1081 QHP_CUST_FILTER_ATTRS =
1473 francois 284
1474 francois 737 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1475     # project's filter section matches. Qt Help Project / Filter Attributes (see:
1476 francois 1081 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1477 francois 737 # This tag requires that the tag GENERATE_QHP is set to YES.
1478 francois 284
1479 francois 1081 QHP_SECT_FILTER_ATTRS =
1480 francois 284
1481 francois 737 # The QHG_LOCATION tag can be used to specify the location of Qt's
1482     # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1483     # generated .qhp file.
1484     # This tag requires that the tag GENERATE_QHP is set to YES.
1485 francois 284
1486 francois 1081 QHG_LOCATION =
1487 francois 284
1488 francois 737 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1489     # generated, together with the HTML files, they form an Eclipse help plugin. To
1490     # install this plugin and make it available under the help contents menu in
1491     # Eclipse, the contents of the directory containing the HTML and XML files needs
1492     # to be copied into the plugins directory of eclipse. The name of the directory
1493     # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1494     # After copying Eclipse needs to be restarted before the help appears.
1495     # The default value is: NO.
1496     # This tag requires that the tag GENERATE_HTML is set to YES.
1497 francois 284
1498     GENERATE_ECLIPSEHELP = NO
1499    
1500 francois 737 # A unique identifier for the Eclipse help plugin. When installing the plugin
1501     # the directory name containing the HTML and XML files should also have this
1502     # name. Each documentation set should have its own identifier.
1503     # The default value is: org.doxygen.Project.
1504     # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1505 francois 284
1506     ECLIPSE_DOC_ID = org.doxygen.Project
1507    
1508 francois 737 # If you want full control over the layout of the generated HTML pages it might
1509     # be necessary to disable the index and replace it with your own. The
1510     # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1511     # of each HTML page. A value of NO enables the index and the value YES disables
1512     # it. Since the tabs in the index contain the same information as the navigation
1513     # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1514     # The default value is: NO.
1515     # This tag requires that the tag GENERATE_HTML is set to YES.
1516 francois 284
1517 6 DISABLE_INDEX = NO
1518 francois 284
1519 francois 737 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1520     # structure should be generated to display hierarchical information. If the tag
1521     # value is set to YES, a side panel will be generated containing a tree-like
1522     # index structure (just like the one that is generated for HTML Help). For this
1523     # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1524     # (i.e. any modern browser). Windows users are probably better off using the
1525 francois 1020 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1526 francois 737 # further fine-tune the look of the index. As an example, the default style
1527     # sheet generated by doxygen has an example that shows how to put an image at
1528     # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1529     # the same information as the tab index, you could consider setting
1530     # DISABLE_INDEX to YES when enabling this option.
1531     # The default value is: NO.
1532     # This tag requires that the tag GENERATE_HTML is set to YES.
1533 francois 284
1534 6 GENERATE_TREEVIEW = YES
1535 francois 284
1536 francois 737 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1537     # doxygen will group on one line in the generated HTML documentation.
1538     #
1539     # Note that a value of 0 will completely suppress the enum values from appearing
1540     # in the overview section.
1541     # Minimum value: 0, maximum value: 20, default value: 4.
1542     # This tag requires that the tag GENERATE_HTML is set to YES.
1543 francois 357
1544     ENUM_VALUES_PER_LINE = 1
1545    
1546 francois 737 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1547     # to set the initial width (in pixels) of the frame in which the tree is shown.
1548     # Minimum value: 0, maximum value: 1500, default value: 250.
1549     # This tag requires that the tag GENERATE_HTML is set to YES.
1550 francois 284
1551 6 TREEVIEW_WIDTH = 250
1552 francois 284
1553 francois 1020 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1554 francois 737 # external symbols imported via tag files in a separate window.
1555     # The default value is: NO.
1556     # This tag requires that the tag GENERATE_HTML is set to YES.
1557 francois 357
1558     EXT_LINKS_IN_WINDOW = NO
1559    
1560 francois 737 # Use this tag to change the font size of LaTeX formulas included as images in
1561     # the HTML documentation. When you change the font size after a successful
1562     # doxygen run you need to manually remove any form_*.png images from the HTML
1563     # output directory to force them to be regenerated.
1564     # Minimum value: 8, maximum value: 50, default value: 10.
1565     # This tag requires that the tag GENERATE_HTML is set to YES.
1566 francois 284
1567     FORMULA_FONTSIZE = 10
1568    
1569 francois 1081 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1570 francois 737 # generated for formulas are transparent PNGs. Transparent PNGs are not
1571     # supported properly for IE 6.0, but are supported on all modern browsers.
1572     #
1573     # Note that when changing this option you need to delete any form_*.png files in
1574     # the HTML output directory before the changes have effect.
1575     # The default value is: YES.
1576     # This tag requires that the tag GENERATE_HTML is set to YES.
1577 francois 357
1578     FORMULA_TRANSPARENT = YES
1579    
1580 francois 1081 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1581     # to create new LaTeX commands to be used in formulas as building blocks. See
1582     # the section "Including formulas" for details.
1583    
1584     FORMULA_MACROFILE =
1585    
1586 francois 737 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1587 francois 1081 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1588 francois 1020 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1589 francois 737 # installed or if you want to formulas look prettier in the HTML output. When
1590     # enabled you may also need to install MathJax separately and configure the path
1591     # to it using the MATHJAX_RELPATH option.
1592     # The default value is: NO.
1593     # This tag requires that the tag GENERATE_HTML is set to YES.
1594 francois 357
1595     USE_MATHJAX = NO
1596    
1597 francois 737 # When MathJax is enabled you can set the default output format to be used for
1598     # the MathJax output. See the MathJax site (see:
1599     # http://docs.mathjax.org/en/latest/output.html) for more details.
1600     # Possible values are: HTML-CSS (which is slower, but has the best
1601     # compatibility), NativeMML (i.e. MathML) and SVG.
1602     # The default value is: HTML-CSS.
1603     # This tag requires that the tag USE_MATHJAX is set to YES.
1604 francois 357
1605 francois 737 MATHJAX_FORMAT = HTML-CSS
1606    
1607     # When MathJax is enabled you need to specify the location relative to the HTML
1608     # output directory using the MATHJAX_RELPATH option. The destination directory
1609     # should contain the MathJax.js script. For instance, if the mathjax directory
1610     # is located at the same level as the HTML output directory, then
1611     # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1612     # Content Delivery Network so you can quickly see the result without installing
1613     # MathJax. However, it is strongly recommended to install a local copy of
1614 francois 1081 # MathJax from https://www.mathjax.org before deployment.
1615     # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1616 francois 737 # This tag requires that the tag USE_MATHJAX is set to YES.
1617    
1618 francois 357 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1619    
1620 francois 737 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1621     # extension names that should be enabled during MathJax rendering. For example
1622     # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1623     # This tag requires that the tag USE_MATHJAX is set to YES.
1624 francois 357
1625 francois 1081 MATHJAX_EXTENSIONS =
1626 francois 357
1627 francois 737 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1628     # of code that will be used on startup of the MathJax code. See the MathJax site
1629     # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1630     # example see the documentation.
1631     # This tag requires that the tag USE_MATHJAX is set to YES.
1632 francois 284
1633 francois 1081 MATHJAX_CODEFILE =
1634 francois 737
1635     # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1636     # the HTML output. The underlying search engine uses javascript and DHTML and
1637     # should work on any modern browser. Note that when using HTML help
1638     # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1639     # there is already a search function so this one should typically be disabled.
1640     # For large projects the javascript based search engine can be slow, then
1641     # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1642     # search using the keyboard; to jump to the search box use <access key> + S
1643     # (what the <access key> is depends on the OS and browser, but it is typically
1644     # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1645     # key> to jump into the search results window, the results can be navigated
1646     # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1647     # the search. The filter options can be selected when the cursor is inside the
1648     # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1649     # to select a filter and <Enter> or <escape> to activate or cancel the filter
1650     # option.
1651     # The default value is: YES.
1652     # This tag requires that the tag GENERATE_HTML is set to YES.
1653    
1654 francois 357 SEARCHENGINE = YES
1655 francois 284
1656 francois 737 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1657 francois 1081 # implemented using a web server instead of a web client using JavaScript. There
1658 francois 1020 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1659     # setting. When disabled, doxygen will generate a PHP script for searching and
1660     # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1661     # and searching needs to be provided by external tools. See the section
1662     # "External Indexing and Searching" for details.
1663 francois 737 # The default value is: NO.
1664     # This tag requires that the tag SEARCHENGINE is set to YES.
1665 francois 284
1666     SERVER_BASED_SEARCH = NO
1667    
1668 francois 737 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1669     # script for searching. Instead the search results are written to an XML file
1670     # which needs to be processed by an external indexer. Doxygen will invoke an
1671     # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1672     # search results.
1673     #
1674 francois 1020 # Doxygen ships with an example indexer (doxyindexer) and search engine
1675 francois 737 # (doxysearch.cgi) which are based on the open source search engine library
1676 francois 1081 # Xapian (see: https://xapian.org/).
1677 francois 737 #
1678     # See the section "External Indexing and Searching" for details.
1679     # The default value is: NO.
1680     # This tag requires that the tag SEARCHENGINE is set to YES.
1681    
1682     EXTERNAL_SEARCH = NO
1683    
1684     # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1685     # which will return the search results when EXTERNAL_SEARCH is enabled.
1686     #
1687 francois 1020 # Doxygen ships with an example indexer (doxyindexer) and search engine
1688 francois 737 # (doxysearch.cgi) which are based on the open source search engine library
1689 francois 1081 # Xapian (see: https://xapian.org/). See the section "External Indexing and
1690 francois 737 # Searching" for details.
1691     # This tag requires that the tag SEARCHENGINE is set to YES.
1692    
1693 francois 1081 SEARCHENGINE_URL =
1694 francois 737
1695     # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1696     # search data is written to a file for indexing by an external tool. With the
1697     # SEARCHDATA_FILE tag the name of this file can be specified.
1698     # The default file is: searchdata.xml.
1699     # This tag requires that the tag SEARCHENGINE is set to YES.
1700    
1701     SEARCHDATA_FILE = searchdata.xml
1702    
1703     # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1704     # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1705     # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1706     # projects and redirect the results back to the right project.
1707     # This tag requires that the tag SEARCHENGINE is set to YES.
1708    
1709 francois 1081 EXTERNAL_SEARCH_ID =
1710 francois 737
1711     # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1712     # projects other than the one defined by this configuration file, but that are
1713     # all added to the same external search index. Each project needs to have a
1714     # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1715     # to a relative location where the documentation can be found. The format is:
1716     # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1717     # This tag requires that the tag SEARCHENGINE is set to YES.
1718    
1719 francois 1081 EXTRA_SEARCH_MAPPINGS =
1720 francois 737
1721 6 #---------------------------------------------------------------------------
1722 francois 737 # Configuration options related to the LaTeX output
1723 6 #---------------------------------------------------------------------------
1724 francois 284
1725 francois 1020 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1726 francois 737 # The default value is: YES.
1727 francois 284
1728 6 GENERATE_LATEX = NO
1729 francois 284
1730 francois 737 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1731     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1732     # it.
1733     # The default directory is: latex.
1734     # This tag requires that the tag GENERATE_LATEX is set to YES.
1735 francois 284
1736 6 LATEX_OUTPUT = latex
1737 francois 284
1738 francois 737 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1739     # invoked.
1740     #
1741 francois 1081 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1742     # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1743     # chosen this is overwritten by pdflatex. For specific output languages the
1744     # default can have been set differently, this depends on the implementation of
1745     # the output language.
1746 francois 737 # This tag requires that the tag GENERATE_LATEX is set to YES.
1747 francois 284
1748 6 LATEX_CMD_NAME = latex
1749 francois 284
1750 francois 737 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1751     # index for LaTeX.
1752 francois 1081 # Note: This tag is used in the Makefile / make.bat.
1753     # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1754     # (.tex).
1755 francois 737 # The default file is: makeindex.
1756     # This tag requires that the tag GENERATE_LATEX is set to YES.
1757 francois 284
1758 6 MAKEINDEX_CMD_NAME = makeindex
1759 francois 284
1760 francois 1081 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1761     # generate index for LaTeX. In case there is no backslash (\) as first character
1762     # it will be automatically added in the LaTeX code.
1763     # Note: This tag is used in the generated output file (.tex).
1764     # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1765     # The default value is: makeindex.
1766     # This tag requires that the tag GENERATE_LATEX is set to YES.
1767    
1768     LATEX_MAKEINDEX_CMD = makeindex
1769    
1770 francois 1020 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1771 francois 737 # documents. This may be useful for small projects and may help to save some
1772     # trees in general.
1773     # The default value is: NO.
1774     # This tag requires that the tag GENERATE_LATEX is set to YES.
1775 francois 284
1776 6 COMPACT_LATEX = NO
1777 francois 284
1778 francois 737 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1779     # printer.
1780     # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1781     # 14 inches) and executive (7.25 x 10.5 inches).
1782     # The default value is: a4.
1783     # This tag requires that the tag GENERATE_LATEX is set to YES.
1784 francois 284
1785 6 PAPER_TYPE = a4wide
1786 francois 284
1787 francois 737 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1788 francois 1020 # that should be included in the LaTeX output. The package can be specified just
1789     # by its name or with the correct syntax as to be used with the LaTeX
1790     # \usepackage command. To get the times font for instance you can specify :
1791     # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1792     # To use the option intlimits with the amsmath package you can specify:
1793     # EXTRA_PACKAGES=[intlimits]{amsmath}
1794 francois 737 # If left blank no extra packages will be included.
1795     # This tag requires that the tag GENERATE_LATEX is set to YES.
1796 francois 284
1797 francois 1081 EXTRA_PACKAGES =
1798 francois 284
1799 francois 737 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1800     # generated LaTeX document. The header should contain everything until the first
1801     # chapter. If it is left blank doxygen will generate a standard header. See
1802     # section "Doxygen usage" for information on how to let doxygen write the
1803     # default header to a separate file.
1804     #
1805     # Note: Only use a user-defined header if you know what you are doing! The
1806     # following commands have a special meaning inside the header: $title,
1807 francois 1020 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1808     # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1809     # string, for the replacement values of the other commands the user is referred
1810     # to HTML_HEADER.
1811 francois 737 # This tag requires that the tag GENERATE_LATEX is set to YES.
1812 francois 284
1813 francois 1081 LATEX_HEADER =
1814 francois 284
1815 francois 737 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1816     # generated LaTeX document. The footer should contain everything after the last
1817 francois 1020 # chapter. If it is left blank doxygen will generate a standard footer. See
1818     # LATEX_HEADER for more information on how to generate a default footer and what
1819     # special commands can be used inside the footer.
1820 francois 737 #
1821     # Note: Only use a user-defined footer if you know what you are doing!
1822     # This tag requires that the tag GENERATE_LATEX is set to YES.
1823 francois 357
1824 francois 1081 LATEX_FOOTER =
1825 francois 357
1826 francois 1020 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1827     # LaTeX style sheets that are included after the standard style sheets created
1828     # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1829     # will copy the style sheet files to the output directory.
1830     # Note: The order of the extra style sheet files is of importance (e.g. the last
1831     # style sheet in the list overrules the setting of the previous ones in the
1832     # list).
1833     # This tag requires that the tag GENERATE_LATEX is set to YES.
1834    
1835 francois 1081 LATEX_EXTRA_STYLESHEET =
1836 francois 1020
1837 francois 737 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1838     # other source files which should be copied to the LATEX_OUTPUT output
1839     # directory. Note that the files will be copied as-is; there are no commands or
1840     # markers available.
1841     # This tag requires that the tag GENERATE_LATEX is set to YES.
1842 francois 284
1843 francois 1081 LATEX_EXTRA_FILES =
1844 francois 737
1845     # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1846     # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1847     # contain links (just like the HTML output) instead of page references. This
1848     # makes the output suitable for online browsing using a PDF viewer.
1849     # The default value is: YES.
1850     # This tag requires that the tag GENERATE_LATEX is set to YES.
1851    
1852 6 PDF_HYPERLINKS = NO
1853 francois 284
1854 francois 1020 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1855     # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1856 francois 284 # higher quality PDF documentation.
1857 francois 737 # The default value is: YES.
1858     # This tag requires that the tag GENERATE_LATEX is set to YES.
1859 francois 284
1860 6 USE_PDFLATEX = NO
1861 francois 284
1862 francois 737 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1863     # command to the generated LaTeX files. This will instruct LaTeX to keep running
1864     # if errors occur, instead of asking the user for help. This option is also used
1865     # when generating formulas in HTML.
1866     # The default value is: NO.
1867     # This tag requires that the tag GENERATE_LATEX is set to YES.
1868 francois 284
1869 6 LATEX_BATCHMODE = NO
1870 francois 284
1871 francois 737 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1872     # index chapters (such as File Index, Compound Index, etc.) in the output.
1873     # The default value is: NO.
1874     # This tag requires that the tag GENERATE_LATEX is set to YES.
1875 francois 284
1876 6 LATEX_HIDE_INDICES = NO
1877 francois 284
1878 francois 737 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1879     # code with syntax highlighting in the LaTeX output.
1880     #
1881     # Note that which sources are shown also depends on other settings such as
1882     # SOURCE_BROWSER.
1883     # The default value is: NO.
1884     # This tag requires that the tag GENERATE_LATEX is set to YES.
1885 francois 284
1886     LATEX_SOURCE_CODE = NO
1887    
1888 francois 737 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1889     # bibliography, e.g. plainnat, or ieeetr. See
1890 francois 1081 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1891 francois 737 # The default value is: plain.
1892     # This tag requires that the tag GENERATE_LATEX is set to YES.
1893 francois 357
1894     LATEX_BIB_STYLE = plain
1895    
1896 francois 1020 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1897     # page will contain the date and time when the page was generated. Setting this
1898     # to NO can help when comparing the output of multiple runs.
1899     # The default value is: NO.
1900     # This tag requires that the tag GENERATE_LATEX is set to YES.
1901    
1902     LATEX_TIMESTAMP = NO
1903    
1904 francois 1081 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1905     # path from which the emoji images will be read. If a relative path is entered,
1906     # it will be relative to the LATEX_OUTPUT directory. If left blank the
1907     # LATEX_OUTPUT directory will be used.
1908     # This tag requires that the tag GENERATE_LATEX is set to YES.
1909    
1910     LATEX_EMOJI_DIRECTORY =
1911    
1912 6 #---------------------------------------------------------------------------
1913 francois 737 # Configuration options related to the RTF output
1914 6 #---------------------------------------------------------------------------
1915 francois 284
1916 francois 1020 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1917 francois 737 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1918     # readers/editors.
1919     # The default value is: NO.
1920 francois 284
1921 6 GENERATE_RTF = NO
1922 francois 284
1923 francois 737 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1924     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1925     # it.
1926     # The default directory is: rtf.
1927     # This tag requires that the tag GENERATE_RTF is set to YES.
1928 francois 284
1929 6 RTF_OUTPUT = rtf
1930 francois 284
1931 francois 1020 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1932 francois 737 # documents. This may be useful for small projects and may help to save some
1933     # trees in general.
1934     # The default value is: NO.
1935     # This tag requires that the tag GENERATE_RTF is set to YES.
1936 francois 284
1937 6 COMPACT_RTF = NO
1938 francois 284
1939 francois 737 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1940     # contain hyperlink fields. The RTF file will contain links (just like the HTML
1941     # output) instead of page references. This makes the output suitable for online
1942     # browsing using Word or some other Word compatible readers that support those
1943     # fields.
1944     #
1945     # Note: WordPad (write) and others do not support links.
1946     # The default value is: NO.
1947     # This tag requires that the tag GENERATE_RTF is set to YES.
1948 francois 284
1949 6 RTF_HYPERLINKS = NO
1950 francois 284
1951 francois 1081 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1952     # configuration file, i.e. a series of assignments. You only have to provide
1953     # replacements, missing definitions are set to their default value.
1954 francois 737 #
1955     # See also section "Doxygen usage" for information on how to generate the
1956     # default style sheet that doxygen normally uses.
1957     # This tag requires that the tag GENERATE_RTF is set to YES.
1958 francois 284
1959 francois 1081 RTF_STYLESHEET_FILE =
1960 francois 284
1961 francois 737 # Set optional variables used in the generation of an RTF document. Syntax is
1962 francois 1081 # similar to doxygen's configuration file. A template extensions file can be
1963     # generated using doxygen -e rtf extensionFile.
1964 francois 737 # This tag requires that the tag GENERATE_RTF is set to YES.
1965 francois 284
1966 francois 1081 RTF_EXTENSIONS_FILE =
1967 francois 284
1968 francois 1020 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1969     # with syntax highlighting in the RTF output.
1970     #
1971     # Note that which sources are shown also depends on other settings such as
1972     # SOURCE_BROWSER.
1973     # The default value is: NO.
1974     # This tag requires that the tag GENERATE_RTF is set to YES.
1975    
1976     RTF_SOURCE_CODE = NO
1977    
1978 6 #---------------------------------------------------------------------------
1979 francois 737 # Configuration options related to the man page output
1980 6 #---------------------------------------------------------------------------
1981 francois 284
1982 francois 1020 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1983 francois 737 # classes and files.
1984     # The default value is: NO.
1985 francois 284
1986 6 GENERATE_MAN = NO
1987 francois 284
1988 francois 737 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1989     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1990     # it. A directory man3 will be created inside the directory specified by
1991     # MAN_OUTPUT.
1992     # The default directory is: man.
1993     # This tag requires that the tag GENERATE_MAN is set to YES.
1994 francois 284
1995 6 MAN_OUTPUT = man
1996 francois 284
1997 francois 737 # The MAN_EXTENSION tag determines the extension that is added to the generated
1998     # man pages. In case the manual section does not start with a number, the number
1999     # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2000     # optional.
2001     # The default value is: .3.
2002     # This tag requires that the tag GENERATE_MAN is set to YES.
2003 francois 284
2004 6 MAN_EXTENSION = .3
2005 francois 284
2006 francois 1020 # The MAN_SUBDIR tag determines the name of the directory created within
2007     # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2008     # MAN_EXTENSION with the initial . removed.
2009     # This tag requires that the tag GENERATE_MAN is set to YES.
2010    
2011 francois 1081 MAN_SUBDIR =
2012 francois 1020
2013 francois 737 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2014     # will generate one additional man file for each entity documented in the real
2015     # man page(s). These additional files only source the real man page, but without
2016     # them the man command would be unable to find the correct page.
2017     # The default value is: NO.
2018     # This tag requires that the tag GENERATE_MAN is set to YES.
2019 francois 284
2020 6 MAN_LINKS = NO
2021 francois 284
2022 6 #---------------------------------------------------------------------------
2023 francois 737 # Configuration options related to the XML output
2024 6 #---------------------------------------------------------------------------
2025 francois 284
2026 francois 1020 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2027 francois 737 # captures the structure of the code including all documentation.
2028     # The default value is: NO.
2029 francois 284
2030 6 GENERATE_XML = NO
2031 francois 284
2032 francois 737 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2033     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2034     # it.
2035     # The default directory is: xml.
2036     # This tag requires that the tag GENERATE_XML is set to YES.
2037 francois 284
2038 6 XML_OUTPUT = xml
2039 francois 284
2040 francois 1020 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2041 francois 737 # listings (including syntax highlighting and cross-referencing information) to
2042     # the XML output. Note that enabling this will significantly increase the size
2043     # of the XML output.
2044     # The default value is: YES.
2045     # This tag requires that the tag GENERATE_XML is set to YES.
2046 francois 284
2047 6 XML_PROGRAMLISTING = YES
2048 francois 284
2049 francois 1081 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2050     # namespace members in file scope as well, matching the HTML output.
2051     # The default value is: NO.
2052     # This tag requires that the tag GENERATE_XML is set to YES.
2053    
2054     XML_NS_MEMB_FILE_SCOPE = NO
2055    
2056 6 #---------------------------------------------------------------------------
2057 francois 737 # Configuration options related to the DOCBOOK output
2058 6 #---------------------------------------------------------------------------
2059 francois 284
2060 francois 1020 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2061 francois 737 # that can be used to generate PDF.
2062     # The default value is: NO.
2063 francois 284
2064 francois 737 GENERATE_DOCBOOK = NO
2065    
2066     # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2067     # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2068     # front of it.
2069     # The default directory is: docbook.
2070     # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2071    
2072     DOCBOOK_OUTPUT = docbook
2073    
2074 francois 1020 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2075     # program listings (including syntax highlighting and cross-referencing
2076     # information) to the DOCBOOK output. Note that enabling this will significantly
2077     # increase the size of the DOCBOOK output.
2078     # The default value is: NO.
2079     # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2080    
2081     DOCBOOK_PROGRAMLISTING = NO
2082    
2083 francois 737 #---------------------------------------------------------------------------
2084     # Configuration options for the AutoGen Definitions output
2085     #---------------------------------------------------------------------------
2086    
2087 francois 1020 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2088 francois 1081 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2089     # the structure of the code including all documentation. Note that this feature
2090     # is still experimental and incomplete at the moment.
2091 francois 737 # The default value is: NO.
2092    
2093 6 GENERATE_AUTOGEN_DEF = NO
2094 francois 284
2095 6 #---------------------------------------------------------------------------
2096 francois 737 # Configuration options related to the Perl module output
2097 6 #---------------------------------------------------------------------------
2098 francois 284
2099 francois 1020 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2100 francois 737 # file that captures the structure of the code including all documentation.
2101     #
2102     # Note that this feature is still experimental and incomplete at the moment.
2103     # The default value is: NO.
2104 francois 284
2105 6 GENERATE_PERLMOD = NO
2106 francois 284
2107 francois 1020 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2108 francois 737 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2109     # output from the Perl module output.
2110     # The default value is: NO.
2111     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2112 francois 284
2113 6 PERLMOD_LATEX = NO
2114 francois 284
2115 francois 1020 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2116 francois 737 # formatted so it can be parsed by a human reader. This is useful if you want to
2117 francois 1020 # understand what is going on. On the other hand, if this tag is set to NO, the
2118 francois 737 # size of the Perl module output will be much smaller and Perl will parse it
2119     # just the same.
2120     # The default value is: YES.
2121     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2122 francois 284
2123 6 PERLMOD_PRETTY = YES
2124 francois 284
2125 francois 737 # The names of the make variables in the generated doxyrules.make file are
2126     # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2127     # so different doxyrules.make files included by the same Makefile don't
2128     # overwrite each other's variables.
2129     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2130 francois 284
2131 francois 1081 PERLMOD_MAKEVAR_PREFIX =
2132 francois 284
2133 6 #---------------------------------------------------------------------------
2134 francois 284 # Configuration options related to the preprocessor
2135 6 #---------------------------------------------------------------------------
2136 francois 284
2137 francois 1020 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2138 francois 737 # C-preprocessor directives found in the sources and include files.
2139     # The default value is: YES.
2140 francois 284
2141 6 ENABLE_PREPROCESSING = YES
2142 francois 284
2143 francois 1020 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2144     # in the source code. If set to NO, only conditional compilation will be
2145 francois 737 # performed. Macro expansion can be done in a controlled way by setting
2146     # EXPAND_ONLY_PREDEF to YES.
2147     # The default value is: NO.
2148     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2149 francois 284
2150 6 MACRO_EXPANSION = NO
2151 francois 284
2152 francois 737 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2153     # the macro expansion is limited to the macros specified with the PREDEFINED and
2154     # EXPAND_AS_DEFINED tags.
2155     # The default value is: NO.
2156     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2157 francois 284
2158 6 EXPAND_ONLY_PREDEF = NO
2159 francois 284
2160 francois 1020 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2161 francois 737 # INCLUDE_PATH will be searched if a #include is found.
2162     # The default value is: YES.
2163     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2164 francois 284
2165 6 SEARCH_INCLUDES = YES
2166 francois 284
2167 francois 737 # The INCLUDE_PATH tag can be used to specify one or more directories that
2168     # contain include files that are not input files but should be processed by the
2169     # preprocessor.
2170     # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2171 francois 284
2172 francois 1081 INCLUDE_PATH =
2173 francois 284
2174 francois 737 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2175     # patterns (like *.h and *.hpp) to filter out the header-files in the
2176     # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2177     # used.
2178     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2179 francois 284
2180 francois 1081 INCLUDE_FILE_PATTERNS =
2181 francois 284
2182 francois 737 # The PREDEFINED tag can be used to specify one or more macro names that are
2183     # defined before the preprocessor is started (similar to the -D option of e.g.
2184     # gcc). The argument of the tag is a list of macros of the form: name or
2185     # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2186     # is assumed. To prevent a macro definition from being undefined via #undef or
2187     # recursively expanded use the := operator instead of the = operator.
2188     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2189 francois 284
2190 6 PREDEFINED = BREP_SAT \
2191     BREP_STEP \
2192 francois 175 BREP_SLD \
2193 francois 1081 BREP_OCC \
2194     ALL_OCC
2195 francois 284
2196 francois 737 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2197     # tag can be used to specify a list of macro names that should be expanded. The
2198     # macro definition that is found in the sources will be used. Use the PREDEFINED
2199     # tag if you want to use a different macro definition that overrules the
2200     # definition found in the source code.
2201     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2202 francois 284
2203 francois 1081 EXPAND_AS_DEFINED =
2204 francois 284
2205 francois 737 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2206 francois 1020 # remove all references to function-like macros that are alone on a line, have
2207     # an all uppercase name, and do not end with a semicolon. Such function macros
2208     # are typically used for boiler-plate code, and will confuse the parser if not
2209 francois 737 # removed.
2210     # The default value is: YES.
2211     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2212 francois 284
2213 francois 652 SKIP_FUNCTION_MACROS = NO
2214 francois 284
2215 6 #---------------------------------------------------------------------------
2216 francois 737 # Configuration options related to external references
2217 6 #---------------------------------------------------------------------------
2218 francois 284
2219 francois 737 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2220     # file the location of the external documentation should be added. The format of
2221     # a tag file without this location is as follows:
2222     # TAGFILES = file1 file2 ...
2223     # Adding location for the tag files is done as follows:
2224     # TAGFILES = file1=loc1 "file2 = loc2" ...
2225     # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2226     # section "Linking to external documentation" for more information about the use
2227     # of tag files.
2228 francois 1020 # Note: Each tag file must have a unique name (where the name does NOT include
2229 francois 737 # the path). If a tag file is not located in the directory in which doxygen is
2230     # run, you must also specify the path to the tagfile here.
2231 francois 284
2232 francois 1081 TAGFILES =
2233 francois 284
2234 francois 737 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2235     # tag file that is based on the input files it reads. See section "Linking to
2236     # external documentation" for more information about the usage of tag files.
2237 francois 284
2238 francois 1081 GENERATE_TAGFILE =
2239 francois 284
2240 francois 1020 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2241     # the class index. If set to NO, only the inherited external classes will be
2242     # listed.
2243 francois 737 # The default value is: NO.
2244 francois 284
2245 6 ALLEXTERNALS = NO
2246 francois 284
2247 francois 1020 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2248     # in the modules index. If set to NO, only the current project's groups will be
2249 francois 737 # listed.
2250     # The default value is: YES.
2251 francois 284
2252 6 EXTERNAL_GROUPS = YES
2253 francois 284
2254 francois 1020 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2255 francois 737 # the related pages index. If set to NO, only the current project's pages will
2256     # be listed.
2257     # The default value is: YES.
2258 francois 284
2259 francois 737 EXTERNAL_PAGES = YES
2260    
2261 6 #---------------------------------------------------------------------------
2262 francois 284 # Configuration options related to the dot tool
2263 6 #---------------------------------------------------------------------------
2264 francois 284
2265 francois 1020 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2266 francois 737 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2267     # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2268     # disabled, but it is recommended to install and use dot, since it yields more
2269     # powerful graphs.
2270     # The default value is: YES.
2271 francois 284
2272 francois 1057 CLASS_DIAGRAMS = YES
2273 francois 284
2274 francois 737 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2275     # then run dia to produce the diagram and insert it in the documentation. The
2276     # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2277     # If left empty dia is assumed to be found in the default search path.
2278 francois 284
2279 francois 1081 DIA_PATH =
2280 francois 737
2281 francois 1020 # If set to YES the inheritance and collaboration graphs will hide inheritance
2282 francois 737 # and usage relations if the target is undocumented or is not a class.
2283     # The default value is: YES.
2284    
2285 6 HIDE_UNDOC_RELATIONS = YES
2286 francois 284
2287 francois 737 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2288     # available from the path. This tool is part of Graphviz (see:
2289     # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2290     # Bell Labs. The other options in this section have no effect if this option is
2291     # set to NO
2292 francois 1020 # The default value is: YES.
2293 francois 284
2294 6 HAVE_DOT = YES
2295 francois 284
2296 francois 737 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2297     # to run in parallel. When set to 0 doxygen will base this on the number of
2298     # processors available in the system. You can set it explicitly to a value
2299     # larger than 0 to get control over the balance between CPU load and processing
2300     # speed.
2301     # Minimum value: 0, maximum value: 32, default value: 0.
2302     # This tag requires that the tag HAVE_DOT is set to YES.
2303 francois 284
2304 francois 357 DOT_NUM_THREADS = 0
2305    
2306 francois 1020 # When you want a differently looking font in the dot files that doxygen
2307 francois 737 # generates you can specify the font name using DOT_FONTNAME. You need to make
2308     # sure dot is able to find the font, which can be done by putting it in a
2309     # standard location or by setting the DOTFONTPATH environment variable or by
2310     # setting DOT_FONTPATH to the directory containing the font.
2311     # The default value is: Helvetica.
2312     # This tag requires that the tag HAVE_DOT is set to YES.
2313 francois 357
2314 francois 284 DOT_FONTNAME = FreeSans
2315    
2316 francois 737 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2317     # dot graphs.
2318     # Minimum value: 4, maximum value: 24, default value: 10.
2319     # This tag requires that the tag HAVE_DOT is set to YES.
2320 francois 284
2321     DOT_FONTSIZE = 10
2322    
2323 francois 737 # By default doxygen will tell dot to use the default font as specified with
2324     # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2325     # the path where dot can find it using this tag.
2326     # This tag requires that the tag HAVE_DOT is set to YES.
2327 francois 284
2328 francois 1081 DOT_FONTPATH =
2329 francois 284
2330 francois 737 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2331     # each documented class showing the direct and indirect inheritance relations.
2332     # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2333     # The default value is: YES.
2334     # This tag requires that the tag HAVE_DOT is set to YES.
2335 francois 284
2336 6 CLASS_GRAPH = YES
2337 francois 284
2338 francois 737 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2339     # graph for each documented class showing the direct and indirect implementation
2340     # dependencies (inheritance, containment, and class references variables) of the
2341     # class with other documented classes.
2342     # The default value is: YES.
2343     # This tag requires that the tag HAVE_DOT is set to YES.
2344 francois 284
2345 6 COLLABORATION_GRAPH = YES
2346 francois 284
2347 francois 737 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2348     # groups, showing the direct groups dependencies.
2349     # The default value is: YES.
2350     # This tag requires that the tag HAVE_DOT is set to YES.
2351 francois 284
2352 6 GROUP_GRAPHS = YES
2353 francois 284
2354 francois 1020 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2355 francois 737 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2356 francois 284 # Language.
2357 francois 737 # The default value is: NO.
2358     # This tag requires that the tag HAVE_DOT is set to YES.
2359 francois 284
2360 6 UML_LOOK = NO
2361 francois 284
2362 francois 737 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2363     # class node. If there are many fields or methods and many nodes the graph may
2364     # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2365     # number of items for each type to make the size more manageable. Set this to 0
2366     # for no limit. Note that the threshold may be exceeded by 50% before the limit
2367     # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2368     # but if the number exceeds 15, the total amount of fields shown is limited to
2369     # 10.
2370     # Minimum value: 0, maximum value: 100, default value: 10.
2371     # This tag requires that the tag HAVE_DOT is set to YES.
2372 francois 284
2373 francois 737 UML_LIMIT_NUM_FIELDS = 10
2374    
2375     # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2376     # collaboration graphs will show the relations between templates and their
2377     # instances.
2378     # The default value is: NO.
2379     # This tag requires that the tag HAVE_DOT is set to YES.
2380    
2381 6 TEMPLATE_RELATIONS = NO
2382 francois 284
2383 francois 737 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2384     # YES then doxygen will generate a graph for each documented file showing the
2385     # direct and indirect include dependencies of the file with other documented
2386     # files.
2387     # The default value is: YES.
2388     # This tag requires that the tag HAVE_DOT is set to YES.
2389 francois 284
2390 6 INCLUDE_GRAPH = YES
2391 francois 284
2392 francois 737 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2393     # set to YES then doxygen will generate a graph for each documented file showing
2394     # the direct and indirect include dependencies of the file with other documented
2395     # files.
2396     # The default value is: YES.
2397     # This tag requires that the tag HAVE_DOT is set to YES.
2398 francois 284
2399 6 INCLUDED_BY_GRAPH = YES
2400 francois 284
2401 francois 737 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2402     # dependency graph for every global function or class method.
2403     #
2404     # Note that enabling this option will significantly increase the time of a run.
2405     # So in most cases it will be better to enable call graphs for selected
2406 francois 1020 # functions only using the \callgraph command. Disabling a call graph can be
2407     # accomplished by means of the command \hidecallgraph.
2408 francois 737 # The default value is: NO.
2409     # This tag requires that the tag HAVE_DOT is set to YES.
2410 francois 284
2411 6 CALL_GRAPH = YES
2412 francois 284
2413 francois 737 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2414     # dependency graph for every global function or class method.
2415     #
2416     # Note that enabling this option will significantly increase the time of a run.
2417     # So in most cases it will be better to enable caller graphs for selected
2418 francois 1020 # functions only using the \callergraph command. Disabling a caller graph can be
2419     # accomplished by means of the command \hidecallergraph.
2420 francois 737 # The default value is: NO.
2421     # This tag requires that the tag HAVE_DOT is set to YES.
2422 francois 284
2423     CALLER_GRAPH = YES
2424    
2425 francois 737 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2426     # hierarchy of all classes instead of a textual one.
2427     # The default value is: YES.
2428     # This tag requires that the tag HAVE_DOT is set to YES.
2429 francois 284
2430 6 GRAPHICAL_HIERARCHY = YES
2431 francois 284
2432 francois 737 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2433     # dependencies a directory has on other directories in a graphical way. The
2434     # dependency relations are determined by the #include relations between the
2435     # files in the directories.
2436     # The default value is: YES.
2437     # This tag requires that the tag HAVE_DOT is set to YES.
2438 francois 284
2439 6 DIRECTORY_GRAPH = YES
2440 francois 284
2441 francois 737 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2442 francois 1020 # generated by dot. For an explanation of the image formats see the section
2443     # output formats in the documentation of the dot tool (Graphviz (see:
2444     # http://www.graphviz.org/)).
2445 francois 737 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2446     # to make the SVG files visible in IE 9+ (other browsers do not have this
2447     # requirement).
2448 francois 1020 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2449     # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2450     # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2451     # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2452     # png:gdiplus:gdiplus.
2453 francois 737 # The default value is: png.
2454     # This tag requires that the tag HAVE_DOT is set to YES.
2455 francois 284
2456 6 DOT_IMAGE_FORMAT = png
2457 francois 284
2458 francois 737 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2459     # enable generation of interactive SVG images that allow zooming and panning.
2460     #
2461     # Note that this requires a modern browser other than Internet Explorer. Tested
2462     # and working are Firefox, Chrome, Safari, and Opera.
2463     # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2464     # the SVG files visible. Older versions of IE do not have SVG support.
2465     # The default value is: NO.
2466     # This tag requires that the tag HAVE_DOT is set to YES.
2467 francois 357
2468     INTERACTIVE_SVG = NO
2469    
2470 francois 737 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2471 francois 284 # found. If left blank, it is assumed the dot tool can be found in the path.
2472 francois 737 # This tag requires that the tag HAVE_DOT is set to YES.
2473 francois 284
2474 francois 1081 DOT_PATH =
2475 francois 284
2476 francois 737 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2477     # contain dot files that are included in the documentation (see the \dotfile
2478     # command).
2479     # This tag requires that the tag HAVE_DOT is set to YES.
2480 francois 284
2481 francois 1081 DOTFILE_DIRS =
2482 francois 284
2483 francois 737 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2484     # contain msc files that are included in the documentation (see the \mscfile
2485     # command).
2486 francois 357
2487 francois 1081 MSCFILE_DIRS =
2488 francois 357
2489 francois 737 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2490     # contain dia files that are included in the documentation (see the \diafile
2491     # command).
2492 francois 284
2493 francois 1081 DIAFILE_DIRS =
2494 francois 737
2495 francois 1020 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2496     # path where java can find the plantuml.jar file. If left blank, it is assumed
2497     # PlantUML is not used or called during a preprocessing step. Doxygen will
2498     # generate a warning when it encounters a \startuml command in this case and
2499     # will not generate output for the diagram.
2500    
2501 francois 1081 PLANTUML_JAR_PATH =
2502 francois 1020
2503 francois 1057 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2504     # configuration file for plantuml.
2505    
2506 francois 1081 PLANTUML_CFG_FILE =
2507 francois 1057
2508 francois 1020 # When using plantuml, the specified paths are searched for files specified by
2509     # the !include statement in a plantuml block.
2510    
2511 francois 1081 PLANTUML_INCLUDE_PATH =
2512 francois 1020
2513 francois 737 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2514     # that will be shown in the graph. If the number of nodes in a graph becomes
2515     # larger than this value, doxygen will truncate the graph, which is visualized
2516     # by representing a node as a red box. Note that doxygen if the number of direct
2517     # children of the root node in a graph is already larger than
2518     # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2519     # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2520     # Minimum value: 0, maximum value: 10000, default value: 50.
2521     # This tag requires that the tag HAVE_DOT is set to YES.
2522    
2523 francois 1057 DOT_GRAPH_MAX_NODES = 500
2524 francois 284
2525 francois 737 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2526     # generated by dot. A depth value of 3 means that only nodes reachable from the
2527     # root by following a path via at most 3 edges will be shown. Nodes that lay
2528     # further from the root node will be omitted. Note that setting this option to 1
2529     # or 2 may greatly reduce the computation time needed for large code bases. Also
2530     # note that the size of a graph can be further restricted by
2531 francois 284 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2532 francois 737 # Minimum value: 0, maximum value: 1000, default value: 0.
2533     # This tag requires that the tag HAVE_DOT is set to YES.
2534 francois 284
2535 6 MAX_DOT_GRAPH_DEPTH = 1000
2536 francois 284
2537 francois 737 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2538     # background. This is disabled by default, because dot on Windows does not seem
2539     # to support this out of the box.
2540     #
2541     # Warning: Depending on the platform used, enabling this option may lead to
2542     # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2543     # read).
2544     # The default value is: NO.
2545     # This tag requires that the tag HAVE_DOT is set to YES.
2546 francois 284
2547 6 DOT_TRANSPARENT = NO
2548 francois 284
2549 francois 1020 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2550 francois 737 # files in one run (i.e. multiple -o and -T options on the command line). This
2551     # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2552     # this, this feature is disabled by default.
2553     # The default value is: NO.
2554     # This tag requires that the tag HAVE_DOT is set to YES.
2555 francois 284
2556 6 DOT_MULTI_TARGETS = NO
2557 francois 284
2558 francois 737 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2559     # explaining the meaning of the various boxes and arrows in the dot generated
2560     # graphs.
2561     # The default value is: YES.
2562     # This tag requires that the tag HAVE_DOT is set to YES.
2563 francois 284
2564 6 GENERATE_LEGEND = YES
2565 francois 284
2566 francois 1020 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2567 francois 737 # files that are used to generate the various graphs.
2568     # The default value is: YES.
2569     # This tag requires that the tag HAVE_DOT is set to YES.
2570 francois 284
2571 6 DOT_CLEANUP = YES