OSDN Git Service

gcc/:
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / doc / doxygen / user.cfg.in
1 # Doxyfile 1.7.4
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 # Using the PROJECT_BRIEF tag one can provide an optional one line description
37 # for a project that appears at the top of each page and should give viewer
38 # a quick idea about the purpose of the project. Keep the description short.
39
40 PROJECT_BRIEF          =
41
42 # With the PROJECT_LOGO tag one can specify an logo or icon that is
43 # included in the documentation. The maximum height of the logo should not
44 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
45 # Doxygen will copy the logo to the output directory.
46
47 PROJECT_LOGO           =
48
49 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
50 # base path where the generated documentation will be put.
51 # If a relative path is entered, it will be relative to the location
52 # where doxygen was started. If left blank the current directory will be used.
53
54 OUTPUT_DIRECTORY       = @outdir@
55
56 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
57 # 4096 sub-directories (in 2 levels) under the output directory of each output
58 # format and will distribute the generated files over these directories.
59 # Enabling this option can be useful when feeding doxygen a huge amount of
60 # source files, where putting all generated files in the same directory would
61 # otherwise cause performance problems for the file system.
62
63 CREATE_SUBDIRS         = NO
64
65 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
66 # documentation generated by doxygen is written. Doxygen will use this
67 # information to generate all constant output in the proper language.
68 # The default language is English, other supported languages are:
69 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
70 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
71 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
72 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
73 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
74 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
75
76 OUTPUT_LANGUAGE        = English
77
78 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
79 # include brief member descriptions after the members that are listed in
80 # the file and class documentation (similar to JavaDoc).
81 # Set to NO to disable this.
82
83 BRIEF_MEMBER_DESC      = NO
84
85 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
86 # the brief description of a member or function before the detailed description.
87 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
88 # brief descriptions will be completely suppressed.
89
90 REPEAT_BRIEF           = YES
91
92 # This tag implements a quasi-intelligent brief description abbreviator
93 # that is used to form the text in various listings. Each string
94 # in this list, if found as the leading text of the brief description, will be
95 # stripped from the text and the result after processing the whole list, is
96 # used as the annotated text. Otherwise, the brief description is used as-is.
97 # If left blank, the following values are used ("$name" is automatically
98 # replaced with the name of the entity): "The $name class" "The $name widget"
99 # "The $name file" "is" "provides" "specifies" "contains"
100 # "represents" "a" "an" "the"
101
102 ABBREVIATE_BRIEF       =
103
104 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
105 # Doxygen will generate a detailed section even if there is only a brief
106 # description.
107
108 ALWAYS_DETAILED_SEC    = YES
109
110 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
111 # inherited members of a class in the documentation of that class as if those
112 # members were ordinary class members. Constructors, destructors and assignment
113 # operators of the base classes will not be shown.
114
115 INLINE_INHERITED_MEMB  = YES
116
117 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
118 # path before files name in the file list and in the header files. If set
119 # to NO the shortest path that makes the file name unique will be used.
120
121 FULL_PATH_NAMES        = NO
122
123 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
124 # can be used to strip a user-defined part of the path. Stripping is
125 # only done if one of the specified strings matches the left-hand part of
126 # the path. The tag can be used to show relative paths in the file list.
127 # If left blank the directory from which doxygen is run is used as the
128 # path to strip.
129
130 STRIP_FROM_PATH        =
131
132 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
133 # the path mentioned in the documentation of a class, which tells
134 # the reader which header file to include in order to use a class.
135 # If left blank only the name of the header file containing the class
136 # definition is used. Otherwise one should specify the include paths that
137 # are normally passed to the compiler using the -I flag.
138
139 STRIP_FROM_INC_PATH    =
140
141 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
142 # (but less readable) file names. This can be useful if your file system
143 # doesn't support long names like on DOS, Mac, or CD-ROM.
144
145 SHORT_NAMES            = @shortname@
146
147 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
148 # will interpret the first line (until the first dot) of a JavaDoc-style
149 # comment as the brief description. If set to NO, the JavaDoc
150 # comments will behave just like regular Qt-style comments
151 # (thus requiring an explicit @brief command for a brief description.)
152
153 JAVADOC_AUTOBRIEF      = NO
154
155 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
156 # interpret the first line (until the first dot) of a Qt-style
157 # comment as the brief description. If set to NO, the comments
158 # will behave just like regular Qt-style comments (thus requiring
159 # an explicit \brief command for a brief description.)
160
161 QT_AUTOBRIEF           = NO
162
163 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
164 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
165 # comments) as a brief description. This used to be the default behaviour.
166 # The new default is to treat a multi-line C++ comment block as a detailed
167 # description. Set this tag to YES if you prefer the old behaviour instead.
168
169 MULTILINE_CPP_IS_BRIEF = YES
170
171 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
172 # member inherits the documentation from any documented member that it
173 # re-implements.
174
175 INHERIT_DOCS           = YES
176
177 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
178 # a new page for each member. If set to NO, the documentation of a member will
179 # be part of the file/class/namespace that contains it.
180
181 SEPARATE_MEMBER_PAGES  = NO
182
183 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
184 # Doxygen uses this value to replace tabs by spaces in code fragments.
185
186 TAB_SIZE               = 4
187
188 # This tag can be used to specify a number of aliases that acts
189 # as commands in the documentation. An alias has the form "name=value".
190 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
191 # put the command \sideeffect (or @sideeffect) in the documentation, which
192 # will result in a user-defined paragraph with heading "Side Effects:".
193 # You can put \n's in the value part of an alias to insert newlines.
194
195 ALIASES                = "doctodo=@todo\nNeeds documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html" \
196                          "headername{1}=Instead, include <\1>." \
197                          "headername{2}=Instead, include <\1> or <\2>."
198
199 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
200 # sources only. Doxygen will then generate output that is more tailored for C.
201 # For instance, some of the names that are used will be different. The list
202 # of all members will be omitted, etc.
203
204 OPTIMIZE_OUTPUT_FOR_C  = NO
205
206 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
207 # sources only. Doxygen will then generate output that is more tailored for
208 # Java. For instance, namespaces will be presented as packages, qualified
209 # scopes will look different, etc.
210
211 OPTIMIZE_OUTPUT_JAVA   = NO
212
213 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
214 # sources only. Doxygen will then generate output that is more tailored for
215 # Fortran.
216
217 OPTIMIZE_FOR_FORTRAN   = NO
218
219 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
220 # sources. Doxygen will then generate output that is tailored for
221 # VHDL.
222
223 OPTIMIZE_OUTPUT_VHDL   = NO
224
225 # Doxygen selects the parser to use depending on the extension of the files it
226 # parses. With this tag you can assign which parser to use for a given extension.
227 # Doxygen has a built-in mapping, but you can override or extend it using this
228 # tag. The format is ext=language, where ext is a file extension, and language
229 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
230 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
231 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
232 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
233 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
234
235 EXTENSION_MAPPING      =
236
237 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
238 # to include (a tag file for) the STL sources as input, then you should
239 # set this tag to YES in order to let doxygen match functions declarations and
240 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
241 # func(std::string) {}). This also makes the inheritance and collaboration
242 # diagrams that involve STL classes more complete and accurate.
243
244 BUILTIN_STL_SUPPORT    = NO
245
246 # If you use Microsoft's C++/CLI language, you should set this option to YES to
247 # enable parsing support.
248
249 CPP_CLI_SUPPORT        = NO
250
251 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
252 # Doxygen will parse them like normal C++ but will assume all classes use public
253 # instead of private inheritance when no explicit protection keyword is present.
254
255 SIP_SUPPORT            = NO
256
257 # For Microsoft's IDL there are propget and propput attributes to indicate getter
258 # and setter methods for a property. Setting this option to YES (the default)
259 # will make doxygen replace the get and set methods by a property in the
260 # documentation. This will only work if the methods are indeed getting or
261 # setting a simple type. If this is not the case, or you want to show the
262 # methods anyway, you should set this option to NO.
263
264 IDL_PROPERTY_SUPPORT   = NO
265
266 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
267 # tag is set to YES, then doxygen will reuse the documentation of the first
268 # member in the group (if any) for the other members of the group. By default
269 # all members of a group must be documented explicitly.
270
271 DISTRIBUTE_GROUP_DOC   = YES
272
273 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
274 # the same type (for instance a group of public functions) to be put as a
275 # subgroup of that type (e.g. under the Public Functions section). Set it to
276 # NO to prevent subgrouping. Alternatively, this can be done per class using
277 # the \nosubgrouping command.
278
279 SUBGROUPING            = YES
280
281 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
282 # unions are shown inside the group in which they are included (e.g. using
283 # @ingroup) instead of on a separate page (for HTML and Man pages) or
284 # section (for LaTeX and RTF).
285
286 INLINE_GROUPED_CLASSES = NO
287
288 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
289 # is documented as struct, union, or enum with the name of the typedef. So
290 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
291 # with name TypeT. When disabled the typedef will appear as a member of a file,
292 # namespace, or class. And the struct will be named TypeS. This can typically
293 # be useful for C code in case the coding convention dictates that all compound
294 # types are typedef'ed and only the typedef is referenced, never the tag name.
295
296 TYPEDEF_HIDES_STRUCT   = NO
297
298 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
299 # determine which symbols to keep in memory and which to flush to disk.
300 # When the cache is full, less often used symbols will be written to disk.
301 # For small to medium size projects (<1000 input files) the default value is
302 # probably good enough. For larger projects a too small cache size can cause
303 # doxygen to be busy swapping symbols to and from disk most of the time
304 # causing a significant performance penalty.
305 # If the system has enough physical memory increasing the cache will improve the
306 # performance by keeping more symbols in memory. Note that the value works on
307 # a logarithmic scale so increasing the size by one will roughly double the
308 # memory usage. The cache size is given by this formula:
309 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
310 # corresponding to a cache size of 2^16 = 65536 symbols
311
312 SYMBOL_CACHE_SIZE      = 0
313
314 #---------------------------------------------------------------------------
315 # Build related configuration options
316 #---------------------------------------------------------------------------
317
318 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
319 # documentation are documented, even if no documentation was available.
320 # Private class members and static file members will be hidden unless
321 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
322
323 EXTRACT_ALL            = NO
324
325 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
326 # will be included in the documentation.
327
328 EXTRACT_PRIVATE        = NO
329
330 # If the EXTRACT_STATIC tag is set to YES all static members of a file
331 # will be included in the documentation.
332
333 EXTRACT_STATIC         = YES
334
335 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
336 # defined locally in source files will be included in the documentation.
337 # If set to NO only classes defined in header files are included.
338
339 EXTRACT_LOCAL_CLASSES  = YES
340
341 # This flag is only useful for Objective-C code. When set to YES local
342 # methods, which are defined in the implementation section but not in
343 # the interface are included in the documentation.
344 # If set to NO (the default) only methods in the interface are included.
345
346 EXTRACT_LOCAL_METHODS  = YES
347
348 # If this flag is set to YES, the members of anonymous namespaces will be
349 # extracted and appear in the documentation as a namespace called
350 # 'anonymous_namespace{file}', where file will be replaced with the base
351 # name of the file that contains the anonymous namespace. By default
352 # anonymous namespaces are hidden.
353
354 EXTRACT_ANON_NSPACES   = NO
355
356 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
357 # undocumented members of documented classes, files or namespaces.
358 # If set to NO (the default) these members will be included in the
359 # various overviews, but no documentation section is generated.
360 # This option has no effect if EXTRACT_ALL is enabled.
361
362 HIDE_UNDOC_MEMBERS     = NO
363
364 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
365 # undocumented classes that are normally visible in the class hierarchy.
366 # If set to NO (the default) these classes will be included in the various
367 # overviews. This option has no effect if EXTRACT_ALL is enabled.
368
369 HIDE_UNDOC_CLASSES     = YES
370
371 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
372 # friend (class|struct|union) declarations.
373 # If set to NO (the default) these declarations will be included in the
374 # documentation.
375
376 HIDE_FRIEND_COMPOUNDS  = NO
377
378 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
379 # documentation blocks found inside the body of a function.
380 # If set to NO (the default) these blocks will be appended to the
381 # function's detailed documentation block.
382
383 HIDE_IN_BODY_DOCS      = NO
384
385 # The INTERNAL_DOCS tag determines if documentation
386 # that is typed after a \internal command is included. If the tag is set
387 # to NO (the default) then the documentation will be excluded.
388 # Set it to YES to include the internal documentation.
389
390 INTERNAL_DOCS          = NO
391
392 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
393 # file names in lower-case letters. If set to YES upper-case letters are also
394 # allowed. This is useful if you have classes or files whose names only differ
395 # in case and if your file system supports case sensitive file names. Windows
396 # and Mac users are advised to set this option to NO.
397
398 CASE_SENSE_NAMES       = NO
399
400 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
401 # will show members with their full class and namespace scopes in the
402 # documentation. If set to YES the scope will be hidden.
403
404 HIDE_SCOPE_NAMES       = NO
405
406 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
407 # will put a list of the files that are included by a file in the documentation
408 # of that file.
409
410 SHOW_INCLUDE_FILES     = NO
411
412 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
413 # will list include files with double quotes in the documentation
414 # rather than with sharp brackets.
415
416 FORCE_LOCAL_INCLUDES   = NO
417
418 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
419 # is inserted in the documentation for inline members.
420
421 INLINE_INFO            = YES
422
423 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
424 # will sort the (detailed) documentation of file and class members
425 # alphabetically by member name. If set to NO the members will appear in
426 # declaration order.
427
428 SORT_MEMBER_DOCS       = YES
429
430 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
431 # brief documentation of file, namespace and class members alphabetically
432 # by member name. If set to NO (the default) the members will appear in
433 # declaration order.
434
435 SORT_BRIEF_DOCS        = YES
436
437 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
438 # will sort the (brief and detailed) documentation of class members so that
439 # constructors and destructors are listed first. If set to NO (the default)
440 # the constructors will appear in the respective orders defined by
441 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
442 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
443 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
444
445 SORT_MEMBERS_CTORS_1ST = YES
446
447 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
448 # hierarchy of group names into alphabetical order. If set to NO (the default)
449 # the group names will appear in their defined order.
450
451 SORT_GROUP_NAMES       = YES
452
453 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
454 # sorted by fully-qualified names, including namespaces. If set to
455 # NO (the default), the class list will be sorted only by class name,
456 # not including the namespace part.
457 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
458 # Note: This option applies only to the class list, not to the
459 # alphabetical list.
460
461 SORT_BY_SCOPE_NAME     = YES
462
463 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
464 # do proper type resolution of all parameters of a function it will reject a
465 # match between the prototype and the implementation of a member function even
466 # if there is only one candidate or it is obvious which candidate to choose
467 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
468 # will still accept a match between prototype and implementation in such cases.
469
470 STRICT_PROTO_MATCHING  = NO
471
472 # The GENERATE_TODOLIST tag can be used to enable (YES) or
473 # disable (NO) the todo list. This list is created by putting \todo
474 # commands in the documentation.
475
476 GENERATE_TODOLIST      = YES
477
478 # The GENERATE_TESTLIST tag can be used to enable (YES) or
479 # disable (NO) the test list. This list is created by putting \test
480 # commands in the documentation.
481
482 GENERATE_TESTLIST      = NO
483
484 # The GENERATE_BUGLIST tag can be used to enable (YES) or
485 # disable (NO) the bug list. This list is created by putting \bug
486 # commands in the documentation.
487
488 GENERATE_BUGLIST       = YES
489
490 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
491 # disable (NO) the deprecated list. This list is created by putting
492 # \deprecated commands in the documentation.
493
494 GENERATE_DEPRECATEDLIST= YES
495
496 # The ENABLED_SECTIONS tag can be used to enable conditional
497 # documentation sections, marked by \if sectionname ... \endif.
498
499 ENABLED_SECTIONS       = @enabled_sections@
500
501 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
502 # the initial value of a variable or macro consists of for it to appear in
503 # the documentation. If the initializer consists of more lines than specified
504 # here it will be hidden. Use a value of 0 to hide initializers completely.
505 # The appearance of the initializer of individual variables and macros in the
506 # documentation can be controlled using \showinitializer or \hideinitializer
507 # command in the documentation regardless of this setting.
508
509 MAX_INITIALIZER_LINES  = 0
510
511 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
512 # at the bottom of the documentation of classes and structs. If set to YES the
513 # list will mention the files that were used to generate the documentation.
514
515 SHOW_USED_FILES        = YES
516
517 # If the sources in your project are distributed over multiple directories
518 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
519 # in the documentation. The default is NO.
520
521 SHOW_DIRECTORIES       = YES
522
523 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
524 # This will remove the Files entry from the Quick Index and from the
525 # Folder Tree View (if specified). The default is YES.
526
527 SHOW_FILES             = YES
528
529 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
530 # Namespaces page.
531 # This will remove the Namespaces entry from the Quick Index
532 # and from the Folder Tree View (if specified). The default is YES.
533
534 SHOW_NAMESPACES        = YES
535
536 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
537 # doxygen should invoke to get the current version for each file (typically from
538 # the version control system). Doxygen will invoke the program by executing (via
539 # popen()) the command <command> <input-file>, where <command> is the value of
540 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
541 # provided by doxygen. Whatever the program writes to standard output
542 # is used as the file version. See the manual for examples.
543
544 FILE_VERSION_FILTER    =
545
546 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
547 # by doxygen. The layout file controls the global structure of the generated
548 # output files in an output format independent way. The create the layout file
549 # that represents doxygen's defaults, run doxygen with the -l option.
550 # You can optionally specify a file name after the option, if omitted
551 # DoxygenLayout.xml will be used as the name of the layout file.
552
553 LAYOUT_FILE            =
554
555 #---------------------------------------------------------------------------
556 # configuration options related to warning and progress messages
557 #---------------------------------------------------------------------------
558
559 # The QUIET tag can be used to turn on/off the messages that are generated
560 # by doxygen. Possible values are YES and NO. If left blank NO is used.
561
562 QUIET                  = NO
563
564 # The WARNINGS tag can be used to turn on/off the warning messages that are
565 # generated by doxygen. Possible values are YES and NO. If left blank
566 # NO is used.
567
568 WARNINGS               = YES
569
570 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
571 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
572 # automatically be disabled.
573
574 WARN_IF_UNDOCUMENTED   = NO
575
576 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
577 # potential errors in the documentation, such as not documenting some
578 # parameters in a documented function, or documenting parameters that
579 # don't exist or using markup commands wrongly.
580
581 WARN_IF_DOC_ERROR      = YES
582
583 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
584 # functions that are documented, but have no documentation for their parameters
585 # or return value. If set to NO (the default) doxygen will only warn about
586 # wrong or incomplete parameter documentation, but not about the absence of
587 # documentation.
588
589 WARN_NO_PARAMDOC       = NO
590
591 # The WARN_FORMAT tag determines the format of the warning messages that
592 # doxygen can produce. The string should contain the $file, $line, and $text
593 # tags, which will be replaced by the file and line number from which the
594 # warning originated and the warning text. Optionally the format may contain
595 # $version, which will be replaced by the version of the file (if it could
596 # be obtained via FILE_VERSION_FILTER)
597
598 WARN_FORMAT            = "$file:$line: $text  "
599
600 # The WARN_LOGFILE tag can be used to specify a file to which warning
601 # and error messages should be written. If left blank the output is written
602 # to stderr.
603
604 WARN_LOGFILE           =
605
606 #---------------------------------------------------------------------------
607 # configuration options related to the input files
608 #---------------------------------------------------------------------------
609
610 # The INPUT tag can be used to specify the files and/or directories that contain
611 # documented source files. You may enter file names like "myfile.cpp" or
612 # directories like "/usr/src/myproject". Separate the files or directories
613 # with spaces.
614
615 INPUT                  = @srcdir@/doc/doxygen/doxygroups.cc \
616                          @srcdir@/libsupc++/cxxabi.h \
617                          @srcdir@/libsupc++/exception \
618                          @srcdir@/libsupc++/initializer_list \
619                          @srcdir@/libsupc++/new \
620                          @srcdir@/libsupc++/typeinfo \
621                          include/algorithm \
622                          include/array \
623                          include/atomic \
624                          include/bitset \
625                          include/chrono \
626                          include/complex \
627                          include/condition_variable \
628                          include/deque \
629                          include/forward_list \
630                          include/fstream \
631                          include/functional \
632                          include/future \
633                          include/iomanip \
634                          include/ios \
635                          include/iosfwd \
636                          include/iostream \
637                          include/istream \
638                          include/iterator \
639                          include/limits \
640                          include/list \
641                          include/locale \
642                          include/map \
643                          include/memory \
644                          include/mutex \
645                          include/numeric \
646                          include/ostream \
647                          include/queue \
648                          include/random \
649                          include/ratio \
650                          include/regex \
651                          include/scoped_allocator \
652                          include/set \
653                          include/sstream \
654                          include/stack \
655                          include/stdexcept \
656                          include/streambuf \
657                          include/string \
658                          include/system_error \
659                          include/thread \
660                          include/tuple \
661                          include/typeindex \
662                          include/type_traits \
663                          include/unordered_map \
664                          include/unordered_set \
665                          include/utility \
666                          include/valarray \
667                          include/vector \
668                          include/cassert \
669                          include/ccomplex \
670                          include/cctype \
671                          include/cerrno \
672                          include/cfenv \
673                          include/cfloat \
674                          include/cinttypes \
675                          include/ciso646 \
676                          include/climits \
677                          include/clocale \
678                          include/cmath \
679                          include/csetjmp \
680                          include/csignal \
681                          include/cstdarg \
682                          include/cstdbool \
683                          include/cstddef \
684                          include/cstdint \
685                          include/cstdio \
686                          include/cstdlib \
687                          include/cstring \
688                          include/ctgmath \
689                          include/ctime \
690                          include/cwchar \
691                          include/cwctype \
692                          include/ \
693                          include/bits \
694                          include/@host_alias@/bits \
695                          include/backward \
696                          include/backward/hash_map \
697                          include/backward/hash_set \
698                          include/backward/strstream \
699                          include/debug \
700                          include/debug/bitset \
701                          include/debug/deque \
702                          include/debug/forward_list \
703                          include/debug/list \
704                          include/debug/map \
705                          include/debug/set \
706                          include/debug/string \
707                          include/debug/unordered_map \
708                          include/debug/unordered_set \
709                          include/debug/vector \
710                          include/profile \
711                          include/profile/impl \
712                          include/profile/bitset \
713                          include/profile/deque \
714                          include/profile/forward_list \
715                          include/profile/list \
716                          include/profile/map \
717                          include/profile/set \
718                          include/profile/unordered_map \
719                          include/profile/unordered_set \
720                          include/profile/vector \
721                          include/ext/algorithm \
722                          include/ext/functional \
723                          include/ext/iterator \
724                          include/ext/memory \
725                          include/ext/numeric \
726                          include/ext/rb_tree \
727                          include/ext/rope \
728                          include/ext/slist \
729                          include/parallel \
730                          include/parallel/algorithm \
731                          include/parallel/numeric \
732                          include/tr1/ccomplex \
733                          include/tr1/cctype \
734                          include/tr1/cfenv \
735                          include/tr1/cfloat \
736                          include/tr1/cinttypes \
737                          include/tr1/climits \
738                          include/tr1/cmath \
739                          include/tr1/complex \
740                          include/tr1/cstdarg \
741                          include/tr1/cstdbool \
742                          include/tr1/cstdint \
743                          include/tr1/cstdio \
744                          include/tr1/cstdlib \
745                          include/tr1/ctgmath \
746                          include/tr1/ctime \
747                          include/tr1/cwchar \
748                          include/tr1/cwctype \
749                          include/tr2/ \
750                          include/tr2/bool_set \
751                          include/tr2/dynamic_bitset \
752                          include/tr2/ratio \
753                          include/tr2/type_traits \
754                          include/decimal/decimal \
755                          include/ext \
756                          include/ext/pb_ds \
757                          include/ext/pb_ds/detail \
758                          include/ext/pb_ds/detail/binary_heap_ \
759                          include/ext/pb_ds/detail/binomial_heap_ \
760                          include/ext/pb_ds/detail/binomial_heap_base_ \
761                          include/ext/pb_ds/detail/bin_search_tree_ \
762                          include/ext/pb_ds/detail/branch_policy \
763                          include/ext/pb_ds/detail/cc_hash_table_map_ \
764                          include/ext/pb_ds/detail/eq_fn \
765                          include/ext/pb_ds/detail/gp_hash_table_map_ \
766                          include/ext/pb_ds/detail/hash_fn \
767                          include/ext/pb_ds/detail/left_child_next_sibling_heap_ \
768                          include/ext/pb_ds/detail/list_update_map_ \
769                          include/ext/pb_ds/detail/list_update_policy \
770                          include/ext/pb_ds/detail/ov_tree_map_ \
771                          include/ext/pb_ds/detail/pairing_heap_ \
772                          include/ext/pb_ds/detail/pat_trie_ \
773                          include/ext/pb_ds/detail/rb_tree_map_ \
774                          include/ext/pb_ds/detail/rc_binomial_heap_ \
775                          include/ext/pb_ds/detail/resize_policy \
776                          include/ext/pb_ds/detail/splay_tree_ \
777                          include/ext/pb_ds/detail/thin_heap_ \
778                          include/ext/pb_ds/detail/tree_policy \
779                          include/ext/pb_ds/detail/trie_policy \
780                          include/ext/pb_ds/detail/unordered_iterator
781
782 # This tag can be used to specify the character encoding of the source files
783 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
784 # also the default input encoding. Doxygen uses libiconv (or the iconv built
785 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
786 # the list of possible encodings.
787
788 INPUT_ENCODING         = UTF-8
789
790 # If the value of the INPUT tag contains directories, you can use the
791 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
792 # and *.h) to filter out the source-files in the directories. If left
793 # blank the following patterns are tested:
794 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
795 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
796 # *.f90 *.f *.for *.vhd *.vhdl
797
798 FILE_PATTERNS          = *.h \
799                          *.hpp \
800                          *.tcc
801
802 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
803 # should be searched for input files as well. Possible values are YES and NO.
804 # If left blank NO is used.
805
806 RECURSIVE              = NO
807
808 # The EXCLUDE tag can be used to specify files and/or directories that should
809 # excluded from the INPUT source files. This way you can easily exclude a
810 # subdirectory from a directory tree whose root is specified with the INPUT tag.
811
812 EXCLUDE                = Makefile
813
814 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
815 # directories that are symbolic links (a Unix file system feature) are excluded
816 # from the input.
817
818 EXCLUDE_SYMLINKS       = NO
819
820 # If the value of the INPUT tag contains directories, you can use the
821 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
822 # certain files from those directories. Note that the wildcards are matched
823 # against the file with absolute path, so to exclude all test directories
824 # for example use the pattern */test/*
825
826 EXCLUDE_PATTERNS       = stamp-* \
827                          doxygroups.cc \
828                          *.gch \
829                          */.svn/*
830
831 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
832 # (namespaces, classes, functions, etc.) that should be excluded from the
833 # output. The symbol name can be a fully qualified name, a word, or if the
834 # wildcard * is used, a substring. Examples: ANamespace, AClass,
835 # AClass::ANamespace, ANamespace::*Test
836
837 EXCLUDE_SYMBOLS        =
838
839 # The EXAMPLE_PATH tag can be used to specify one or more files or
840 # directories that contain example code fragments that are included (see
841 # the \include command).
842
843 EXAMPLE_PATH           =
844
845 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
846 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
847 # and *.h) to filter out the source-files in the directories. If left
848 # blank all files are included.
849
850 EXAMPLE_PATTERNS       =
851
852 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
853 # searched for input files to be used with the \include or \dontinclude
854 # commands irrespective of the value of the RECURSIVE tag.
855 # Possible values are YES and NO. If left blank NO is used.
856
857 EXAMPLE_RECURSIVE      = NO
858
859 # The IMAGE_PATH tag can be used to specify one or more files or
860 # directories that contain image that are included in the documentation (see
861 # the \image command).
862
863 IMAGE_PATH             =
864
865 # The INPUT_FILTER tag can be used to specify a program that doxygen should
866 # invoke to filter for each input file. Doxygen will invoke the filter program
867 # by executing (via popen()) the command <filter> <input-file>, where <filter>
868 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
869 # input file. Doxygen will then use the output that the filter program writes
870 # to standard output.
871 # If FILTER_PATTERNS is specified, this tag will be
872 # ignored.
873
874 INPUT_FILTER           =
875
876 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
877 # basis.
878 # Doxygen will compare the file name with each pattern and apply the
879 # filter if there is a match.
880 # The filters are a list of the form:
881 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
882 # info on how filters are used. If FILTER_PATTERNS is empty or if
883 # non of the patterns match the file name, INPUT_FILTER is applied.
884
885 FILTER_PATTERNS        =
886
887 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
888 # INPUT_FILTER) will be used to filter the input files when producing source
889 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
890
891 FILTER_SOURCE_FILES    = NO
892
893 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
894 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
895 # and it is also possible to disable source filtering for a specific pattern
896 # using *.ext= (so without naming a filter). This option only has effect when
897 # FILTER_SOURCE_FILES is enabled.
898
899 FILTER_SOURCE_PATTERNS =
900
901 #---------------------------------------------------------------------------
902 # configuration options related to source browsing
903 #---------------------------------------------------------------------------
904
905 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
906 # be generated. Documented entities will be cross-referenced with these sources.
907 # Note: To get rid of all source code in the generated output, make sure also
908 # VERBATIM_HEADERS is set to NO.
909
910 SOURCE_BROWSER         = YES
911
912 # Setting the INLINE_SOURCES tag to YES will include the body
913 # of functions and classes directly in the documentation.
914
915 INLINE_SOURCES         = NO
916
917 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
918 # doxygen to hide any special comment blocks from generated source code
919 # fragments. Normal C and C++ comments will always remain visible.
920
921 STRIP_CODE_COMMENTS    = NO
922
923 # If the REFERENCED_BY_RELATION tag is set to YES
924 # then for each documented function all documented
925 # functions referencing it will be listed.
926
927 REFERENCED_BY_RELATION = YES
928
929 # If the REFERENCES_RELATION tag is set to YES
930 # then for each documented function all documented entities
931 # called/used by that function will be listed.
932
933 REFERENCES_RELATION    = YES
934
935 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
936 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
937 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
938 # link to the source code.
939 # Otherwise they will link to the documentation.
940
941 REFERENCES_LINK_SOURCE = YES
942
943 # If the USE_HTAGS tag is set to YES then the references to source code
944 # will point to the HTML generated by the htags(1) tool instead of doxygen
945 # built-in source browser. The htags tool is part of GNU's global source
946 # tagging system (see http://www.gnu.org/software/global/global.html). You
947 # will need version 4.8.6 or higher.
948
949 USE_HTAGS              = NO
950
951 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
952 # will generate a verbatim copy of the header file for each class for
953 # which an include is specified. Set to NO to disable this.
954
955 VERBATIM_HEADERS       = NO
956
957 #---------------------------------------------------------------------------
958 # configuration options related to the alphabetical class index
959 #---------------------------------------------------------------------------
960
961 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
962 # of all compounds will be generated. Enable this if the project
963 # contains a lot of classes, structs, unions or interfaces.
964
965 ALPHABETICAL_INDEX     = YES
966
967 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
968 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
969 # in which this list will be split (can be a number in the range [1..20])
970
971 COLS_IN_ALPHA_INDEX    = 2
972
973 # In case all classes in a project start with a common prefix, all
974 # classes will be put under the same header in the alphabetical index.
975 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
976 # should be ignored while generating the index headers.
977
978 IGNORE_PREFIX          =
979
980 #---------------------------------------------------------------------------
981 # configuration options related to the HTML output
982 #---------------------------------------------------------------------------
983
984 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
985 # generate HTML output.
986
987 GENERATE_HTML          = @do_html@
988
989 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
990 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
991 # put in front of it. If left blank `html' will be used as the default path.
992
993 HTML_OUTPUT            = html
994
995 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
996 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
997 # doxygen will generate files with .html extension.
998
999 HTML_FILE_EXTENSION    = .html
1000
1001 # The HTML_HEADER tag can be used to specify a personal HTML header for
1002 # each generated HTML page. If it is left blank doxygen will generate a
1003 # standard header. Note that when using a custom header you are responsible
1004 # for the proper inclusion of any scripts and style sheets that doxygen
1005 # needs, which is dependent on the configuration options used.
1006 # It is adviced to generate a default header using "doxygen -w html
1007 # header.html footer.html stylesheet.css YourConfigFile" and then modify
1008 # that header. Note that the header is subject to change so you typically
1009 # have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!
1010
1011 HTML_HEADER            =
1012
1013 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
1014 # each generated HTML page. If it is left blank doxygen will generate a
1015 # standard footer.
1016
1017 HTML_FOOTER            =
1018
1019 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1020 # style sheet that is used by each HTML page. It can be used to
1021 # fine-tune the look of the HTML output. If the tag is left blank doxygen
1022 # will generate a default style sheet. Note that doxygen will try to copy
1023 # the style sheet file to the HTML output directory, so don't put your own
1024 # stylesheet in the HTML output directory as well, or it will be erased!
1025
1026 HTML_STYLESHEET        =
1027
1028 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1029 # other source files which should be copied to the HTML output directory. Note
1030 # that these files will be copied to the base HTML output directory. Use the
1031 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1032 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
1033 # the files will be copied as-is; there are no commands or markers available.
1034
1035 HTML_EXTRA_FILES       =
1036
1037 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
1038 # Doxygen will adjust the colors in the stylesheet and background images
1039 # according to this color. Hue is specified as an angle on a colorwheel,
1040 # see http://en.wikipedia.org/wiki/Hue for more information.
1041 # For instance the value 0 represents red, 60 is yellow, 120 is green,
1042 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
1043 # The allowed range is 0 to 359.
1044
1045 HTML_COLORSTYLE_HUE    = 220
1046
1047 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
1048 # the colors in the HTML output. For a value of 0 the output will use
1049 # grayscales only. A value of 255 will produce the most vivid colors.
1050
1051 HTML_COLORSTYLE_SAT    = 100
1052
1053 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
1054 # the luminance component of the colors in the HTML output. Values below
1055 # 100 gradually make the output lighter, whereas values above 100 make
1056 # the output darker. The value divided by 100 is the actual gamma applied,
1057 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1058 # and 100 does not change the gamma.
1059
1060 HTML_COLORSTYLE_GAMMA  = 80
1061
1062 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1063 # page will contain the date and time when the page was generated. Setting
1064 # this to NO can help when comparing the output of multiple runs.
1065
1066 HTML_TIMESTAMP         = NO
1067
1068 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
1069 # files or namespaces will be aligned in HTML using tables. If set to
1070 # NO a bullet list will be used.
1071
1072 HTML_ALIGN_MEMBERS     = NO
1073
1074 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1075 # documentation will contain sections that can be hidden and shown after the
1076 # page has loaded. For this to work a browser that supports
1077 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
1078 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
1079
1080 HTML_DYNAMIC_SECTIONS  = NO
1081
1082 # If the GENERATE_DOCSET tag is set to YES, additional index files
1083 # will be generated that can be used as input for Apple's Xcode 3
1084 # integrated development environment, introduced with OSX 10.5 (Leopard).
1085 # To create a documentation set, doxygen will generate a Makefile in the
1086 # HTML output directory. Running make will produce the docset in that
1087 # directory and running "make install" will install the docset in
1088 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1089 # it at startup.
1090 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1091 # for more information.
1092
1093 GENERATE_DOCSET        = NO
1094
1095 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1096 # feed. A documentation feed provides an umbrella under which multiple
1097 # documentation sets from a single provider (such as a company or product suite)
1098 # can be grouped.
1099
1100 DOCSET_FEEDNAME        = "Doxygen generated docs"
1101
1102 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1103 # should uniquely identify the documentation set bundle. This should be a
1104 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1105 # will append .docset to the name.
1106
1107 DOCSET_BUNDLE_ID       = org.gnu.libstdc++
1108
1109 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1110 # the documentation publisher. This should be a reverse domain-name style
1111 # string, e.g. com.mycompany.MyDocSet.documentation.
1112
1113 DOCSET_PUBLISHER_ID    = org.fsf
1114
1115 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1116
1117 DOCSET_PUBLISHER_NAME  = libstdc++
1118
1119 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
1120 # will be generated that can be used as input for tools like the
1121 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1122 # of the generated HTML documentation.
1123
1124 GENERATE_HTMLHELP      = NO
1125
1126 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1127 # be used to specify the file name of the resulting .chm file. You
1128 # can add a path in front of the file if the result should not be
1129 # written to the html output directory.
1130
1131 CHM_FILE               =
1132
1133 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1134 # be used to specify the location (absolute path including file name) of
1135 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1136 # the HTML help compiler on the generated index.hhp.
1137
1138 HHC_LOCATION           =
1139
1140 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1141 # controls if a separate .chi index file is generated (YES) or that
1142 # it should be included in the master .chm file (NO).
1143
1144 GENERATE_CHI           = NO
1145
1146 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1147 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
1148 # content.
1149
1150 CHM_INDEX_ENCODING     =
1151
1152 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1153 # controls whether a binary table of contents is generated (YES) or a
1154 # normal table of contents (NO) in the .chm file.
1155
1156 BINARY_TOC             = NO
1157
1158 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1159 # to the contents of the HTML help documentation and to the tree view.
1160
1161 TOC_EXPAND             = NO
1162
1163 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1164 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1165 # that can be used as input for Qt's qhelpgenerator to generate a
1166 # Qt Compressed Help (.qch) of the generated HTML documentation.
1167
1168 GENERATE_QHP           = NO
1169
1170 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1171 # be used to specify the file name of the resulting .qch file.
1172 # The path specified is relative to the HTML output folder.
1173
1174 QCH_FILE               =
1175
1176 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1177 # Qt Help Project output. For more information please see
1178 # http://doc.trolltech.com/qthelpproject.html#namespace
1179
1180 QHP_NAMESPACE          = org.doxygen.Project
1181
1182 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1183 # Qt Help Project output. For more information please see
1184 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1185
1186 QHP_VIRTUAL_FOLDER     = doc
1187
1188 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1189 # add. For more information please see
1190 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1191
1192 QHP_CUST_FILTER_NAME   =
1193
1194 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1195 # custom filter to add. For more information please see
1196 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1197 # Qt Help Project / Custom Filters</a>.
1198
1199 QHP_CUST_FILTER_ATTRS  =
1200
1201 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1202 # project's
1203 # filter section matches.
1204 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1205 # Qt Help Project / Filter Attributes</a>.
1206
1207 QHP_SECT_FILTER_ATTRS  =
1208
1209 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1210 # be used to specify the location of Qt's qhelpgenerator.
1211 # If non-empty doxygen will try to run qhelpgenerator on the generated
1212 # .qhp file.
1213
1214 QHG_LOCATION           =
1215
1216 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1217 #  will be generated, which together with the HTML files, form an Eclipse help
1218 # plugin. To install this plugin and make it available under the help contents
1219 # menu in Eclipse, the contents of the directory containing the HTML and XML
1220 # files needs to be copied into the plugins directory of eclipse. The name of
1221 # the directory within the plugins directory should be the same as
1222 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1223 # the help appears.
1224
1225 GENERATE_ECLIPSEHELP   = NO
1226
1227 # A unique identifier for the eclipse help plugin. When installing the plugin
1228 # the directory name containing the HTML and XML files should also have
1229 # this name.
1230
1231 ECLIPSE_DOC_ID         = org.doxygen.Project
1232
1233 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1234 # top of each HTML page. The value NO (the default) enables the index and
1235 # the value YES disables it.
1236
1237 DISABLE_INDEX          = YES
1238
1239 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1240 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1241 # documentation. Note that a value of 0 will completely suppress the enum
1242 # values from appearing in the overview section.
1243
1244 ENUM_VALUES_PER_LINE   = 4
1245
1246 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1247 # structure should be generated to display hierarchical information.
1248 # If the tag value is set to YES, a side panel will be generated
1249 # containing a tree-like index structure (just like the one that
1250 # is generated for HTML Help). For this to work a browser that supports
1251 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1252 # Windows users are probably better off using the HTML help feature.
1253
1254 GENERATE_TREEVIEW      = YES
1255
1256 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1257 # and Class Hierarchy pages using a tree view instead of an ordered list.
1258
1259 USE_INLINE_TREES       = NO
1260
1261 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1262 # used to set the initial width (in pixels) of the frame in which the tree
1263 # is shown.
1264
1265 TREEVIEW_WIDTH         = 250
1266
1267 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1268 # links to external symbols imported via tag files in a separate window.
1269
1270 EXT_LINKS_IN_WINDOW    = NO
1271
1272 # Use this tag to change the font size of Latex formulas included
1273 # as images in the HTML documentation. The default is 10. Note that
1274 # when you change the font size after a successful doxygen run you need
1275 # to manually remove any form_*.png images from the HTML output directory
1276 # to force them to be regenerated.
1277
1278 FORMULA_FONTSIZE       = 10
1279
1280 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1281 # generated for formulas are transparent PNGs. Transparent PNGs are
1282 # not supported properly for IE 6.0, but are supported on all modern browsers.
1283 # Note that when changing this option you need to delete any form_*.png files
1284 # in the HTML output before the changes have effect.
1285
1286 FORMULA_TRANSPARENT    = YES
1287
1288 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1289 # (see http://www.mathjax.org) which uses client side Javascript for the
1290 # rendering instead of using prerendered bitmaps. Use this if you do not
1291 # have LaTeX installed or if you want to formulas look prettier in the HTML
1292 # output. When enabled you also need to install MathJax separately and
1293 # configure the path to it using the MATHJAX_RELPATH option.
1294
1295 USE_MATHJAX            = NO
1296
1297 # When MathJax is enabled you need to specify the location relative to the
1298 # HTML output directory using the MATHJAX_RELPATH option. The destination
1299 # directory should contain the MathJax.js script. For instance, if the mathjax
1300 # directory is located at the same level as the HTML output directory, then
1301 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1302 # mathjax.org site, so you can quickly see the result without installing
1303 # MathJax, but it is strongly recommended to install a local copy of MathJax
1304 # before deployment.
1305
1306 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1307
1308 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1309 # for the HTML output. The underlying search engine uses javascript
1310 # and DHTML and should work on any modern browser. Note that when using
1311 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1312 # (GENERATE_DOCSET) there is already a search function so this one should
1313 # typically be disabled. For large projects the javascript based search engine
1314 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1315
1316 SEARCHENGINE           = NO
1317
1318 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1319 # implemented using a PHP enabled web server instead of at the web client
1320 # using Javascript. Doxygen will generate the search PHP script and index
1321 # file to put on the web server. The advantage of the server
1322 # based approach is that it scales better to large projects and allows
1323 # full text search. The disadvantages are that it is more difficult to setup
1324 # and does not have live searching capabilities.
1325
1326 SERVER_BASED_SEARCH    = NO
1327
1328 #---------------------------------------------------------------------------
1329 # configuration options related to the LaTeX output
1330 #---------------------------------------------------------------------------
1331
1332 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1333 # generate Latex output.
1334
1335 GENERATE_LATEX         = @do_latex@
1336
1337 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1338 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1339 # put in front of it. If left blank `latex' will be used as the default path.
1340
1341 LATEX_OUTPUT           = latex
1342
1343 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1344 # invoked. If left blank `latex' will be used as the default command name.
1345 # Note that when enabling USE_PDFLATEX this option is only used for
1346 # generating bitmaps for formulas in the HTML output, but not in the
1347 # Makefile that is written to the output directory.
1348
1349 LATEX_CMD_NAME         = latex
1350
1351 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1352 # generate index for LaTeX. If left blank `makeindex' will be used as the
1353 # default command name.
1354
1355 MAKEINDEX_CMD_NAME     = makeindex
1356
1357 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1358 # LaTeX documents. This may be useful for small projects and may help to
1359 # save some trees in general.
1360
1361 COMPACT_LATEX          = YES
1362
1363 # The PAPER_TYPE tag can be used to set the paper type that is used
1364 # by the printer. Possible values are: a4, letter, legal and
1365 # executive. If left blank a4wide will be used.
1366
1367 PAPER_TYPE             = letter
1368
1369 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1370 # packages that should be included in the LaTeX output.
1371
1372 EXTRA_PACKAGES         = amsmath
1373
1374 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1375 # the generated latex document. The header should contain everything until
1376 # the first chapter. If it is left blank doxygen will generate a
1377 # standard header. Notice: only use this tag if you know what you are doing!
1378
1379 LATEX_HEADER           =
1380
1381 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1382 # the generated latex document. The footer should contain everything after
1383 # the last chapter. If it is left blank doxygen will generate a
1384 # standard footer. Notice: only use this tag if you know what you are doing!
1385
1386 LATEX_FOOTER           =
1387
1388 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1389 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1390 # contain links (just like the HTML output) instead of page references
1391 # This makes the output suitable for online browsing using a pdf viewer.
1392
1393 PDF_HYPERLINKS         = NO
1394
1395 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1396 # plain latex in the generated Makefile. Set this option to YES to get a
1397 # higher quality PDF documentation.
1398
1399 USE_PDFLATEX           = YES
1400
1401 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1402 # command to the generated LaTeX files. This will instruct LaTeX to keep
1403 # running if errors occur, instead of asking the user for help.
1404 # This option is also used when generating formulas in HTML.
1405
1406 LATEX_BATCHMODE        = YES
1407
1408 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1409 # include the index chapters (such as File Index, Compound Index, etc.)
1410 # in the output.
1411
1412 LATEX_HIDE_INDICES     = YES
1413
1414 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1415 # source code with syntax highlighting in the LaTeX output.
1416 # Note that which sources are shown also depends on other settings
1417 # such as SOURCE_BROWSER.
1418
1419 LATEX_SOURCE_CODE      = NO
1420
1421 #---------------------------------------------------------------------------
1422 # configuration options related to the RTF output
1423 #---------------------------------------------------------------------------
1424
1425 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1426 # The RTF output is optimized for Word 97 and may not look very pretty with
1427 # other RTF readers or editors.
1428
1429 GENERATE_RTF           = NO
1430
1431 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1432 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1433 # put in front of it. If left blank `rtf' will be used as the default path.
1434
1435 RTF_OUTPUT             = rtf
1436
1437 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1438 # RTF documents. This may be useful for small projects and may help to
1439 # save some trees in general.
1440
1441 COMPACT_RTF            = NO
1442
1443 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1444 # will contain hyperlink fields. The RTF file will
1445 # contain links (just like the HTML output) instead of page references.
1446 # This makes the output suitable for online browsing using WORD or other
1447 # programs which support those fields.
1448 # Note: wordpad (write) and others do not support links.
1449
1450 RTF_HYPERLINKS         = NO
1451
1452 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1453 # config file, i.e. a series of assignments. You only have to provide
1454 # replacements, missing definitions are set to their default value.
1455
1456 RTF_STYLESHEET_FILE    =
1457
1458 # Set optional variables used in the generation of an rtf document.
1459 # Syntax is similar to doxygen's config file.
1460
1461 RTF_EXTENSIONS_FILE    =
1462
1463 #---------------------------------------------------------------------------
1464 # configuration options related to the man page output
1465 #---------------------------------------------------------------------------
1466
1467 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1468 # generate man pages
1469
1470 GENERATE_MAN           = @do_man@
1471
1472 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1473 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1474 # put in front of it. If left blank `man' will be used as the default path.
1475
1476 MAN_OUTPUT             = man
1477
1478 # The MAN_EXTENSION tag determines the extension that is added to
1479 # the generated man pages (default is the subroutine's section .3)
1480
1481 MAN_EXTENSION          = .3
1482
1483 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1484 # then it will generate one additional man file for each entity
1485 # documented in the real man page(s). These additional files
1486 # only source the real man page, but without them the man command
1487 # would be unable to find the correct page. The default is NO.
1488
1489 MAN_LINKS              = NO
1490
1491 #---------------------------------------------------------------------------
1492 # configuration options related to the XML output
1493 #---------------------------------------------------------------------------
1494
1495 # If the GENERATE_XML tag is set to YES Doxygen will
1496 # generate an XML file that captures the structure of
1497 # the code including all documentation.
1498
1499 GENERATE_XML           = @do_xml@
1500
1501 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1502 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1503 # put in front of it. If left blank `xml' will be used as the default path.
1504
1505 XML_OUTPUT             = xml
1506
1507 # The XML_SCHEMA tag can be used to specify an XML schema,
1508 # which can be used by a validating XML parser to check the
1509 # syntax of the XML files.
1510
1511 XML_SCHEMA             =
1512
1513 # The XML_DTD tag can be used to specify an XML DTD,
1514 # which can be used by a validating XML parser to check the
1515 # syntax of the XML files.
1516
1517 XML_DTD                =
1518
1519 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1520 # dump the program listings (including syntax highlighting
1521 # and cross-referencing information) to the XML output. Note that
1522 # enabling this will significantly increase the size of the XML output.
1523
1524 XML_PROGRAMLISTING     = NO
1525
1526 #---------------------------------------------------------------------------
1527 # configuration options for the AutoGen Definitions output
1528 #---------------------------------------------------------------------------
1529
1530 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1531 # generate an AutoGen Definitions (see autogen.sf.net) file
1532 # that captures the structure of the code including all
1533 # documentation. Note that this feature is still experimental
1534 # and incomplete at the moment.
1535
1536 GENERATE_AUTOGEN_DEF   = NO
1537
1538 #---------------------------------------------------------------------------
1539 # configuration options related to the Perl module output
1540 #---------------------------------------------------------------------------
1541
1542 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1543 # generate a Perl module file that captures the structure of
1544 # the code including all documentation. Note that this
1545 # feature is still experimental and incomplete at the
1546 # moment.
1547
1548 GENERATE_PERLMOD       = NO
1549
1550 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1551 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1552 # to generate PDF and DVI output from the Perl module output.
1553
1554 PERLMOD_LATEX          = NO
1555
1556 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1557 # nicely formatted so it can be parsed by a human reader.
1558 # This is useful
1559 # if you want to understand what is going on.
1560 # On the other hand, if this
1561 # tag is set to NO the size of the Perl module output will be much smaller
1562 # and Perl will parse it just the same.
1563
1564 PERLMOD_PRETTY         = YES
1565
1566 # The names of the make variables in the generated doxyrules.make file
1567 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1568 # This is useful so different doxyrules.make files included by the same
1569 # Makefile don't overwrite each other's variables.
1570
1571 PERLMOD_MAKEVAR_PREFIX =
1572
1573 #---------------------------------------------------------------------------
1574 # Configuration options related to the preprocessor
1575 #---------------------------------------------------------------------------
1576
1577 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1578 # evaluate all C-preprocessor directives found in the sources and include
1579 # files.
1580
1581 ENABLE_PREPROCESSING   = YES
1582
1583 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1584 # names in the source code. If set to NO (the default) only conditional
1585 # compilation will be performed. Macro expansion can be done in a controlled
1586 # way by setting EXPAND_ONLY_PREDEF to YES.
1587
1588 MACRO_EXPANSION        = YES
1589
1590 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1591 # then the macro expansion is limited to the macros specified with the
1592 # PREDEFINED and EXPAND_AS_DEFINED tags.
1593
1594 EXPAND_ONLY_PREDEF     = NO
1595
1596 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1597 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1598
1599 SEARCH_INCLUDES        = YES
1600
1601 # The INCLUDE_PATH tag can be used to specify one or more directories that
1602 # contain include files that are not input files but should be processed by
1603 # the preprocessor.
1604
1605 INCLUDE_PATH           = include
1606
1607 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1608 # patterns (like *.h and *.hpp) to filter out the header-files in the
1609 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1610 # be used.
1611
1612 INCLUDE_FILE_PATTERNS  =
1613
1614 # The PREDEFINED tag can be used to specify one or more macro names that
1615 # are defined before the preprocessor is started (similar to the -D option of
1616 # gcc). The argument of the tag is a list of macros of the form: name
1617 # or name=definition (no spaces). If the definition and the = are
1618 # omitted =1 is assumed. To prevent a macro definition from being
1619 # undefined via #undef or recursively expanded use the := operator
1620 # instead of the = operator.
1621
1622 PREDEFINED             = __cplusplus \
1623                          __GTHREADS \
1624                          _GLIBCXX_HAS_GTHREADS \
1625                          __GXX_EXPERIMENTAL_CXX0X__ \
1626                          _GLIBCXX_INCLUDE_AS_CXX0X \
1627                          "_GLIBCXX_PURE= " \
1628                          "_GLIBCXX_CONST= " \
1629                          "_GLIBCXX_NORETURN= " \
1630                          "_GLIBCXX_NOTHROW= " \
1631                          "_GLIBCXX_STD_C= " \
1632                          "_GLIBCXX_STD_A= " \
1633                          "_GLIBCXX_VISIBILITY(V)= " \
1634                          "_GLIBCXX_BEGIN_NAMESPACE_VERSION= " \
1635                          "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \
1636                          "_GLIBCXX_BEGIN_NAMESPACE_CONTAINER= " \
1637                          "_GLIBCXX_BEGIN_NAMESPACE_LDBL= " \
1638                          "_GLIBCXX_END_NAMESPACE_VERSION= " \
1639                          "_GLIBCXX_END_NAMESPACE_ALGO= " \
1640                          "_GLIBCXX_END_NAMESPACE_CONTAINER= " \
1641                          "_GLIBCXX_END_NAMESPACE_LDBL= " \
1642                          "_GLIBCXX_TEMPLATE_ARGS=...  " \
1643                          _GLIBCXX_DEPRECATED \
1644                          _GLIBCXX_CONSTEXPR=constexpr \
1645                          _GLIBCXX_USE_CONSTEXPR=constexpr \
1646                          _GLIBCXX_USE_WCHAR_T \
1647                          _GLIBCXX_USE_LONG_LONG \
1648                          _GLIBCXX_USE_C99_STDINT_TR1 \
1649                          _GLIBCXX_USE_SCHED_YIELD \
1650                          _GLIBCXX_USE_NANOSLEEP \
1651                          __EXCEPTIONS \
1652                          __GXX_RTTI \
1653                          ATOMIC_INT_LOCK_FREE \
1654                          PB_DS_DATA_TRUE_INDICATOR \
1655                          __glibcxx_function_requires=// \
1656                          __glibcxx_class_requires=// \
1657                          __glibcxx_class_requires2=// \
1658                          __glibcxx_class_requires3=// \
1659                          __glibcxx_class_requires4=//
1660
1661 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1662 # this tag can be used to specify a list of macro names that should be expanded.
1663 # The macro definition that is found in the sources will be used.
1664 # Use the PREDEFINED tag if you want to use a different macro definition that
1665 # overrules the definition found in the source code.
1666
1667 EXPAND_AS_DEFINED      =
1668
1669 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1670 # doxygen's preprocessor will remove all references to function-like macros
1671 # that are alone on a line, have an all uppercase name, and do not end with a
1672 # semicolon, because these will confuse the parser if not removed.
1673
1674 SKIP_FUNCTION_MACROS   = YES
1675
1676 #---------------------------------------------------------------------------
1677 # Configuration::additions related to external references
1678 #---------------------------------------------------------------------------
1679
1680 # The TAGFILES option can be used to specify one or more tagfiles.
1681 # Optionally an initial location of the external documentation
1682 # can be added for each tagfile. The format of a tag file without
1683 # this location is as follows:
1684 #
1685 # TAGFILES = file1 file2 ...
1686 # Adding location for the tag files is done as follows:
1687 #
1688 # TAGFILES = file1=loc1 "file2 = loc2" ...
1689 # where "loc1" and "loc2" can be relative or absolute paths or
1690 # URLs. If a location is present for each tag, the installdox tool
1691 # does not have to be run to correct the links.
1692 # Note that each tag file must have a unique name
1693 # (where the name does NOT include the path)
1694 # If a tag file is not located in the directory in which doxygen
1695 # is run, you must also specify the path to the tagfile here.
1696
1697 TAGFILES               =
1698
1699 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1700 # a tag file that is based on the input files it reads.
1701
1702 GENERATE_TAGFILE       = @generate_tagfile@
1703
1704 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1705 # in the class index. If set to NO only the inherited external classes
1706 # will be listed.
1707
1708 ALLEXTERNALS           = YES
1709
1710 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1711 # in the modules index. If set to NO, only the current project's groups will
1712 # be listed.
1713
1714 EXTERNAL_GROUPS        = YES
1715
1716 # The PERL_PATH should be the absolute path and name of the perl script
1717 # interpreter (i.e. the result of `which perl').
1718
1719 PERL_PATH              = /usr/bin/perl
1720
1721 #---------------------------------------------------------------------------
1722 # Configuration options related to the dot tool
1723 #---------------------------------------------------------------------------
1724
1725 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1726 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1727 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1728 # this option also works with HAVE_DOT disabled, but it is recommended to
1729 # install and use dot, since it yields more powerful graphs.
1730
1731 CLASS_DIAGRAMS         = YES
1732
1733 # You can define message sequence charts within doxygen comments using the \msc
1734 # command. Doxygen will then run the mscgen tool (see
1735 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1736 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1737 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1738 # default search path.
1739
1740 MSCGEN_PATH            =
1741
1742 # If set to YES, the inheritance and collaboration graphs will hide
1743 # inheritance and usage relations if the target is undocumented
1744 # or is not a class.
1745
1746 HIDE_UNDOC_RELATIONS   = NO
1747
1748 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1749 # available from the path. This tool is part of Graphviz, a graph visualization
1750 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1751 # have no effect if this option is set to NO (the default)
1752
1753 HAVE_DOT               = YES
1754
1755 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1756 # allowed to run in parallel. When set to 0 (the default) doxygen will
1757 # base this on the number of processors available in the system. You can set it
1758 # explicitly to a value larger than 0 to get control over the balance
1759 # between CPU load and processing speed.
1760
1761 DOT_NUM_THREADS        = 0
1762
1763 # By default doxygen will write a font called Helvetica to the output
1764 # directory and reference it in all dot files that doxygen generates.
1765 # When you want a differently looking font you can specify the font name
1766 # using DOT_FONTNAME. You need to make sure dot is able to find the font,
1767 # which can be done by putting it in a standard location or by setting the
1768 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1769 # containing the font.
1770
1771 DOT_FONTNAME           = FreeSans
1772
1773 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1774 # The default size is 10pt.
1775
1776 DOT_FONTSIZE           = 9
1777
1778 # By default doxygen will tell dot to use the output directory to look for the
1779 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1780 # different font using DOT_FONTNAME you can set the path where dot
1781 # can find it using this tag.
1782
1783 DOT_FONTPATH           =
1784
1785 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1786 # will generate a graph for each documented class showing the direct and
1787 # indirect inheritance relations. Setting this tag to YES will force the
1788 # the CLASS_DIAGRAMS tag to NO.
1789
1790 CLASS_GRAPH            = YES
1791
1792 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1793 # will generate a graph for each documented class showing the direct and
1794 # indirect implementation dependencies (inheritance, containment, and
1795 # class references variables) of the class with other documented classes.
1796
1797 COLLABORATION_GRAPH    = NO
1798
1799 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1800 # will generate a graph for groups, showing the direct groups dependencies
1801
1802 GROUP_GRAPHS           = YES
1803
1804 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1805 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1806 # Language.
1807
1808 UML_LOOK               = NO
1809
1810 # If set to YES, the inheritance and collaboration graphs will show the
1811 # relations between templates and their instances.
1812
1813 TEMPLATE_RELATIONS     = YES
1814
1815 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1816 # tags are set to YES then doxygen will generate a graph for each documented
1817 # file showing the direct and indirect include dependencies of the file with
1818 # other documented files.
1819
1820 INCLUDE_GRAPH          = NO
1821
1822 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1823 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1824 # documented header file showing the documented files that directly or
1825 # indirectly include this file.
1826
1827 INCLUDED_BY_GRAPH      = NO
1828
1829 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1830 # doxygen will generate a call dependency graph for every global function
1831 # or class method. Note that enabling this option will significantly increase
1832 # the time of a run. So in most cases it will be better to enable call graphs
1833 # for selected functions only using the \callgraph command.
1834
1835 CALL_GRAPH             = NO
1836
1837 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1838 # doxygen will generate a caller dependency graph for every global function
1839 # or class method. Note that enabling this option will significantly increase
1840 # the time of a run. So in most cases it will be better to enable caller
1841 # graphs for selected functions only using the \callergraph command.
1842
1843 CALLER_GRAPH           = NO
1844
1845 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1846 # will generate a graphical hierarchy of all classes instead of a textual one.
1847
1848 GRAPHICAL_HIERARCHY    = YES
1849
1850 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1851 # then doxygen will show the dependencies a directory has on other directories
1852 # in a graphical way. The dependency relations are determined by the #include
1853 # relations between the files in the directories.
1854
1855 DIRECTORY_GRAPH        = YES
1856
1857 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1858 # generated by dot. Possible values are svg, png, jpg, or gif.
1859 # If left blank png will be used.
1860
1861 DOT_IMAGE_FORMAT       = png
1862
1863 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1864 # found. If left blank, it is assumed the dot tool can be found in the path.
1865
1866 DOT_PATH               =
1867
1868 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1869 # contain dot files that are included in the documentation (see the
1870 # \dotfile command).
1871
1872 DOTFILE_DIRS           =
1873
1874 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1875 # contain msc files that are included in the documentation (see the
1876 # \mscfile command).
1877
1878 MSCFILE_DIRS           =
1879
1880 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1881 # nodes that will be shown in the graph. If the number of nodes in a graph
1882 # becomes larger than this value, doxygen will truncate the graph, which is
1883 # visualized by representing a node as a red box. Note that doxygen if the
1884 # number of direct children of the root node in a graph is already larger than
1885 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1886 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1887
1888 DOT_GRAPH_MAX_NODES    = 50
1889
1890 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1891 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1892 # from the root by following a path via at most 3 edges will be shown. Nodes
1893 # that lay further from the root node will be omitted. Note that setting this
1894 # option to 1 or 2 may greatly reduce the computation time needed for large
1895 # code bases. Also note that the size of a graph can be further restricted by
1896 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1897
1898 MAX_DOT_GRAPH_DEPTH    = 0
1899
1900 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1901 # background. This is disabled by default, because dot on Windows does not
1902 # seem to support this out of the box. Warning: Depending on the platform used,
1903 # enabling this option may lead to badly anti-aliased labels on the edges of
1904 # a graph (i.e. they become hard to read).
1905
1906 DOT_TRANSPARENT        = NO
1907
1908 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1909 # files in one run (i.e. multiple -o and -T options on the command line). This
1910 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1911 # support this, this feature is disabled by default.
1912
1913 DOT_MULTI_TARGETS      = YES
1914
1915 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1916 # generate a legend page explaining the meaning of the various boxes and
1917 # arrows in the dot generated graphs.
1918
1919 GENERATE_LEGEND        = YES
1920
1921 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1922 # remove the intermediate dot files that are used to generate
1923 # the various graphs.
1924
1925 DOT_CLEANUP            = YES