ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/REPOS_ERICCA/magic/documentation/docmagic
Revision: 284
Committed: Thu Sep 15 20:50:01 2011 UTC (13 years, 8 months ago) by francois
File size: 67545 byte(s)
Log Message:
Mise a jour documentation

File Contents

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