ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/REPOS_ERICCA/magic/documentation/docmagic
Revision: 1020
Committed: Wed Jun 5 14:33:14 2019 UTC (5 years, 11 months ago) by francois
File size: 107861 byte(s)
Log Message:
mise a jour de la documentation en lien avec le changement de structure

File Contents

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