ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/REPOS_ERICCA/magic/documentation/docmagic
Revision: 1081
Committed: Mon Nov 1 21:29:51 2021 UTC (3 years, 6 months ago) by francois
File size: 112280 byte(s)
Log Message:
ajout des classe de constructrion de forme geometrique dans la documentation

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 1008 PROJECT_NUMBER = v4
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 1081 PROJECT_BRIEF =
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 1081 PROJECT_LOGO =
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     EXTRACT_PRIV_VIRTUAL = NO
483    
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 737 INPUT = ../lib \
833 francois 1069 ../addin \
834     ../app/aide
835 francois 284
836 francois 737 # This tag can be used to specify the character encoding of the source files
837     # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
838     # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
839 francois 1081 # documentation (see: https://www.gnu.org/software/libiconv/) for the list of
840 francois 737 # possible encodings.
841     # The default value is: UTF-8.
842 francois 284
843     INPUT_ENCODING = UTF-8
844    
845 francois 737 # If the value of the INPUT tag contains directories, you can use the
846     # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
847 francois 1020 # *.h) to filter out the source-files in the directories.
848     #
849     # Note that for custom extensions or not directly supported extensions you also
850     # need to set EXTENSION_MAPPING for the extension otherwise the files are not
851     # read by doxygen.
852     #
853     # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
854     # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
855     # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
856 francois 1081 # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
857     # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
858     # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd,
859     # *.vhdl, *.ucf, *.qsf and *.ice.
860 francois 284
861 6 FILE_PATTERNS = *.c \
862     *.cc \
863     *.cxx \
864     *.cpp \
865     *.c++ \
866     *.java \
867     *.ii \
868     *.ixx \
869     *.ipp \
870     *.i++ \
871     *.inl \
872     *.h \
873     *.hh \
874     *.hxx \
875     *.hpp \
876     *.h++ \
877     *.idl \
878     *.odl \
879     *.cs \
880     *.php \
881     *.php3 \
882     *.inc \
883     *.m \
884     *.mm \
885     *.dox
886 francois 284
887 francois 737 # The RECURSIVE tag can be used to specify whether or not subdirectories should
888     # be searched for input files as well.
889     # The default value is: NO.
890 francois 284
891 6 RECURSIVE = YES
892 francois 284
893 francois 737 # The EXCLUDE tag can be used to specify files and/or directories that should be
894     # excluded from the INPUT source files. This way you can easily exclude a
895     # subdirectory from a directory tree whose root is specified with the INPUT tag.
896     #
897     # Note that relative paths are relative to the directory from which doxygen is
898 francois 357 # run.
899 francois 284
900     EXCLUDE = ../lib/OCC_Fonction \
901 francois 357 ../lib/geometrie/Imports \
902 francois 1020 ../lib/diamesh \
903 francois 1061 ../addin/poly_occ/voro++-0.4.6
904 francois 284
905 francois 737 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
906     # directories that are symbolic links (a Unix file system feature) are excluded
907 francois 284 # from the input.
908 francois 737 # The default value is: NO.
909 francois 284
910 6 EXCLUDE_SYMLINKS = NO
911 francois 284
912 francois 737 # If the value of the INPUT tag contains directories, you can use the
913     # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
914     # certain files from those directories.
915     #
916     # Note that the wildcards are matched against the file with absolute path, so to
917     # exclude all test directories for example use the pattern */test/*
918 francois 284
919 francois 1081 EXCLUDE_PATTERNS =
920 francois 284
921 francois 737 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
922     # (namespaces, classes, functions, etc.) that should be excluded from the
923     # output. The symbol name can be a fully qualified name, a word, or if the
924     # wildcard * is used, a substring. Examples: ANamespace, AClass,
925 francois 284 # AClass::ANamespace, ANamespace::*Test
926 francois 737 #
927     # Note that the wildcards are matched against the file with absolute path, so to
928     # exclude all test directories use the pattern */test/*
929 francois 284
930 francois 1081 EXCLUDE_SYMBOLS =
931 francois 284
932 francois 737 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
933     # that contain example code fragments that are included (see the \include
934     # command).
935 francois 284
936 francois 1081 EXAMPLE_PATH =
937 francois 284
938 francois 737 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
939     # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
940     # *.h) to filter out the source-files in the directories. If left blank all
941     # files are included.
942 francois 284
943 6 EXAMPLE_PATTERNS = *
944 francois 284
945 francois 737 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
946     # searched for input files to be used with the \include or \dontinclude commands
947     # irrespective of the value of the RECURSIVE tag.
948     # The default value is: NO.
949 francois 284
950 6 EXAMPLE_RECURSIVE = NO
951 francois 284
952 francois 737 # The IMAGE_PATH tag can be used to specify one or more files or directories
953     # that contain images that are to be included in the documentation (see the
954     # \image command).
955 francois 284
956 francois 1081 IMAGE_PATH =
957 francois 284
958 francois 737 # The INPUT_FILTER tag can be used to specify a program that doxygen should
959     # invoke to filter for each input file. Doxygen will invoke the filter program
960     # by executing (via popen()) the command:
961     #
962     # <filter> <input-file>
963     #
964     # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
965     # name of an input file. Doxygen will then use the output that the filter
966     # program writes to standard output. If FILTER_PATTERNS is specified, this tag
967     # will be ignored.
968     #
969     # Note that the filter must not add or remove lines; it is applied before the
970     # code is scanned, but not when the output code is generated. If lines are added
971     # or removed, the anchors will not be placed correctly.
972 francois 1020 #
973     # Note that for custom extensions or not directly supported extensions you also
974     # need to set EXTENSION_MAPPING for the extension otherwise the files are not
975     # properly processed by doxygen.
976 francois 284
977 francois 1081 INPUT_FILTER =
978 francois 284
979 francois 737 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
980     # basis. Doxygen will compare the file name with each pattern and apply the
981     # filter if there is a match. The filters are a list of the form: pattern=filter
982     # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
983     # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
984     # patterns match the file name, INPUT_FILTER is applied.
985 francois 1020 #
986     # Note that for custom extensions or not directly supported extensions you also
987     # need to set EXTENSION_MAPPING for the extension otherwise the files are not
988     # properly processed by doxygen.
989 francois 284
990 francois 1081 FILTER_PATTERNS =
991 francois 284
992 francois 737 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
993 francois 1020 # INPUT_FILTER) will also be used to filter the input files that are used for
994 francois 737 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
995     # The default value is: NO.
996 francois 284
997 6 FILTER_SOURCE_FILES = NO
998 francois 284
999 francois 737 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1000     # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1001     # it is also possible to disable source filtering for a specific pattern using
1002     # *.ext= (so without naming a filter).
1003     # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1004 francois 357
1005 francois 1081 FILTER_SOURCE_PATTERNS =
1006 francois 357
1007 francois 737 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1008     # is part of the input, its contents will be placed on the main page
1009     # (index.html). This can be useful if you have a project on for instance GitHub
1010     # and want to reuse the introduction page also for the doxygen output.
1011    
1012 francois 1081 USE_MDFILE_AS_MAINPAGE =
1013 francois 737
1014 6 #---------------------------------------------------------------------------
1015 francois 737 # Configuration options related to source browsing
1016 6 #---------------------------------------------------------------------------
1017 francois 284
1018 francois 737 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1019     # generated. Documented entities will be cross-referenced with these sources.
1020     #
1021     # Note: To get rid of all source code in the generated output, make sure that
1022     # also VERBATIM_HEADERS is set to NO.
1023     # The default value is: NO.
1024 francois 284
1025 francois 175 SOURCE_BROWSER = YES
1026 francois 284
1027 francois 737 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1028     # classes and enums directly into the documentation.
1029     # The default value is: NO.
1030 francois 284
1031 6 INLINE_SOURCES = NO
1032 francois 284
1033 francois 737 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1034     # special comment blocks from generated source code fragments. Normal C, C++ and
1035     # Fortran comments will always remain visible.
1036     # The default value is: YES.
1037 francois 284
1038 6 STRIP_CODE_COMMENTS = YES
1039 francois 284
1040 francois 737 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1041 francois 1081 # entity all documented functions referencing it will be listed.
1042 francois 737 # The default value is: NO.
1043 francois 284
1044 6 REFERENCED_BY_RELATION = YES
1045 francois 284
1046 francois 737 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1047     # all documented entities called/used by that function will be listed.
1048     # The default value is: NO.
1049 francois 284
1050 6 REFERENCES_RELATION = YES
1051 francois 284
1052 francois 737 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1053 francois 1020 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1054 francois 737 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1055     # link to the documentation.
1056     # The default value is: YES.
1057 francois 284
1058     REFERENCES_LINK_SOURCE = YES
1059    
1060 francois 737 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1061     # source code will show a tooltip with additional information such as prototype,
1062     # brief description and links to the definition and documentation. Since this
1063     # will make the HTML file larger and loading of large files a bit slower, you
1064     # can opt to disable this feature.
1065     # The default value is: YES.
1066     # This tag requires that the tag SOURCE_BROWSER is set to YES.
1067 francois 284
1068 francois 737 SOURCE_TOOLTIPS = YES
1069    
1070     # If the USE_HTAGS tag is set to YES then the references to source code will
1071     # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1072     # source browser. The htags tool is part of GNU's global source tagging system
1073 francois 1081 # (see https://www.gnu.org/software/global/global.html). You will need version
1074 francois 737 # 4.8.6 or higher.
1075     #
1076     # To use it do the following:
1077     # - Install the latest version of global
1078 francois 1081 # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1079 francois 737 # - Make sure the INPUT points to the root of the source tree
1080     # - Run doxygen as normal
1081     #
1082     # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1083     # tools must be available from the command line (i.e. in the search path).
1084     #
1085     # The result: instead of the source browser generated by doxygen, the links to
1086     # source code will now point to the output of htags.
1087     # The default value is: NO.
1088     # This tag requires that the tag SOURCE_BROWSER is set to YES.
1089    
1090 francois 284 USE_HTAGS = NO
1091    
1092 francois 737 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1093     # verbatim copy of the header file for each class for which an include is
1094     # specified. Set to NO to disable this.
1095     # See also: Section \class.
1096     # The default value is: YES.
1097 francois 284
1098 6 VERBATIM_HEADERS = YES
1099 francois 284
1100 francois 1020 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1101     # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1102     # cost of reduced performance. This can be particularly helpful with template
1103     # rich C++ code for which doxygen's built-in parser lacks the necessary type
1104     # information.
1105     # Note: The availability of this option depends on whether or not doxygen was
1106 francois 1081 # generated with the -Duse_libclang=ON option for CMake.
1107 francois 1020 # The default value is: NO.
1108    
1109     CLANG_ASSISTED_PARSING = NO
1110    
1111     # If clang assisted parsing is enabled you can provide the compiler with command
1112     # line options that you would normally use when invoking the compiler. Note that
1113     # the include paths will already be set by doxygen for the files and directories
1114     # specified with INPUT and INCLUDE_PATH.
1115     # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1116    
1117 francois 1081 CLANG_OPTIONS =
1118 francois 1020
1119 francois 1081 # If clang assisted parsing is enabled you can provide the clang parser with the
1120     # path to the compilation database (see:
1121     # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1122     # were built. This is equivalent to specifying the "-p" option to a clang tool,
1123     # such as clang-check. These options will then be passed to the parser.
1124     # Note: The availability of this option depends on whether or not doxygen was
1125     # generated with the -Duse_libclang=ON option for CMake.
1126    
1127     CLANG_DATABASE_PATH =
1128    
1129 6 #---------------------------------------------------------------------------
1130 francois 737 # Configuration options related to the alphabetical class index
1131 6 #---------------------------------------------------------------------------
1132 francois 284
1133 francois 737 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1134     # compounds will be generated. Enable this if the project contains a lot of
1135     # classes, structs, unions or interfaces.
1136     # The default value is: YES.
1137 francois 284
1138 francois 357 ALPHABETICAL_INDEX = YES
1139 francois 284
1140 francois 737 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1141     # which the alphabetical index list will be split.
1142     # Minimum value: 1, maximum value: 20, default value: 5.
1143     # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1144 francois 284
1145 6 COLS_IN_ALPHA_INDEX = 5
1146 francois 284
1147 francois 737 # In case all classes in a project start with a common prefix, all classes will
1148     # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1149     # can be used to specify a prefix (or a list of prefixes) that should be ignored
1150     # while generating the index headers.
1151     # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1152 francois 284
1153 francois 1081 IGNORE_PREFIX =
1154 francois 284
1155 6 #---------------------------------------------------------------------------
1156 francois 737 # Configuration options related to the HTML output
1157 6 #---------------------------------------------------------------------------
1158 francois 284
1159 francois 1020 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1160 francois 737 # The default value is: YES.
1161 francois 284
1162 6 GENERATE_HTML = YES
1163 francois 284
1164 francois 737 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1165     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1166     # it.
1167     # The default directory is: html.
1168     # This tag requires that the tag GENERATE_HTML is set to YES.
1169 francois 284
1170 francois 400 HTML_OUTPUT = ./
1171 francois 284
1172 francois 737 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1173     # generated HTML page (for example: .htm, .php, .asp).
1174     # The default value is: .html.
1175     # This tag requires that the tag GENERATE_HTML is set to YES.
1176 francois 284
1177 6 HTML_FILE_EXTENSION = .html
1178 francois 284
1179 francois 737 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1180     # each generated HTML page. If the tag is left blank doxygen will generate a
1181     # standard header.
1182     #
1183     # To get valid HTML the header file that includes any scripts and style sheets
1184     # that doxygen needs, which is dependent on the configuration options used (e.g.
1185     # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1186     # default header using
1187     # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1188     # YourConfigFile
1189     # and then modify the file new_header.html. See also section "Doxygen usage"
1190     # for information on how to generate the default header that doxygen normally
1191     # uses.
1192     # Note: The header is subject to change so you typically have to regenerate the
1193     # default header when upgrading to a newer version of doxygen. For a description
1194     # of the possible markers and block names see the documentation.
1195     # This tag requires that the tag GENERATE_HTML is set to YES.
1196 francois 284
1197 francois 1081 HTML_HEADER =
1198 francois 284
1199 francois 737 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1200     # generated HTML page. If the tag is left blank doxygen will generate a standard
1201     # footer. See HTML_HEADER for more information on how to generate a default
1202     # footer and what special commands can be used inside the footer. See also
1203     # section "Doxygen usage" for information on how to generate the default footer
1204     # that doxygen normally uses.
1205     # This tag requires that the tag GENERATE_HTML is set to YES.
1206 francois 284
1207 francois 1081 HTML_FOOTER =
1208 francois 284
1209 francois 737 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1210     # sheet that is used by each HTML page. It can be used to fine-tune the look of
1211     # the HTML output. If left blank doxygen will generate a default style sheet.
1212     # See also section "Doxygen usage" for information on how to generate the style
1213     # sheet that doxygen normally uses.
1214     # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1215     # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1216     # obsolete.
1217     # This tag requires that the tag GENERATE_HTML is set to YES.
1218 francois 284
1219 francois 1081 HTML_STYLESHEET =
1220 francois 284
1221 francois 1020 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1222     # cascading style sheets that are included after the standard style sheets
1223 francois 737 # created by doxygen. Using this option one can overrule certain style aspects.
1224     # This is preferred over using HTML_STYLESHEET since it does not replace the
1225 francois 1020 # standard style sheet and is therefore more robust against future updates.
1226     # Doxygen will copy the style sheet files to the output directory.
1227     # Note: The order of the extra style sheet files is of importance (e.g. the last
1228     # style sheet in the list overrules the setting of the previous ones in the
1229     # list). For an example see the documentation.
1230 francois 737 # This tag requires that the tag GENERATE_HTML is set to YES.
1231 francois 357
1232 francois 1081 HTML_EXTRA_STYLESHEET =
1233 francois 737
1234     # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1235     # other source files which should be copied to the HTML output directory. Note
1236     # that these files will be copied to the base HTML output directory. Use the
1237     # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1238     # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1239     # files will be copied as-is; there are no commands or markers available.
1240     # This tag requires that the tag GENERATE_HTML is set to YES.
1241    
1242 francois 1081 HTML_EXTRA_FILES =
1243 francois 357
1244 francois 737 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1245 francois 1020 # will adjust the colors in the style sheet and background images according to
1246 francois 737 # this color. Hue is specified as an angle on a colorwheel, see
1247 francois 1081 # https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1248 francois 737 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1249     # purple, and 360 is red again.
1250     # Minimum value: 0, maximum value: 359, default value: 220.
1251     # This tag requires that the tag GENERATE_HTML is set to YES.
1252 francois 357
1253     HTML_COLORSTYLE_HUE = 220
1254    
1255 francois 737 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1256     # in the HTML output. For a value of 0 the output will use grayscales only. A
1257     # value of 255 will produce the most vivid colors.
1258     # Minimum value: 0, maximum value: 255, default value: 100.
1259     # This tag requires that the tag GENERATE_HTML is set to YES.
1260 francois 357
1261     HTML_COLORSTYLE_SAT = 100
1262    
1263 francois 737 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1264     # luminance component of the colors in the HTML output. Values below 100
1265     # gradually make the output lighter, whereas values above 100 make the output
1266     # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1267     # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1268     # change the gamma.
1269     # Minimum value: 40, maximum value: 240, default value: 80.
1270     # This tag requires that the tag GENERATE_HTML is set to YES.
1271 francois 357
1272     HTML_COLORSTYLE_GAMMA = 84
1273    
1274 francois 737 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1275     # page will contain the date and time when the page was generated. Setting this
1276 francois 1020 # to YES can help to show when doxygen was last run and thus if the
1277     # documentation is up to date.
1278     # The default value is: NO.
1279 francois 737 # This tag requires that the tag GENERATE_HTML is set to YES.
1280 francois 284
1281     HTML_TIMESTAMP = YES
1282    
1283 francois 1081 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1284     # documentation will contain a main index with vertical navigation menus that
1285     # are dynamically created via JavaScript. If disabled, the navigation index will
1286     # consists of multiple levels of tabs that are statically embedded in every HTML
1287     # page. Disable this option to support browsers that do not have JavaScript,
1288     # like the Qt help browser.
1289     # The default value is: YES.
1290     # This tag requires that the tag GENERATE_HTML is set to YES.
1291    
1292     HTML_DYNAMIC_MENUS = YES
1293    
1294 francois 737 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1295     # documentation will contain sections that can be hidden and shown after the
1296     # page has loaded.
1297     # The default value is: NO.
1298     # This tag requires that the tag GENERATE_HTML is set to YES.
1299 francois 284
1300 francois 737 HTML_DYNAMIC_SECTIONS = NO
1301 francois 284
1302 francois 737 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1303     # shown in the various tree structured indices initially; the user can expand
1304     # and collapse entries dynamically later on. Doxygen will expand the tree to
1305     # such a level that at most the specified number of entries are visible (unless
1306     # a fully collapsed tree already exceeds this amount). So setting the number of
1307     # entries 1 will produce a full collapsed tree by default. 0 is a special value
1308     # representing an infinite number of entries and will result in a full expanded
1309     # tree by default.
1310     # Minimum value: 0, maximum value: 9999, default value: 100.
1311     # This tag requires that the tag GENERATE_HTML is set to YES.
1312 francois 284
1313 francois 737 HTML_INDEX_NUM_ENTRIES = 100
1314 francois 284
1315 francois 737 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1316     # generated that can be used as input for Apple's Xcode 3 integrated development
1317 francois 1081 # environment (see: https://developer.apple.com/xcode/), introduced with OSX
1318     # 10.5 (Leopard). To create a documentation set, doxygen will generate a
1319 francois 737 # Makefile in the HTML output directory. Running make will produce the docset in
1320     # that directory and running make install will install the docset in
1321     # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1322 francois 1081 # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1323     # genXcode/_index.html for more information.
1324 francois 737 # The default value is: NO.
1325     # This tag requires that the tag GENERATE_HTML is set to YES.
1326 francois 284
1327     GENERATE_DOCSET = NO
1328    
1329 francois 737 # This tag determines the name of the docset feed. A documentation feed provides
1330     # an umbrella under which multiple documentation sets from a single provider
1331     # (such as a company or product suite) can be grouped.
1332     # The default value is: Doxygen generated docs.
1333     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1334 francois 284
1335     DOCSET_FEEDNAME = "Doxygen generated docs"
1336    
1337 francois 737 # This tag specifies a string that should uniquely identify the documentation
1338     # set bundle. This should be a reverse domain-name style string, e.g.
1339     # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1340     # The default value is: org.doxygen.Project.
1341     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1342 francois 284
1343     DOCSET_BUNDLE_ID = org.doxygen.Project
1344    
1345 francois 737 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1346     # the documentation publisher. This should be a reverse domain-name style
1347 francois 357 # string, e.g. com.mycompany.MyDocSet.documentation.
1348 francois 737 # The default value is: org.doxygen.Publisher.
1349     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1350 francois 357
1351     DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1352    
1353 francois 737 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1354     # The default value is: Publisher.
1355     # This tag requires that the tag GENERATE_DOCSET is set to YES.
1356 francois 357
1357     DOCSET_PUBLISHER_NAME = Publisher
1358    
1359 francois 737 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1360     # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1361     # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1362 francois 1081 # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1363 francois 737 # Windows.
1364     #
1365     # The HTML Help Workshop contains a compiler that can convert all HTML output
1366     # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1367     # files are now used as the Windows 98 help format, and will replace the old
1368     # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1369     # HTML files also contain an index, a table of contents, and you can search for
1370     # words in the documentation. The HTML workshop also contains a viewer for
1371     # compressed HTML files.
1372     # The default value is: NO.
1373     # This tag requires that the tag GENERATE_HTML is set to YES.
1374 francois 284
1375 6 GENERATE_HTMLHELP = NO
1376 francois 284
1377 francois 737 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1378     # file. You can add a path in front of the file if the result should not be
1379 francois 284 # written to the html output directory.
1380 francois 737 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1381 francois 284
1382 francois 1081 CHM_FILE =
1383 francois 284
1384 francois 737 # The HHC_LOCATION tag can be used to specify the location (absolute path
1385 francois 1020 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1386 francois 737 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1387     # The file has to be specified with full path.
1388     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1389 francois 284
1390 francois 1081 HHC_LOCATION =
1391 francois 284
1392 francois 1020 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1393     # (YES) or that it should be included in the master .chm file (NO).
1394 francois 737 # The default value is: NO.
1395     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1396 francois 284
1397 6 GENERATE_CHI = NO
1398 francois 284
1399 francois 1020 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1400 francois 737 # and project file content.
1401     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1402 francois 284
1403 francois 1081 CHM_INDEX_ENCODING =
1404 francois 284
1405 francois 1020 # The BINARY_TOC flag controls whether a binary table of contents is generated
1406     # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1407     # enables the Previous and Next buttons.
1408 francois 737 # The default value is: NO.
1409     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1410 francois 284
1411 6 BINARY_TOC = NO
1412 francois 284
1413 francois 737 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1414     # the table of contents of the HTML help documentation and to the tree view.
1415     # The default value is: NO.
1416     # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1417 francois 284
1418 6 TOC_EXPAND = NO
1419 francois 284
1420 francois 737 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1421     # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1422     # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1423     # (.qch) of the generated HTML documentation.
1424     # The default value is: NO.
1425     # This tag requires that the tag GENERATE_HTML is set to YES.
1426 francois 284
1427     GENERATE_QHP = NO
1428    
1429 francois 737 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1430     # the file name of the resulting .qch file. The path specified is relative to
1431     # the HTML output folder.
1432     # This tag requires that the tag GENERATE_QHP is set to YES.
1433 francois 284
1434 francois 1081 QCH_FILE =
1435 francois 284
1436 francois 737 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1437     # Project output. For more information please see Qt Help Project / Namespace
1438 francois 1081 # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1439 francois 737 # The default value is: org.doxygen.Project.
1440     # This tag requires that the tag GENERATE_QHP is set to YES.
1441 francois 284
1442     QHP_NAMESPACE = org.doxygen.Project
1443    
1444 francois 737 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1445     # Help Project output. For more information please see Qt Help Project / Virtual
1446 francois 1081 # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1447 francois 737 # folders).
1448     # The default value is: doc.
1449     # This tag requires that the tag GENERATE_QHP is set to YES.
1450 francois 284
1451     QHP_VIRTUAL_FOLDER = doc
1452    
1453 francois 737 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1454     # filter to add. For more information please see Qt Help Project / Custom
1455 francois 1081 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1456 francois 737 # filters).
1457     # This tag requires that the tag GENERATE_QHP is set to YES.
1458 francois 284
1459 francois 1081 QHP_CUST_FILTER_NAME =
1460 francois 284
1461 francois 737 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1462     # custom filter to add. For more information please see Qt Help Project / Custom
1463 francois 1081 # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1464 francois 737 # filters).
1465     # This tag requires that the tag GENERATE_QHP is set to YES.
1466 francois 284
1467 francois 1081 QHP_CUST_FILTER_ATTRS =
1468 francois 284
1469 francois 737 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1470     # project's filter section matches. Qt Help Project / Filter Attributes (see:
1471 francois 1081 # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1472 francois 737 # This tag requires that the tag GENERATE_QHP is set to YES.
1473 francois 284
1474 francois 1081 QHP_SECT_FILTER_ATTRS =
1475 francois 284
1476 francois 737 # The QHG_LOCATION tag can be used to specify the location of Qt's
1477     # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1478     # generated .qhp file.
1479     # This tag requires that the tag GENERATE_QHP is set to YES.
1480 francois 284
1481 francois 1081 QHG_LOCATION =
1482 francois 284
1483 francois 737 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1484     # generated, together with the HTML files, they form an Eclipse help plugin. To
1485     # install this plugin and make it available under the help contents menu in
1486     # Eclipse, the contents of the directory containing the HTML and XML files needs
1487     # to be copied into the plugins directory of eclipse. The name of the directory
1488     # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1489     # After copying Eclipse needs to be restarted before the help appears.
1490     # The default value is: NO.
1491     # This tag requires that the tag GENERATE_HTML is set to YES.
1492 francois 284
1493     GENERATE_ECLIPSEHELP = NO
1494    
1495 francois 737 # A unique identifier for the Eclipse help plugin. When installing the plugin
1496     # the directory name containing the HTML and XML files should also have this
1497     # name. Each documentation set should have its own identifier.
1498     # The default value is: org.doxygen.Project.
1499     # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1500 francois 284
1501     ECLIPSE_DOC_ID = org.doxygen.Project
1502    
1503 francois 737 # If you want full control over the layout of the generated HTML pages it might
1504     # be necessary to disable the index and replace it with your own. The
1505     # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1506     # of each HTML page. A value of NO enables the index and the value YES disables
1507     # it. Since the tabs in the index contain the same information as the navigation
1508     # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1509     # The default value is: NO.
1510     # This tag requires that the tag GENERATE_HTML is set to YES.
1511 francois 284
1512 6 DISABLE_INDEX = NO
1513 francois 284
1514 francois 737 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1515     # structure should be generated to display hierarchical information. If the tag
1516     # value is set to YES, a side panel will be generated containing a tree-like
1517     # index structure (just like the one that is generated for HTML Help). For this
1518     # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1519     # (i.e. any modern browser). Windows users are probably better off using the
1520 francois 1020 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1521 francois 737 # further fine-tune the look of the index. As an example, the default style
1522     # sheet generated by doxygen has an example that shows how to put an image at
1523     # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1524     # the same information as the tab index, you could consider setting
1525     # DISABLE_INDEX to YES when enabling this option.
1526     # The default value is: NO.
1527     # This tag requires that the tag GENERATE_HTML is set to YES.
1528 francois 284
1529 6 GENERATE_TREEVIEW = YES
1530 francois 284
1531 francois 737 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1532     # doxygen will group on one line in the generated HTML documentation.
1533     #
1534     # Note that a value of 0 will completely suppress the enum values from appearing
1535     # in the overview section.
1536     # Minimum value: 0, maximum value: 20, default value: 4.
1537     # This tag requires that the tag GENERATE_HTML is set to YES.
1538 francois 357
1539     ENUM_VALUES_PER_LINE = 1
1540    
1541 francois 737 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1542     # to set the initial width (in pixels) of the frame in which the tree is shown.
1543     # Minimum value: 0, maximum value: 1500, default value: 250.
1544     # This tag requires that the tag GENERATE_HTML is set to YES.
1545 francois 284
1546 6 TREEVIEW_WIDTH = 250
1547 francois 284
1548 francois 1020 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1549 francois 737 # external symbols imported via tag files in a separate window.
1550     # The default value is: NO.
1551     # This tag requires that the tag GENERATE_HTML is set to YES.
1552 francois 357
1553     EXT_LINKS_IN_WINDOW = NO
1554    
1555 francois 737 # Use this tag to change the font size of LaTeX formulas included as images in
1556     # the HTML documentation. When you change the font size after a successful
1557     # doxygen run you need to manually remove any form_*.png images from the HTML
1558     # output directory to force them to be regenerated.
1559     # Minimum value: 8, maximum value: 50, default value: 10.
1560     # This tag requires that the tag GENERATE_HTML is set to YES.
1561 francois 284
1562     FORMULA_FONTSIZE = 10
1563    
1564 francois 1081 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1565 francois 737 # generated for formulas are transparent PNGs. Transparent PNGs are not
1566     # supported properly for IE 6.0, but are supported on all modern browsers.
1567     #
1568     # Note that when changing this option you need to delete any form_*.png files in
1569     # the HTML output directory before the changes have effect.
1570     # The default value is: YES.
1571     # This tag requires that the tag GENERATE_HTML is set to YES.
1572 francois 357
1573     FORMULA_TRANSPARENT = YES
1574    
1575 francois 1081 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1576     # to create new LaTeX commands to be used in formulas as building blocks. See
1577     # the section "Including formulas" for details.
1578    
1579     FORMULA_MACROFILE =
1580    
1581 francois 737 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1582 francois 1081 # https://www.mathjax.org) which uses client side JavaScript for the rendering
1583 francois 1020 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1584 francois 737 # installed or if you want to formulas look prettier in the HTML output. When
1585     # enabled you may also need to install MathJax separately and configure the path
1586     # to it using the MATHJAX_RELPATH option.
1587     # The default value is: NO.
1588     # This tag requires that the tag GENERATE_HTML is set to YES.
1589 francois 357
1590     USE_MATHJAX = NO
1591    
1592 francois 737 # When MathJax is enabled you can set the default output format to be used for
1593     # the MathJax output. See the MathJax site (see:
1594     # http://docs.mathjax.org/en/latest/output.html) for more details.
1595     # Possible values are: HTML-CSS (which is slower, but has the best
1596     # compatibility), NativeMML (i.e. MathML) and SVG.
1597     # The default value is: HTML-CSS.
1598     # This tag requires that the tag USE_MATHJAX is set to YES.
1599 francois 357
1600 francois 737 MATHJAX_FORMAT = HTML-CSS
1601    
1602     # When MathJax is enabled you need to specify the location relative to the HTML
1603     # output directory using the MATHJAX_RELPATH option. The destination directory
1604     # should contain the MathJax.js script. For instance, if the mathjax directory
1605     # is located at the same level as the HTML output directory, then
1606     # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1607     # Content Delivery Network so you can quickly see the result without installing
1608     # MathJax. However, it is strongly recommended to install a local copy of
1609 francois 1081 # MathJax from https://www.mathjax.org before deployment.
1610     # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
1611 francois 737 # This tag requires that the tag USE_MATHJAX is set to YES.
1612    
1613 francois 357 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1614    
1615 francois 737 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1616     # extension names that should be enabled during MathJax rendering. For example
1617     # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1618     # This tag requires that the tag USE_MATHJAX is set to YES.
1619 francois 357
1620 francois 1081 MATHJAX_EXTENSIONS =
1621 francois 357
1622 francois 737 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1623     # of code that will be used on startup of the MathJax code. See the MathJax site
1624     # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1625     # example see the documentation.
1626     # This tag requires that the tag USE_MATHJAX is set to YES.
1627 francois 284
1628 francois 1081 MATHJAX_CODEFILE =
1629 francois 737
1630     # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1631     # the HTML output. The underlying search engine uses javascript and DHTML and
1632     # should work on any modern browser. Note that when using HTML help
1633     # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1634     # there is already a search function so this one should typically be disabled.
1635     # For large projects the javascript based search engine can be slow, then
1636     # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1637     # search using the keyboard; to jump to the search box use <access key> + S
1638     # (what the <access key> is depends on the OS and browser, but it is typically
1639     # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1640     # key> to jump into the search results window, the results can be navigated
1641     # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1642     # the search. The filter options can be selected when the cursor is inside the
1643     # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1644     # to select a filter and <Enter> or <escape> to activate or cancel the filter
1645     # option.
1646     # The default value is: YES.
1647     # This tag requires that the tag GENERATE_HTML is set to YES.
1648    
1649 francois 357 SEARCHENGINE = YES
1650 francois 284
1651 francois 737 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1652 francois 1081 # implemented using a web server instead of a web client using JavaScript. There
1653 francois 1020 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1654     # setting. When disabled, doxygen will generate a PHP script for searching and
1655     # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1656     # and searching needs to be provided by external tools. See the section
1657     # "External Indexing and Searching" for details.
1658 francois 737 # The default value is: NO.
1659     # This tag requires that the tag SEARCHENGINE is set to YES.
1660 francois 284
1661     SERVER_BASED_SEARCH = NO
1662    
1663 francois 737 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1664     # script for searching. Instead the search results are written to an XML file
1665     # which needs to be processed by an external indexer. Doxygen will invoke an
1666     # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1667     # search results.
1668     #
1669 francois 1020 # Doxygen ships with an example indexer (doxyindexer) and search engine
1670 francois 737 # (doxysearch.cgi) which are based on the open source search engine library
1671 francois 1081 # Xapian (see: https://xapian.org/).
1672 francois 737 #
1673     # See the section "External Indexing and Searching" for details.
1674     # The default value is: NO.
1675     # This tag requires that the tag SEARCHENGINE is set to YES.
1676    
1677     EXTERNAL_SEARCH = NO
1678    
1679     # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1680     # which will return the search results when EXTERNAL_SEARCH is enabled.
1681     #
1682 francois 1020 # Doxygen ships with an example indexer (doxyindexer) and search engine
1683 francois 737 # (doxysearch.cgi) which are based on the open source search engine library
1684 francois 1081 # Xapian (see: https://xapian.org/). See the section "External Indexing and
1685 francois 737 # Searching" for details.
1686     # This tag requires that the tag SEARCHENGINE is set to YES.
1687    
1688 francois 1081 SEARCHENGINE_URL =
1689 francois 737
1690     # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1691     # search data is written to a file for indexing by an external tool. With the
1692     # SEARCHDATA_FILE tag the name of this file can be specified.
1693     # The default file is: searchdata.xml.
1694     # This tag requires that the tag SEARCHENGINE is set to YES.
1695    
1696     SEARCHDATA_FILE = searchdata.xml
1697    
1698     # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1699     # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1700     # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1701     # projects and redirect the results back to the right project.
1702     # This tag requires that the tag SEARCHENGINE is set to YES.
1703    
1704 francois 1081 EXTERNAL_SEARCH_ID =
1705 francois 737
1706     # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1707     # projects other than the one defined by this configuration file, but that are
1708     # all added to the same external search index. Each project needs to have a
1709     # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1710     # to a relative location where the documentation can be found. The format is:
1711     # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1712     # This tag requires that the tag SEARCHENGINE is set to YES.
1713    
1714 francois 1081 EXTRA_SEARCH_MAPPINGS =
1715 francois 737
1716 6 #---------------------------------------------------------------------------
1717 francois 737 # Configuration options related to the LaTeX output
1718 6 #---------------------------------------------------------------------------
1719 francois 284
1720 francois 1020 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1721 francois 737 # The default value is: YES.
1722 francois 284
1723 6 GENERATE_LATEX = NO
1724 francois 284
1725 francois 737 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1726     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1727     # it.
1728     # The default directory is: latex.
1729     # This tag requires that the tag GENERATE_LATEX is set to YES.
1730 francois 284
1731 6 LATEX_OUTPUT = latex
1732 francois 284
1733 francois 737 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1734     # invoked.
1735     #
1736 francois 1081 # Note that when not enabling USE_PDFLATEX the default is latex when enabling
1737     # USE_PDFLATEX the default is pdflatex and when in the later case latex is
1738     # chosen this is overwritten by pdflatex. For specific output languages the
1739     # default can have been set differently, this depends on the implementation of
1740     # the output language.
1741 francois 737 # This tag requires that the tag GENERATE_LATEX is set to YES.
1742 francois 284
1743 6 LATEX_CMD_NAME = latex
1744 francois 284
1745 francois 737 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1746     # index for LaTeX.
1747 francois 1081 # Note: This tag is used in the Makefile / make.bat.
1748     # See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1749     # (.tex).
1750 francois 737 # The default file is: makeindex.
1751     # This tag requires that the tag GENERATE_LATEX is set to YES.
1752 francois 284
1753 6 MAKEINDEX_CMD_NAME = makeindex
1754 francois 284
1755 francois 1081 # The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1756     # generate index for LaTeX. In case there is no backslash (\) as first character
1757     # it will be automatically added in the LaTeX code.
1758     # Note: This tag is used in the generated output file (.tex).
1759     # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1760     # The default value is: makeindex.
1761     # This tag requires that the tag GENERATE_LATEX is set to YES.
1762    
1763     LATEX_MAKEINDEX_CMD = makeindex
1764    
1765 francois 1020 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1766 francois 737 # documents. This may be useful for small projects and may help to save some
1767     # trees in general.
1768     # The default value is: NO.
1769     # This tag requires that the tag GENERATE_LATEX is set to YES.
1770 francois 284
1771 6 COMPACT_LATEX = NO
1772 francois 284
1773 francois 737 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1774     # printer.
1775     # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1776     # 14 inches) and executive (7.25 x 10.5 inches).
1777     # The default value is: a4.
1778     # This tag requires that the tag GENERATE_LATEX is set to YES.
1779 francois 284
1780 6 PAPER_TYPE = a4wide
1781 francois 284
1782 francois 737 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1783 francois 1020 # that should be included in the LaTeX output. The package can be specified just
1784     # by its name or with the correct syntax as to be used with the LaTeX
1785     # \usepackage command. To get the times font for instance you can specify :
1786     # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1787     # To use the option intlimits with the amsmath package you can specify:
1788     # EXTRA_PACKAGES=[intlimits]{amsmath}
1789 francois 737 # If left blank no extra packages will be included.
1790     # This tag requires that the tag GENERATE_LATEX is set to YES.
1791 francois 284
1792 francois 1081 EXTRA_PACKAGES =
1793 francois 284
1794 francois 737 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1795     # generated LaTeX document. The header should contain everything until the first
1796     # chapter. If it is left blank doxygen will generate a standard header. See
1797     # section "Doxygen usage" for information on how to let doxygen write the
1798     # default header to a separate file.
1799     #
1800     # Note: Only use a user-defined header if you know what you are doing! The
1801     # following commands have a special meaning inside the header: $title,
1802 francois 1020 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1803     # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1804     # string, for the replacement values of the other commands the user is referred
1805     # to HTML_HEADER.
1806 francois 737 # This tag requires that the tag GENERATE_LATEX is set to YES.
1807 francois 284
1808 francois 1081 LATEX_HEADER =
1809 francois 284
1810 francois 737 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1811     # generated LaTeX document. The footer should contain everything after the last
1812 francois 1020 # chapter. If it is left blank doxygen will generate a standard footer. See
1813     # LATEX_HEADER for more information on how to generate a default footer and what
1814     # special commands can be used inside the footer.
1815 francois 737 #
1816     # Note: Only use a user-defined footer if you know what you are doing!
1817     # This tag requires that the tag GENERATE_LATEX is set to YES.
1818 francois 357
1819 francois 1081 LATEX_FOOTER =
1820 francois 357
1821 francois 1020 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1822     # LaTeX style sheets that are included after the standard style sheets created
1823     # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1824     # will copy the style sheet files to the output directory.
1825     # Note: The order of the extra style sheet files is of importance (e.g. the last
1826     # style sheet in the list overrules the setting of the previous ones in the
1827     # list).
1828     # This tag requires that the tag GENERATE_LATEX is set to YES.
1829    
1830 francois 1081 LATEX_EXTRA_STYLESHEET =
1831 francois 1020
1832 francois 737 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1833     # other source files which should be copied to the LATEX_OUTPUT output
1834     # directory. Note that the files will be copied as-is; there are no commands or
1835     # markers available.
1836     # This tag requires that the tag GENERATE_LATEX is set to YES.
1837 francois 284
1838 francois 1081 LATEX_EXTRA_FILES =
1839 francois 737
1840     # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1841     # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1842     # contain links (just like the HTML output) instead of page references. This
1843     # makes the output suitable for online browsing using a PDF viewer.
1844     # The default value is: YES.
1845     # This tag requires that the tag GENERATE_LATEX is set to YES.
1846    
1847 6 PDF_HYPERLINKS = NO
1848 francois 284
1849 francois 1020 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1850     # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1851 francois 284 # higher quality PDF documentation.
1852 francois 737 # The default value is: YES.
1853     # This tag requires that the tag GENERATE_LATEX is set to YES.
1854 francois 284
1855 6 USE_PDFLATEX = NO
1856 francois 284
1857 francois 737 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1858     # command to the generated LaTeX files. This will instruct LaTeX to keep running
1859     # if errors occur, instead of asking the user for help. This option is also used
1860     # when generating formulas in HTML.
1861     # The default value is: NO.
1862     # This tag requires that the tag GENERATE_LATEX is set to YES.
1863 francois 284
1864 6 LATEX_BATCHMODE = NO
1865 francois 284
1866 francois 737 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1867     # index chapters (such as File Index, Compound Index, etc.) in the output.
1868     # The default value is: NO.
1869     # This tag requires that the tag GENERATE_LATEX is set to YES.
1870 francois 284
1871 6 LATEX_HIDE_INDICES = NO
1872 francois 284
1873 francois 737 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1874     # code with syntax highlighting in the LaTeX output.
1875     #
1876     # Note that which sources are shown also depends on other settings such as
1877     # SOURCE_BROWSER.
1878     # The default value is: NO.
1879     # This tag requires that the tag GENERATE_LATEX is set to YES.
1880 francois 284
1881     LATEX_SOURCE_CODE = NO
1882    
1883 francois 737 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1884     # bibliography, e.g. plainnat, or ieeetr. See
1885 francois 1081 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1886 francois 737 # The default value is: plain.
1887     # This tag requires that the tag GENERATE_LATEX is set to YES.
1888 francois 357
1889     LATEX_BIB_STYLE = plain
1890    
1891 francois 1020 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1892     # page will contain the date and time when the page was generated. Setting this
1893     # to NO can help when comparing the output of multiple runs.
1894     # The default value is: NO.
1895     # This tag requires that the tag GENERATE_LATEX is set to YES.
1896    
1897     LATEX_TIMESTAMP = NO
1898    
1899 francois 1081 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1900     # path from which the emoji images will be read. If a relative path is entered,
1901     # it will be relative to the LATEX_OUTPUT directory. If left blank the
1902     # LATEX_OUTPUT directory will be used.
1903     # This tag requires that the tag GENERATE_LATEX is set to YES.
1904    
1905     LATEX_EMOJI_DIRECTORY =
1906    
1907 6 #---------------------------------------------------------------------------
1908 francois 737 # Configuration options related to the RTF output
1909 6 #---------------------------------------------------------------------------
1910 francois 284
1911 francois 1020 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1912 francois 737 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1913     # readers/editors.
1914     # The default value is: NO.
1915 francois 284
1916 6 GENERATE_RTF = NO
1917 francois 284
1918 francois 737 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1919     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1920     # it.
1921     # The default directory is: rtf.
1922     # This tag requires that the tag GENERATE_RTF is set to YES.
1923 francois 284
1924 6 RTF_OUTPUT = rtf
1925 francois 284
1926 francois 1020 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1927 francois 737 # documents. This may be useful for small projects and may help to save some
1928     # trees in general.
1929     # The default value is: NO.
1930     # This tag requires that the tag GENERATE_RTF is set to YES.
1931 francois 284
1932 6 COMPACT_RTF = NO
1933 francois 284
1934 francois 737 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1935     # contain hyperlink fields. The RTF file will contain links (just like the HTML
1936     # output) instead of page references. This makes the output suitable for online
1937     # browsing using Word or some other Word compatible readers that support those
1938     # fields.
1939     #
1940     # Note: WordPad (write) and others do not support links.
1941     # The default value is: NO.
1942     # This tag requires that the tag GENERATE_RTF is set to YES.
1943 francois 284
1944 6 RTF_HYPERLINKS = NO
1945 francois 284
1946 francois 1081 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1947     # configuration file, i.e. a series of assignments. You only have to provide
1948     # replacements, missing definitions are set to their default value.
1949 francois 737 #
1950     # See also section "Doxygen usage" for information on how to generate the
1951     # default style sheet that doxygen normally uses.
1952     # This tag requires that the tag GENERATE_RTF is set to YES.
1953 francois 284
1954 francois 1081 RTF_STYLESHEET_FILE =
1955 francois 284
1956 francois 737 # Set optional variables used in the generation of an RTF document. Syntax is
1957 francois 1081 # similar to doxygen's configuration file. A template extensions file can be
1958     # generated using doxygen -e rtf extensionFile.
1959 francois 737 # This tag requires that the tag GENERATE_RTF is set to YES.
1960 francois 284
1961 francois 1081 RTF_EXTENSIONS_FILE =
1962 francois 284
1963 francois 1020 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1964     # with syntax highlighting in the RTF output.
1965     #
1966     # Note that which sources are shown also depends on other settings such as
1967     # SOURCE_BROWSER.
1968     # The default value is: NO.
1969     # This tag requires that the tag GENERATE_RTF is set to YES.
1970    
1971     RTF_SOURCE_CODE = NO
1972    
1973 6 #---------------------------------------------------------------------------
1974 francois 737 # Configuration options related to the man page output
1975 6 #---------------------------------------------------------------------------
1976 francois 284
1977 francois 1020 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1978 francois 737 # classes and files.
1979     # The default value is: NO.
1980 francois 284
1981 6 GENERATE_MAN = NO
1982 francois 284
1983 francois 737 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1984     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1985     # it. A directory man3 will be created inside the directory specified by
1986     # MAN_OUTPUT.
1987     # The default directory is: man.
1988     # This tag requires that the tag GENERATE_MAN is set to YES.
1989 francois 284
1990 6 MAN_OUTPUT = man
1991 francois 284
1992 francois 737 # The MAN_EXTENSION tag determines the extension that is added to the generated
1993     # man pages. In case the manual section does not start with a number, the number
1994     # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1995     # optional.
1996     # The default value is: .3.
1997     # This tag requires that the tag GENERATE_MAN is set to YES.
1998 francois 284
1999 6 MAN_EXTENSION = .3
2000 francois 284
2001 francois 1020 # The MAN_SUBDIR tag determines the name of the directory created within
2002     # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2003     # MAN_EXTENSION with the initial . removed.
2004     # This tag requires that the tag GENERATE_MAN is set to YES.
2005    
2006 francois 1081 MAN_SUBDIR =
2007 francois 1020
2008 francois 737 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2009     # will generate one additional man file for each entity documented in the real
2010     # man page(s). These additional files only source the real man page, but without
2011     # them the man command would be unable to find the correct page.
2012     # The default value is: NO.
2013     # This tag requires that the tag GENERATE_MAN is set to YES.
2014 francois 284
2015 6 MAN_LINKS = NO
2016 francois 284
2017 6 #---------------------------------------------------------------------------
2018 francois 737 # Configuration options related to the XML output
2019 6 #---------------------------------------------------------------------------
2020 francois 284
2021 francois 1020 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2022 francois 737 # captures the structure of the code including all documentation.
2023     # The default value is: NO.
2024 francois 284
2025 6 GENERATE_XML = NO
2026 francois 284
2027 francois 737 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2028     # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2029     # it.
2030     # The default directory is: xml.
2031     # This tag requires that the tag GENERATE_XML is set to YES.
2032 francois 284
2033 6 XML_OUTPUT = xml
2034 francois 284
2035 francois 1020 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2036 francois 737 # listings (including syntax highlighting and cross-referencing information) to
2037     # the XML output. Note that enabling this will significantly increase the size
2038     # of the XML output.
2039     # The default value is: YES.
2040     # This tag requires that the tag GENERATE_XML is set to YES.
2041 francois 284
2042 6 XML_PROGRAMLISTING = YES
2043 francois 284
2044 francois 1081 # If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2045     # namespace members in file scope as well, matching the HTML output.
2046     # The default value is: NO.
2047     # This tag requires that the tag GENERATE_XML is set to YES.
2048    
2049     XML_NS_MEMB_FILE_SCOPE = NO
2050    
2051 6 #---------------------------------------------------------------------------
2052 francois 737 # Configuration options related to the DOCBOOK output
2053 6 #---------------------------------------------------------------------------
2054 francois 284
2055 francois 1020 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2056 francois 737 # that can be used to generate PDF.
2057     # The default value is: NO.
2058 francois 284
2059 francois 737 GENERATE_DOCBOOK = NO
2060    
2061     # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2062     # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2063     # front of it.
2064     # The default directory is: docbook.
2065     # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2066    
2067     DOCBOOK_OUTPUT = docbook
2068    
2069 francois 1020 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2070     # program listings (including syntax highlighting and cross-referencing
2071     # information) to the DOCBOOK output. Note that enabling this will significantly
2072     # increase the size of the DOCBOOK output.
2073     # The default value is: NO.
2074     # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2075    
2076     DOCBOOK_PROGRAMLISTING = NO
2077    
2078 francois 737 #---------------------------------------------------------------------------
2079     # Configuration options for the AutoGen Definitions output
2080     #---------------------------------------------------------------------------
2081    
2082 francois 1020 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2083 francois 1081 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2084     # the structure of the code including all documentation. Note that this feature
2085     # is still experimental and incomplete at the moment.
2086 francois 737 # The default value is: NO.
2087    
2088 6 GENERATE_AUTOGEN_DEF = NO
2089 francois 284
2090 6 #---------------------------------------------------------------------------
2091 francois 737 # Configuration options related to the Perl module output
2092 6 #---------------------------------------------------------------------------
2093 francois 284
2094 francois 1020 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2095 francois 737 # file that captures the structure of the code including all documentation.
2096     #
2097     # Note that this feature is still experimental and incomplete at the moment.
2098     # The default value is: NO.
2099 francois 284
2100 6 GENERATE_PERLMOD = NO
2101 francois 284
2102 francois 1020 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2103 francois 737 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2104     # output from the Perl module output.
2105     # The default value is: NO.
2106     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2107 francois 284
2108 6 PERLMOD_LATEX = NO
2109 francois 284
2110 francois 1020 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2111 francois 737 # formatted so it can be parsed by a human reader. This is useful if you want to
2112 francois 1020 # understand what is going on. On the other hand, if this tag is set to NO, the
2113 francois 737 # size of the Perl module output will be much smaller and Perl will parse it
2114     # just the same.
2115     # The default value is: YES.
2116     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2117 francois 284
2118 6 PERLMOD_PRETTY = YES
2119 francois 284
2120 francois 737 # The names of the make variables in the generated doxyrules.make file are
2121     # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2122     # so different doxyrules.make files included by the same Makefile don't
2123     # overwrite each other's variables.
2124     # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2125 francois 284
2126 francois 1081 PERLMOD_MAKEVAR_PREFIX =
2127 francois 284
2128 6 #---------------------------------------------------------------------------
2129 francois 284 # Configuration options related to the preprocessor
2130 6 #---------------------------------------------------------------------------
2131 francois 284
2132 francois 1020 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2133 francois 737 # C-preprocessor directives found in the sources and include files.
2134     # The default value is: YES.
2135 francois 284
2136 6 ENABLE_PREPROCESSING = YES
2137 francois 284
2138 francois 1020 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2139     # in the source code. If set to NO, only conditional compilation will be
2140 francois 737 # performed. Macro expansion can be done in a controlled way by setting
2141     # EXPAND_ONLY_PREDEF to YES.
2142     # The default value is: NO.
2143     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2144 francois 284
2145 6 MACRO_EXPANSION = NO
2146 francois 284
2147 francois 737 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2148     # the macro expansion is limited to the macros specified with the PREDEFINED and
2149     # EXPAND_AS_DEFINED tags.
2150     # The default value is: NO.
2151     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2152 francois 284
2153 6 EXPAND_ONLY_PREDEF = NO
2154 francois 284
2155 francois 1020 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2156 francois 737 # INCLUDE_PATH will be searched if a #include is found.
2157     # The default value is: YES.
2158     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2159 francois 284
2160 6 SEARCH_INCLUDES = YES
2161 francois 284
2162 francois 737 # The INCLUDE_PATH tag can be used to specify one or more directories that
2163     # contain include files that are not input files but should be processed by the
2164     # preprocessor.
2165     # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2166 francois 284
2167 francois 1081 INCLUDE_PATH =
2168 francois 284
2169 francois 737 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2170     # patterns (like *.h and *.hpp) to filter out the header-files in the
2171     # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2172     # used.
2173     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2174 francois 284
2175 francois 1081 INCLUDE_FILE_PATTERNS =
2176 francois 284
2177 francois 737 # The PREDEFINED tag can be used to specify one or more macro names that are
2178     # defined before the preprocessor is started (similar to the -D option of e.g.
2179     # gcc). The argument of the tag is a list of macros of the form: name or
2180     # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2181     # is assumed. To prevent a macro definition from being undefined via #undef or
2182     # recursively expanded use the := operator instead of the = operator.
2183     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2184 francois 284
2185 6 PREDEFINED = BREP_SAT \
2186     BREP_STEP \
2187 francois 175 BREP_SLD \
2188 francois 1081 BREP_OCC \
2189     ALL_OCC
2190 francois 284
2191 francois 737 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2192     # tag can be used to specify a list of macro names that should be expanded. The
2193     # macro definition that is found in the sources will be used. Use the PREDEFINED
2194     # tag if you want to use a different macro definition that overrules the
2195     # definition found in the source code.
2196     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2197 francois 284
2198 francois 1081 EXPAND_AS_DEFINED =
2199 francois 284
2200 francois 737 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2201 francois 1020 # remove all references to function-like macros that are alone on a line, have
2202     # an all uppercase name, and do not end with a semicolon. Such function macros
2203     # are typically used for boiler-plate code, and will confuse the parser if not
2204 francois 737 # removed.
2205     # The default value is: YES.
2206     # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2207 francois 284
2208 francois 652 SKIP_FUNCTION_MACROS = NO
2209 francois 284
2210 6 #---------------------------------------------------------------------------
2211 francois 737 # Configuration options related to external references
2212 6 #---------------------------------------------------------------------------
2213 francois 284
2214 francois 737 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2215     # file the location of the external documentation should be added. The format of
2216     # a tag file without this location is as follows:
2217     # TAGFILES = file1 file2 ...
2218     # Adding location for the tag files is done as follows:
2219     # TAGFILES = file1=loc1 "file2 = loc2" ...
2220     # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2221     # section "Linking to external documentation" for more information about the use
2222     # of tag files.
2223 francois 1020 # Note: Each tag file must have a unique name (where the name does NOT include
2224 francois 737 # the path). If a tag file is not located in the directory in which doxygen is
2225     # run, you must also specify the path to the tagfile here.
2226 francois 284
2227 francois 1081 TAGFILES =
2228 francois 284
2229 francois 737 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2230     # tag file that is based on the input files it reads. See section "Linking to
2231     # external documentation" for more information about the usage of tag files.
2232 francois 284
2233 francois 1081 GENERATE_TAGFILE =
2234 francois 284
2235 francois 1020 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2236     # the class index. If set to NO, only the inherited external classes will be
2237     # listed.
2238 francois 737 # The default value is: NO.
2239 francois 284
2240 6 ALLEXTERNALS = NO
2241 francois 284
2242 francois 1020 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2243     # in the modules index. If set to NO, only the current project's groups will be
2244 francois 737 # listed.
2245     # The default value is: YES.
2246 francois 284
2247 6 EXTERNAL_GROUPS = YES
2248 francois 284
2249 francois 1020 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2250 francois 737 # the related pages index. If set to NO, only the current project's pages will
2251     # be listed.
2252     # The default value is: YES.
2253 francois 284
2254 francois 737 EXTERNAL_PAGES = YES
2255    
2256 6 #---------------------------------------------------------------------------
2257 francois 284 # Configuration options related to the dot tool
2258 6 #---------------------------------------------------------------------------
2259 francois 284
2260 francois 1020 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2261 francois 737 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2262     # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2263     # disabled, but it is recommended to install and use dot, since it yields more
2264     # powerful graphs.
2265     # The default value is: YES.
2266 francois 284
2267 francois 1057 CLASS_DIAGRAMS = YES
2268 francois 284
2269 francois 737 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2270     # then run dia to produce the diagram and insert it in the documentation. The
2271     # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2272     # If left empty dia is assumed to be found in the default search path.
2273 francois 284
2274 francois 1081 DIA_PATH =
2275 francois 737
2276 francois 1020 # If set to YES the inheritance and collaboration graphs will hide inheritance
2277 francois 737 # and usage relations if the target is undocumented or is not a class.
2278     # The default value is: YES.
2279    
2280 6 HIDE_UNDOC_RELATIONS = YES
2281 francois 284
2282 francois 737 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2283     # available from the path. This tool is part of Graphviz (see:
2284     # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2285     # Bell Labs. The other options in this section have no effect if this option is
2286     # set to NO
2287 francois 1020 # The default value is: YES.
2288 francois 284
2289 6 HAVE_DOT = YES
2290 francois 284
2291 francois 737 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2292     # to run in parallel. When set to 0 doxygen will base this on the number of
2293     # processors available in the system. You can set it explicitly to a value
2294     # larger than 0 to get control over the balance between CPU load and processing
2295     # speed.
2296     # Minimum value: 0, maximum value: 32, default value: 0.
2297     # This tag requires that the tag HAVE_DOT is set to YES.
2298 francois 284
2299 francois 357 DOT_NUM_THREADS = 0
2300    
2301 francois 1020 # When you want a differently looking font in the dot files that doxygen
2302 francois 737 # generates you can specify the font name using DOT_FONTNAME. You need to make
2303     # sure dot is able to find the font, which can be done by putting it in a
2304     # standard location or by setting the DOTFONTPATH environment variable or by
2305     # setting DOT_FONTPATH to the directory containing the font.
2306     # The default value is: Helvetica.
2307     # This tag requires that the tag HAVE_DOT is set to YES.
2308 francois 357
2309 francois 284 DOT_FONTNAME = FreeSans
2310    
2311 francois 737 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2312     # dot graphs.
2313     # Minimum value: 4, maximum value: 24, default value: 10.
2314     # This tag requires that the tag HAVE_DOT is set to YES.
2315 francois 284
2316     DOT_FONTSIZE = 10
2317    
2318 francois 737 # By default doxygen will tell dot to use the default font as specified with
2319     # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2320     # the path where dot can find it using this tag.
2321     # This tag requires that the tag HAVE_DOT is set to YES.
2322 francois 284
2323 francois 1081 DOT_FONTPATH =
2324 francois 284
2325 francois 737 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2326     # each documented class showing the direct and indirect inheritance relations.
2327     # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2328     # The default value is: YES.
2329     # This tag requires that the tag HAVE_DOT is set to YES.
2330 francois 284
2331 6 CLASS_GRAPH = YES
2332 francois 284
2333 francois 737 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2334     # graph for each documented class showing the direct and indirect implementation
2335     # dependencies (inheritance, containment, and class references variables) of the
2336     # class with other documented classes.
2337     # The default value is: YES.
2338     # This tag requires that the tag HAVE_DOT is set to YES.
2339 francois 284
2340 6 COLLABORATION_GRAPH = YES
2341 francois 284
2342 francois 737 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2343     # groups, showing the direct groups dependencies.
2344     # The default value is: YES.
2345     # This tag requires that the tag HAVE_DOT is set to YES.
2346 francois 284
2347 6 GROUP_GRAPHS = YES
2348 francois 284
2349 francois 1020 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2350 francois 737 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2351 francois 284 # Language.
2352 francois 737 # The default value is: NO.
2353     # This tag requires that the tag HAVE_DOT is set to YES.
2354 francois 284
2355 6 UML_LOOK = NO
2356 francois 284
2357 francois 737 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2358     # class node. If there are many fields or methods and many nodes the graph may
2359     # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2360     # number of items for each type to make the size more manageable. Set this to 0
2361     # for no limit. Note that the threshold may be exceeded by 50% before the limit
2362     # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2363     # but if the number exceeds 15, the total amount of fields shown is limited to
2364     # 10.
2365     # Minimum value: 0, maximum value: 100, default value: 10.
2366     # This tag requires that the tag HAVE_DOT is set to YES.
2367 francois 284
2368 francois 737 UML_LIMIT_NUM_FIELDS = 10
2369    
2370     # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2371     # collaboration graphs will show the relations between templates and their
2372     # instances.
2373     # The default value is: NO.
2374     # This tag requires that the tag HAVE_DOT is set to YES.
2375    
2376 6 TEMPLATE_RELATIONS = NO
2377 francois 284
2378 francois 737 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2379     # YES then doxygen will generate a graph for each documented file showing the
2380     # direct and indirect include dependencies of the file with other documented
2381     # files.
2382     # The default value is: YES.
2383     # This tag requires that the tag HAVE_DOT is set to YES.
2384 francois 284
2385 6 INCLUDE_GRAPH = YES
2386 francois 284
2387 francois 737 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2388     # set to YES then doxygen will generate a graph for each documented file showing
2389     # the direct and indirect include dependencies of the file with other documented
2390     # files.
2391     # The default value is: YES.
2392     # This tag requires that the tag HAVE_DOT is set to YES.
2393 francois 284
2394 6 INCLUDED_BY_GRAPH = YES
2395 francois 284
2396 francois 737 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2397     # dependency graph for every global function or class method.
2398     #
2399     # Note that enabling this option will significantly increase the time of a run.
2400     # So in most cases it will be better to enable call graphs for selected
2401 francois 1020 # functions only using the \callgraph command. Disabling a call graph can be
2402     # accomplished by means of the command \hidecallgraph.
2403 francois 737 # The default value is: NO.
2404     # This tag requires that the tag HAVE_DOT is set to YES.
2405 francois 284
2406 6 CALL_GRAPH = YES
2407 francois 284
2408 francois 737 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2409     # dependency graph for every global function or class method.
2410     #
2411     # Note that enabling this option will significantly increase the time of a run.
2412     # So in most cases it will be better to enable caller graphs for selected
2413 francois 1020 # functions only using the \callergraph command. Disabling a caller graph can be
2414     # accomplished by means of the command \hidecallergraph.
2415 francois 737 # The default value is: NO.
2416     # This tag requires that the tag HAVE_DOT is set to YES.
2417 francois 284
2418     CALLER_GRAPH = YES
2419    
2420 francois 737 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2421     # hierarchy of all classes instead of a textual one.
2422     # The default value is: YES.
2423     # This tag requires that the tag HAVE_DOT is set to YES.
2424 francois 284
2425 6 GRAPHICAL_HIERARCHY = YES
2426 francois 284
2427 francois 737 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2428     # dependencies a directory has on other directories in a graphical way. The
2429     # dependency relations are determined by the #include relations between the
2430     # files in the directories.
2431     # The default value is: YES.
2432     # This tag requires that the tag HAVE_DOT is set to YES.
2433 francois 284
2434 6 DIRECTORY_GRAPH = YES
2435 francois 284
2436 francois 737 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2437 francois 1020 # generated by dot. For an explanation of the image formats see the section
2438     # output formats in the documentation of the dot tool (Graphviz (see:
2439     # http://www.graphviz.org/)).
2440 francois 737 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2441     # to make the SVG files visible in IE 9+ (other browsers do not have this
2442     # requirement).
2443 francois 1020 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2444     # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2445     # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2446     # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2447     # png:gdiplus:gdiplus.
2448 francois 737 # The default value is: png.
2449     # This tag requires that the tag HAVE_DOT is set to YES.
2450 francois 284
2451 6 DOT_IMAGE_FORMAT = png
2452 francois 284
2453 francois 737 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2454     # enable generation of interactive SVG images that allow zooming and panning.
2455     #
2456     # Note that this requires a modern browser other than Internet Explorer. Tested
2457     # and working are Firefox, Chrome, Safari, and Opera.
2458     # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2459     # the SVG files visible. Older versions of IE do not have SVG support.
2460     # The default value is: NO.
2461     # This tag requires that the tag HAVE_DOT is set to YES.
2462 francois 357
2463     INTERACTIVE_SVG = NO
2464    
2465 francois 737 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2466 francois 284 # found. If left blank, it is assumed the dot tool can be found in the path.
2467 francois 737 # This tag requires that the tag HAVE_DOT is set to YES.
2468 francois 284
2469 francois 1081 DOT_PATH =
2470 francois 284
2471 francois 737 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2472     # contain dot files that are included in the documentation (see the \dotfile
2473     # command).
2474     # This tag requires that the tag HAVE_DOT is set to YES.
2475 francois 284
2476 francois 1081 DOTFILE_DIRS =
2477 francois 284
2478 francois 737 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2479     # contain msc files that are included in the documentation (see the \mscfile
2480     # command).
2481 francois 357
2482 francois 1081 MSCFILE_DIRS =
2483 francois 357
2484 francois 737 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2485     # contain dia files that are included in the documentation (see the \diafile
2486     # command).
2487 francois 284
2488 francois 1081 DIAFILE_DIRS =
2489 francois 737
2490 francois 1020 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2491     # path where java can find the plantuml.jar file. If left blank, it is assumed
2492     # PlantUML is not used or called during a preprocessing step. Doxygen will
2493     # generate a warning when it encounters a \startuml command in this case and
2494     # will not generate output for the diagram.
2495    
2496 francois 1081 PLANTUML_JAR_PATH =
2497 francois 1020
2498 francois 1057 # When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2499     # configuration file for plantuml.
2500    
2501 francois 1081 PLANTUML_CFG_FILE =
2502 francois 1057
2503 francois 1020 # When using plantuml, the specified paths are searched for files specified by
2504     # the !include statement in a plantuml block.
2505    
2506 francois 1081 PLANTUML_INCLUDE_PATH =
2507 francois 1020
2508 francois 737 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2509     # that will be shown in the graph. If the number of nodes in a graph becomes
2510     # larger than this value, doxygen will truncate the graph, which is visualized
2511     # by representing a node as a red box. Note that doxygen if the number of direct
2512     # children of the root node in a graph is already larger than
2513     # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2514     # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2515     # Minimum value: 0, maximum value: 10000, default value: 50.
2516     # This tag requires that the tag HAVE_DOT is set to YES.
2517    
2518 francois 1057 DOT_GRAPH_MAX_NODES = 500
2519 francois 284
2520 francois 737 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2521     # generated by dot. A depth value of 3 means that only nodes reachable from the
2522     # root by following a path via at most 3 edges will be shown. Nodes that lay
2523     # further from the root node will be omitted. Note that setting this option to 1
2524     # or 2 may greatly reduce the computation time needed for large code bases. Also
2525     # note that the size of a graph can be further restricted by
2526 francois 284 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2527 francois 737 # Minimum value: 0, maximum value: 1000, default value: 0.
2528     # This tag requires that the tag HAVE_DOT is set to YES.
2529 francois 284
2530 6 MAX_DOT_GRAPH_DEPTH = 1000
2531 francois 284
2532 francois 737 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2533     # background. This is disabled by default, because dot on Windows does not seem
2534     # to support this out of the box.
2535     #
2536     # Warning: Depending on the platform used, enabling this option may lead to
2537     # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2538     # read).
2539     # The default value is: NO.
2540     # This tag requires that the tag HAVE_DOT is set to YES.
2541 francois 284
2542 6 DOT_TRANSPARENT = NO
2543 francois 284
2544 francois 1020 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2545 francois 737 # files in one run (i.e. multiple -o and -T options on the command line). This
2546     # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2547     # this, this feature is disabled by default.
2548     # The default value is: NO.
2549     # This tag requires that the tag HAVE_DOT is set to YES.
2550 francois 284
2551 6 DOT_MULTI_TARGETS = NO
2552 francois 284
2553 francois 737 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2554     # explaining the meaning of the various boxes and arrows in the dot generated
2555     # graphs.
2556     # The default value is: YES.
2557     # This tag requires that the tag HAVE_DOT is set to YES.
2558 francois 284
2559 6 GENERATE_LEGEND = YES
2560 francois 284
2561 francois 1020 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2562 francois 737 # files that are used to generate the various graphs.
2563     # The default value is: YES.
2564     # This tag requires that the tag HAVE_DOT is set to YES.
2565 francois 284
2566 6 DOT_CLEANUP = YES