OSDN Git Service

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