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