ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/REPOS_ERICCA/magic/documentation/docmagic
Revision: 1069
Committed: Mon Jun 14 20:12:11 2021 UTC (3 years, 10 months ago) by francois
File size: 108362 byte(s)
Log Message:
suite mise a jour aide

File Contents

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