OSDN Git Service

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