OSDN Git Service

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