ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/REPOS_ERICCA/magic/documentation/docmagic.in
Revision: 1057
Committed: Tue Mar 30 23:03:55 2021 UTC (4 years, 1 month ago) by francois
Original Path: magic/documentation/docmagic
File size: 108419 byte(s)
Log Message:
ajout d'un graph des classes + test nouveau serveur svn

File Contents

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