OSDN Git Service

2006-11-29 Benjamin Kosnik <bkoz@redhat.com>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / docs / doxygen / user.cfg.in
1 # Doxyfile 1.5.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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
18 # by quotes) that should identify the project.
19
20 PROJECT_NAME           = libstdc++
21
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
23 # This could be handy for archiving the generated documentation or 
24 # if some version control system is used.
25
26 PROJECT_NUMBER         = 
27
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
29 # base path where the generated documentation will be put. 
30 # If a relative path is entered, it will be relative to the location 
31 # where doxygen was started. If left blank the current directory will be used.
32
33 OUTPUT_DIRECTORY       = @outdir@
34
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
36 # 4096 sub-directories (in 2 levels) under the output directory of each output 
37 # format and will distribute the generated files over these directories. 
38 # Enabling this option can be useful when feeding doxygen a huge amount of 
39 # source files, where putting all generated files in the same directory would 
40 # otherwise cause performance problems for the file system.
41
42 CREATE_SUBDIRS         = NO
43
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
45 # documentation generated by doxygen is written. Doxygen will use this 
46 # information to generate all constant output in the proper language. 
47 # The default language is English, other supported languages are: 
48 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
49 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
50 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
51 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
52 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
53
54 OUTPUT_LANGUAGE        = English
55
56 # This tag can be used to specify the encoding used in the generated
57 # output.  The encoding is not always determined by the language that
58 # is chosen, but also whether or not the output is meant for Windows
59 # or non-Windows users.  In case there is a difference, setting the
60 # USE_WINDOWS_ENCODING tag to YES forces the Windows encoding (this is
61 # the default for the Windows binary), whereas setting the tag to NO
62 # uses a Unix-style encoding (the default for all platforms other than
63 # Windows).
64
65 USE_WINDOWS_ENCODING   = NO
66
67 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
68 # include brief member descriptions after the members that are listed in 
69 # the file and class documentation (similar to JavaDoc). 
70 # Set to NO to disable this.
71
72 BRIEF_MEMBER_DESC      = NO
73
74 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will
75 # prepend the brief description of a member or function before the
76 # detailed description.  Note: if both HIDE_UNDOC_MEMBERS and
77 # BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be
78 # completely suppressed.
79
80 REPEAT_BRIEF           = NO
81
82 # This tag implements a quasi-intelligent brief description abbreviator 
83 # that is used to form the text in various listings. Each string 
84 # in this list, if found as the leading text of the brief description, will be 
85 # stripped from the text and the result after processing the whole list, is 
86 # used as the annotated text. Otherwise, the brief description is used as-is. 
87 # If left blank, the following values are used ("$name" is automatically 
88 # replaced with the name of the entity): "The $name class" "The $name widget" 
89 # "The $name file" "is" "provides" "specifies" "contains" 
90 # "represents" "a" "an" "the"
91
92 ABBREVIATE_BRIEF       = 
93
94 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
95 # Doxygen will generate a detailed section even if there is only a brief 
96 # description.
97
98 ALWAYS_DETAILED_SEC    = YES
99
100 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show
101 # all inherited members of a class in the documentation of that class
102 # as if those members were ordinary class members. Constructors,
103 # destructors and assignment operators of the base classes will not be
104 # shown.
105
106 INLINE_INHERITED_MEMB  = YES
107
108 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
109 # path before files name in the file list and in the header files. If set 
110 # to NO the shortest path that makes the file name unique will be used.
111
112 FULL_PATH_NAMES        = NO
113
114 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
115 # can be used to strip a user-defined part of the path. Stripping is 
116 # only done if one of the specified strings matches the left-hand part of 
117 # the path. The tag can be used to show relative paths in the file list. 
118 # If left blank the directory from which doxygen is run is used as the 
119 # path to strip.
120
121 STRIP_FROM_PATH        = 
122
123 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
124 # the path mentioned in the documentation of a class, which tells 
125 # the reader which header file to include in order to use a class. 
126 # If left blank only the name of the header file containing the class 
127 # definition is used. Otherwise one should specify the include paths that 
128 # are normally passed to the compiler using the -I flag.
129
130 STRIP_FROM_INC_PATH    = 
131
132 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
133 # (but less readable) file names. This can be useful is your file systems 
134 # doesn't support long names like on DOS, Mac, or CD-ROM.
135
136 SHORT_NAMES            = NO
137
138 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
139 # will interpret the first line (until the first dot) of a JavaDoc-style 
140 # comment as the brief description. If set to NO, the JavaDoc 
141 # comments will behave just like the Qt-style comments (thus requiring an 
142 # explicit @brief command for a brief description.
143
144 JAVADOC_AUTOBRIEF      = NO
145
146 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
147 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
148 # comments) as a brief description. This used to be the default behaviour. 
149 # The new default is to treat a multi-line C++ comment block as a detailed 
150 # description. Set this tag to YES if you prefer the old behaviour instead.
151
152 MULTILINE_CPP_IS_BRIEF = YES
153
154 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 
155 # will output the detailed description near the top, like JavaDoc.
156 # If set to NO, the detailed description appears after the member 
157 # documentation.
158
159 DETAILS_AT_TOP         = YES
160
161 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
162 # member inherits the documentation from any documented member that it 
163 # re-implements.
164
165 INHERIT_DOCS           = YES
166
167 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
168 # a new page for each member. If set to NO, the documentation of a member will 
169 # be part of the file/class/namespace that contains it.
170
171 SEPARATE_MEMBER_PAGES  = NO
172
173 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
174 # Doxygen uses this value to replace tabs by spaces in code fragments.
175
176 TAB_SIZE               = 4
177
178 # This tag can be used to specify a number of aliases that acts 
179 # as commands in the documentation. An alias has the form "name=value". 
180 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
181 # put the command \sideeffect (or @sideeffect) in the documentation, which 
182 # will result in a user-defined paragraph with heading "Side Effects:". 
183 # You can put \n's in the value part of an alias to insert newlines.
184
185 ALIASES                = "doctodo=@todo\nDoc me!  See docs/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more." \
186                          "isiosfwd=One of the @link s27_2_iosfwd I/O forward declarations @endlink"
187
188 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
189 # sources only. Doxygen will then generate output that is more tailored for C. 
190 # For instance, some of the names that are used will be different. The list 
191 # of all members will be omitted, etc.
192
193 OPTIMIZE_OUTPUT_FOR_C  = NO
194
195 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of
196 # Java sources only. Doxygen will then generate output that is more
197 # tailored for Java.  For instance, namespaces will be presented as
198 # packages, qualified scopes will look different, etc.
199
200 OPTIMIZE_OUTPUT_JAVA   = NO
201
202 # If you use STL classes (i.e. std::string, std::vector, etc.) but do
203 # not want to include (a tag file for) the STL sources as input, then
204 # you should set this tag to YES in order to let doxygen match
205 # functions declarations and definitions whose arguments contain STL
206 # classes (e.g. func(std::string); v.s.  func(std::string) {}). This
207 # also make the inheritance and collaboration diagrams that involve
208 # STL classes more complete and accurate.
209
210 BUILTIN_STL_SUPPORT    = NO
211
212 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
213 # tag is set to YES, then doxygen will reuse the documentation of the first 
214 # member in the group (if any) for the other members of the group. By default 
215 # all members of a group must be documented explicitly.
216
217 DISTRIBUTE_GROUP_DOC   = YES
218
219 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
220 # the same type (for instance a group of public functions) to be put as a 
221 # subgroup of that type (e.g. under the Public Functions section). Set it to 
222 # NO to prevent subgrouping. Alternatively, this can be done per class using 
223 # the \nosubgrouping command.
224
225 SUBGROUPING            = YES
226
227 #---------------------------------------------------------------------------
228 # Build related configuration options
229 #---------------------------------------------------------------------------
230
231 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
232 # documentation are documented, even if no documentation was available. 
233 # Private class members and static file members will be hidden unless 
234 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
235
236 EXTRACT_ALL            = NO
237
238 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
239 # will be included in the documentation.
240
241 EXTRACT_PRIVATE        = NO
242
243 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
244 # will be included in the documentation.
245
246 EXTRACT_STATIC         = YES
247
248 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
249 # defined locally in source files will be included in the documentation. 
250 # If set to NO only classes defined in header files are included.
251
252 EXTRACT_LOCAL_CLASSES  = YES
253
254 # This flag is only useful for Objective-C code. When set to YES local 
255 # methods, which are defined in the implementation section but not in 
256 # the interface are included in the documentation. 
257 # If set to NO (the default) only methods in the interface are included.
258
259 EXTRACT_LOCAL_METHODS  = YES
260
261 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
262 # undocumented members of documented classes, files or namespaces. 
263 # If set to NO (the default) these members will be included in the 
264 # various overviews, but no documentation section is generated. 
265 # This option has no effect if EXTRACT_ALL is enabled.
266
267 HIDE_UNDOC_MEMBERS     = NO
268
269 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
270 # undocumented classes that are normally visible in the class hierarchy. 
271 # If set to NO (the default) these classes will be included in the various 
272 # overviews. This option has no effect if EXTRACT_ALL is enabled.
273
274 HIDE_UNDOC_CLASSES     = YES
275
276 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
277 # friend (class|struct|union) declarations. 
278 # If set to NO (the default) these declarations will be included in the 
279 # documentation.
280
281 HIDE_FRIEND_COMPOUNDS  = NO
282
283 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
284 # documentation blocks found inside the body of a function. 
285 # If set to NO (the default) these blocks will be appended to the 
286 # function's detailed documentation block.
287
288 HIDE_IN_BODY_DOCS      = NO
289
290 # The INTERNAL_DOCS tag determines if documentation 
291 # that is typed after a \internal command is included. If the tag is set 
292 # to NO (the default) then the documentation will be excluded. 
293 # Set it to YES to include the internal documentation.
294
295 INTERNAL_DOCS          = NO
296
297 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
298 # file names in lower-case letters. If set to YES upper-case letters are also 
299 # allowed. This is useful if you have classes or files whose names only differ 
300 # in case and if your file system supports case sensitive file names. Windows 
301 # and Mac users are advised to set this option to NO.
302
303 CASE_SENSE_NAMES       = NO#
304
305 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
306 # will show members with their full class and namespace scopes in the 
307 # documentation. If set to YES the scope will be hidden.
308
309 HIDE_SCOPE_NAMES       = NO
310 #HIDE_SCOPE_NAMES       = YES
311
312 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then
313 # Doxygen will put a list of the files that are included by a file in
314 # the documentation of that file.
315
316 SHOW_INCLUDE_FILES     = NO
317
318 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
319 # is inserted in the documentation for inline members.
320
321 INLINE_INFO            = YES
322
323 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
324 # will sort the (detailed) documentation of file and class members 
325 # alphabetically by member name. If set to NO the members will appear in 
326 # declaration order.
327
328 SORT_MEMBER_DOCS       = YES
329
330 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
331 # brief documentation of file, namespace and class members alphabetically 
332 # by member name. If set to NO (the default) the members will appear in 
333 # declaration order.
334
335 SORT_BRIEF_DOCS        = YES
336
337 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
338 # sorted by fully-qualified names, including namespaces. If set to 
339 # NO (the default), the class list will be sorted only by class name, 
340 # not including the namespace part. 
341 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
342 # Note: This option applies only to the class list, not to the 
343 # alphabetical list.
344
345 #SORT_BY_SCOPE_NAME     = NO
346 SORT_BY_SCOPE_NAME     = YES
347
348 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
349 # disable (NO) the todo list. This list is created by putting \todo 
350 # commands in the documentation.
351
352 GENERATE_TODOLIST      = YES
353
354 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
355 # disable (NO) the test list. This list is created by putting \test 
356 # commands in the documentation.
357
358 GENERATE_TESTLIST      = NO
359
360 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
361 # disable (NO) the bug list. This list is created by putting \bug 
362 # commands in the documentation.
363
364 GENERATE_BUGLIST       = YES
365
366 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
367 # disable (NO) the deprecated list. This list is created by putting 
368 # \deprecated commands in the documentation.
369
370 GENERATE_DEPRECATEDLIST= YES
371
372 # The ENABLED_SECTIONS tag can be used to enable conditional 
373 # documentation sections, marked by \if sectionname ... \endif.
374
375 ENABLED_SECTIONS       = @enabled_sections@
376
377 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
378 # the initial value of a variable or define consists of for it to appear in 
379 # the documentation. If the initializer consists of more lines than specified 
380 # here it will be hidden. Use a value of 0 to hide initializers completely. 
381 # The appearance of the initializer of individual variables and defines in the 
382 # documentation can be controlled using \showinitializer or \hideinitializer 
383 # command in the documentation regardless of this setting.
384
385 MAX_INITIALIZER_LINES  = 0
386
387 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
388 # at the bottom of the documentation of classes and structs. If set to YES the 
389 # list will mention the files that were used to generate the documentation.
390
391 SHOW_USED_FILES        = YES
392
393 # If the sources in your project are distributed over multiple
394 # directories then setting the SHOW_DIRECTORIES tag to YES will show
395 # the directory hierarchy in the documentation. The default is NO.
396
397 SHOW_DIRECTORIES       = YES
398
399 # The FILE_VERSION_FILTER tag can be used to specify a program or
400 # script that doxygen should invoke to get the current version for
401 # each file (typically from the version control system). Doxygen will
402 # invoke the program by executing (via popen()) the command <command>
403 # <input-file>, where <command> is the value of the
404 # FILE_VERSION_FILTER tag, and <input-file> is the name of an input
405 # file provided by doxygen. Whatever the program writes to standard
406 # output is used as the file version. See the manual for examples.
407
408 FILE_VERSION_FILTER    = 
409
410 #---------------------------------------------------------------------------
411 # configuration options related to warning and progress messages
412 #---------------------------------------------------------------------------
413
414 # The QUIET tag can be used to turn on/off the messages that are generated 
415 # by doxygen. Possible values are YES and NO. If left blank NO is used.
416
417 QUIET                  = NO
418
419 # The WARNINGS tag can be used to turn on/off the warning messages that are 
420 # generated by doxygen. Possible values are YES and NO. If left blank 
421 # NO is used.
422
423 WARNINGS               = YES
424
425 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
426 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
427 # automatically be disabled.
428
429 WARN_IF_UNDOCUMENTED   = NO
430
431 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
432 # potential errors in the documentation, such as not documenting some 
433 # parameters in a documented function, or documenting parameters that 
434 # don't exist or using markup commands wrongly.
435
436 WARN_IF_DOC_ERROR      = NO
437
438 # This WARN_NO_PARAMDOC option can be abled to get warnings for
439 # functions that are documented, but have no documentation for their
440 # parameters or return value. If set to NO (the default) doxygen will
441 # only warn about wrong or incomplete parameter documentation, but not
442 # about the absence of documentation.
443
444 WARN_NO_PARAMDOC       = NO
445
446 # The WARN_FORMAT tag determines the format of the warning messages that 
447 # doxygen can produce. The string should contain the $file, $line, and $text 
448 # tags, which will be replaced by the file and line number from which the 
449 # warning originated and the warning text. Optionally the format may contain 
450 # $version, which will be replaced by the version of the file (if it could 
451 # be obtained via FILE_VERSION_FILTER)
452
453 WARN_FORMAT            = "$file:$line: $text"
454
455 # The WARN_LOGFILE tag can be used to specify a file to which warning 
456 # and error messages should be written. If left blank the output is written 
457 # to stderr.
458
459 WARN_LOGFILE           = 
460
461 #---------------------------------------------------------------------------
462 # configuration options related to the input files
463 #---------------------------------------------------------------------------
464
465 # The INPUT tag can be used to specify the files and/or directories
466 # that contain documented source files. You may enter file names like
467 # "myfile.cpp" or directories like "/usr/src/myproject". Separate the
468 # files or directories with spaces.
469
470 INPUT                  = @srcdir@/docs/doxygen/doxygroups.cc \
471                          @srcdir@/libsupc++ \
472                          @srcdir@/libsupc++/exception \
473                          @srcdir@/libsupc++/new \
474                          @srcdir@/libsupc++/typeinfo \
475                          include/@host_alias@/bits \
476                          include/bits \
477                          include/debug \
478                          include/ext \
479                          include/tr1 \
480                          include/algorithm \
481                          include/bitset \
482                          include/deque \
483                          include/fstream \
484                          include/functional \
485                          include/iomanip \
486                          include/ios \
487                          include/iosfwd \
488                          include/iostream \
489                          include/istream \
490                          include/iterator \
491                          include/limits \
492                          include/list \
493                          include/locale \
494                          include/map \
495                          include/memory \
496                          include/numeric \
497                          include/ostream \
498                          include/queue \
499                          include/set \
500                          include/sstream \
501                          include/stack \
502                          include/stdexcept \
503                          include/streambuf \
504                          include/string \
505                          include/utility \
506                          include/valarray \
507                          include/vector \
508                          include/debug/bitset \
509                          include/debug/deque \
510                          include/debug/hash_map \
511                          include/debug/hash_set \
512                          include/debug/list \
513                          include/debug/map \
514                          include/debug/set \
515                          include/debug/string \
516                          include/debug/vector \
517                          include/ext/algorithm \
518                          include/ext/functional \
519                          include/ext/hash_map \
520                          include/ext/hash_set \
521                          include/ext/iterator \
522                          include/ext/memory \
523                          include/ext/numeric \
524                          include/ext/rb_tree \
525                          include/ext/rope \
526                          include/ext/slist \
527                          include/ext/pb_ds \
528                          include/ext/pb_ds/detail \
529                          include/tr1/array \
530                          include/tr1/cctype \
531                          include/tr1/cfenv \
532                          include/tr1/cfloat \
533                          include/tr1/cinttypes \
534                          include/tr1/climits \
535                          include/tr1/cmath \
536                          include/tr1/complex \
537                          include/tr1/cstdarg \
538                          include/tr1/cstdbool \
539                          include/tr1/cstdint \
540                          include/tr1/cstdio \
541                          include/tr1/cstdlib \
542                          include/tr1/ctgmath \
543                          include/tr1/ctime \
544                          include/tr1/cwchar \
545                          include/tr1/cwctype \
546                          include/tr1/functional \
547                          include/tr1/hashtable \
548                          include/tr1/memory \
549                          include/tr1/random \
550                          include/tr1/tuple \
551                          include/tr1/type_traits \
552                          include/tr1/unordered_map \
553                          include/tr1/unordered_set \
554                          include/tr1/utility
555
556 # If the value of the INPUT tag contains directories, you can use the
557 # FILE_PATTERNS tag to specify one or more wildcard pattern (like
558 # *.cpp and *.h) to filter out the source-files in the directories. If
559 # left blank the following patterns are tested: *.c *.cc *.cxx *.cpp
560 # *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++
561 # *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
562
563 FILE_PATTERNS          = *.h \
564                          *.hpp \
565                          *.tcc
566
567 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
568 # should be searched for input files as well. Possible values are YES and NO. 
569 # If left blank NO is used.
570
571 RECURSIVE              = NO
572
573 # The EXCLUDE tag can be used to specify files and/or directories that
574 # should excluded from the INPUT source files. This way you can easily
575 # exclude a subdirectory from a directory tree whose root is specified
576 # with the INPUT tag.
577
578 EXCLUDE                = Makefile
579
580 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
581 # directories that are symbolic links (a Unix filesystem feature) are excluded 
582 # from the input.
583
584 EXCLUDE_SYMLINKS       = NO
585
586 # If the value of the INPUT tag contains directories, you can use the 
587 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
588 # certain files from those directories. Note that the wildcards are matched 
589 # against the file with absolute path, so to exclude all test directories 
590 # for example use the pattern */test/*
591
592 EXCLUDE_PATTERNS       = stamp-* \
593                          Makefile \
594                          *gch* \
595                          */.svn/*
596
597 # The EXAMPLE_PATH tag can be used to specify one or more files or 
598 # directories that contain example code fragments that are included (see 
599 # the \include command).
600
601 EXAMPLE_PATH           = 
602
603 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
604 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
605 # and *.h) to filter out the source-files in the directories. If left 
606 # blank all files are included.
607
608 EXAMPLE_PATTERNS       = 
609
610 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
611 # searched for input files to be used with the \include or \dontinclude 
612 # commands irrespective of the value of the RECURSIVE tag. 
613 # Possible values are YES and NO. If left blank NO is used.
614
615 EXAMPLE_RECURSIVE      = NO
616
617 # The IMAGE_PATH tag can be used to specify one or more files or 
618 # directories that contain image that are included in the documentation (see 
619 # the \image command).
620
621 IMAGE_PATH             = 
622
623 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
624 # invoke to filter for each input file. Doxygen will invoke the filter program 
625 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
626 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
627 # input file. Doxygen will then use the output that the filter program writes 
628 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
629 # ignored.
630
631 INPUT_FILTER           = 
632
633 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
634 # basis.  Doxygen will compare the file name with each pattern and apply the 
635 # filter if there is a match.  The filters are a list of the form: 
636 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
637 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
638 # is applied to all files.
639
640 FILTER_PATTERNS        = 
641
642 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
643 # INPUT_FILTER) will be used to filter the input files when producing source 
644 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
645
646 FILTER_SOURCE_FILES    = NO
647
648 #---------------------------------------------------------------------------
649 # configuration options related to source browsing
650 #---------------------------------------------------------------------------
651
652 # If the SOURCE_BROWSER tag is set to YES then a list of source files
653 # will be generated. Documented entities will be cross-referenced with
654 # these sources.  Note: To get rid of all source code in the generated
655 # output, make sure also VERBATIM_HEADERS is set to NO.
656
657 SOURCE_BROWSER         = YES
658
659 # Setting the INLINE_SOURCES tag to YES will include the body 
660 # of functions and classes directly in the documentation.
661
662 INLINE_SOURCES         = NO
663
664 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
665 # doxygen to hide any special comment blocks from generated source code 
666 # fragments. Normal C and C++ comments will always remain visible.
667
668 STRIP_CODE_COMMENTS    = NO
669
670 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
671 # then for each documented function all documented 
672 # functions referencing it will be listed.
673
674 REFERENCED_BY_RELATION = YES
675
676 # If the REFERENCES_RELATION tag is set to YES (the default) 
677 # then for each documented function all documented entities 
678 # called/used by that function will be listed.
679
680 REFERENCES_RELATION    = YES
681
682 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
683 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
684 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
685 # link to the source code.  Otherwise they will link to the documentstion.
686
687 REFERENCES_LINK_SOURCE = YES
688
689 # If the USE_HTAGS tag is set to YES then the references to source code 
690 # will point to the HTML generated by the htags(1) tool instead of doxygen 
691 # built-in source browser. The htags tool is part of GNU's global source 
692 # tagging system (see http://www.gnu.org/software/global/global.html). You 
693 # will need version 4.8.6 or higher.
694
695 USE_HTAGS              = NO
696
697 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
698 # will generate a verbatim copy of the header file for each class for 
699 # which an include is specified. Set to NO to disable this.
700
701 VERBATIM_HEADERS       = NO
702
703 #---------------------------------------------------------------------------
704 # configuration options related to the alphabetical class index
705 #---------------------------------------------------------------------------
706
707 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
708 # of all compounds will be generated. Enable this if the project 
709 # contains a lot of classes, structs, unions or interfaces.
710
711 ALPHABETICAL_INDEX     = YES
712
713 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
714 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
715 # in which this list will be split (can be a number in the range [1..20])
716
717 COLS_IN_ALPHA_INDEX    = 2
718
719 # In case all classes in a project start with a common prefix, all 
720 # classes will be put under the same header in the alphabetical index. 
721 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
722 # should be ignored while generating the index headers.
723
724 #IGNORE_PREFIX          = std \
725 #                         std::tr1 \
726 #                         __gnu_cxx \
727 #                         __gnu_debug
728 IGNORE_PREFIX          = 
729
730 #---------------------------------------------------------------------------
731 # configuration options related to the HTML output
732 #---------------------------------------------------------------------------
733
734 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
735 # generate HTML output.
736
737 GENERATE_HTML          = @do_html@
738
739 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
740 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
741 # put in front of it. If left blank `html' will be used as the default path.
742
743 HTML_OUTPUT            = @html_output_dir@
744
745 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
746 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
747 # doxygen will generate files with .html extension.
748
749 HTML_FILE_EXTENSION    = .html
750
751 # The HTML_HEADER tag can be used to specify a personal HTML header for 
752 # each generated HTML page. If it is left blank doxygen will generate a 
753 # standard header.
754
755 HTML_HEADER            = 
756
757 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
758 # each generated HTML page. If it is left blank doxygen will generate a 
759 # standard footer.
760
761 HTML_FOOTER            = 
762
763 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
764 # style sheet that is used by each HTML page. It can be used to 
765 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
766 # will generate a default style sheet. Note that doxygen will try to copy 
767 # the style sheet file to the HTML output directory, so don't put your own 
768 # stylesheet in the HTML output directory as well, or it will be erased!
769
770 HTML_STYLESHEET        = @srcdir@/docs/doxygen/style.css
771
772 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
773 # files or namespaces will be aligned in HTML using tables. If set to 
774 # NO a bullet list will be used.
775
776 HTML_ALIGN_MEMBERS     = NO
777
778 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
779 # will be generated that can be used as input for tools like the 
780 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
781 # of the generated HTML documentation.
782
783 GENERATE_HTMLHELP      = NO
784
785 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
786 # be used to specify the file name of the resulting .chm file. You 
787 # can add a path in front of the file if the result should not be 
788 # written to the html output directory.
789
790 CHM_FILE               = 
791
792 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
793 # be used to specify the location (absolute path including file name) of 
794 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
795 # the HTML help compiler on the generated index.hhp.
796
797 HHC_LOCATION           = 
798
799 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
800 # controls if a separate .chi index file is generated (YES) or that 
801 # it should be included in the master .chm file (NO).
802
803 GENERATE_CHI           = NO
804
805 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
806 # controls whether a binary table of contents is generated (YES) or a 
807 # normal table of contents (NO) in the .chm file.
808
809 BINARY_TOC             = NO
810
811 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
812 # to the contents of the HTML help documentation and to the tree view.
813
814 TOC_EXPAND             = NO
815
816 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
817 # top of each HTML page. The value NO (the default) enables the index and 
818 # the value YES disables it.
819
820 DISABLE_INDEX          = YES
821
822 # This tag can be used to set the number of enum values (range [1..20]) 
823 # that doxygen will group on one line in the generated HTML documentation.
824
825 ENUM_VALUES_PER_LINE   = 4
826
827 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
828 # generated containing a tree-like index structure (just like the one that 
829 # is generated for HTML Help). For this to work a browser that supports 
830 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
831 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
832 # probably better off using the HTML help feature.
833
834 GENERATE_TREEVIEW      = YES
835
836 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
837 # used to set the initial width (in pixels) of the frame in which the tree 
838 # is shown.
839
840 TREEVIEW_WIDTH         = 250
841
842 #---------------------------------------------------------------------------
843 # configuration options related to the LaTeX output
844 #---------------------------------------------------------------------------
845
846 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
847 # generate Latex output.
848
849 GENERATE_LATEX         = NO
850
851 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
852 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
853 # put in front of it. If left blank `latex' will be used as the default path.
854
855 LATEX_OUTPUT           = latex
856
857 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
858 # invoked. If left blank `latex' will be used as the default command name.
859
860 LATEX_CMD_NAME         = latex
861
862 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
863 # generate index for LaTeX. If left blank `makeindex' will be used as the 
864 # default command name.
865
866 MAKEINDEX_CMD_NAME     = makeindex
867
868 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
869 # LaTeX documents. This may be useful for small projects and may help to 
870 # save some trees in general.
871
872 COMPACT_LATEX          = NO
873
874 # The PAPER_TYPE tag can be used to set the paper type that is used 
875 # by the printer. Possible values are: a4, a4wide, letter, legal and 
876 # executive. If left blank a4wide will be used.
877
878 PAPER_TYPE             = letter
879
880 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
881 # packages that should be included in the LaTeX output.
882
883 EXTRA_PACKAGES         = 
884
885 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
886 # the generated latex document. The header should contain everything until 
887 # the first chapter. If it is left blank doxygen will generate a 
888 # standard header. Notice: only use this tag if you know what you are doing!
889
890 LATEX_HEADER           = 
891
892 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
893 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
894 # contain links (just like the HTML output) instead of page references 
895 # This makes the output suitable for online browsing using a pdf viewer.
896
897 PDF_HYPERLINKS         = NO
898
899 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
900 # plain latex in the generated Makefile. Set this option to YES to get a 
901 # higher quality PDF documentation.
902
903 USE_PDFLATEX           = NO
904
905 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
906 # command to the generated LaTeX files. This will instruct LaTeX to keep 
907 # running if errors occur, instead of asking the user for help. 
908 # This option is also used when generating formulas in HTML.
909
910 LATEX_BATCHMODE        = NO
911
912 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
913 # include the index chapters (such as File Index, Compound Index, etc.) 
914 # in the output.
915
916 LATEX_HIDE_INDICES     = NO
917
918 #---------------------------------------------------------------------------
919 # configuration options related to the RTF output
920 #---------------------------------------------------------------------------
921
922 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
923 # The RTF output is optimized for Word 97 and may not look very pretty with 
924 # other RTF readers or editors.
925
926 GENERATE_RTF           = NO
927
928 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
929 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
930 # put in front of it. If left blank `rtf' will be used as the default path.
931
932 RTF_OUTPUT             = rtf
933
934 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
935 # RTF documents. This may be useful for small projects and may help to 
936 # save some trees in general.
937
938 COMPACT_RTF            = NO
939
940 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
941 # will contain hyperlink fields. The RTF file will 
942 # contain links (just like the HTML output) instead of page references. 
943 # This makes the output suitable for online browsing using WORD or other 
944 # programs which support those fields. 
945 # Note: wordpad (write) and others do not support links.
946
947 RTF_HYPERLINKS         = NO
948
949 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
950 # config file, i.e. a series of assignments. You only have to provide 
951 # replacements, missing definitions are set to their default value.
952
953 RTF_STYLESHEET_FILE    = 
954
955 # Set optional variables used in the generation of an rtf document. 
956 # Syntax is similar to doxygen's config file.
957
958 RTF_EXTENSIONS_FILE    = 
959
960 #---------------------------------------------------------------------------
961 # configuration options related to the man page output
962 #---------------------------------------------------------------------------
963
964 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
965 # generate man pages
966
967 GENERATE_MAN           = @do_man@
968
969 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
970 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
971 # put in front of it. If left blank `man' will be used as the default path.
972
973 MAN_OUTPUT             = man
974
975 # The MAN_EXTENSION tag determines the extension that is added to 
976 # the generated man pages (default is the subroutine's section .3)
977
978 MAN_EXTENSION          = .3
979
980 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
981 # then it will generate one additional man file for each entity 
982 # documented in the real man page(s). These additional files 
983 # only source the real man page, but without them the man command 
984 # would be unable to find the correct page. The default is NO.
985
986 MAN_LINKS              = NO
987
988 #---------------------------------------------------------------------------
989 # configuration options related to the XML output
990 #---------------------------------------------------------------------------
991
992 # If the GENERATE_XML tag is set to YES Doxygen will 
993 # generate an XML file that captures the structure of 
994 # the code including all documentation.
995
996 GENERATE_XML           = YES
997
998 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
999 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1000 # put in front of it. If left blank `xml' will be used as the default path.
1001
1002 XML_OUTPUT             = xml
1003
1004 # The XML_SCHEMA tag can be used to specify an XML schema, 
1005 # which can be used by a validating XML parser to check the 
1006 # syntax of the XML files.
1007
1008 XML_SCHEMA             = 
1009
1010 # The XML_DTD tag can be used to specify an XML DTD, 
1011 # which can be used by a validating XML parser to check the 
1012 # syntax of the XML files.
1013
1014 XML_DTD                = 
1015
1016 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
1017 # dump the program listings (including syntax highlighting 
1018 # and cross-referencing information) to the XML output. Note that 
1019 # enabling this will significantly increase the size of the XML output.
1020
1021 XML_PROGRAMLISTING     = YES
1022
1023 #---------------------------------------------------------------------------
1024 # configuration options for the AutoGen Definitions output
1025 #---------------------------------------------------------------------------
1026
1027 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
1028 # generate an AutoGen Definitions (see autogen.sf.net) file 
1029 # that captures the structure of the code including all 
1030 # documentation. Note that this feature is still experimental 
1031 # and incomplete at the moment.
1032
1033 GENERATE_AUTOGEN_DEF   = NO
1034
1035 #---------------------------------------------------------------------------
1036 # configuration options related to the Perl module output
1037 #---------------------------------------------------------------------------
1038
1039 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
1040 # generate a Perl module file that captures the structure of 
1041 # the code including all documentation. Note that this 
1042 # feature is still experimental and incomplete at the 
1043 # moment.
1044
1045 GENERATE_PERLMOD       = NO
1046
1047 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1048 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
1049 # to generate PDF and DVI output from the Perl module output.
1050
1051 PERLMOD_LATEX          = NO
1052
1053 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1054 # nicely formatted so it can be parsed by a human reader.  This is useful 
1055 # if you want to understand what is going on.  On the other hand, if this 
1056 # tag is set to NO the size of the Perl module output will be much smaller 
1057 # and Perl will parse it just the same.
1058
1059 PERLMOD_PRETTY         = YES
1060
1061 # The names of the make variables in the generated doxyrules.make file 
1062 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1063 # This is useful so different doxyrules.make files included by the same 
1064 # Makefile don't overwrite each other's variables.
1065
1066 PERLMOD_MAKEVAR_PREFIX = 
1067
1068 #---------------------------------------------------------------------------
1069 # Configuration options related to the preprocessor   
1070 #---------------------------------------------------------------------------
1071
1072 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1073 # evaluate all C-preprocessor directives found in the sources and include 
1074 # files.
1075
1076 ENABLE_PREPROCESSING   = YES
1077
1078 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1079 # names in the source code. If set to NO (the default) only conditional 
1080 # compilation will be performed. Macro expansion can be done in a controlled 
1081 # way by setting EXPAND_ONLY_PREDEF to YES.
1082 # GLIBCXX NOTE: Necessary for namespaces to be sorted correctly.
1083
1084 MACRO_EXPANSION        = YES
1085
1086 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1087 # then the macro expansion is limited to the macros specified with the 
1088 # PREDEFINED and EXPAND_AS_DEFINED tags.
1089
1090 EXPAND_ONLY_PREDEF     = NO
1091
1092 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1093 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1094
1095 SEARCH_INCLUDES        = YES
1096
1097 # The INCLUDE_PATH tag can be used to specify one or more directories that 
1098 # contain include files that are not input files but should be processed by 
1099 # the preprocessor.
1100
1101 INCLUDE_PATH           = 
1102
1103 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1104 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1105 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1106 # be used.
1107
1108 INCLUDE_FILE_PATTERNS  = 
1109
1110 # The PREDEFINED tag can be used to specify one or more macro names
1111 # that are defined before the preprocessor is started (similar to the
1112 # -D option of gcc). The argument of the tag is a list of macros of
1113 # the form: name or name=definition (no spaces). If the definition and
1114 # the = are omitted =1 is assumed. To prevent a macro definition from
1115 # being undefined via #undef or recursively expanded use the :=
1116 # operator instead of the = operator.
1117
1118 PREDEFINED             = __GTHREADS \
1119                          _GLIBCXX_STD=std \
1120                          "_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name {" \
1121              "_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name {" \
1122                          _GLIBCXX_END_NAMESPACE=} \
1123                          _GLIBCXX_END_NESTED_NAMESPACE=} \
1124                          "_GLIBCXX_TEMPLATE_ARGS=..." \
1125                          _GLIBCXX_DEPRECATED \
1126                          _GLIBCXX_USE_WCHAR_T \
1127                          _GLIBCXX_USE_LONG_LONG \
1128                          __glibcxx_function_requires=// \
1129                          __glibcxx_class_requires=// \
1130                          __glibcxx_class_requires2=// \
1131                          __glibcxx_class_requires3=// \
1132                          __glibcxx_class_requires4=//
1133
1134 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES
1135 # then this tag can be used to specify a list of macro names that
1136 # should be expanded.  The macro definition that is found in the
1137 # sources will be used.  Use the PREDEFINED tag if you want to use a
1138 # different macro definition.
1139
1140 EXPAND_AS_DEFINED      = 
1141
1142 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1143 # doxygen's preprocessor will remove all function-like macros that are alone 
1144 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
1145 # function macros are typically used for boiler-plate code, and will confuse 
1146 # the parser if not removed.
1147
1148 SKIP_FUNCTION_MACROS   = YES
1149
1150 #---------------------------------------------------------------------------
1151 # Configuration::additions related to external references   
1152 #---------------------------------------------------------------------------
1153
1154 # The TAGFILES option can be used to specify one or more tagfiles. 
1155 # Optionally an initial location of the external documentation 
1156 # can be added for each tagfile. The format of a tag file without 
1157 # this location is as follows: 
1158 #   TAGFILES = file1 file2 ... 
1159 # Adding location for the tag files is done as follows: 
1160 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1161 # where "loc1" and "loc2" can be relative or absolute paths or 
1162 # URLs. If a location is present for each tag, the installdox tool 
1163 # does not have to be run to correct the links.
1164 # Note that each tag file must have a unique name
1165 # (where the name does NOT include the path)
1166 # If a tag file is not located in the directory in which doxygen 
1167 # is run, you must also specify the path to the tagfile here.
1168
1169 TAGFILES               = 
1170
1171 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1172 # a tag file that is based on the input files it reads.
1173
1174 GENERATE_TAGFILE       = @generate_tagfile@
1175
1176 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1177 # in the class index. If set to NO only the inherited external classes 
1178 # will be listed.
1179
1180 ALLEXTERNALS           = YES
1181
1182 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1183 # in the modules index. If set to NO, only the current project's groups will 
1184 # be listed.
1185
1186 EXTERNAL_GROUPS        = YES
1187
1188 # The PERL_PATH should be the absolute path and name of the perl script 
1189 # interpreter (i.e. the result of `which perl').
1190
1191 PERL_PATH              = /usr/bin/perl
1192
1193 #---------------------------------------------------------------------------
1194 # Configuration options related to the dot tool   
1195 #---------------------------------------------------------------------------
1196
1197 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1198 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes
1199 # with base or super classes. Setting the tag to NO turns the diagrams
1200 # off. Note that this option is superseded by the HAVE_DOT option
1201 # below. This is only a fallback. It is recommended to install and use
1202 # dot, since it yields more powerful graphs.
1203
1204 CLASS_DIAGRAMS         = YES
1205
1206 # If set to YES, the inheritance and collaboration graphs will hide 
1207 # inheritance and usage relations if the target is undocumented 
1208 # or is not a class.
1209
1210 HIDE_UNDOC_RELATIONS   = NO
1211
1212 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot
1213 # tool is available from the path. This tool is part of Graphviz, a
1214 # graph visualization toolkit from AT&T and Lucent Bell Labs. The
1215 # other options in this section have no effect if this option is set
1216 # to NO (the default)
1217
1218 HAVE_DOT               = YES
1219
1220 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1221 # will generate a graph for each documented class showing the direct and 
1222 # indirect inheritance relations. Setting this tag to YES will force the 
1223 # the CLASS_DIAGRAMS tag to NO.
1224
1225 CLASS_GRAPH            = YES
1226
1227 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1228 # will generate a graph for each documented class showing the direct and 
1229 # indirect implementation dependencies (inheritance, containment, and 
1230 # class references variables) of the class with other documented classes.
1231
1232 COLLABORATION_GRAPH    = NO
1233
1234 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1235 # will generate a graph for groups, showing the direct groups dependencies
1236
1237 GROUP_GRAPHS           = YES
1238
1239 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1240 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1241 # Language.
1242
1243 UML_LOOK               = NO
1244
1245 # If set to YES, the inheritance and collaboration graphs will show the 
1246 # relations between templates and their instances.
1247
1248 #TEMPLATE_RELATIONS     = YES
1249 TEMPLATE_RELATIONS     = NO
1250
1251 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1252 # tags are set to YES then doxygen will generate a graph for each documented 
1253 # file showing the direct and indirect include dependencies of the file with 
1254 # other documented files.
1255
1256 INCLUDE_GRAPH          = NO
1257
1258 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1259 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1260 # documented header file showing the documented files that directly or 
1261 # indirectly include this file.
1262
1263 INCLUDED_BY_GRAPH      = NO
1264
1265 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1266 # generate a call dependency graph for every global function or class
1267 # method.  Note that enabling this option will significantly increase
1268 # the time of a run.  So in most cases it will be better to enable
1269 # call graphs for selected functions only using the \callgraph
1270 # command.
1271
1272 CALL_GRAPH             = NO
1273
1274 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen
1275 # will generate a caller dependency graph for every global function or
1276 # class method.  Note that enabling this option will significantly
1277 # increase the time of a run.  So in most cases it will be better to
1278 # enable caller graphs for selected functions only using the
1279 # \callergraph command.
1280
1281 CALLER_GRAPH           = NO
1282
1283 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1284 # will graphical hierarchy of all classes instead of a textual one.
1285
1286 GRAPHICAL_HIERARCHY    = YES
1287
1288 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1289 # then doxygen will show the dependencies a directory has on other directories 
1290 # in a graphical way. The dependency relations are determined by the #include
1291 # relations between the files in the directories.
1292
1293 DIRECTORY_GRAPH        = YES
1294
1295 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1296 # generated by dot. Possible values are png, jpg, or gif
1297 # If left blank png will be used.
1298
1299 #DOT_IMAGE_FORMAT       = svg
1300 DOT_IMAGE_FORMAT       = png
1301
1302 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1303 # found. If left blank, it is assumed the dot tool can be found in the path.
1304
1305 DOT_PATH               = 
1306
1307 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1308 # contain dot files that are included in the documentation (see the 
1309 # \dotfile command).
1310
1311 DOTFILE_DIRS           = 
1312
1313 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
1314 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1315 # this value, doxygen will try to truncate the graph, so that it fits within 
1316 # the specified constraint. Beware that most browsers cannot cope with very 
1317 # large images.
1318
1319 MAX_DOT_GRAPH_WIDTH    = 1024
1320
1321 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
1322 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1323 # this value, doxygen will try to truncate the graph, so that it fits within 
1324 # the specified constraint. Beware that most browsers cannot cope with very 
1325 # large images.
1326
1327 MAX_DOT_GRAPH_HEIGHT   = 1024
1328
1329 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of
1330 # the graphs generated by dot. A depth value of 3 means that only
1331 # nodes reachable from the root by following a path via at most 3
1332 # edges will be shown. Nodes that lay further from the root node will
1333 # be omitted. Note that setting this option to 1 or 2 may greatly
1334 # reduce the computation time needed for large code bases. Also note
1335 # that a graph may be further truncated if the graph's image
1336 # dimensions are not sufficient to fit the graph (see
1337 # MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the
1338 # depth value (the default), the graph is not depth-constrained.
1339
1340 MAX_DOT_GRAPH_DEPTH    = 0
1341
1342 # Set the DOT_TRANSPARENT tag to YES to generate images with a
1343 # transparent background. This is disabled by default, which results
1344 # in a white background.  Warning: Depending on the platform used,
1345 # enabling this option may lead to badly anti-aliased labels on the
1346 # edges of a graph (i.e. they become hard to read).
1347
1348 DOT_TRANSPARENT        = NO
1349
1350 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1351 # files in one run (i.e. multiple -o and -T options on the command line). This 
1352 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1353 # support this, this feature is disabled by default.
1354
1355 DOT_MULTI_TARGETS      = YES
1356
1357 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1358 # generate a legend page explaining the meaning of the various boxes and 
1359 # arrows in the dot generated graphs.
1360
1361 GENERATE_LEGEND        = NO
1362
1363 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1364 # remove the intermediate dot files that are used to generate 
1365 # the various graphs.
1366
1367 DOT_CLEANUP            = YES
1368
1369 #---------------------------------------------------------------------------
1370 # Configuration::additions related to the search engine   
1371 #---------------------------------------------------------------------------
1372
1373 # The SEARCHENGINE tag specifies whether or not a search engine should be 
1374 # used. If set to NO the values of all tags below this one will be ignored.
1375
1376 SEARCHENGINE           = NO