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