ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/REPOS_ERICCA/magic/documentation/docmagic
Revision: 652
Committed: Thu Feb 19 19:35:16 2015 UTC (10 years, 2 months ago) by francois
File size: 77761 byte(s)
Log Message:
Mise des unites à 0.001 automatiquement pour l'importation OCC

File Contents

# User Rev Content
1 francois 357 # Doxyfile 1.7.6.1
2 francois 97
3 francois 284 # This file describes the settings to be used by the documentation system
4     # doxygen (www.doxygen.org) for a project
5     #
6     # All text after a hash (#) is considered a comment and will be ignored
7     # The format is:
8     # TAG = value [value, ...]
9     # For lists items can also be appended using:
10     # TAG += value [value, ...]
11     # Values that contain spaces should be placed between quotes (" ")
12    
13 6 #---------------------------------------------------------------------------
14     # Project related configuration options
15     #---------------------------------------------------------------------------
16 francois 284
17     # This tag specifies the encoding used for all characters in the config file
18     # that follow. The default is UTF-8 which is also the encoding used for all
19     # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20     # iconv built into libc) for the transcoding. See
21     # http://www.gnu.org/software/libiconv for the list of possible encodings.
22    
23     DOXYFILE_ENCODING = UTF-8
24    
25 francois 357 # The PROJECT_NAME tag is a single word (or sequence of words) that should
26     # identify the project. Note that if you do not use Doxywizard you need
27     # to put quotes around the project name if it contains spaces.
28 francois 284
29     PROJECT_NAME = MAGiC
30    
31     # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32     # This could be handy for archiving the generated documentation or
33     # if some version control system is used.
34    
35 francois 652 PROJECT_NUMBER = 2015
36 francois 284
37 francois 357 # Using the PROJECT_BRIEF tag one can provide an optional one line description
38     # for a project that appears at the top of each page and should give viewer
39     # a quick idea about the purpose of the project. Keep the description short.
40    
41     PROJECT_BRIEF =
42    
43     # With the PROJECT_LOGO tag one can specify an logo or icon that is
44     # included in the documentation. The maximum height of the logo should not
45     # exceed 55 pixels and the maximum width should not exceed 200 pixels.
46     # Doxygen will copy the logo to the output directory.
47    
48     PROJECT_LOGO =
49    
50 francois 284 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51     # base path where the generated documentation will be put.
52     # If a relative path is entered, it will be relative to the location
53     # where doxygen was started. If left blank the current directory will be used.
54    
55 francois 400 OUTPUT_DIRECTORY = ./
56 francois 284
57     # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58     # 4096 sub-directories (in 2 levels) under the output directory of each output
59     # format and will distribute the generated files over these directories.
60     # Enabling this option can be useful when feeding doxygen a huge amount of
61     # source files, where putting all generated files in the same directory would
62     # otherwise cause performance problems for the file system.
63    
64 6 CREATE_SUBDIRS = YES
65 francois 284
66     # The OUTPUT_LANGUAGE tag is used to specify the language in which all
67     # documentation generated by doxygen is written. Doxygen will use this
68     # information to generate all constant output in the proper language.
69     # The default language is English, other supported languages are:
70     # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71     # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72     # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73     # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74 francois 357 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75 francois 284 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76    
77     OUTPUT_LANGUAGE = French
78    
79     # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80     # include brief member descriptions after the members that are listed in
81     # the file and class documentation (similar to JavaDoc).
82     # Set to NO to disable this.
83    
84 6 BRIEF_MEMBER_DESC = YES
85 francois 284
86     # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87     # the brief description of a member or function before the detailed description.
88     # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89     # brief descriptions will be completely suppressed.
90    
91 6 REPEAT_BRIEF = YES
92 francois 284
93     # This tag implements a quasi-intelligent brief description abbreviator
94     # that is used to form the text in various listings. Each string
95     # in this list, if found as the leading text of the brief description, will be
96     # stripped from the text and the result after processing the whole list, is
97     # used as the annotated text. Otherwise, the brief description is used as-is.
98     # If left blank, the following values are used ("$name" is automatically
99     # replaced with the name of the entity): "The $name class" "The $name widget"
100     # "The $name file" "is" "provides" "specifies" "contains"
101     # "represents" "a" "an" "the"
102    
103 6 ABBREVIATE_BRIEF = "The $name class" \
104     "The $name widget" \
105     "The $name file" \
106     is \
107     provides \
108     specifies \
109     contains \
110     represents \
111     a \
112     an \
113     the
114 francois 284
115     # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
116     # Doxygen will generate a detailed section even if there is only a brief
117     # description.
118    
119 6 ALWAYS_DETAILED_SEC = NO
120 francois 284
121     # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
122     # inherited members of a class in the documentation of that class as if those
123     # members were ordinary class members. Constructors, destructors and assignment
124     # operators of the base classes will not be shown.
125    
126 6 INLINE_INHERITED_MEMB = NO
127 francois 284
128     # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
129     # path before files name in the file list and in the header files. If set
130     # to NO the shortest path that makes the file name unique will be used.
131    
132 6 FULL_PATH_NAMES = NO
133 francois 284
134     # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
135     # can be used to strip a user-defined part of the path. Stripping is
136     # only done if one of the specified strings matches the left-hand part of
137     # the path. The tag can be used to show relative paths in the file list.
138     # If left blank the directory from which doxygen is run is used as the
139     # path to strip.
140    
141 6 STRIP_FROM_PATH = "C:/Documents and Settings/francois/"
142 francois 284
143     # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
144     # the path mentioned in the documentation of a class, which tells
145     # the reader which header file to include in order to use a class.
146     # If left blank only the name of the header file containing the class
147     # definition is used. Otherwise one should specify the include paths that
148     # are normally passed to the compiler using the -I flag.
149    
150 6 STRIP_FROM_INC_PATH =
151 francois 284
152     # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
153 francois 357 # (but less readable) file names. This can be useful if your file system
154 francois 284 # doesn't support long names like on DOS, Mac, or CD-ROM.
155    
156 6 SHORT_NAMES = NO
157 francois 284
158     # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
159     # will interpret the first line (until the first dot) of a JavaDoc-style
160     # comment as the brief description. If set to NO, the JavaDoc
161     # comments will behave just like regular Qt-style comments
162     # (thus requiring an explicit @brief command for a brief description.)
163    
164 6 JAVADOC_AUTOBRIEF = NO
165 francois 284
166     # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
167     # interpret the first line (until the first dot) of a Qt-style
168     # comment as the brief description. If set to NO, the comments
169     # will behave just like regular Qt-style comments (thus requiring
170     # an explicit \brief command for a brief description.)
171    
172     QT_AUTOBRIEF = NO
173    
174     # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
175     # treat a multi-line C++ special comment block (i.e. a block of //! or ///
176     # comments) as a brief description. This used to be the default behaviour.
177     # The new default is to treat a multi-line C++ comment block as a detailed
178     # description. Set this tag to YES if you prefer the old behaviour instead.
179    
180 6 MULTILINE_CPP_IS_BRIEF = NO
181 francois 284
182     # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
183     # member inherits the documentation from any documented member that it
184     # re-implements.
185    
186 6 INHERIT_DOCS = YES
187 francois 284
188     # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
189     # a new page for each member. If set to NO, the documentation of a member will
190     # be part of the file/class/namespace that contains it.
191    
192     SEPARATE_MEMBER_PAGES = NO
193    
194     # The TAB_SIZE tag can be used to set the number of spaces in a tab.
195     # Doxygen uses this value to replace tabs by spaces in code fragments.
196    
197 6 TAB_SIZE = 8
198 francois 284
199     # This tag can be used to specify a number of aliases that acts
200     # as commands in the documentation. An alias has the form "name=value".
201     # For example adding "sideeffect=\par Side Effects:\n" will allow you to
202     # put the command \sideeffect (or @sideeffect) in the documentation, which
203     # will result in a user-defined paragraph with heading "Side Effects:".
204     # You can put \n's in the value part of an alias to insert newlines.
205    
206 6 ALIASES =
207 francois 284
208 francois 357 # This tag can be used to specify a number of word-keyword mappings (TCL only).
209     # A mapping has the form "name=value". For example adding
210     # "class=itcl::class" will allow you to use the command class in the
211     # itcl::class meaning.
212    
213     TCL_SUBST =
214    
215 francois 284 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
216     # sources only. Doxygen will then generate output that is more tailored for C.
217     # For instance, some of the names that are used will be different. The list
218     # of all members will be omitted, etc.
219    
220 6 OPTIMIZE_OUTPUT_FOR_C = NO
221 francois 284
222     # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
223     # sources only. Doxygen will then generate output that is more tailored for
224     # Java. For instance, namespaces will be presented as packages, qualified
225     # scopes will look different, etc.
226    
227 6 OPTIMIZE_OUTPUT_JAVA = NO
228 francois 284
229     # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
230     # sources only. Doxygen will then generate output that is more tailored for
231     # Fortran.
232    
233     OPTIMIZE_FOR_FORTRAN = NO
234    
235     # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
236     # sources. Doxygen will then generate output that is tailored for
237     # VHDL.
238    
239     OPTIMIZE_OUTPUT_VHDL = NO
240    
241 francois 357 # Doxygen selects the parser to use depending on the extension of the files it
242     # parses. With this tag you can assign which parser to use for a given extension.
243     # Doxygen has a built-in mapping, but you can override or extend it using this
244     # tag. The format is ext=language, where ext is a file extension, and language
245     # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
246     # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
247     # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
248     # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
249     # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
250 francois 284
251     EXTENSION_MAPPING =
252    
253     # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
254     # to include (a tag file for) the STL sources as input, then you should
255     # set this tag to YES in order to let doxygen match functions declarations and
256     # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
257 francois 357 # func(std::string) {}). This also makes the inheritance and collaboration
258 francois 284 # diagrams that involve STL classes more complete and accurate.
259    
260     BUILTIN_STL_SUPPORT = NO
261    
262     # If you use Microsoft's C++/CLI language, you should set this option to YES to
263     # enable parsing support.
264    
265     CPP_CLI_SUPPORT = NO
266    
267     # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
268     # Doxygen will parse them like normal C++ but will assume all classes use public
269     # instead of private inheritance when no explicit protection keyword is present.
270    
271     SIP_SUPPORT = NO
272    
273     # For Microsoft's IDL there are propget and propput attributes to indicate getter
274     # and setter methods for a property. Setting this option to YES (the default)
275 francois 357 # will make doxygen replace the get and set methods by a property in the
276 francois 284 # documentation. This will only work if the methods are indeed getting or
277     # setting a simple type. If this is not the case, or you want to show the
278     # methods anyway, you should set this option to NO.
279    
280     IDL_PROPERTY_SUPPORT = YES
281    
282     # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
283     # tag is set to YES, then doxygen will reuse the documentation of the first
284     # member in the group (if any) for the other members of the group. By default
285     # all members of a group must be documented explicitly.
286    
287     DISTRIBUTE_GROUP_DOC = NO
288    
289     # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
290     # the same type (for instance a group of public functions) to be put as a
291     # subgroup of that type (e.g. under the Public Functions section). Set it to
292     # NO to prevent subgrouping. Alternatively, this can be done per class using
293     # the \nosubgrouping command.
294    
295 6 SUBGROUPING = YES
296 francois 284
297 francois 357 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
298     # unions are shown inside the group in which they are included (e.g. using
299     # @ingroup) instead of on a separate page (for HTML and Man pages) or
300     # section (for LaTeX and RTF).
301    
302     INLINE_GROUPED_CLASSES = NO
303    
304     # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
305     # unions with only public data fields will be shown inline in the documentation
306     # of the scope in which they are defined (i.e. file, namespace, or group
307     # documentation), provided this scope is documented. If set to NO (the default),
308     # structs, classes, and unions are shown on a separate page (for HTML and Man
309     # pages) or section (for LaTeX and RTF).
310    
311     INLINE_SIMPLE_STRUCTS = NO
312    
313 francois 284 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
314     # is documented as struct, union, or enum with the name of the typedef. So
315     # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
316     # with name TypeT. When disabled the typedef will appear as a member of a file,
317     # namespace, or class. And the struct will be named TypeS. This can typically
318     # be useful for C code in case the coding convention dictates that all compound
319     # types are typedef'ed and only the typedef is referenced, never the tag name.
320    
321     TYPEDEF_HIDES_STRUCT = NO
322    
323     # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
324     # determine which symbols to keep in memory and which to flush to disk.
325     # When the cache is full, less often used symbols will be written to disk.
326     # For small to medium size projects (<1000 input files) the default value is
327     # probably good enough. For larger projects a too small cache size can cause
328     # doxygen to be busy swapping symbols to and from disk most of the time
329 francois 357 # causing a significant performance penalty.
330 francois 284 # If the system has enough physical memory increasing the cache will improve the
331     # performance by keeping more symbols in memory. Note that the value works on
332 francois 357 # a logarithmic scale so increasing the size by one will roughly double the
333 francois 284 # memory usage. The cache size is given by this formula:
334     # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
335 francois 357 # corresponding to a cache size of 2^16 = 65536 symbols.
336 francois 284
337     SYMBOL_CACHE_SIZE = 0
338    
339 francois 357 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
340     # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
341     # their name and scope. Since this can be an expensive process and often the
342     # same symbol appear multiple times in the code, doxygen keeps a cache of
343     # pre-resolved symbols. If the cache is too small doxygen will become slower.
344     # If the cache is too large, memory is wasted. The cache size is given by this
345     # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
346     # corresponding to a cache size of 2^16 = 65536 symbols.
347    
348     LOOKUP_CACHE_SIZE = 0
349    
350 6 #---------------------------------------------------------------------------
351     # Build related configuration options
352     #---------------------------------------------------------------------------
353 francois 284
354     # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
355     # documentation are documented, even if no documentation was available.
356     # Private class members and static file members will be hidden unless
357     # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
358    
359 6 EXTRACT_ALL = YES
360 francois 284
361     # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
362     # will be included in the documentation.
363    
364 francois 175 EXTRACT_PRIVATE = YES
365 francois 284
366     # If the EXTRACT_STATIC tag is set to YES all static members of a file
367     # will be included in the documentation.
368    
369 francois 175 EXTRACT_STATIC = YES
370 francois 284
371     # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
372     # defined locally in source files will be included in the documentation.
373     # If set to NO only classes defined in header files are included.
374    
375 6 EXTRACT_LOCAL_CLASSES = YES
376 francois 284
377     # This flag is only useful for Objective-C code. When set to YES local
378     # methods, which are defined in the implementation section but not in
379     # the interface are included in the documentation.
380     # If set to NO (the default) only methods in the interface are included.
381    
382 francois 357 EXTRACT_LOCAL_METHODS = YES
383 francois 284
384     # If this flag is set to YES, the members of anonymous namespaces will be
385     # extracted and appear in the documentation as a namespace called
386     # 'anonymous_namespace{file}', where file will be replaced with the base
387     # name of the file that contains the anonymous namespace. By default
388 francois 357 # anonymous namespaces are hidden.
389 francois 284
390     EXTRACT_ANON_NSPACES = NO
391    
392     # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
393     # undocumented members of documented classes, files or namespaces.
394     # If set to NO (the default) these members will be included in the
395     # various overviews, but no documentation section is generated.
396     # This option has no effect if EXTRACT_ALL is enabled.
397    
398 francois 175 HIDE_UNDOC_MEMBERS = NO
399 francois 284
400     # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
401     # undocumented classes that are normally visible in the class hierarchy.
402     # If set to NO (the default) these classes will be included in the various
403     # overviews. This option has no effect if EXTRACT_ALL is enabled.
404    
405 francois 175 HIDE_UNDOC_CLASSES = NO
406 francois 284
407     # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
408     # friend (class|struct|union) declarations.
409     # If set to NO (the default) these declarations will be included in the
410     # documentation.
411    
412 6 HIDE_FRIEND_COMPOUNDS = NO
413 francois 284
414     # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
415     # documentation blocks found inside the body of a function.
416     # If set to NO (the default) these blocks will be appended to the
417     # function's detailed documentation block.
418    
419 6 HIDE_IN_BODY_DOCS = NO
420 francois 284
421     # The INTERNAL_DOCS tag determines if documentation
422     # that is typed after a \internal command is included. If the tag is set
423     # to NO (the default) then the documentation will be excluded.
424     # Set it to YES to include the internal documentation.
425    
426 6 INTERNAL_DOCS = NO
427 francois 284
428     # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
429     # file names in lower-case letters. If set to YES upper-case letters are also
430     # allowed. This is useful if you have classes or files whose names only differ
431     # in case and if your file system supports case sensitive file names. Windows
432     # and Mac users are advised to set this option to NO.
433    
434 6 CASE_SENSE_NAMES = NO
435 francois 284
436     # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
437     # will show members with their full class and namespace scopes in the
438     # documentation. If set to YES the scope will be hidden.
439    
440 6 HIDE_SCOPE_NAMES = NO
441 francois 284
442     # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
443     # will put a list of the files that are included by a file in the documentation
444     # of that file.
445    
446 6 SHOW_INCLUDE_FILES = YES
447 francois 284
448     # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
449     # will list include files with double quotes in the documentation
450     # rather than with sharp brackets.
451    
452     FORCE_LOCAL_INCLUDES = NO
453    
454     # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
455     # is inserted in the documentation for inline members.
456    
457 6 INLINE_INFO = YES
458 francois 284
459     # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
460     # will sort the (detailed) documentation of file and class members
461     # alphabetically by member name. If set to NO the members will appear in
462     # declaration order.
463    
464 6 SORT_MEMBER_DOCS = YES
465 francois 284
466     # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
467     # brief documentation of file, namespace and class members alphabetically
468     # by member name. If set to NO (the default) the members will appear in
469     # declaration order.
470    
471 6 SORT_BRIEF_DOCS = NO
472 francois 284
473 francois 357 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
474     # will sort the (brief and detailed) documentation of class members so that
475     # constructors and destructors are listed first. If set to NO (the default)
476     # the constructors will appear in the respective orders defined by
477     # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
478     # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
479 francois 284 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
480    
481     SORT_MEMBERS_CTORS_1ST = NO
482    
483     # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
484     # hierarchy of group names into alphabetical order. If set to NO (the default)
485     # the group names will appear in their defined order.
486    
487     SORT_GROUP_NAMES = NO
488    
489     # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
490     # sorted by fully-qualified names, including namespaces. If set to
491     # NO (the default), the class list will be sorted only by class name,
492     # not including the namespace part.
493     # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
494     # Note: This option applies only to the class list, not to the
495     # alphabetical list.
496    
497 6 SORT_BY_SCOPE_NAME = NO
498 francois 284
499 francois 357 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
500     # do proper type resolution of all parameters of a function it will reject a
501     # match between the prototype and the implementation of a member function even
502     # if there is only one candidate or it is obvious which candidate to choose
503     # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
504     # will still accept a match between prototype and implementation in such cases.
505    
506     STRICT_PROTO_MATCHING = NO
507    
508 francois 284 # The GENERATE_TODOLIST tag can be used to enable (YES) or
509     # disable (NO) the todo list. This list is created by putting \todo
510     # commands in the documentation.
511    
512 6 GENERATE_TODOLIST = YES
513 francois 284
514     # The GENERATE_TESTLIST tag can be used to enable (YES) or
515     # disable (NO) the test list. This list is created by putting \test
516     # commands in the documentation.
517    
518 6 GENERATE_TESTLIST = YES
519 francois 284
520     # The GENERATE_BUGLIST tag can be used to enable (YES) or
521     # disable (NO) the bug list. This list is created by putting \bug
522     # commands in the documentation.
523    
524 6 GENERATE_BUGLIST = YES
525 francois 284
526     # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
527     # disable (NO) the deprecated list. This list is created by putting
528     # \deprecated commands in the documentation.
529    
530 6 GENERATE_DEPRECATEDLIST= YES
531 francois 284
532     # The ENABLED_SECTIONS tag can be used to enable conditional
533     # documentation sections, marked by \if sectionname ... \endif.
534    
535 6 ENABLED_SECTIONS =
536 francois 284
537     # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
538 francois 357 # the initial value of a variable or macro consists of for it to appear in
539 francois 284 # the documentation. If the initializer consists of more lines than specified
540     # here it will be hidden. Use a value of 0 to hide initializers completely.
541 francois 357 # The appearance of the initializer of individual variables and macros in the
542 francois 284 # documentation can be controlled using \showinitializer or \hideinitializer
543     # command in the documentation regardless of this setting.
544    
545 6 MAX_INITIALIZER_LINES = 30
546 francois 284
547     # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
548     # at the bottom of the documentation of classes and structs. If set to YES the
549     # list will mention the files that were used to generate the documentation.
550    
551 6 SHOW_USED_FILES = YES
552 francois 284
553     # If the sources in your project are distributed over multiple directories
554     # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
555     # in the documentation. The default is NO.
556    
557 6 SHOW_DIRECTORIES = NO
558 francois 284
559     # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
560     # This will remove the Files entry from the Quick Index and from the
561     # Folder Tree View (if specified). The default is YES.
562    
563     SHOW_FILES = YES
564    
565     # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
566     # Namespaces page. This will remove the Namespaces entry from the Quick Index
567     # and from the Folder Tree View (if specified). The default is YES.
568    
569     SHOW_NAMESPACES = YES
570    
571     # The FILE_VERSION_FILTER tag can be used to specify a program or script that
572     # doxygen should invoke to get the current version for each file (typically from
573     # the version control system). Doxygen will invoke the program by executing (via
574     # popen()) the command <command> <input-file>, where <command> is the value of
575     # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
576     # provided by doxygen. Whatever the program writes to standard output
577     # is used as the file version. See the manual for examples.
578    
579 6 FILE_VERSION_FILTER =
580 francois 284
581 francois 357 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
582     # by doxygen. The layout file controls the global structure of the generated
583     # output files in an output format independent way. The create the layout file
584     # that represents doxygen's defaults, run doxygen with the -l option.
585     # You can optionally specify a file name after the option, if omitted
586     # DoxygenLayout.xml will be used as the name of the layout file.
587 francois 284
588     LAYOUT_FILE =
589    
590 francois 357 # The CITE_BIB_FILES tag can be used to specify one or more bib files
591     # containing the references data. This must be a list of .bib files. The
592     # .bib extension is automatically appended if omitted. Using this command
593     # requires the bibtex tool to be installed. See also
594     # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
595     # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
596     # feature you need bibtex and perl available in the search path.
597    
598     CITE_BIB_FILES =
599    
600 6 #---------------------------------------------------------------------------
601     # configuration options related to warning and progress messages
602     #---------------------------------------------------------------------------
603 francois 284
604     # The QUIET tag can be used to turn on/off the messages that are generated
605     # by doxygen. Possible values are YES and NO. If left blank NO is used.
606    
607 6 QUIET = NO
608 francois 284
609     # The WARNINGS tag can be used to turn on/off the warning messages that are
610     # generated by doxygen. Possible values are YES and NO. If left blank
611     # NO is used.
612    
613 6 WARNINGS = YES
614 francois 284
615     # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
616     # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
617     # automatically be disabled.
618    
619 6 WARN_IF_UNDOCUMENTED = YES
620 francois 284
621     # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
622     # potential errors in the documentation, such as not documenting some
623     # parameters in a documented function, or documenting parameters that
624     # don't exist or using markup commands wrongly.
625    
626 6 WARN_IF_DOC_ERROR = YES
627 francois 284
628 francois 357 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
629 francois 284 # functions that are documented, but have no documentation for their parameters
630     # or return value. If set to NO (the default) doxygen will only warn about
631     # wrong or incomplete parameter documentation, but not about the absence of
632     # documentation.
633    
634 6 WARN_NO_PARAMDOC = NO
635 francois 284
636     # The WARN_FORMAT tag determines the format of the warning messages that
637     # doxygen can produce. The string should contain the $file, $line, and $text
638     # tags, which will be replaced by the file and line number from which the
639     # warning originated and the warning text. Optionally the format may contain
640     # $version, which will be replaced by the version of the file (if it could
641     # be obtained via FILE_VERSION_FILTER)
642    
643 6 WARN_FORMAT = "$file:$line: $text"
644 francois 284
645     # The WARN_LOGFILE tag can be used to specify a file to which warning
646     # and error messages should be written. If left blank the output is written
647     # to stderr.
648    
649 6 WARN_LOGFILE =
650 francois 284
651 6 #---------------------------------------------------------------------------
652     # configuration options related to the input files
653     #---------------------------------------------------------------------------
654 francois 284
655     # The INPUT tag can be used to specify the files and/or directories that contain
656     # documented source files. You may enter file names like "myfile.cpp" or
657     # directories like "/usr/src/myproject". Separate the files or directories
658     # with spaces.
659    
660 francois 357 INPUT = ../lib
661 francois 284
662     # This tag can be used to specify the character encoding of the source files
663     # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
664     # also the default input encoding. Doxygen uses libiconv (or the iconv built
665     # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
666     # the list of possible encodings.
667    
668     INPUT_ENCODING = UTF-8
669    
670     # If the value of the INPUT tag contains directories, you can use the
671     # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
672     # and *.h) to filter out the source-files in the directories. If left
673     # blank the following patterns are tested:
674 francois 357 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
675     # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
676     # *.f90 *.f *.for *.vhd *.vhdl
677 francois 284
678 6 FILE_PATTERNS = *.c \
679     *.cc \
680     *.cxx \
681     *.cpp \
682     *.c++ \
683     *.java \
684     *.ii \
685     *.ixx \
686     *.ipp \
687     *.i++ \
688     *.inl \
689     *.h \
690     *.hh \
691     *.hxx \
692     *.hpp \
693     *.h++ \
694     *.idl \
695     *.odl \
696     *.cs \
697     *.php \
698     *.php3 \
699     *.inc \
700     *.m \
701     *.mm \
702     *.dox
703 francois 284
704     # The RECURSIVE tag can be used to turn specify whether or not subdirectories
705     # should be searched for input files as well. Possible values are YES and NO.
706     # If left blank NO is used.
707    
708 6 RECURSIVE = YES
709 francois 284
710 francois 357 # The EXCLUDE tag can be used to specify files and/or directories that should be
711 francois 284 # excluded from the INPUT source files. This way you can easily exclude a
712 francois 357 # subdirectory from a directory tree whose root is specified with the INPUT tag.
713     # Note that relative paths are relative to the directory from which doxygen is
714     # run.
715 francois 284
716     EXCLUDE = ../lib/OCC_Fonction \
717 francois 357 ../lib/geometrie/Imports \
718     ../lib/diamesh
719 francois 284
720 francois 357 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
721     # directories that are symbolic links (a Unix file system feature) are excluded
722 francois 284 # from the input.
723    
724 6 EXCLUDE_SYMLINKS = NO
725 francois 284
726     # If the value of the INPUT tag contains directories, you can use the
727     # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
728     # certain files from those directories. Note that the wildcards are matched
729     # against the file with absolute path, so to exclude all test directories
730     # for example use the pattern */test/*
731    
732 6 EXCLUDE_PATTERNS =
733 francois 284
734     # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
735     # (namespaces, classes, functions, etc.) that should be excluded from the
736     # output. The symbol name can be a fully qualified name, a word, or if the
737     # wildcard * is used, a substring. Examples: ANamespace, AClass,
738     # AClass::ANamespace, ANamespace::*Test
739    
740     EXCLUDE_SYMBOLS =
741    
742     # The EXAMPLE_PATH tag can be used to specify one or more files or
743     # directories that contain example code fragments that are included (see
744     # the \include command).
745    
746 6 EXAMPLE_PATH =
747 francois 284
748     # If the value of the EXAMPLE_PATH tag contains directories, you can use the
749     # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
750     # and *.h) to filter out the source-files in the directories. If left
751     # blank all files are included.
752    
753 6 EXAMPLE_PATTERNS = *
754 francois 284
755     # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
756     # searched for input files to be used with the \include or \dontinclude
757     # commands irrespective of the value of the RECURSIVE tag.
758     # Possible values are YES and NO. If left blank NO is used.
759    
760 6 EXAMPLE_RECURSIVE = NO
761 francois 284
762     # The IMAGE_PATH tag can be used to specify one or more files or
763     # directories that contain image that are included in the documentation (see
764     # the \image command).
765    
766 6 IMAGE_PATH =
767 francois 284
768     # The INPUT_FILTER tag can be used to specify a program that doxygen should
769     # invoke to filter for each input file. Doxygen will invoke the filter program
770     # by executing (via popen()) the command <filter> <input-file>, where <filter>
771     # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
772     # input file. Doxygen will then use the output that the filter program writes
773     # to standard output. If FILTER_PATTERNS is specified, this tag will be
774     # ignored.
775    
776 6 INPUT_FILTER =
777 francois 284
778     # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
779     # basis. Doxygen will compare the file name with each pattern and apply the
780     # filter if there is a match. The filters are a list of the form:
781     # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
782 francois 357 # info on how filters are used. If FILTER_PATTERNS is empty or if
783     # non of the patterns match the file name, INPUT_FILTER is applied.
784 francois 284
785 6 FILTER_PATTERNS =
786 francois 284
787     # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
788     # INPUT_FILTER) will be used to filter the input files when producing source
789     # files to browse (i.e. when SOURCE_BROWSER is set to YES).
790    
791 6 FILTER_SOURCE_FILES = NO
792 francois 284
793 francois 357 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
794     # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
795     # and it is also possible to disable source filtering for a specific pattern
796     # using *.ext= (so without naming a filter). This option only has effect when
797     # FILTER_SOURCE_FILES is enabled.
798    
799     FILTER_SOURCE_PATTERNS =
800    
801 6 #---------------------------------------------------------------------------
802     # configuration options related to source browsing
803     #---------------------------------------------------------------------------
804 francois 284
805     # If the SOURCE_BROWSER tag is set to YES then a list of source files will
806     # be generated. Documented entities will be cross-referenced with these sources.
807     # Note: To get rid of all source code in the generated output, make sure also
808     # VERBATIM_HEADERS is set to NO.
809    
810 francois 175 SOURCE_BROWSER = YES
811 francois 284
812     # Setting the INLINE_SOURCES tag to YES will include the body
813     # of functions and classes directly in the documentation.
814    
815 6 INLINE_SOURCES = NO
816 francois 284
817     # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
818     # doxygen to hide any special comment blocks from generated source code
819     # fragments. Normal C and C++ comments will always remain visible.
820    
821 6 STRIP_CODE_COMMENTS = YES
822 francois 284
823     # If the REFERENCED_BY_RELATION tag is set to YES
824     # then for each documented function all documented
825     # functions referencing it will be listed.
826    
827 6 REFERENCED_BY_RELATION = YES
828 francois 284
829     # If the REFERENCES_RELATION tag is set to YES
830     # then for each documented function all documented entities
831     # called/used by that function will be listed.
832    
833 6 REFERENCES_RELATION = YES
834 francois 284
835     # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
836     # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
837     # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
838     # link to the source code. Otherwise they will link to the documentation.
839    
840     REFERENCES_LINK_SOURCE = YES
841    
842     # If the USE_HTAGS tag is set to YES then the references to source code
843     # will point to the HTML generated by the htags(1) tool instead of doxygen
844     # built-in source browser. The htags tool is part of GNU's global source
845     # tagging system (see http://www.gnu.org/software/global/global.html). You
846     # will need version 4.8.6 or higher.
847    
848     USE_HTAGS = NO
849    
850     # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
851     # will generate a verbatim copy of the header file for each class for
852     # which an include is specified. Set to NO to disable this.
853    
854 6 VERBATIM_HEADERS = YES
855 francois 284
856 6 #---------------------------------------------------------------------------
857     # configuration options related to the alphabetical class index
858     #---------------------------------------------------------------------------
859 francois 284
860     # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
861     # of all compounds will be generated. Enable this if the project
862     # contains a lot of classes, structs, unions or interfaces.
863    
864 francois 357 ALPHABETICAL_INDEX = YES
865 francois 284
866     # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
867     # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
868     # in which this list will be split (can be a number in the range [1..20])
869    
870 6 COLS_IN_ALPHA_INDEX = 5
871 francois 284
872     # In case all classes in a project start with a common prefix, all
873     # classes will be put under the same header in the alphabetical index.
874     # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
875     # should be ignored while generating the index headers.
876    
877 6 IGNORE_PREFIX =
878 francois 284
879 6 #---------------------------------------------------------------------------
880     # configuration options related to the HTML output
881     #---------------------------------------------------------------------------
882 francois 284
883     # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
884     # generate HTML output.
885    
886 6 GENERATE_HTML = YES
887 francois 284
888     # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
889     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
890     # put in front of it. If left blank `html' will be used as the default path.
891    
892 francois 400 HTML_OUTPUT = ./
893 francois 284
894     # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
895     # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
896     # doxygen will generate files with .html extension.
897    
898 6 HTML_FILE_EXTENSION = .html
899 francois 284
900     # The HTML_HEADER tag can be used to specify a personal HTML header for
901     # each generated HTML page. If it is left blank doxygen will generate a
902 francois 357 # standard header. Note that when using a custom header you are responsible
903     # for the proper inclusion of any scripts and style sheets that doxygen
904     # needs, which is dependent on the configuration options used.
905     # It is advised to generate a default header using "doxygen -w html
906     # header.html footer.html stylesheet.css YourConfigFile" and then modify
907     # that header. Note that the header is subject to change so you typically
908     # have to redo this when upgrading to a newer version of doxygen or when
909     # changing the value of configuration settings such as GENERATE_TREEVIEW!
910 francois 284
911 6 HTML_HEADER =
912 francois 284
913     # The HTML_FOOTER tag can be used to specify a personal HTML footer for
914     # each generated HTML page. If it is left blank doxygen will generate a
915     # standard footer.
916    
917 6 HTML_FOOTER =
918 francois 284
919     # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
920     # style sheet that is used by each HTML page. It can be used to
921     # fine-tune the look of the HTML output. If the tag is left blank doxygen
922     # will generate a default style sheet. Note that doxygen will try to copy
923     # the style sheet file to the HTML output directory, so don't put your own
924 francois 357 # style sheet in the HTML output directory as well, or it will be erased!
925 francois 284
926 6 HTML_STYLESHEET =
927 francois 284
928 francois 357 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
929     # other source files which should be copied to the HTML output directory. Note
930     # that these files will be copied to the base HTML output directory. Use the
931     # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
932     # files. In the HTML_STYLESHEET file, use the file name only. Also note that
933     # the files will be copied as-is; there are no commands or markers available.
934    
935     HTML_EXTRA_FILES =
936    
937     # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
938     # Doxygen will adjust the colors in the style sheet and background images
939     # according to this color. Hue is specified as an angle on a colorwheel,
940     # see http://en.wikipedia.org/wiki/Hue for more information.
941     # For instance the value 0 represents red, 60 is yellow, 120 is green,
942     # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
943     # The allowed range is 0 to 359.
944    
945     HTML_COLORSTYLE_HUE = 220
946    
947     # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
948     # the colors in the HTML output. For a value of 0 the output will use
949     # grayscales only. A value of 255 will produce the most vivid colors.
950    
951     HTML_COLORSTYLE_SAT = 100
952    
953     # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
954     # the luminance component of the colors in the HTML output. Values below
955     # 100 gradually make the output lighter, whereas values above 100 make
956     # the output darker. The value divided by 100 is the actual gamma applied,
957     # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
958     # and 100 does not change the gamma.
959    
960     HTML_COLORSTYLE_GAMMA = 84
961    
962 francois 284 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
963     # page will contain the date and time when the page was generated. Setting
964     # this to NO can help when comparing the output of multiple runs.
965    
966     HTML_TIMESTAMP = YES
967    
968     # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
969     # files or namespaces will be aligned in HTML using tables. If set to
970     # NO a bullet list will be used.
971    
972 6 HTML_ALIGN_MEMBERS = YES
973 francois 284
974     # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
975     # documentation will contain sections that can be hidden and shown after the
976     # page has loaded. For this to work a browser that supports
977     # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
978     # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
979    
980     HTML_DYNAMIC_SECTIONS = NO
981    
982     # If the GENERATE_DOCSET tag is set to YES, additional index files
983     # will be generated that can be used as input for Apple's Xcode 3
984     # integrated development environment, introduced with OSX 10.5 (Leopard).
985     # To create a documentation set, doxygen will generate a Makefile in the
986     # HTML output directory. Running make will produce the docset in that
987     # directory and running "make install" will install the docset in
988     # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
989     # it at startup.
990 francois 357 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
991     # for more information.
992 francois 284
993     GENERATE_DOCSET = NO
994    
995     # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
996     # feed. A documentation feed provides an umbrella under which multiple
997     # documentation sets from a single provider (such as a company or product suite)
998     # can be grouped.
999    
1000     DOCSET_FEEDNAME = "Doxygen generated docs"
1001    
1002     # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1003     # should uniquely identify the documentation set bundle. This should be a
1004     # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1005     # will append .docset to the name.
1006    
1007     DOCSET_BUNDLE_ID = org.doxygen.Project
1008    
1009 francois 357 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1010     # the documentation publisher. This should be a reverse domain-name style
1011     # string, e.g. com.mycompany.MyDocSet.documentation.
1012    
1013     DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1014    
1015     # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1016    
1017     DOCSET_PUBLISHER_NAME = Publisher
1018    
1019 francois 284 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1020     # will be generated that can be used as input for tools like the
1021     # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1022     # of the generated HTML documentation.
1023    
1024 6 GENERATE_HTMLHELP = NO
1025 francois 284
1026     # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1027     # be used to specify the file name of the resulting .chm file. You
1028     # can add a path in front of the file if the result should not be
1029     # written to the html output directory.
1030    
1031 6 CHM_FILE =
1032 francois 284
1033     # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1034     # be used to specify the location (absolute path including file name) of
1035     # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1036     # the HTML help compiler on the generated index.hhp.
1037    
1038 6 HHC_LOCATION =
1039 francois 284
1040     # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1041     # controls if a separate .chi index file is generated (YES) or that
1042     # it should be included in the master .chm file (NO).
1043    
1044 6 GENERATE_CHI = NO
1045 francois 284
1046     # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1047     # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1048     # content.
1049    
1050     CHM_INDEX_ENCODING =
1051    
1052     # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1053     # controls whether a binary table of contents is generated (YES) or a
1054     # normal table of contents (NO) in the .chm file.
1055    
1056 6 BINARY_TOC = NO
1057 francois 284
1058     # The TOC_EXPAND flag can be set to YES to add extra items for group members
1059     # to the contents of the HTML help documentation and to the tree view.
1060    
1061 6 TOC_EXPAND = NO
1062 francois 284
1063 francois 357 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1064     # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1065     # that can be used as input for Qt's qhelpgenerator to generate a
1066     # Qt Compressed Help (.qch) of the generated HTML documentation.
1067 francois 284
1068     GENERATE_QHP = NO
1069    
1070     # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1071     # be used to specify the file name of the resulting .qch file.
1072     # The path specified is relative to the HTML output folder.
1073    
1074     QCH_FILE =
1075    
1076     # The QHP_NAMESPACE tag specifies the namespace to use when generating
1077     # Qt Help Project output. For more information please see
1078     # http://doc.trolltech.com/qthelpproject.html#namespace
1079    
1080     QHP_NAMESPACE = org.doxygen.Project
1081    
1082     # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1083     # Qt Help Project output. For more information please see
1084     # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1085    
1086     QHP_VIRTUAL_FOLDER = doc
1087    
1088 francois 357 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1089     # add. For more information please see
1090 francois 284 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1091    
1092     QHP_CUST_FILTER_NAME =
1093    
1094 francois 357 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1095     # custom filter to add. For more information please see
1096     # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1097     # Qt Help Project / Custom Filters</a>.
1098 francois 284
1099     QHP_CUST_FILTER_ATTRS =
1100    
1101 francois 357 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1102     # project's
1103 francois 284 # filter section matches.
1104 francois 357 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1105     # Qt Help Project / Filter Attributes</a>.
1106 francois 284
1107     QHP_SECT_FILTER_ATTRS =
1108    
1109     # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1110     # be used to specify the location of Qt's qhelpgenerator.
1111     # If non-empty doxygen will try to run qhelpgenerator on the generated
1112     # .qhp file.
1113    
1114     QHG_LOCATION =
1115    
1116     # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1117 francois 357 # will be generated, which together with the HTML files, form an Eclipse help
1118 francois 284 # plugin. To install this plugin and make it available under the help contents
1119     # menu in Eclipse, the contents of the directory containing the HTML and XML
1120     # files needs to be copied into the plugins directory of eclipse. The name of
1121     # the directory within the plugins directory should be the same as
1122 francois 357 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1123 francois 284 # the help appears.
1124    
1125     GENERATE_ECLIPSEHELP = NO
1126    
1127     # A unique identifier for the eclipse help plugin. When installing the plugin
1128     # the directory name containing the HTML and XML files should also have
1129     # this name.
1130    
1131     ECLIPSE_DOC_ID = org.doxygen.Project
1132    
1133 francois 357 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1134     # at top of each HTML page. The value NO (the default) enables the index and
1135     # the value YES disables it. Since the tabs have the same information as the
1136     # navigation tree you can set this option to NO if you already set
1137     # GENERATE_TREEVIEW to YES.
1138 francois 284
1139 6 DISABLE_INDEX = NO
1140 francois 284
1141     # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1142     # structure should be generated to display hierarchical information.
1143     # If the tag value is set to YES, a side panel will be generated
1144     # containing a tree-like index structure (just like the one that
1145     # is generated for HTML Help). For this to work a browser that supports
1146     # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1147 francois 357 # Windows users are probably better off using the HTML help feature.
1148     # Since the tree basically has the same information as the tab index you
1149     # could consider to set DISABLE_INDEX to NO when enabling this option.
1150 francois 284
1151 6 GENERATE_TREEVIEW = YES
1152 francois 284
1153 francois 357 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1154     # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1155     # documentation. Note that a value of 0 will completely suppress the enum
1156     # values from appearing in the overview section.
1157    
1158     ENUM_VALUES_PER_LINE = 1
1159    
1160 francois 284 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1161     # and Class Hierarchy pages using a tree view instead of an ordered list.
1162    
1163     USE_INLINE_TREES = NO
1164    
1165     # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1166     # used to set the initial width (in pixels) of the frame in which the tree
1167     # is shown.
1168    
1169 6 TREEVIEW_WIDTH = 250
1170 francois 284
1171 francois 357 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1172     # links to external symbols imported via tag files in a separate window.
1173    
1174     EXT_LINKS_IN_WINDOW = NO
1175    
1176 francois 284 # Use this tag to change the font size of Latex formulas included
1177     # as images in the HTML documentation. The default is 10. Note that
1178     # when you change the font size after a successful doxygen run you need
1179     # to manually remove any form_*.png images from the HTML output directory
1180     # to force them to be regenerated.
1181    
1182     FORMULA_FONTSIZE = 10
1183    
1184 francois 357 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1185     # generated for formulas are transparent PNGs. Transparent PNGs are
1186     # not supported properly for IE 6.0, but are supported on all modern browsers.
1187     # Note that when changing this option you need to delete any form_*.png files
1188     # in the HTML output before the changes have effect.
1189    
1190     FORMULA_TRANSPARENT = YES
1191    
1192     # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1193     # (see http://www.mathjax.org) which uses client side Javascript for the
1194     # rendering instead of using prerendered bitmaps. Use this if you do not
1195     # have LaTeX installed or if you want to formulas look prettier in the HTML
1196     # output. When enabled you also need to install MathJax separately and
1197     # configure the path to it using the MATHJAX_RELPATH option.
1198    
1199     USE_MATHJAX = NO
1200    
1201     # When MathJax is enabled you need to specify the location relative to the
1202     # HTML output directory using the MATHJAX_RELPATH option. The destination
1203     # directory should contain the MathJax.js script. For instance, if the mathjax
1204     # directory is located at the same level as the HTML output directory, then
1205     # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1206     # mathjax.org site, so you can quickly see the result without installing
1207     # MathJax, but it is strongly recommended to install a local copy of MathJax
1208     # before deployment.
1209    
1210     MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1211    
1212     # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1213     # names that should be enabled during MathJax rendering.
1214    
1215     MATHJAX_EXTENSIONS =
1216    
1217     # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1218 francois 284 # for the HTML output. The underlying search engine uses javascript
1219 francois 357 # and DHTML and should work on any modern browser. Note that when using
1220     # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1221 francois 284 # (GENERATE_DOCSET) there is already a search function so this one should
1222     # typically be disabled. For large projects the javascript based search engine
1223     # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1224    
1225 francois 357 SEARCHENGINE = YES
1226 francois 284
1227 francois 357 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1228     # implemented using a PHP enabled web server instead of at the web client
1229 francois 284 # using Javascript. Doxygen will generate the search PHP script and index
1230 francois 357 # file to put on the web server. The advantage of the server
1231     # based approach is that it scales better to large projects and allows
1232     # full text search. The disadvantages are that it is more difficult to setup
1233 francois 284 # and does not have live searching capabilities.
1234    
1235     SERVER_BASED_SEARCH = NO
1236    
1237 6 #---------------------------------------------------------------------------
1238     # configuration options related to the LaTeX output
1239     #---------------------------------------------------------------------------
1240 francois 284
1241     # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1242     # generate Latex output.
1243    
1244 6 GENERATE_LATEX = NO
1245 francois 284
1246     # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1247     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1248     # put in front of it. If left blank `latex' will be used as the default path.
1249    
1250 6 LATEX_OUTPUT = latex
1251 francois 284
1252     # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1253     # invoked. If left blank `latex' will be used as the default command name.
1254     # Note that when enabling USE_PDFLATEX this option is only used for
1255     # generating bitmaps for formulas in the HTML output, but not in the
1256     # Makefile that is written to the output directory.
1257    
1258 6 LATEX_CMD_NAME = latex
1259 francois 284
1260     # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1261     # generate index for LaTeX. If left blank `makeindex' will be used as the
1262     # default command name.
1263    
1264 6 MAKEINDEX_CMD_NAME = makeindex
1265 francois 284
1266     # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1267     # LaTeX documents. This may be useful for small projects and may help to
1268     # save some trees in general.
1269    
1270 6 COMPACT_LATEX = NO
1271 francois 284
1272     # The PAPER_TYPE tag can be used to set the paper type that is used
1273 francois 357 # by the printer. Possible values are: a4, letter, legal and
1274 francois 284 # executive. If left blank a4wide will be used.
1275    
1276 6 PAPER_TYPE = a4wide
1277 francois 284
1278     # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1279     # packages that should be included in the LaTeX output.
1280    
1281 6 EXTRA_PACKAGES =
1282 francois 284
1283     # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1284     # the generated latex document. The header should contain everything until
1285     # the first chapter. If it is left blank doxygen will generate a
1286     # standard header. Notice: only use this tag if you know what you are doing!
1287    
1288 6 LATEX_HEADER =
1289 francois 284
1290 francois 357 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1291     # the generated latex document. The footer should contain everything after
1292     # the last chapter. If it is left blank doxygen will generate a
1293     # standard footer. Notice: only use this tag if you know what you are doing!
1294    
1295     LATEX_FOOTER =
1296    
1297 francois 284 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1298     # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1299     # contain links (just like the HTML output) instead of page references
1300     # This makes the output suitable for online browsing using a pdf viewer.
1301    
1302 6 PDF_HYPERLINKS = NO
1303 francois 284
1304     # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1305     # plain latex in the generated Makefile. Set this option to YES to get a
1306     # higher quality PDF documentation.
1307    
1308 6 USE_PDFLATEX = NO
1309 francois 284
1310     # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1311     # command to the generated LaTeX files. This will instruct LaTeX to keep
1312     # running if errors occur, instead of asking the user for help.
1313     # This option is also used when generating formulas in HTML.
1314    
1315 6 LATEX_BATCHMODE = NO
1316 francois 284
1317     # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1318     # include the index chapters (such as File Index, Compound Index, etc.)
1319     # in the output.
1320    
1321 6 LATEX_HIDE_INDICES = NO
1322 francois 284
1323 francois 357 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1324     # source code with syntax highlighting in the LaTeX output.
1325     # Note that which sources are shown also depends on other settings
1326 francois 284 # such as SOURCE_BROWSER.
1327    
1328     LATEX_SOURCE_CODE = NO
1329    
1330 francois 357 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1331     # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1332     # http://en.wikipedia.org/wiki/BibTeX for more info.
1333    
1334     LATEX_BIB_STYLE = plain
1335    
1336 6 #---------------------------------------------------------------------------
1337     # configuration options related to the RTF output
1338     #---------------------------------------------------------------------------
1339 francois 284
1340     # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1341     # The RTF output is optimized for Word 97 and may not look very pretty with
1342     # other RTF readers or editors.
1343    
1344 6 GENERATE_RTF = NO
1345 francois 284
1346     # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1347     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1348     # put in front of it. If left blank `rtf' will be used as the default path.
1349    
1350 6 RTF_OUTPUT = rtf
1351 francois 284
1352     # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1353     # RTF documents. This may be useful for small projects and may help to
1354     # save some trees in general.
1355    
1356 6 COMPACT_RTF = NO
1357 francois 284
1358     # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1359     # will contain hyperlink fields. The RTF file will
1360     # contain links (just like the HTML output) instead of page references.
1361     # This makes the output suitable for online browsing using WORD or other
1362     # programs which support those fields.
1363     # Note: wordpad (write) and others do not support links.
1364    
1365 6 RTF_HYPERLINKS = NO
1366 francois 284
1367 francois 357 # Load style sheet definitions from file. Syntax is similar to doxygen's
1368 francois 284 # config file, i.e. a series of assignments. You only have to provide
1369     # replacements, missing definitions are set to their default value.
1370    
1371 6 RTF_STYLESHEET_FILE =
1372 francois 284
1373     # Set optional variables used in the generation of an rtf document.
1374     # Syntax is similar to doxygen's config file.
1375    
1376 6 RTF_EXTENSIONS_FILE =
1377 francois 284
1378 6 #---------------------------------------------------------------------------
1379     # configuration options related to the man page output
1380     #---------------------------------------------------------------------------
1381 francois 284
1382     # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1383     # generate man pages
1384    
1385 6 GENERATE_MAN = NO
1386 francois 284
1387     # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1388     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1389     # put in front of it. If left blank `man' will be used as the default path.
1390    
1391 6 MAN_OUTPUT = man
1392 francois 284
1393     # The MAN_EXTENSION tag determines the extension that is added to
1394     # the generated man pages (default is the subroutine's section .3)
1395    
1396 6 MAN_EXTENSION = .3
1397 francois 284
1398     # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1399     # then it will generate one additional man file for each entity
1400     # documented in the real man page(s). These additional files
1401     # only source the real man page, but without them the man command
1402     # would be unable to find the correct page. The default is NO.
1403    
1404 6 MAN_LINKS = NO
1405 francois 284
1406 6 #---------------------------------------------------------------------------
1407     # configuration options related to the XML output
1408     #---------------------------------------------------------------------------
1409 francois 284
1410     # If the GENERATE_XML tag is set to YES Doxygen will
1411     # generate an XML file that captures the structure of
1412     # the code including all documentation.
1413    
1414 6 GENERATE_XML = NO
1415 francois 284
1416     # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1417     # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1418     # put in front of it. If left blank `xml' will be used as the default path.
1419    
1420 6 XML_OUTPUT = xml
1421 francois 284
1422     # The XML_SCHEMA tag can be used to specify an XML schema,
1423     # which can be used by a validating XML parser to check the
1424     # syntax of the XML files.
1425    
1426 6 XML_SCHEMA =
1427 francois 284
1428     # The XML_DTD tag can be used to specify an XML DTD,
1429     # which can be used by a validating XML parser to check the
1430     # syntax of the XML files.
1431    
1432 6 XML_DTD =
1433 francois 284
1434     # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1435     # dump the program listings (including syntax highlighting
1436     # and cross-referencing information) to the XML output. Note that
1437     # enabling this will significantly increase the size of the XML output.
1438    
1439 6 XML_PROGRAMLISTING = YES
1440 francois 284
1441 6 #---------------------------------------------------------------------------
1442     # configuration options for the AutoGen Definitions output
1443     #---------------------------------------------------------------------------
1444 francois 284
1445     # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1446     # generate an AutoGen Definitions (see autogen.sf.net) file
1447     # that captures the structure of the code including all
1448     # documentation. Note that this feature is still experimental
1449     # and incomplete at the moment.
1450    
1451 6 GENERATE_AUTOGEN_DEF = NO
1452 francois 284
1453 6 #---------------------------------------------------------------------------
1454     # configuration options related to the Perl module output
1455     #---------------------------------------------------------------------------
1456 francois 284
1457     # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1458     # generate a Perl module file that captures the structure of
1459     # the code including all documentation. Note that this
1460     # feature is still experimental and incomplete at the
1461     # moment.
1462    
1463 6 GENERATE_PERLMOD = NO
1464 francois 284
1465     # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1466     # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1467     # to generate PDF and DVI output from the Perl module output.
1468    
1469 6 PERLMOD_LATEX = NO
1470 francois 284
1471     # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1472     # nicely formatted so it can be parsed by a human reader. This is useful
1473     # if you want to understand what is going on. On the other hand, if this
1474     # tag is set to NO the size of the Perl module output will be much smaller
1475     # and Perl will parse it just the same.
1476    
1477 6 PERLMOD_PRETTY = YES
1478 francois 284
1479     # The names of the make variables in the generated doxyrules.make file
1480     # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1481     # This is useful so different doxyrules.make files included by the same
1482     # Makefile don't overwrite each other's variables.
1483    
1484 6 PERLMOD_MAKEVAR_PREFIX =
1485 francois 284
1486 6 #---------------------------------------------------------------------------
1487 francois 284 # Configuration options related to the preprocessor
1488 6 #---------------------------------------------------------------------------
1489 francois 284
1490     # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1491     # evaluate all C-preprocessor directives found in the sources and include
1492     # files.
1493    
1494 6 ENABLE_PREPROCESSING = YES
1495 francois 284
1496     # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1497     # names in the source code. If set to NO (the default) only conditional
1498     # compilation will be performed. Macro expansion can be done in a controlled
1499     # way by setting EXPAND_ONLY_PREDEF to YES.
1500    
1501 6 MACRO_EXPANSION = NO
1502 francois 284
1503     # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1504     # then the macro expansion is limited to the macros specified with the
1505     # PREDEFINED and EXPAND_AS_DEFINED tags.
1506    
1507 6 EXPAND_ONLY_PREDEF = NO
1508 francois 284
1509     # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1510 francois 357 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1511 francois 284
1512 6 SEARCH_INCLUDES = YES
1513 francois 284
1514     # The INCLUDE_PATH tag can be used to specify one or more directories that
1515     # contain include files that are not input files but should be processed by
1516     # the preprocessor.
1517    
1518 6 INCLUDE_PATH =
1519 francois 284
1520     # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1521     # patterns (like *.h and *.hpp) to filter out the header-files in the
1522     # directories. If left blank, the patterns specified with FILE_PATTERNS will
1523     # be used.
1524    
1525 6 INCLUDE_FILE_PATTERNS =
1526 francois 284
1527     # The PREDEFINED tag can be used to specify one or more macro names that
1528     # are defined before the preprocessor is started (similar to the -D option of
1529     # gcc). The argument of the tag is a list of macros of the form: name
1530     # or name=definition (no spaces). If the definition and the = are
1531     # omitted =1 is assumed. To prevent a macro definition from being
1532     # undefined via #undef or recursively expanded use the := operator
1533     # instead of the = operator.
1534    
1535 6 PREDEFINED = BREP_SAT \
1536     BREP_STEP \
1537 francois 175 BREP_SLD \
1538     BREP_OCC
1539 francois 284
1540     # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1541     # this tag can be used to specify a list of macro names that should be expanded.
1542     # The macro definition that is found in the sources will be used.
1543 francois 357 # Use the PREDEFINED tag if you want to use a different macro definition that
1544     # overrules the definition found in the source code.
1545 francois 284
1546 6 EXPAND_AS_DEFINED =
1547 francois 284
1548     # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1549 francois 357 # doxygen's preprocessor will remove all references to function-like macros
1550     # that are alone on a line, have an all uppercase name, and do not end with a
1551     # semicolon, because these will confuse the parser if not removed.
1552 francois 284
1553 francois 652 SKIP_FUNCTION_MACROS = NO
1554 francois 284
1555 6 #---------------------------------------------------------------------------
1556 francois 284 # Configuration::additions related to external references
1557 6 #---------------------------------------------------------------------------
1558 francois 284
1559     # The TAGFILES option can be used to specify one or more tagfiles.
1560     # Optionally an initial location of the external documentation
1561     # can be added for each tagfile. The format of a tag file without
1562     # this location is as follows:
1563     # TAGFILES = file1 file2 ...
1564     # Adding location for the tag files is done as follows:
1565     # TAGFILES = file1=loc1 "file2 = loc2" ...
1566     # where "loc1" and "loc2" can be relative or absolute paths or
1567     # URLs. If a location is present for each tag, the installdox tool
1568     # does not have to be run to correct the links.
1569     # Note that each tag file must have a unique name
1570     # (where the name does NOT include the path)
1571     # If a tag file is not located in the directory in which doxygen
1572     # is run, you must also specify the path to the tagfile here.
1573    
1574 6 TAGFILES =
1575 francois 284
1576     # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1577     # a tag file that is based on the input files it reads.
1578    
1579 6 GENERATE_TAGFILE =
1580 francois 284
1581     # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1582     # in the class index. If set to NO only the inherited external classes
1583     # will be listed.
1584    
1585 6 ALLEXTERNALS = NO
1586 francois 284
1587     # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1588     # in the modules index. If set to NO, only the current project's groups will
1589     # be listed.
1590    
1591 6 EXTERNAL_GROUPS = YES
1592 francois 284
1593     # The PERL_PATH should be the absolute path and name of the perl script
1594     # interpreter (i.e. the result of `which perl').
1595    
1596 6 PERL_PATH = /usr/bin/perl
1597 francois 284
1598 6 #---------------------------------------------------------------------------
1599 francois 284 # Configuration options related to the dot tool
1600 6 #---------------------------------------------------------------------------
1601 francois 284
1602     # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1603     # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1604     # or super classes. Setting the tag to NO turns the diagrams off. Note that
1605 francois 357 # this option also works with HAVE_DOT disabled, but it is recommended to
1606     # install and use dot, since it yields more powerful graphs.
1607 francois 284
1608 francois 175 CLASS_DIAGRAMS = NO
1609 francois 284
1610     # You can define message sequence charts within doxygen comments using the \msc
1611     # command. Doxygen will then run the mscgen tool (see
1612     # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1613     # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1614     # the mscgen tool resides. If left empty the tool is assumed to be found in the
1615     # default search path.
1616    
1617     MSCGEN_PATH =
1618    
1619     # If set to YES, the inheritance and collaboration graphs will hide
1620     # inheritance and usage relations if the target is undocumented
1621     # or is not a class.
1622    
1623 6 HIDE_UNDOC_RELATIONS = YES
1624 francois 284
1625     # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1626     # available from the path. This tool is part of Graphviz, a graph visualization
1627     # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1628     # have no effect if this option is set to NO (the default)
1629    
1630 6 HAVE_DOT = YES
1631 francois 284
1632 francois 357 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1633     # allowed to run in parallel. When set to 0 (the default) doxygen will
1634     # base this on the number of processors available in the system. You can set it
1635     # explicitly to a value larger than 0 to get control over the balance
1636     # between CPU load and processing speed.
1637 francois 284
1638 francois 357 DOT_NUM_THREADS = 0
1639    
1640     # By default doxygen will use the Helvetica font for all dot files that
1641     # doxygen generates. When you want a differently looking font you can specify
1642     # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1643     # the font, which can be done by putting it in a standard location or by setting
1644     # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1645     # directory containing the font.
1646    
1647 francois 284 DOT_FONTNAME = FreeSans
1648    
1649     # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1650     # The default size is 10pt.
1651    
1652     DOT_FONTSIZE = 10
1653    
1654 francois 357 # By default doxygen will tell dot to use the Helvetica font.
1655     # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1656     # set the path where dot can find it.
1657 francois 284
1658     DOT_FONTPATH =
1659    
1660     # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1661     # will generate a graph for each documented class showing the direct and
1662     # indirect inheritance relations. Setting this tag to YES will force the
1663 francois 357 # CLASS_DIAGRAMS tag to NO.
1664 francois 284
1665 6 CLASS_GRAPH = YES
1666 francois 284
1667     # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1668     # will generate a graph for each documented class showing the direct and
1669     # indirect implementation dependencies (inheritance, containment, and
1670     # class references variables) of the class with other documented classes.
1671    
1672 6 COLLABORATION_GRAPH = YES
1673 francois 284
1674     # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1675     # will generate a graph for groups, showing the direct groups dependencies
1676    
1677 6 GROUP_GRAPHS = YES
1678 francois 284
1679     # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1680     # collaboration diagrams in a style similar to the OMG's Unified Modeling
1681     # Language.
1682    
1683 6 UML_LOOK = NO
1684 francois 284
1685     # If set to YES, the inheritance and collaboration graphs will show the
1686     # relations between templates and their instances.
1687    
1688 6 TEMPLATE_RELATIONS = NO
1689 francois 284
1690     # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1691     # tags are set to YES then doxygen will generate a graph for each documented
1692     # file showing the direct and indirect include dependencies of the file with
1693     # other documented files.
1694    
1695 6 INCLUDE_GRAPH = YES
1696 francois 284
1697     # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1698     # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1699     # documented header file showing the documented files that directly or
1700     # indirectly include this file.
1701    
1702 6 INCLUDED_BY_GRAPH = YES
1703 francois 284
1704     # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1705     # doxygen will generate a call dependency graph for every global function
1706     # or class method. Note that enabling this option will significantly increase
1707     # the time of a run. So in most cases it will be better to enable call graphs
1708     # for selected functions only using the \callgraph command.
1709    
1710 6 CALL_GRAPH = YES
1711 francois 284
1712     # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1713     # doxygen will generate a caller dependency graph for every global function
1714     # or class method. Note that enabling this option will significantly increase
1715     # the time of a run. So in most cases it will be better to enable caller
1716     # graphs for selected functions only using the \callergraph command.
1717    
1718     CALLER_GRAPH = YES
1719    
1720     # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1721 francois 357 # will generate a graphical hierarchy of all classes instead of a textual one.
1722 francois 284
1723 6 GRAPHICAL_HIERARCHY = YES
1724 francois 284
1725     # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1726     # then doxygen will show the dependencies a directory has on other directories
1727     # in a graphical way. The dependency relations are determined by the #include
1728     # relations between the files in the directories.
1729    
1730 6 DIRECTORY_GRAPH = YES
1731 francois 284
1732     # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1733 francois 357 # generated by dot. Possible values are svg, png, jpg, or gif.
1734     # If left blank png will be used. If you choose svg you need to set
1735     # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1736     # visible in IE 9+ (other browsers do not have this requirement).
1737 francois 284
1738 6 DOT_IMAGE_FORMAT = png
1739 francois 284
1740 francois 357 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1741     # enable generation of interactive SVG images that allow zooming and panning.
1742     # Note that this requires a modern browser other than Internet Explorer.
1743     # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1744     # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1745     # visible. Older versions of IE do not have SVG support.
1746    
1747     INTERACTIVE_SVG = NO
1748    
1749 francois 284 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1750     # found. If left blank, it is assumed the dot tool can be found in the path.
1751    
1752 6 DOT_PATH =
1753 francois 284
1754     # The DOTFILE_DIRS tag can be used to specify one or more directories that
1755     # contain dot files that are included in the documentation (see the
1756     # \dotfile command).
1757    
1758 6 DOTFILE_DIRS =
1759 francois 284
1760 francois 357 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1761     # contain msc files that are included in the documentation (see the
1762     # \mscfile command).
1763    
1764     MSCFILE_DIRS =
1765    
1766 francois 284 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1767     # nodes that will be shown in the graph. If the number of nodes in a graph
1768     # becomes larger than this value, doxygen will truncate the graph, which is
1769     # visualized by representing a node as a red box. Note that doxygen if the
1770     # number of direct children of the root node in a graph is already larger than
1771     # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1772     # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1773    
1774     DOT_GRAPH_MAX_NODES = 50
1775    
1776     # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1777     # graphs generated by dot. A depth value of 3 means that only nodes reachable
1778     # from the root by following a path via at most 3 edges will be shown. Nodes
1779     # that lay further from the root node will be omitted. Note that setting this
1780     # option to 1 or 2 may greatly reduce the computation time needed for large
1781     # code bases. Also note that the size of a graph can be further restricted by
1782     # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1783    
1784 6 MAX_DOT_GRAPH_DEPTH = 1000
1785 francois 284
1786     # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1787     # background. This is disabled by default, because dot on Windows does not
1788     # seem to support this out of the box. Warning: Depending on the platform used,
1789     # enabling this option may lead to badly anti-aliased labels on the edges of
1790     # a graph (i.e. they become hard to read).
1791    
1792 6 DOT_TRANSPARENT = NO
1793 francois 284
1794     # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1795     # files in one run (i.e. multiple -o and -T options on the command line). This
1796     # makes dot run faster, but since only newer versions of dot (>1.8.10)
1797     # support this, this feature is disabled by default.
1798    
1799 6 DOT_MULTI_TARGETS = NO
1800 francois 284
1801     # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1802     # generate a legend page explaining the meaning of the various boxes and
1803     # arrows in the dot generated graphs.
1804    
1805 6 GENERATE_LEGEND = YES
1806 francois 284
1807     # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1808     # remove the intermediate dot files that are used to generate
1809     # the various graphs.
1810    
1811 6 DOT_CLEANUP = YES