apidoc: Update Doxyfile
[strongswan.git] / Doxyfile.in
1 # Doxyfile 1.8.11
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 double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
8 #
9 # All text after a single hash (#) is considered a comment and will be ignored.
10 # The format is:
11 # TAG = value [value, ...]
12 # For lists, items can also be appended using:
13 # TAG += value [value, ...]
14 # Values that contain spaces should be placed between quotes (\" \").
15
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
19
20 # This tag specifies the encoding used for all characters in the config file
21 # that follow. The default is UTF-8 which is also the encoding used for all text
22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24 # for the list of possible encodings.
25 # The default value is: UTF-8.
26
27 DOXYFILE_ENCODING      = UTF-8
28
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
32 # title of most generated pages and in a few other places.
33 # The default value is: My Project.
34
35 PROJECT_NAME           = "@PACKAGE_NAME@"
36
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
39 # control system is used.
40
41 PROJECT_NUMBER         = "@PACKAGE_VERSION@"
42
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 # for a project that appears at the top of each page and should give viewer a
45 # quick idea about the purpose of the project. Keep the description short.
46
47 PROJECT_BRIEF          =
48
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50 # in the documentation. The maximum height of the logo should not exceed 55
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52 # the logo to the output directory.
53
54 PROJECT_LOGO           =
55
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
60
61 OUTPUT_DIRECTORY       = apidoc
62
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64 # directories (in 2 levels) under the output directory of each output format and
65 # will distribute the generated files over these directories. Enabling this
66 # option can be useful when feeding doxygen a huge amount of source files, where
67 # putting all generated files in the same directory would otherwise causes
68 # performance problems for the file system.
69 # The default value is: NO.
70
71 CREATE_SUBDIRS         = NO
72
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76 # U+3044.
77 # The default value is: NO.
78
79 ALLOW_UNICODE_NAMES    = NO
80
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82 # documentation generated by doxygen is written. Doxygen will use this
83 # information to generate all constant output in the proper language.
84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91 # Ukrainian and Vietnamese.
92 # The default value is: English.
93
94 OUTPUT_LANGUAGE        = English
95
96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97 # descriptions after the members that are listed in the file and class
98 # documentation (similar to Javadoc). Set to NO to disable this.
99 # The default value is: YES.
100
101 BRIEF_MEMBER_DESC      = YES
102
103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104 # description of a member or function before the detailed description
105 #
106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107 # brief descriptions will be completely suppressed.
108 # The default value is: YES.
109
110 REPEAT_BRIEF           = YES
111
112 # This tag implements a quasi-intelligent brief description abbreviator that is
113 # used to form the text in various listings. Each string in this list, if found
114 # as the leading text of the brief description, will be stripped from the text
115 # and the result, after processing the whole list, is used as the annotated
116 # text. Otherwise, the brief description is used as-is. If left blank, the
117 # following values are used ($name is automatically replaced with the name of
118 # the entity):The $name class, The $name widget, The $name file, is, provides,
119 # specifies, contains, represents, a, an and the.
120
121 ABBREVIATE_BRIEF       =
122
123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124 # doxygen will generate a detailed section even if there is only a brief
125 # description.
126 # The default value is: NO.
127
128 ALWAYS_DETAILED_SEC    = NO
129
130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131 # inherited members of a class in the documentation of that class as if those
132 # members were ordinary class members. Constructors, destructors and assignment
133 # operators of the base classes will not be shown.
134 # The default value is: NO.
135
136 INLINE_INHERITED_MEMB  = NO
137
138 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
139 # before files name in the file list and in the header files. If set to NO the
140 # shortest path that makes the file name unique will be used
141 # The default value is: YES.
142
143 FULL_PATH_NAMES        = YES
144
145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146 # Stripping is only done if one of the specified strings matches the left-hand
147 # part of the path. The tag can be used to show relative paths in the file list.
148 # If left blank the directory from which doxygen is run is used as the path to
149 # strip.
150 #
151 # Note that you can specify absolute paths here, but also relative paths, which
152 # will be relative from the directory where doxygen is started.
153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
155 STRIP_FROM_PATH        =
156
157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158 # path mentioned in the documentation of a class, which tells the reader which
159 # header file to include in order to use a class. If left blank only the name of
160 # the header file containing the class definition is used. Otherwise one should
161 # specify the list of include paths that are normally passed to the compiler
162 # using the -I flag.
163
164 STRIP_FROM_INC_PATH    =
165
166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167 # less readable) file names. This can be useful is your file systems doesn't
168 # support long names like on DOS, Mac, or CD-ROM.
169 # The default value is: NO.
170
171 SHORT_NAMES            = NO
172
173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174 # first line (until the first dot) of a Javadoc-style comment as the brief
175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
176 # style comments (thus requiring an explicit @brief command for a brief
177 # description.)
178 # The default value is: NO.
179
180 JAVADOC_AUTOBRIEF      = YES
181
182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183 # line (until the first dot) of a Qt-style comment as the brief description. If
184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185 # requiring an explicit \brief command for a brief description.)
186 # The default value is: NO.
187
188 QT_AUTOBRIEF           = NO
189
190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192 # a brief description. This used to be the default behavior. The new default is
193 # to treat a multi-line C++ comment block as a detailed description. Set this
194 # tag to YES if you prefer the old behavior instead.
195 #
196 # Note that setting this tag to YES also means that rational rose comments are
197 # not recognized any more.
198 # The default value is: NO.
199
200 MULTILINE_CPP_IS_BRIEF = NO
201
202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203 # documentation from any documented member that it re-implements.
204 # The default value is: YES.
205
206 INHERIT_DOCS           = YES
207
208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209 # page for each member. If set to NO, the documentation of a member will be part
210 # of the file/class/namespace that contains it.
211 # The default value is: NO.
212
213 SEPARATE_MEMBER_PAGES  = NO
214
215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216 # uses this value to replace tabs by spaces in code fragments.
217 # Minimum value: 1, maximum value: 16, default value: 4.
218
219 TAB_SIZE               = 4
220
221 # This tag can be used to specify a number of aliases that act as commands in
222 # the documentation. An alias has the form:
223 # name=value
224 # For example adding
225 # "sideeffect=@par Side Effects:\n"
226 # will allow you to put the command \sideeffect (or @sideeffect) in the
227 # documentation, which will result in a user-defined paragraph with heading
228 # "Side Effects:". You can put \n's in the value part of an alias to insert
229 # newlines.
230
231 ALIASES                =
232
233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
234 # A mapping has the form "name=value". For example adding "class=itcl::class"
235 # will allow you to use the command class in the itcl::class meaning.
236
237 TCL_SUBST              =
238
239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240 # only. Doxygen will then generate output that is more tailored for C. For
241 # instance, some of the names that are used will be different. The list of all
242 # members will be omitted, etc.
243 # The default value is: NO.
244
245 OPTIMIZE_OUTPUT_FOR_C  = NO
246
247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248 # Python sources only. Doxygen will then generate output that is more tailored
249 # for that language. For instance, namespaces will be presented as packages,
250 # qualified scopes will look different, etc.
251 # The default value is: NO.
252
253 OPTIMIZE_OUTPUT_JAVA   = NO
254
255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256 # sources. Doxygen will then generate output that is tailored for Fortran.
257 # The default value is: NO.
258
259 OPTIMIZE_FOR_FORTRAN   = NO
260
261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262 # sources. Doxygen will then generate output that is tailored for VHDL.
263 # The default value is: NO.
264
265 OPTIMIZE_OUTPUT_VHDL   = NO
266
267 # Doxygen selects the parser to use depending on the extension of the files it
268 # parses. With this tag you can assign which parser to use for a given
269 # extension. Doxygen has a built-in mapping, but you can override or extend it
270 # using this tag. The format is ext=language, where ext is a file extension, and
271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274 # Fortran. In the later case the parser tries to guess whether the code is fixed
275 # or free formatted code, this is the default for Fortran type files), VHDL. For
276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
278 #
279 # Note: For files without extension you can use no_extension as a placeholder.
280 #
281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282 # the files are not read by doxygen.
283
284 EXTENSION_MAPPING      =
285
286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287 # according to the Markdown format, which allows for more readable
288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
289 # The output of markdown processing is further processed by doxygen, so you can
290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291 # case of backward compatibilities issues.
292 # The default value is: YES.
293
294 MARKDOWN_SUPPORT       = YES
295
296 # When enabled doxygen tries to link words that correspond to documented
297 # classes, or namespaces to their corresponding documentation. Such a link can
298 # be prevented in individual cases by putting a % sign in front of the word or
299 # globally by setting AUTOLINK_SUPPORT to NO.
300 # The default value is: YES.
301
302 AUTOLINK_SUPPORT       = YES
303
304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305 # to include (a tag file for) the STL sources as input, then you should set this
306 # tag to YES in order to let doxygen match functions declarations and
307 # definitions whose arguments contain STL classes (e.g. func(std::string);
308 # versus func(std::string) {}). This also make the inheritance and collaboration
309 # diagrams that involve STL classes more complete and accurate.
310 # The default value is: NO.
311
312 BUILTIN_STL_SUPPORT    = NO
313
314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
315 # enable parsing support.
316 # The default value is: NO.
317
318 CPP_CLI_SUPPORT        = NO
319
320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322 # will parse them like normal C++ but will assume all classes use public instead
323 # of private inheritance when no explicit protection keyword is present.
324 # The default value is: NO.
325
326 SIP_SUPPORT            = NO
327
328 # For Microsoft's IDL there are propget and propput attributes to indicate
329 # getter and setter methods for a property. Setting this option to YES will make
330 # doxygen to replace the get and set methods by a property in the documentation.
331 # This will only work if the methods are indeed getting or setting a simple
332 # type. If this is not the case, or you want to show the methods anyway, you
333 # should set this option to NO.
334 # The default value is: YES.
335
336 IDL_PROPERTY_SUPPORT   = YES
337
338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339 # tag is set to YES then doxygen will reuse the documentation of the first
340 # member in the group (if any) for the other members of the group. By default
341 # all members of a group must be documented explicitly.
342 # The default value is: NO.
343
344 DISTRIBUTE_GROUP_DOC   = NO
345
346 # If one adds a struct or class to a group and this option is enabled, then also
347 # any nested class or struct is added to the same group. By default this option
348 # is disabled and one has to add nested compounds explicitly via \ingroup.
349 # The default value is: NO.
350
351 GROUP_NESTED_COMPOUNDS = NO
352
353 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
354 # (for instance a group of public functions) to be put as a subgroup of that
355 # type (e.g. under the Public Functions section). Set it to NO to prevent
356 # subgrouping. Alternatively, this can be done per class using the
357 # \nosubgrouping command.
358 # The default value is: YES.
359
360 SUBGROUPING            = YES
361
362 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
363 # are shown inside the group in which they are included (e.g. using \ingroup)
364 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
365 # and RTF).
366 #
367 # Note that this feature does not work in combination with
368 # SEPARATE_MEMBER_PAGES.
369 # The default value is: NO.
370
371 INLINE_GROUPED_CLASSES = NO
372
373 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
374 # with only public data fields or simple typedef fields will be shown inline in
375 # the documentation of the scope in which they are defined (i.e. file,
376 # namespace, or group documentation), provided this scope is documented. If set
377 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
378 # Man pages) or section (for LaTeX and RTF).
379 # The default value is: NO.
380
381 INLINE_SIMPLE_STRUCTS  = NO
382
383 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
384 # enum is documented as struct, union, or enum with the name of the typedef. So
385 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
386 # with name TypeT. When disabled the typedef will appear as a member of a file,
387 # namespace, or class. And the struct will be named TypeS. This can typically be
388 # useful for C code in case the coding convention dictates that all compound
389 # types are typedef'ed and only the typedef is referenced, never the tag name.
390 # The default value is: NO.
391
392 TYPEDEF_HIDES_STRUCT   = YES
393
394 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
395 # cache is used to resolve symbols given their name and scope. Since this can be
396 # an expensive process and often the same symbol appears multiple times in the
397 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
398 # doxygen will become slower. If the cache is too large, memory is wasted. The
399 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
400 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
401 # symbols. At the end of a run doxygen will report the cache usage and suggest
402 # the optimal cache size from a speed point of view.
403 # Minimum value: 0, maximum value: 9, default value: 0.
404
405 LOOKUP_CACHE_SIZE      = 0
406
407 #---------------------------------------------------------------------------
408 # Build related configuration options
409 #---------------------------------------------------------------------------
410
411 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
412 # documentation are documented, even if no documentation was available. Private
413 # class members and static file members will be hidden unless the
414 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
415 # Note: This will also disable the warnings about undocumented members that are
416 # normally produced when WARNINGS is set to YES.
417 # The default value is: NO.
418
419 EXTRACT_ALL            = NO
420
421 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
422 # be included in the documentation.
423 # The default value is: NO.
424
425 EXTRACT_PRIVATE        = NO
426
427 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
428 # scope will be included in the documentation.
429 # The default value is: NO.
430
431 EXTRACT_PACKAGE        = NO
432
433 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
434 # included in the documentation.
435 # The default value is: NO.
436
437 EXTRACT_STATIC         = YES
438
439 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
440 # locally in source files will be included in the documentation. If set to NO,
441 # only classes defined in header files are included. Does not have any effect
442 # for Java sources.
443 # The default value is: YES.
444
445 EXTRACT_LOCAL_CLASSES  = NO
446
447 # This flag is only useful for Objective-C code. If set to YES, local methods,
448 # which are defined in the implementation section but not in the interface are
449 # included in the documentation. If set to NO, only methods in the interface are
450 # included.
451 # The default value is: NO.
452
453 EXTRACT_LOCAL_METHODS  = NO
454
455 # If this flag is set to YES, the members of anonymous namespaces will be
456 # extracted and appear in the documentation as a namespace called
457 # 'anonymous_namespace{file}', where file will be replaced with the base name of
458 # the file that contains the anonymous namespace. By default anonymous namespace
459 # are hidden.
460 # The default value is: NO.
461
462 EXTRACT_ANON_NSPACES   = NO
463
464 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
465 # undocumented members inside documented classes or files. If set to NO these
466 # members will be included in the various overviews, but no documentation
467 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
468 # The default value is: NO.
469
470 HIDE_UNDOC_MEMBERS     = NO
471
472 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
473 # undocumented classes that are normally visible in the class hierarchy. If set
474 # to NO, these classes will be included in the various overviews. This option
475 # has no effect if EXTRACT_ALL is enabled.
476 # The default value is: NO.
477
478 HIDE_UNDOC_CLASSES     = NO
479
480 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
481 # (class|struct|union) declarations. If set to NO, these declarations will be
482 # included in the documentation.
483 # The default value is: NO.
484
485 HIDE_FRIEND_COMPOUNDS  = NO
486
487 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
488 # documentation blocks found inside the body of a function. If set to NO, these
489 # blocks will be appended to the function's detailed documentation block.
490 # The default value is: NO.
491
492 HIDE_IN_BODY_DOCS      = NO
493
494 # The INTERNAL_DOCS tag determines if documentation that is typed after a
495 # \internal command is included. If the tag is set to NO then the documentation
496 # will be excluded. Set it to YES to include the internal documentation.
497 # The default value is: NO.
498
499 INTERNAL_DOCS          = NO
500
501 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
502 # names in lower-case letters. If set to YES, upper-case letters are also
503 # allowed. This is useful if you have classes or files whose names only differ
504 # in case and if your file system supports case sensitive file names. Windows
505 # and Mac users are advised to set this option to NO.
506 # The default value is: system dependent.
507
508 CASE_SENSE_NAMES       = YES
509
510 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
511 # their full class and namespace scopes in the documentation. If set to YES, the
512 # scope will be hidden.
513 # The default value is: NO.
514
515 HIDE_SCOPE_NAMES       = NO
516
517 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
518 # append additional text to a page's title, such as Class Reference. If set to
519 # YES the compound reference will be hidden.
520 # The default value is: NO.
521
522 HIDE_COMPOUND_REFERENCE= NO
523
524 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
525 # the files that are included by a file in the documentation of that file.
526 # The default value is: YES.
527
528 SHOW_INCLUDE_FILES     = NO
529
530 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
531 # grouped member an include statement to the documentation, telling the reader
532 # which file to include in order to use the member.
533 # The default value is: NO.
534
535 SHOW_GROUPED_MEMB_INC  = NO
536
537 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
538 # files with double quotes in the documentation rather than with sharp brackets.
539 # The default value is: NO.
540
541 FORCE_LOCAL_INCLUDES   = NO
542
543 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
544 # documentation for inline members.
545 # The default value is: YES.
546
547 INLINE_INFO            = YES
548
549 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
550 # (detailed) documentation of file and class members alphabetically by member
551 # name. If set to NO, the members will appear in declaration order.
552 # The default value is: YES.
553
554 SORT_MEMBER_DOCS       = NO
555
556 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
557 # descriptions of file, namespace and class members alphabetically by member
558 # name. If set to NO, the members will appear in declaration order. Note that
559 # this will also influence the order of the classes in the class list.
560 # The default value is: NO.
561
562 SORT_BRIEF_DOCS        = NO
563
564 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
565 # (brief and detailed) documentation of class members so that constructors and
566 # destructors are listed first. If set to NO the constructors will appear in the
567 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
568 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
569 # member documentation.
570 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
571 # detailed member documentation.
572 # The default value is: NO.
573
574 SORT_MEMBERS_CTORS_1ST = NO
575
576 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
577 # of group names into alphabetical order. If set to NO the group names will
578 # appear in their defined order.
579 # The default value is: NO.
580
581 SORT_GROUP_NAMES       = YES
582
583 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
584 # fully-qualified names, including namespaces. If set to NO, the class list will
585 # be sorted only by class name, not including the namespace part.
586 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
587 # Note: This option applies only to the class list, not to the alphabetical
588 # list.
589 # The default value is: NO.
590
591 SORT_BY_SCOPE_NAME     = NO
592
593 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
594 # type resolution of all parameters of a function it will reject a match between
595 # the prototype and the implementation of a member function even if there is
596 # only one candidate or it is obvious which candidate to choose by doing a
597 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
598 # accept a match between prototype and implementation in such cases.
599 # The default value is: NO.
600
601 STRICT_PROTO_MATCHING  = NO
602
603 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
604 # list. This list is created by putting \todo commands in the documentation.
605 # The default value is: YES.
606
607 GENERATE_TODOLIST      = NO
608
609 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
610 # list. This list is created by putting \test commands in the documentation.
611 # The default value is: YES.
612
613 GENERATE_TESTLIST      = NO
614
615 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
616 # list. This list is created by putting \bug commands in the documentation.
617 # The default value is: YES.
618
619 GENERATE_BUGLIST       = NO
620
621 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
622 # the deprecated list. This list is created by putting \deprecated commands in
623 # the documentation.
624 # The default value is: YES.
625
626 GENERATE_DEPRECATEDLIST= NO
627
628 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
629 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
630 # ... \endcond blocks.
631
632 ENABLED_SECTIONS       =
633
634 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
635 # initial value of a variable or macro / define can have for it to appear in the
636 # documentation. If the initializer consists of more lines than specified here
637 # it will be hidden. Use a value of 0 to hide initializers completely. The
638 # appearance of the value of individual variables and macros / defines can be
639 # controlled using \showinitializer or \hideinitializer command in the
640 # documentation regardless of this setting.
641 # Minimum value: 0, maximum value: 10000, default value: 30.
642
643 MAX_INITIALIZER_LINES  = 30
644
645 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
646 # the bottom of the documentation of classes and structs. If set to YES, the
647 # list will mention the files that were used to generate the documentation.
648 # The default value is: YES.
649
650 SHOW_USED_FILES        = NO
651
652 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
653 # will remove the Files entry from the Quick Index and from the Folder Tree View
654 # (if specified).
655 # The default value is: YES.
656
657 SHOW_FILES             = YES
658
659 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
660 # page. This will remove the Namespaces entry from the Quick Index and from the
661 # Folder Tree View (if specified).
662 # The default value is: YES.
663
664 SHOW_NAMESPACES        = YES
665
666 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
667 # doxygen should invoke to get the current version for each file (typically from
668 # the version control system). Doxygen will invoke the program by executing (via
669 # popen()) the command command input-file, where command is the value of the
670 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
671 # by doxygen. Whatever the program writes to standard output is used as the file
672 # version. For an example see the documentation.
673
674 FILE_VERSION_FILTER    =
675
676 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
677 # by doxygen. The layout file controls the global structure of the generated
678 # output files in an output format independent way. To create the layout file
679 # that represents doxygen's defaults, run doxygen with the -l option. You can
680 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
681 # will be used as the name of the layout file.
682 #
683 # Note that if you run doxygen from a directory containing a file called
684 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
685 # tag is left empty.
686
687 LAYOUT_FILE            =
688
689 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
690 # the reference definitions. This must be a list of .bib files. The .bib
691 # extension is automatically appended if omitted. This requires the bibtex tool
692 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
693 # For LaTeX the style of the bibliography can be controlled using
694 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
695 # search path. See also \cite for info how to create references.
696
697 CITE_BIB_FILES         =
698
699 #---------------------------------------------------------------------------
700 # Configuration options related to warning and progress messages
701 #---------------------------------------------------------------------------
702
703 # The QUIET tag can be used to turn on/off the messages that are generated to
704 # standard output by doxygen. If QUIET is set to YES this implies that the
705 # messages are off.
706 # The default value is: NO.
707
708 QUIET                  = YES
709
710 # The WARNINGS tag can be used to turn on/off the warning messages that are
711 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
712 # this implies that the warnings are on.
713 #
714 # Tip: Turn warnings on while writing the documentation.
715 # The default value is: YES.
716
717 WARNINGS               = YES
718
719 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
720 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
721 # will automatically be disabled.
722 # The default value is: YES.
723
724 WARN_IF_UNDOCUMENTED   = NO
725
726 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
727 # potential errors in the documentation, such as not documenting some parameters
728 # in a documented function, or documenting parameters that don't exist or using
729 # markup commands wrongly.
730 # The default value is: YES.
731
732 WARN_IF_DOC_ERROR      = YES
733
734 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
735 # are documented, but have no documentation for their parameters or return
736 # value. If set to NO, doxygen will only warn about wrong or incomplete
737 # parameter documentation, but not about the absence of documentation.
738 # The default value is: NO.
739
740 WARN_NO_PARAMDOC       = YES
741
742 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
743 # a warning is encountered.
744 # The default value is: NO.
745
746 WARN_AS_ERROR          = NO
747
748 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
749 # can produce. The string should contain the $file, $line, and $text tags, which
750 # will be replaced by the file and line number from which the warning originated
751 # and the warning text. Optionally the format may contain $version, which will
752 # be replaced by the version of the file (if it could be obtained via
753 # FILE_VERSION_FILTER)
754 # The default value is: $file:$line: $text.
755
756 WARN_FORMAT            = "$file:$line: $text"
757
758 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
759 # messages should be written. If left blank the output is written to standard
760 # error (stderr).
761
762 WARN_LOGFILE           =
763
764 #---------------------------------------------------------------------------
765 # Configuration options related to the input files
766 #---------------------------------------------------------------------------
767
768 # The INPUT tag is used to specify the files and/or directories that contain
769 # documented source files. You may enter file names like myfile.cpp or
770 # directories like /usr/src/myproject. Separate the files or directories with
771 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
772 # Note: If this tag is empty the current directory is searched.
773
774 INPUT                  = @SRC_DIR@/README.md \
775                          @SRC_DIR@/README_LEGACY.md \
776                          @SRC_DIR@/src
777
778 # This tag can be used to specify the character encoding of the source files
779 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
780 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
781 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
782 # possible encodings.
783 # The default value is: UTF-8.
784
785 INPUT_ENCODING         = UTF-8
786
787 # If the value of the INPUT tag contains directories, you can use the
788 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
789 # *.h) to filter out the source-files in the directories.
790 #
791 # Note that for custom extensions or not directly supported extensions you also
792 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
793 # read by doxygen.
794 #
795 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
796 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
797 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
798 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
799 # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
800
801 FILE_PATTERNS          = *.h \
802                          *.md
803
804 # The RECURSIVE tag can be used to specify whether or not subdirectories should
805 # be searched for input files as well.
806 # The default value is: NO.
807
808 RECURSIVE              = YES
809
810 # The EXCLUDE tag can be used to specify files and/or directories that should be
811 # excluded from the INPUT source files. This way you can easily exclude a
812 # subdirectory from a directory tree whose root is specified with the INPUT tag.
813 #
814 # Note that relative paths are relative to the directory from which doxygen is
815 # run.
816
817 EXCLUDE                = @SRC_DIR@/src/include
818
819 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
820 # directories that are symbolic links (a Unix file system feature) are excluded
821 # from the input.
822 # The default value is: NO.
823
824 EXCLUDE_SYMLINKS       = YES
825
826 # If the value of the INPUT tag contains directories, you can use the
827 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
828 # certain files from those directories.
829 #
830 # Note that the wildcards are matched against the file with absolute path, so to
831 # exclude all test directories for example use the pattern */test/*
832
833 EXCLUDE_PATTERNS       = */.git/*
834
835 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
836 # (namespaces, classes, functions, etc.) that should be excluded from the
837 # output. The symbol name can be a fully qualified name, a word, or if the
838 # wildcard * is used, a substring. Examples: ANamespace, AClass,
839 # AClass::ANamespace, ANamespace::*Test
840 #
841 # Note that the wildcards are matched against the file with absolute path, so to
842 # exclude all test directories use the pattern */test/*
843
844 EXCLUDE_SYMBOLS        =
845
846 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
847 # that contain example code fragments that are included (see the \include
848 # command).
849
850 EXAMPLE_PATH           =
851
852 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
853 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
854 # *.h) to filter out the source-files in the directories. If left blank all
855 # files are included.
856
857 EXAMPLE_PATTERNS       =
858
859 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
860 # searched for input files to be used with the \include or \dontinclude commands
861 # irrespective of the value of the RECURSIVE tag.
862 # The default value is: NO.
863
864 EXAMPLE_RECURSIVE      = NO
865
866 # The IMAGE_PATH tag can be used to specify one or more files or directories
867 # that contain images that are to be included in the documentation (see the
868 # \image command).
869
870 IMAGE_PATH             =
871
872 # The INPUT_FILTER tag can be used to specify a program that doxygen should
873 # invoke to filter for each input file. Doxygen will invoke the filter program
874 # by executing (via popen()) the command:
875 #
876 # <filter> <input-file>
877 #
878 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
879 # name of an input file. Doxygen will then use the output that the filter
880 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
881 # will be ignored.
882 #
883 # Note that the filter must not add or remove lines; it is applied before the
884 # code is scanned, but not when the output code is generated. If lines are added
885 # or removed, the anchors will not be placed correctly.
886 #
887 # Note that for custom extensions or not directly supported extensions you also
888 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
889 # properly processed by doxygen.
890
891 INPUT_FILTER           =
892
893 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
894 # basis. Doxygen will compare the file name with each pattern and apply the
895 # filter if there is a match. The filters are a list of the form: pattern=filter
896 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
897 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
898 # patterns match the file name, INPUT_FILTER is applied.
899 #
900 # Note that for custom extensions or not directly supported extensions you also
901 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
902 # properly processed by doxygen.
903
904 FILTER_PATTERNS        =
905
906 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
907 # INPUT_FILTER) will also be used to filter the input files that are used for
908 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
909 # The default value is: NO.
910
911 FILTER_SOURCE_FILES    = NO
912
913 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
914 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
915 # it is also possible to disable source filtering for a specific pattern using
916 # *.ext= (so without naming a filter).
917 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
918
919 FILTER_SOURCE_PATTERNS =
920
921 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
922 # is part of the input, its contents will be placed on the main page
923 # (index.html). This can be useful if you have a project on for instance GitHub
924 # and want to reuse the introduction page also for the doxygen output.
925
926 USE_MDFILE_AS_MAINPAGE =
927
928 #---------------------------------------------------------------------------
929 # Configuration options related to source browsing
930 #---------------------------------------------------------------------------
931
932 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
933 # generated. Documented entities will be cross-referenced with these sources.
934 #
935 # Note: To get rid of all source code in the generated output, make sure that
936 # also VERBATIM_HEADERS is set to NO.
937 # The default value is: NO.
938
939 SOURCE_BROWSER         = YES
940
941 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
942 # classes and enums directly into the documentation.
943 # The default value is: NO.
944
945 INLINE_SOURCES         = NO
946
947 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
948 # special comment blocks from generated source code fragments. Normal C, C++ and
949 # Fortran comments will always remain visible.
950 # The default value is: YES.
951
952 STRIP_CODE_COMMENTS    = NO
953
954 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
955 # function all documented functions referencing it will be listed.
956 # The default value is: NO.
957
958 REFERENCED_BY_RELATION = NO
959
960 # If the REFERENCES_RELATION tag is set to YES then for each documented function
961 # all documented entities called/used by that function will be listed.
962 # The default value is: NO.
963
964 REFERENCES_RELATION    = NO
965
966 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
967 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
968 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
969 # link to the documentation.
970 # The default value is: YES.
971
972 REFERENCES_LINK_SOURCE = YES
973
974 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
975 # source code will show a tooltip with additional information such as prototype,
976 # brief description and links to the definition and documentation. Since this
977 # will make the HTML file larger and loading of large files a bit slower, you
978 # can opt to disable this feature.
979 # The default value is: YES.
980 # This tag requires that the tag SOURCE_BROWSER is set to YES.
981
982 SOURCE_TOOLTIPS        = YES
983
984 # If the USE_HTAGS tag is set to YES then the references to source code will
985 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
986 # source browser. The htags tool is part of GNU's global source tagging system
987 # (see http://www.gnu.org/software/global/global.html). You will need version
988 # 4.8.6 or higher.
989 #
990 # To use it do the following:
991 # - Install the latest version of global
992 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
993 # - Make sure the INPUT points to the root of the source tree
994 # - Run doxygen as normal
995 #
996 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
997 # tools must be available from the command line (i.e. in the search path).
998 #
999 # The result: instead of the source browser generated by doxygen, the links to
1000 # source code will now point to the output of htags.
1001 # The default value is: NO.
1002 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1003
1004 USE_HTAGS              = NO
1005
1006 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1007 # verbatim copy of the header file for each class for which an include is
1008 # specified. Set to NO to disable this.
1009 # See also: Section \class.
1010 # The default value is: YES.
1011
1012 VERBATIM_HEADERS       = YES
1013
1014 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1015 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1016 # cost of reduced performance. This can be particularly helpful with template
1017 # rich C++ code for which doxygen's built-in parser lacks the necessary type
1018 # information.
1019 # Note: The availability of this option depends on whether or not doxygen was
1020 # generated with the -Duse-libclang=ON option for CMake.
1021 # The default value is: NO.
1022
1023 CLANG_ASSISTED_PARSING = NO
1024
1025 # If clang assisted parsing is enabled you can provide the compiler with command
1026 # line options that you would normally use when invoking the compiler. Note that
1027 # the include paths will already be set by doxygen for the files and directories
1028 # specified with INPUT and INCLUDE_PATH.
1029 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1030
1031 CLANG_OPTIONS          =
1032
1033 #---------------------------------------------------------------------------
1034 # Configuration options related to the alphabetical class index
1035 #---------------------------------------------------------------------------
1036
1037 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1038 # compounds will be generated. Enable this if the project contains a lot of
1039 # classes, structs, unions or interfaces.
1040 # The default value is: YES.
1041
1042 ALPHABETICAL_INDEX     = YES
1043
1044 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1045 # which the alphabetical index list will be split.
1046 # Minimum value: 1, maximum value: 20, default value: 5.
1047 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1048
1049 COLS_IN_ALPHA_INDEX    = 5
1050
1051 # In case all classes in a project start with a common prefix, all classes will
1052 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1053 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1054 # while generating the index headers.
1055 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1056
1057 IGNORE_PREFIX          =
1058
1059 #---------------------------------------------------------------------------
1060 # Configuration options related to the HTML output
1061 #---------------------------------------------------------------------------
1062
1063 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1064 # The default value is: YES.
1065
1066 GENERATE_HTML          = YES
1067
1068 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1069 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1070 # it.
1071 # The default directory is: html.
1072 # This tag requires that the tag GENERATE_HTML is set to YES.
1073
1074 HTML_OUTPUT            = .
1075
1076 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1077 # generated HTML page (for example: .htm, .php, .asp).
1078 # The default value is: .html.
1079 # This tag requires that the tag GENERATE_HTML is set to YES.
1080
1081 HTML_FILE_EXTENSION    = .html
1082
1083 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1084 # each generated HTML page. If the tag is left blank doxygen will generate a
1085 # standard header.
1086 #
1087 # To get valid HTML the header file that includes any scripts and style sheets
1088 # that doxygen needs, which is dependent on the configuration options used (e.g.
1089 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1090 # default header using
1091 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1092 # YourConfigFile
1093 # and then modify the file new_header.html. See also section "Doxygen usage"
1094 # for information on how to generate the default header that doxygen normally
1095 # uses.
1096 # Note: The header is subject to change so you typically have to regenerate the
1097 # default header when upgrading to a newer version of doxygen. For a description
1098 # of the possible markers and block names see the documentation.
1099 # This tag requires that the tag GENERATE_HTML is set to YES.
1100
1101 HTML_HEADER            =
1102
1103 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1104 # generated HTML page. If the tag is left blank doxygen will generate a standard
1105 # footer. See HTML_HEADER for more information on how to generate a default
1106 # footer and what special commands can be used inside the footer. See also
1107 # section "Doxygen usage" for information on how to generate the default footer
1108 # that doxygen normally uses.
1109 # This tag requires that the tag GENERATE_HTML is set to YES.
1110
1111 HTML_FOOTER            =
1112
1113 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1114 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1115 # the HTML output. If left blank doxygen will generate a default style sheet.
1116 # See also section "Doxygen usage" for information on how to generate the style
1117 # sheet that doxygen normally uses.
1118 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1119 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1120 # obsolete.
1121 # This tag requires that the tag GENERATE_HTML is set to YES.
1122
1123 HTML_STYLESHEET        =
1124
1125 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1126 # cascading style sheets that are included after the standard style sheets
1127 # created by doxygen. Using this option one can overrule certain style aspects.
1128 # This is preferred over using HTML_STYLESHEET since it does not replace the
1129 # standard style sheet and is therefore more robust against future updates.
1130 # Doxygen will copy the style sheet files to the output directory.
1131 # Note: The order of the extra style sheet files is of importance (e.g. the last
1132 # style sheet in the list overrules the setting of the previous ones in the
1133 # list). For an example see the documentation.
1134 # This tag requires that the tag GENERATE_HTML is set to YES.
1135
1136 HTML_EXTRA_STYLESHEET  =
1137
1138 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1139 # other source files which should be copied to the HTML output directory. Note
1140 # that these files will be copied to the base HTML output directory. Use the
1141 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1142 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1143 # files will be copied as-is; there are no commands or markers available.
1144 # This tag requires that the tag GENERATE_HTML is set to YES.
1145
1146 HTML_EXTRA_FILES       =
1147
1148 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1149 # will adjust the colors in the style sheet and background images according to
1150 # this color. Hue is specified as an angle on a colorwheel, see
1151 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1152 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1153 # purple, and 360 is red again.
1154 # Minimum value: 0, maximum value: 359, default value: 220.
1155 # This tag requires that the tag GENERATE_HTML is set to YES.
1156
1157 HTML_COLORSTYLE_HUE    = 220
1158
1159 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1160 # in the HTML output. For a value of 0 the output will use grayscales only. A
1161 # value of 255 will produce the most vivid colors.
1162 # Minimum value: 0, maximum value: 255, default value: 100.
1163 # This tag requires that the tag GENERATE_HTML is set to YES.
1164
1165 HTML_COLORSTYLE_SAT    = 100
1166
1167 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1168 # luminance component of the colors in the HTML output. Values below 100
1169 # gradually make the output lighter, whereas values above 100 make the output
1170 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1171 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1172 # change the gamma.
1173 # Minimum value: 40, maximum value: 240, default value: 80.
1174 # This tag requires that the tag GENERATE_HTML is set to YES.
1175
1176 HTML_COLORSTYLE_GAMMA  = 80
1177
1178 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1179 # page will contain the date and time when the page was generated. Setting this
1180 # to YES can help to show when doxygen was last run and thus if the
1181 # documentation is up to date.
1182 # The default value is: NO.
1183 # This tag requires that the tag GENERATE_HTML is set to YES.
1184
1185 HTML_TIMESTAMP         = YES
1186
1187 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1188 # documentation will contain sections that can be hidden and shown after the
1189 # page has loaded.
1190 # The default value is: NO.
1191 # This tag requires that the tag GENERATE_HTML is set to YES.
1192
1193 HTML_DYNAMIC_SECTIONS  = YES
1194
1195 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1196 # shown in the various tree structured indices initially; the user can expand
1197 # and collapse entries dynamically later on. Doxygen will expand the tree to
1198 # such a level that at most the specified number of entries are visible (unless
1199 # a fully collapsed tree already exceeds this amount). So setting the number of
1200 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1201 # representing an infinite number of entries and will result in a full expanded
1202 # tree by default.
1203 # Minimum value: 0, maximum value: 9999, default value: 100.
1204 # This tag requires that the tag GENERATE_HTML is set to YES.
1205
1206 HTML_INDEX_NUM_ENTRIES = 100
1207
1208 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1209 # generated that can be used as input for Apple's Xcode 3 integrated development
1210 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1211 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1212 # Makefile in the HTML output directory. Running make will produce the docset in
1213 # that directory and running make install will install the docset in
1214 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1215 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1216 # for more information.
1217 # The default value is: NO.
1218 # This tag requires that the tag GENERATE_HTML is set to YES.
1219
1220 GENERATE_DOCSET        = NO
1221
1222 # This tag determines the name of the docset feed. A documentation feed provides
1223 # an umbrella under which multiple documentation sets from a single provider
1224 # (such as a company or product suite) can be grouped.
1225 # The default value is: Doxygen generated docs.
1226 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1227
1228 DOCSET_FEEDNAME        = "Doxygen generated docs"
1229
1230 # This tag specifies a string that should uniquely identify the documentation
1231 # set bundle. This should be a reverse domain-name style string, e.g.
1232 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1233 # The default value is: org.doxygen.Project.
1234 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1235
1236 DOCSET_BUNDLE_ID       = org.doxygen.Project
1237
1238 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1239 # the documentation publisher. This should be a reverse domain-name style
1240 # string, e.g. com.mycompany.MyDocSet.documentation.
1241 # The default value is: org.doxygen.Publisher.
1242 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1243
1244 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1245
1246 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1247 # The default value is: Publisher.
1248 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1249
1250 DOCSET_PUBLISHER_NAME  = Publisher
1251
1252 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1253 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1254 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1255 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1256 # Windows.
1257 #
1258 # The HTML Help Workshop contains a compiler that can convert all HTML output
1259 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1260 # files are now used as the Windows 98 help format, and will replace the old
1261 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1262 # HTML files also contain an index, a table of contents, and you can search for
1263 # words in the documentation. The HTML workshop also contains a viewer for
1264 # compressed HTML files.
1265 # The default value is: NO.
1266 # This tag requires that the tag GENERATE_HTML is set to YES.
1267
1268 GENERATE_HTMLHELP      = NO
1269
1270 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1271 # file. You can add a path in front of the file if the result should not be
1272 # written to the html output directory.
1273 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1274
1275 CHM_FILE               =
1276
1277 # The HHC_LOCATION tag can be used to specify the location (absolute path
1278 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1279 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1280 # The file has to be specified with full path.
1281 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1282
1283 HHC_LOCATION           =
1284
1285 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1286 # (YES) or that it should be included in the master .chm file (NO).
1287 # The default value is: NO.
1288 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1289
1290 GENERATE_CHI           = NO
1291
1292 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1293 # and project file content.
1294 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1295
1296 CHM_INDEX_ENCODING     =
1297
1298 # The BINARY_TOC flag controls whether a binary table of contents is generated
1299 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1300 # enables the Previous and Next buttons.
1301 # The default value is: NO.
1302 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1303
1304 BINARY_TOC             = NO
1305
1306 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1307 # the table of contents of the HTML help documentation and to the tree view.
1308 # The default value is: NO.
1309 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1310
1311 TOC_EXPAND             = NO
1312
1313 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1314 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1315 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1316 # (.qch) of the generated HTML documentation.
1317 # The default value is: NO.
1318 # This tag requires that the tag GENERATE_HTML is set to YES.
1319
1320 GENERATE_QHP           = NO
1321
1322 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1323 # the file name of the resulting .qch file. The path specified is relative to
1324 # the HTML output folder.
1325 # This tag requires that the tag GENERATE_QHP is set to YES.
1326
1327 QCH_FILE               =
1328
1329 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1330 # Project output. For more information please see Qt Help Project / Namespace
1331 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1332 # The default value is: org.doxygen.Project.
1333 # This tag requires that the tag GENERATE_QHP is set to YES.
1334
1335 QHP_NAMESPACE          = org.doxygen.Project
1336
1337 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1338 # Help Project output. For more information please see Qt Help Project / Virtual
1339 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1340 # folders).
1341 # The default value is: doc.
1342 # This tag requires that the tag GENERATE_QHP is set to YES.
1343
1344 QHP_VIRTUAL_FOLDER     = doc
1345
1346 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1347 # filter to add. For more information please see Qt Help Project / Custom
1348 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1349 # filters).
1350 # This tag requires that the tag GENERATE_QHP is set to YES.
1351
1352 QHP_CUST_FILTER_NAME   =
1353
1354 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1355 # custom filter to add. For more information please see Qt Help Project / Custom
1356 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1357 # filters).
1358 # This tag requires that the tag GENERATE_QHP is set to YES.
1359
1360 QHP_CUST_FILTER_ATTRS  =
1361
1362 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1363 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1364 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1365 # This tag requires that the tag GENERATE_QHP is set to YES.
1366
1367 QHP_SECT_FILTER_ATTRS  =
1368
1369 # The QHG_LOCATION tag can be used to specify the location of Qt's
1370 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1371 # generated .qhp file.
1372 # This tag requires that the tag GENERATE_QHP is set to YES.
1373
1374 QHG_LOCATION           =
1375
1376 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1377 # generated, together with the HTML files, they form an Eclipse help plugin. To
1378 # install this plugin and make it available under the help contents menu in
1379 # Eclipse, the contents of the directory containing the HTML and XML files needs
1380 # to be copied into the plugins directory of eclipse. The name of the directory
1381 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1382 # After copying Eclipse needs to be restarted before the help appears.
1383 # The default value is: NO.
1384 # This tag requires that the tag GENERATE_HTML is set to YES.
1385
1386 GENERATE_ECLIPSEHELP   = NO
1387
1388 # A unique identifier for the Eclipse help plugin. When installing the plugin
1389 # the directory name containing the HTML and XML files should also have this
1390 # name. Each documentation set should have its own identifier.
1391 # The default value is: org.doxygen.Project.
1392 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1393
1394 ECLIPSE_DOC_ID         = org.doxygen.Project
1395
1396 # If you want full control over the layout of the generated HTML pages it might
1397 # be necessary to disable the index and replace it with your own. The
1398 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1399 # of each HTML page. A value of NO enables the index and the value YES disables
1400 # it. Since the tabs in the index contain the same information as the navigation
1401 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1402 # The default value is: NO.
1403 # This tag requires that the tag GENERATE_HTML is set to YES.
1404
1405 DISABLE_INDEX          = NO
1406
1407 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1408 # structure should be generated to display hierarchical information. If the tag
1409 # value is set to YES, a side panel will be generated containing a tree-like
1410 # index structure (just like the one that is generated for HTML Help). For this
1411 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1412 # (i.e. any modern browser). Windows users are probably better off using the
1413 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1414 # further fine-tune the look of the index. As an example, the default style
1415 # sheet generated by doxygen has an example that shows how to put an image at
1416 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1417 # the same information as the tab index, you could consider setting
1418 # DISABLE_INDEX to YES when enabling this option.
1419 # The default value is: NO.
1420 # This tag requires that the tag GENERATE_HTML is set to YES.
1421
1422 GENERATE_TREEVIEW      = YES
1423
1424 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1425 # doxygen will group on one line in the generated HTML documentation.
1426 #
1427 # Note that a value of 0 will completely suppress the enum values from appearing
1428 # in the overview section.
1429 # Minimum value: 0, maximum value: 20, default value: 4.
1430 # This tag requires that the tag GENERATE_HTML is set to YES.
1431
1432 ENUM_VALUES_PER_LINE   = 1
1433
1434 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1435 # to set the initial width (in pixels) of the frame in which the tree is shown.
1436 # Minimum value: 0, maximum value: 1500, default value: 250.
1437 # This tag requires that the tag GENERATE_HTML is set to YES.
1438
1439 TREEVIEW_WIDTH         = 250
1440
1441 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1442 # external symbols imported via tag files in a separate window.
1443 # The default value is: NO.
1444 # This tag requires that the tag GENERATE_HTML is set to YES.
1445
1446 EXT_LINKS_IN_WINDOW    = NO
1447
1448 # Use this tag to change the font size of LaTeX formulas included as images in
1449 # the HTML documentation. When you change the font size after a successful
1450 # doxygen run you need to manually remove any form_*.png images from the HTML
1451 # output directory to force them to be regenerated.
1452 # Minimum value: 8, maximum value: 50, default value: 10.
1453 # This tag requires that the tag GENERATE_HTML is set to YES.
1454
1455 FORMULA_FONTSIZE       = 10
1456
1457 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1458 # generated for formulas are transparent PNGs. Transparent PNGs are not
1459 # supported properly for IE 6.0, but are supported on all modern browsers.
1460 #
1461 # Note that when changing this option you need to delete any form_*.png files in
1462 # the HTML output directory before the changes have effect.
1463 # The default value is: YES.
1464 # This tag requires that the tag GENERATE_HTML is set to YES.
1465
1466 FORMULA_TRANSPARENT    = YES
1467
1468 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1469 # http://www.mathjax.org) which uses client side Javascript for the rendering
1470 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1471 # installed or if you want to formulas look prettier in the HTML output. When
1472 # enabled you may also need to install MathJax separately and configure the path
1473 # to it using the MATHJAX_RELPATH option.
1474 # The default value is: NO.
1475 # This tag requires that the tag GENERATE_HTML is set to YES.
1476
1477 USE_MATHJAX            = NO
1478
1479 # When MathJax is enabled you can set the default output format to be used for
1480 # the MathJax output. See the MathJax site (see:
1481 # http://docs.mathjax.org/en/latest/output.html) for more details.
1482 # Possible values are: HTML-CSS (which is slower, but has the best
1483 # compatibility), NativeMML (i.e. MathML) and SVG.
1484 # The default value is: HTML-CSS.
1485 # This tag requires that the tag USE_MATHJAX is set to YES.
1486
1487 MATHJAX_FORMAT         = HTML-CSS
1488
1489 # When MathJax is enabled you need to specify the location relative to the HTML
1490 # output directory using the MATHJAX_RELPATH option. The destination directory
1491 # should contain the MathJax.js script. For instance, if the mathjax directory
1492 # is located at the same level as the HTML output directory, then
1493 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1494 # Content Delivery Network so you can quickly see the result without installing
1495 # MathJax. However, it is strongly recommended to install a local copy of
1496 # MathJax from http://www.mathjax.org before deployment.
1497 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1498 # This tag requires that the tag USE_MATHJAX is set to YES.
1499
1500 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1501
1502 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1503 # extension names that should be enabled during MathJax rendering. For example
1504 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1505 # This tag requires that the tag USE_MATHJAX is set to YES.
1506
1507 MATHJAX_EXTENSIONS     =
1508
1509 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1510 # of code that will be used on startup of the MathJax code. See the MathJax site
1511 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1512 # example see the documentation.
1513 # This tag requires that the tag USE_MATHJAX is set to YES.
1514
1515 MATHJAX_CODEFILE       =
1516
1517 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1518 # the HTML output. The underlying search engine uses javascript and DHTML and
1519 # should work on any modern browser. Note that when using HTML help
1520 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1521 # there is already a search function so this one should typically be disabled.
1522 # For large projects the javascript based search engine can be slow, then
1523 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1524 # search using the keyboard; to jump to the search box use <access key> + S
1525 # (what the <access key> is depends on the OS and browser, but it is typically
1526 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1527 # key> to jump into the search results window, the results can be navigated
1528 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1529 # the search. The filter options can be selected when the cursor is inside the
1530 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1531 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1532 # option.
1533 # The default value is: YES.
1534 # This tag requires that the tag GENERATE_HTML is set to YES.
1535
1536 SEARCHENGINE           = NO
1537
1538 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1539 # implemented using a web server instead of a web client using Javascript. There
1540 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1541 # setting. When disabled, doxygen will generate a PHP script for searching and
1542 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1543 # and searching needs to be provided by external tools. See the section
1544 # "External Indexing and Searching" for details.
1545 # The default value is: NO.
1546 # This tag requires that the tag SEARCHENGINE is set to YES.
1547
1548 SERVER_BASED_SEARCH    = NO
1549
1550 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1551 # script for searching. Instead the search results are written to an XML file
1552 # which needs to be processed by an external indexer. Doxygen will invoke an
1553 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1554 # search results.
1555 #
1556 # Doxygen ships with an example indexer (doxyindexer) and search engine
1557 # (doxysearch.cgi) which are based on the open source search engine library
1558 # Xapian (see: http://xapian.org/).
1559 #
1560 # See the section "External Indexing and Searching" for details.
1561 # The default value is: NO.
1562 # This tag requires that the tag SEARCHENGINE is set to YES.
1563
1564 EXTERNAL_SEARCH        = NO
1565
1566 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1567 # which will return the search results when EXTERNAL_SEARCH is enabled.
1568 #
1569 # Doxygen ships with an example indexer (doxyindexer) and search engine
1570 # (doxysearch.cgi) which are based on the open source search engine library
1571 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1572 # Searching" for details.
1573 # This tag requires that the tag SEARCHENGINE is set to YES.
1574
1575 SEARCHENGINE_URL       =
1576
1577 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1578 # search data is written to a file for indexing by an external tool. With the
1579 # SEARCHDATA_FILE tag the name of this file can be specified.
1580 # The default file is: searchdata.xml.
1581 # This tag requires that the tag SEARCHENGINE is set to YES.
1582
1583 SEARCHDATA_FILE        = searchdata.xml
1584
1585 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1586 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1587 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1588 # projects and redirect the results back to the right project.
1589 # This tag requires that the tag SEARCHENGINE is set to YES.
1590
1591 EXTERNAL_SEARCH_ID     =
1592
1593 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1594 # projects other than the one defined by this configuration file, but that are
1595 # all added to the same external search index. Each project needs to have a
1596 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1597 # to a relative location where the documentation can be found. The format is:
1598 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1599 # This tag requires that the tag SEARCHENGINE is set to YES.
1600
1601 EXTRA_SEARCH_MAPPINGS  =
1602
1603 #---------------------------------------------------------------------------
1604 # Configuration options related to the LaTeX output
1605 #---------------------------------------------------------------------------
1606
1607 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1608 # The default value is: YES.
1609
1610 GENERATE_LATEX         = NO
1611
1612 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1613 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1614 # it.
1615 # The default directory is: latex.
1616 # This tag requires that the tag GENERATE_LATEX is set to YES.
1617
1618 LATEX_OUTPUT           = latex
1619
1620 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1621 # invoked.
1622 #
1623 # Note that when enabling USE_PDFLATEX this option is only used for generating
1624 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1625 # written to the output directory.
1626 # The default file is: latex.
1627 # This tag requires that the tag GENERATE_LATEX is set to YES.
1628
1629 LATEX_CMD_NAME         = latex
1630
1631 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1632 # index for LaTeX.
1633 # The default file is: makeindex.
1634 # This tag requires that the tag GENERATE_LATEX is set to YES.
1635
1636 MAKEINDEX_CMD_NAME     = makeindex
1637
1638 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1639 # documents. This may be useful for small projects and may help to save some
1640 # trees in general.
1641 # The default value is: NO.
1642 # This tag requires that the tag GENERATE_LATEX is set to YES.
1643
1644 COMPACT_LATEX          = NO
1645
1646 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1647 # printer.
1648 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1649 # 14 inches) and executive (7.25 x 10.5 inches).
1650 # The default value is: a4.
1651 # This tag requires that the tag GENERATE_LATEX is set to YES.
1652
1653 PAPER_TYPE             = a4wide
1654
1655 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1656 # that should be included in the LaTeX output. The package can be specified just
1657 # by its name or with the correct syntax as to be used with the LaTeX
1658 # \usepackage command. To get the times font for instance you can specify :
1659 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1660 # To use the option intlimits with the amsmath package you can specify:
1661 # EXTRA_PACKAGES=[intlimits]{amsmath}
1662 # If left blank no extra packages will be included.
1663 # This tag requires that the tag GENERATE_LATEX is set to YES.
1664
1665 EXTRA_PACKAGES         =
1666
1667 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1668 # generated LaTeX document. The header should contain everything until the first
1669 # chapter. If it is left blank doxygen will generate a standard header. See
1670 # section "Doxygen usage" for information on how to let doxygen write the
1671 # default header to a separate file.
1672 #
1673 # Note: Only use a user-defined header if you know what you are doing! The
1674 # following commands have a special meaning inside the header: $title,
1675 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1676 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1677 # string, for the replacement values of the other commands the user is referred
1678 # to HTML_HEADER.
1679 # This tag requires that the tag GENERATE_LATEX is set to YES.
1680
1681 LATEX_HEADER           =
1682
1683 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1684 # generated LaTeX document. The footer should contain everything after the last
1685 # chapter. If it is left blank doxygen will generate a standard footer. See
1686 # LATEX_HEADER for more information on how to generate a default footer and what
1687 # special commands can be used inside the footer.
1688 #
1689 # Note: Only use a user-defined footer if you know what you are doing!
1690 # This tag requires that the tag GENERATE_LATEX is set to YES.
1691
1692 LATEX_FOOTER           =
1693
1694 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1695 # LaTeX style sheets that are included after the standard style sheets created
1696 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1697 # will copy the style sheet files to the output directory.
1698 # Note: The order of the extra style sheet files is of importance (e.g. the last
1699 # style sheet in the list overrules the setting of the previous ones in the
1700 # list).
1701 # This tag requires that the tag GENERATE_LATEX is set to YES.
1702
1703 LATEX_EXTRA_STYLESHEET =
1704
1705 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1706 # other source files which should be copied to the LATEX_OUTPUT output
1707 # directory. Note that the files will be copied as-is; there are no commands or
1708 # markers available.
1709 # This tag requires that the tag GENERATE_LATEX is set to YES.
1710
1711 LATEX_EXTRA_FILES      =
1712
1713 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1714 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1715 # contain links (just like the HTML output) instead of page references. This
1716 # makes the output suitable for online browsing using a PDF viewer.
1717 # The default value is: YES.
1718 # This tag requires that the tag GENERATE_LATEX is set to YES.
1719
1720 PDF_HYPERLINKS         = NO
1721
1722 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1723 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1724 # higher quality PDF documentation.
1725 # The default value is: YES.
1726 # This tag requires that the tag GENERATE_LATEX is set to YES.
1727
1728 USE_PDFLATEX           = NO
1729
1730 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1731 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1732 # if errors occur, instead of asking the user for help. This option is also used
1733 # when generating formulas in HTML.
1734 # The default value is: NO.
1735 # This tag requires that the tag GENERATE_LATEX is set to YES.
1736
1737 LATEX_BATCHMODE        = NO
1738
1739 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1740 # index chapters (such as File Index, Compound Index, etc.) in the output.
1741 # The default value is: NO.
1742 # This tag requires that the tag GENERATE_LATEX is set to YES.
1743
1744 LATEX_HIDE_INDICES     = NO
1745
1746 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1747 # code with syntax highlighting in the LaTeX output.
1748 #
1749 # Note that which sources are shown also depends on other settings such as
1750 # SOURCE_BROWSER.
1751 # The default value is: NO.
1752 # This tag requires that the tag GENERATE_LATEX is set to YES.
1753
1754 LATEX_SOURCE_CODE      = NO
1755
1756 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1757 # bibliography, e.g. plainnat, or ieeetr. See
1758 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1759 # The default value is: plain.
1760 # This tag requires that the tag GENERATE_LATEX is set to YES.
1761
1762 LATEX_BIB_STYLE        = plain
1763
1764 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1765 # page will contain the date and time when the page was generated. Setting this
1766 # to NO can help when comparing the output of multiple runs.
1767 # The default value is: NO.
1768 # This tag requires that the tag GENERATE_LATEX is set to YES.
1769
1770 LATEX_TIMESTAMP        = NO
1771
1772 #---------------------------------------------------------------------------
1773 # Configuration options related to the RTF output
1774 #---------------------------------------------------------------------------
1775
1776 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1777 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1778 # readers/editors.
1779 # The default value is: NO.
1780
1781 GENERATE_RTF           = NO
1782
1783 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1784 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1785 # it.
1786 # The default directory is: rtf.
1787 # This tag requires that the tag GENERATE_RTF is set to YES.
1788
1789 RTF_OUTPUT             = rtf
1790
1791 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1792 # documents. This may be useful for small projects and may help to save some
1793 # trees in general.
1794 # The default value is: NO.
1795 # This tag requires that the tag GENERATE_RTF is set to YES.
1796
1797 COMPACT_RTF            = NO
1798
1799 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1800 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1801 # output) instead of page references. This makes the output suitable for online
1802 # browsing using Word or some other Word compatible readers that support those
1803 # fields.
1804 #
1805 # Note: WordPad (write) and others do not support links.
1806 # The default value is: NO.
1807 # This tag requires that the tag GENERATE_RTF is set to YES.
1808
1809 RTF_HYPERLINKS         = NO
1810
1811 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1812 # file, i.e. a series of assignments. You only have to provide replacements,
1813 # missing definitions are set to their default value.
1814 #
1815 # See also section "Doxygen usage" for information on how to generate the
1816 # default style sheet that doxygen normally uses.
1817 # This tag requires that the tag GENERATE_RTF is set to YES.
1818
1819 RTF_STYLESHEET_FILE    =
1820
1821 # Set optional variables used in the generation of an RTF document. Syntax is
1822 # similar to doxygen's config file. A template extensions file can be generated
1823 # using doxygen -e rtf extensionFile.
1824 # This tag requires that the tag GENERATE_RTF is set to YES.
1825
1826 RTF_EXTENSIONS_FILE    =
1827
1828 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1829 # with syntax highlighting in the RTF output.
1830 #
1831 # Note that which sources are shown also depends on other settings such as
1832 # SOURCE_BROWSER.
1833 # The default value is: NO.
1834 # This tag requires that the tag GENERATE_RTF is set to YES.
1835
1836 RTF_SOURCE_CODE        = NO
1837
1838 #---------------------------------------------------------------------------
1839 # Configuration options related to the man page output
1840 #---------------------------------------------------------------------------
1841
1842 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1843 # classes and files.
1844 # The default value is: NO.
1845
1846 GENERATE_MAN           = NO
1847
1848 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1849 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1850 # it. A directory man3 will be created inside the directory specified by
1851 # MAN_OUTPUT.
1852 # The default directory is: man.
1853 # This tag requires that the tag GENERATE_MAN is set to YES.
1854
1855 MAN_OUTPUT             = man
1856
1857 # The MAN_EXTENSION tag determines the extension that is added to the generated
1858 # man pages. In case the manual section does not start with a number, the number
1859 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1860 # optional.
1861 # The default value is: .3.
1862 # This tag requires that the tag GENERATE_MAN is set to YES.
1863
1864 MAN_EXTENSION          = .3
1865
1866 # The MAN_SUBDIR tag determines the name of the directory created within
1867 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1868 # MAN_EXTENSION with the initial . removed.
1869 # This tag requires that the tag GENERATE_MAN is set to YES.
1870
1871 MAN_SUBDIR             =
1872
1873 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1874 # will generate one additional man file for each entity documented in the real
1875 # man page(s). These additional files only source the real man page, but without
1876 # them the man command would be unable to find the correct page.
1877 # The default value is: NO.
1878 # This tag requires that the tag GENERATE_MAN is set to YES.
1879
1880 MAN_LINKS              = YES
1881
1882 #---------------------------------------------------------------------------
1883 # Configuration options related to the XML output
1884 #---------------------------------------------------------------------------
1885
1886 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1887 # captures the structure of the code including all documentation.
1888 # The default value is: NO.
1889
1890 GENERATE_XML           = NO
1891
1892 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1893 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1894 # it.
1895 # The default directory is: xml.
1896 # This tag requires that the tag GENERATE_XML is set to YES.
1897
1898 XML_OUTPUT             = xml
1899
1900 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1901 # listings (including syntax highlighting and cross-referencing information) to
1902 # the XML output. Note that enabling this will significantly increase the size
1903 # of the XML output.
1904 # The default value is: YES.
1905 # This tag requires that the tag GENERATE_XML is set to YES.
1906
1907 XML_PROGRAMLISTING     = YES
1908
1909 #---------------------------------------------------------------------------
1910 # Configuration options related to the DOCBOOK output
1911 #---------------------------------------------------------------------------
1912
1913 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1914 # that can be used to generate PDF.
1915 # The default value is: NO.
1916
1917 GENERATE_DOCBOOK       = NO
1918
1919 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1920 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1921 # front of it.
1922 # The default directory is: docbook.
1923 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1924
1925 DOCBOOK_OUTPUT         = docbook
1926
1927 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1928 # program listings (including syntax highlighting and cross-referencing
1929 # information) to the DOCBOOK output. Note that enabling this will significantly
1930 # increase the size of the DOCBOOK output.
1931 # The default value is: NO.
1932 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1933
1934 DOCBOOK_PROGRAMLISTING = NO
1935
1936 #---------------------------------------------------------------------------
1937 # Configuration options for the AutoGen Definitions output
1938 #---------------------------------------------------------------------------
1939
1940 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1941 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1942 # structure of the code including all documentation. Note that this feature is
1943 # still experimental and incomplete at the moment.
1944 # The default value is: NO.
1945
1946 GENERATE_AUTOGEN_DEF   = NO
1947
1948 #---------------------------------------------------------------------------
1949 # Configuration options related to the Perl module output
1950 #---------------------------------------------------------------------------
1951
1952 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1953 # file that captures the structure of the code including all documentation.
1954 #
1955 # Note that this feature is still experimental and incomplete at the moment.
1956 # The default value is: NO.
1957
1958 GENERATE_PERLMOD       = NO
1959
1960 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1961 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1962 # output from the Perl module output.
1963 # The default value is: NO.
1964 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1965
1966 PERLMOD_LATEX          = NO
1967
1968 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1969 # formatted so it can be parsed by a human reader. This is useful if you want to
1970 # understand what is going on. On the other hand, if this tag is set to NO, the
1971 # size of the Perl module output will be much smaller and Perl will parse it
1972 # just the same.
1973 # The default value is: YES.
1974 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1975
1976 PERLMOD_PRETTY         = YES
1977
1978 # The names of the make variables in the generated doxyrules.make file are
1979 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1980 # so different doxyrules.make files included by the same Makefile don't
1981 # overwrite each other's variables.
1982 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1983
1984 PERLMOD_MAKEVAR_PREFIX =
1985
1986 #---------------------------------------------------------------------------
1987 # Configuration options related to the preprocessor
1988 #---------------------------------------------------------------------------
1989
1990 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1991 # C-preprocessor directives found in the sources and include files.
1992 # The default value is: YES.
1993
1994 ENABLE_PREPROCESSING   = YES
1995
1996 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1997 # in the source code. If set to NO, only conditional compilation will be
1998 # performed. Macro expansion can be done in a controlled way by setting
1999 # EXPAND_ONLY_PREDEF to YES.
2000 # The default value is: NO.
2001 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2002
2003 MACRO_EXPANSION        = YES
2004
2005 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2006 # the macro expansion is limited to the macros specified with the PREDEFINED and
2007 # EXPAND_AS_DEFINED tags.
2008 # The default value is: NO.
2009 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2010
2011 EXPAND_ONLY_PREDEF     = NO
2012
2013 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2014 # INCLUDE_PATH will be searched if a #include is found.
2015 # The default value is: YES.
2016 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2017
2018 SEARCH_INCLUDES        = YES
2019
2020 # The INCLUDE_PATH tag can be used to specify one or more directories that
2021 # contain include files that are not input files but should be processed by the
2022 # preprocessor.
2023 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2024
2025 INCLUDE_PATH           =
2026
2027 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2028 # patterns (like *.h and *.hpp) to filter out the header-files in the
2029 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2030 # used.
2031 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2032
2033 INCLUDE_FILE_PATTERNS  =
2034
2035 # The PREDEFINED tag can be used to specify one or more macro names that are
2036 # defined before the preprocessor is started (similar to the -D option of e.g.
2037 # gcc). The argument of the tag is a list of macros of the form: name or
2038 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2039 # is assumed. To prevent a macro definition from being undefined via #undef or
2040 # recursively expanded use the := operator instead of the = operator.
2041 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2042
2043 PREDEFINED             = LEAK_DETECTIVE \
2044                          __attribute__(x)=
2045
2046 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2047 # tag can be used to specify a list of macro names that should be expanded. The
2048 # macro definition that is found in the sources will be used. Use the PREDEFINED
2049 # tag if you want to use a different macro definition that overrules the
2050 # definition found in the source code.
2051 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2052
2053 EXPAND_AS_DEFINED      =
2054
2055 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2056 # remove all references to function-like macros that are alone on a line, have
2057 # an all uppercase name, and do not end with a semicolon. Such function macros
2058 # are typically used for boiler-plate code, and will confuse the parser if not
2059 # removed.
2060 # The default value is: YES.
2061 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2062
2063 SKIP_FUNCTION_MACROS   = YES
2064
2065 #---------------------------------------------------------------------------
2066 # Configuration options related to external references
2067 #---------------------------------------------------------------------------
2068
2069 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2070 # file the location of the external documentation should be added. The format of
2071 # a tag file without this location is as follows:
2072 # TAGFILES = file1 file2 ...
2073 # Adding location for the tag files is done as follows:
2074 # TAGFILES = file1=loc1 "file2 = loc2" ...
2075 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2076 # section "Linking to external documentation" for more information about the use
2077 # of tag files.
2078 # Note: Each tag file must have a unique name (where the name does NOT include
2079 # the path). If a tag file is not located in the directory in which doxygen is
2080 # run, you must also specify the path to the tagfile here.
2081
2082 TAGFILES               =
2083
2084 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2085 # tag file that is based on the input files it reads. See section "Linking to
2086 # external documentation" for more information about the usage of tag files.
2087
2088 GENERATE_TAGFILE       =
2089
2090 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2091 # the class index. If set to NO, only the inherited external classes will be
2092 # listed.
2093 # The default value is: NO.
2094
2095 ALLEXTERNALS           = NO
2096
2097 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2098 # in the modules index. If set to NO, only the current project's groups will be
2099 # listed.
2100 # The default value is: YES.
2101
2102 EXTERNAL_GROUPS        = YES
2103
2104 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2105 # the related pages index. If set to NO, only the current project's pages will
2106 # be listed.
2107 # The default value is: YES.
2108
2109 EXTERNAL_PAGES         = YES
2110
2111 # The PERL_PATH should be the absolute path and name of the perl script
2112 # interpreter (i.e. the result of 'which perl').
2113 # The default file (with absolute path) is: /usr/bin/perl.
2114
2115 PERL_PATH              = /usr/bin/perl
2116
2117 #---------------------------------------------------------------------------
2118 # Configuration options related to the dot tool
2119 #---------------------------------------------------------------------------
2120
2121 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2122 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2123 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2124 # disabled, but it is recommended to install and use dot, since it yields more
2125 # powerful graphs.
2126 # The default value is: YES.
2127
2128 CLASS_DIAGRAMS         = YES
2129
2130 # You can define message sequence charts within doxygen comments using the \msc
2131 # command. Doxygen will then run the mscgen tool (see:
2132 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2133 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2134 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2135 # default search path.
2136
2137 MSCGEN_PATH            =
2138
2139 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2140 # then run dia to produce the diagram and insert it in the documentation. The
2141 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2142 # If left empty dia is assumed to be found in the default search path.
2143
2144 DIA_PATH               =
2145
2146 # If set to YES the inheritance and collaboration graphs will hide inheritance
2147 # and usage relations if the target is undocumented or is not a class.
2148 # The default value is: YES.
2149
2150 HIDE_UNDOC_RELATIONS   = YES
2151
2152 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2153 # available from the path. This tool is part of Graphviz (see:
2154 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2155 # Bell Labs. The other options in this section have no effect if this option is
2156 # set to NO
2157 # The default value is: YES.
2158
2159 HAVE_DOT               = NO
2160
2161 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2162 # to run in parallel. When set to 0 doxygen will base this on the number of
2163 # processors available in the system. You can set it explicitly to a value
2164 # larger than 0 to get control over the balance between CPU load and processing
2165 # speed.
2166 # Minimum value: 0, maximum value: 32, default value: 0.
2167 # This tag requires that the tag HAVE_DOT is set to YES.
2168
2169 DOT_NUM_THREADS        = 0
2170
2171 # When you want a differently looking font in the dot files that doxygen
2172 # generates you can specify the font name using DOT_FONTNAME. You need to make
2173 # sure dot is able to find the font, which can be done by putting it in a
2174 # standard location or by setting the DOTFONTPATH environment variable or by
2175 # setting DOT_FONTPATH to the directory containing the font.
2176 # The default value is: Helvetica.
2177 # This tag requires that the tag HAVE_DOT is set to YES.
2178
2179 DOT_FONTNAME           =
2180
2181 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2182 # dot graphs.
2183 # Minimum value: 4, maximum value: 24, default value: 10.
2184 # This tag requires that the tag HAVE_DOT is set to YES.
2185
2186 DOT_FONTSIZE           = 10
2187
2188 # By default doxygen will tell dot to use the default font as specified with
2189 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2190 # the path where dot can find it using this tag.
2191 # This tag requires that the tag HAVE_DOT is set to YES.
2192
2193 DOT_FONTPATH           =
2194
2195 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2196 # each documented class showing the direct and indirect inheritance relations.
2197 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2198 # The default value is: YES.
2199 # This tag requires that the tag HAVE_DOT is set to YES.
2200
2201 CLASS_GRAPH            = YES
2202
2203 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2204 # graph for each documented class showing the direct and indirect implementation
2205 # dependencies (inheritance, containment, and class references variables) of the
2206 # class with other documented classes.
2207 # The default value is: YES.
2208 # This tag requires that the tag HAVE_DOT is set to YES.
2209
2210 COLLABORATION_GRAPH    = YES
2211
2212 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2213 # groups, showing the direct groups dependencies.
2214 # The default value is: YES.
2215 # This tag requires that the tag HAVE_DOT is set to YES.
2216
2217 GROUP_GRAPHS           = YES
2218
2219 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2220 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2221 # Language.
2222 # The default value is: NO.
2223 # This tag requires that the tag HAVE_DOT is set to YES.
2224
2225 UML_LOOK               = NO
2226
2227 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2228 # class node. If there are many fields or methods and many nodes the graph may
2229 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2230 # number of items for each type to make the size more manageable. Set this to 0
2231 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2232 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2233 # but if the number exceeds 15, the total amount of fields shown is limited to
2234 # 10.
2235 # Minimum value: 0, maximum value: 100, default value: 10.
2236 # This tag requires that the tag HAVE_DOT is set to YES.
2237
2238 UML_LIMIT_NUM_FIELDS   = 10
2239
2240 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2241 # collaboration graphs will show the relations between templates and their
2242 # instances.
2243 # The default value is: NO.
2244 # This tag requires that the tag HAVE_DOT is set to YES.
2245
2246 TEMPLATE_RELATIONS     = NO
2247
2248 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2249 # YES then doxygen will generate a graph for each documented file showing the
2250 # direct and indirect include dependencies of the file with other documented
2251 # files.
2252 # The default value is: YES.
2253 # This tag requires that the tag HAVE_DOT is set to YES.
2254
2255 INCLUDE_GRAPH          = YES
2256
2257 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2258 # set to YES then doxygen will generate a graph for each documented file showing
2259 # the direct and indirect include dependencies of the file with other documented
2260 # files.
2261 # The default value is: YES.
2262 # This tag requires that the tag HAVE_DOT is set to YES.
2263
2264 INCLUDED_BY_GRAPH      = YES
2265
2266 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2267 # dependency graph for every global function or class method.
2268 #
2269 # Note that enabling this option will significantly increase the time of a run.
2270 # So in most cases it will be better to enable call graphs for selected
2271 # functions only using the \callgraph command. Disabling a call graph can be
2272 # accomplished by means of the command \hidecallgraph.
2273 # The default value is: NO.
2274 # This tag requires that the tag HAVE_DOT is set to YES.
2275
2276 CALL_GRAPH             = NO
2277
2278 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2279 # dependency graph for every global function or class method.
2280 #
2281 # Note that enabling this option will significantly increase the time of a run.
2282 # So in most cases it will be better to enable caller graphs for selected
2283 # functions only using the \callergraph command. Disabling a caller graph can be
2284 # accomplished by means of the command \hidecallergraph.
2285 # The default value is: NO.
2286 # This tag requires that the tag HAVE_DOT is set to YES.
2287
2288 CALLER_GRAPH           = NO
2289
2290 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2291 # hierarchy of all classes instead of a textual one.
2292 # The default value is: YES.
2293 # This tag requires that the tag HAVE_DOT is set to YES.
2294
2295 GRAPHICAL_HIERARCHY    = YES
2296
2297 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2298 # dependencies a directory has on other directories in a graphical way. The
2299 # dependency relations are determined by the #include relations between the
2300 # files in the directories.
2301 # The default value is: YES.
2302 # This tag requires that the tag HAVE_DOT is set to YES.
2303
2304 DIRECTORY_GRAPH        = YES
2305
2306 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2307 # generated by dot. For an explanation of the image formats see the section
2308 # output formats in the documentation of the dot tool (Graphviz (see:
2309 # http://www.graphviz.org/)).
2310 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2311 # to make the SVG files visible in IE 9+ (other browsers do not have this
2312 # requirement).
2313 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2314 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2315 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2316 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2317 # png:gdiplus:gdiplus.
2318 # The default value is: png.
2319 # This tag requires that the tag HAVE_DOT is set to YES.
2320
2321 DOT_IMAGE_FORMAT       = png
2322
2323 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2324 # enable generation of interactive SVG images that allow zooming and panning.
2325 #
2326 # Note that this requires a modern browser other than Internet Explorer. Tested
2327 # and working are Firefox, Chrome, Safari, and Opera.
2328 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2329 # the SVG files visible. Older versions of IE do not have SVG support.
2330 # The default value is: NO.
2331 # This tag requires that the tag HAVE_DOT is set to YES.
2332
2333 INTERACTIVE_SVG        = NO
2334
2335 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2336 # found. If left blank, it is assumed the dot tool can be found in the path.
2337 # This tag requires that the tag HAVE_DOT is set to YES.
2338
2339 DOT_PATH               =
2340
2341 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2342 # contain dot files that are included in the documentation (see the \dotfile
2343 # command).
2344 # This tag requires that the tag HAVE_DOT is set to YES.
2345
2346 DOTFILE_DIRS           =
2347
2348 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2349 # contain msc files that are included in the documentation (see the \mscfile
2350 # command).
2351
2352 MSCFILE_DIRS           =
2353
2354 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2355 # contain dia files that are included in the documentation (see the \diafile
2356 # command).
2357
2358 DIAFILE_DIRS           =
2359
2360 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2361 # path where java can find the plantuml.jar file. If left blank, it is assumed
2362 # PlantUML is not used or called during a preprocessing step. Doxygen will
2363 # generate a warning when it encounters a \startuml command in this case and
2364 # will not generate output for the diagram.
2365
2366 PLANTUML_JAR_PATH      =
2367
2368 # When using plantuml, the specified paths are searched for files specified by
2369 # the !include statement in a plantuml block.
2370
2371 PLANTUML_INCLUDE_PATH  =
2372
2373 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2374 # that will be shown in the graph. If the number of nodes in a graph becomes
2375 # larger than this value, doxygen will truncate the graph, which is visualized
2376 # by representing a node as a red box. Note that doxygen if the number of direct
2377 # children of the root node in a graph is already larger than
2378 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2379 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2380 # Minimum value: 0, maximum value: 10000, default value: 50.
2381 # This tag requires that the tag HAVE_DOT is set to YES.
2382
2383 DOT_GRAPH_MAX_NODES    = 50
2384
2385 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2386 # generated by dot. A depth value of 3 means that only nodes reachable from the
2387 # root by following a path via at most 3 edges will be shown. Nodes that lay
2388 # further from the root node will be omitted. Note that setting this option to 1
2389 # or 2 may greatly reduce the computation time needed for large code bases. Also
2390 # note that the size of a graph can be further restricted by
2391 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2392 # Minimum value: 0, maximum value: 1000, default value: 0.
2393 # This tag requires that the tag HAVE_DOT is set to YES.
2394
2395 MAX_DOT_GRAPH_DEPTH    = 0
2396
2397 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2398 # background. This is disabled by default, because dot on Windows does not seem
2399 # to support this out of the box.
2400 #
2401 # Warning: Depending on the platform used, enabling this option may lead to
2402 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2403 # read).
2404 # The default value is: NO.
2405 # This tag requires that the tag HAVE_DOT is set to YES.
2406
2407 DOT_TRANSPARENT        = NO
2408
2409 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2410 # files in one run (i.e. multiple -o and -T options on the command line). This
2411 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2412 # this, this feature is disabled by default.
2413 # The default value is: NO.
2414 # This tag requires that the tag HAVE_DOT is set to YES.
2415
2416 DOT_MULTI_TARGETS      = NO
2417
2418 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2419 # explaining the meaning of the various boxes and arrows in the dot generated
2420 # graphs.
2421 # The default value is: YES.
2422 # This tag requires that the tag HAVE_DOT is set to YES.
2423
2424 GENERATE_LEGEND        = YES
2425
2426 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2427 # files that are used to generate the various graphs.
2428 # The default value is: YES.
2429 # This tag requires that the tag HAVE_DOT is set to YES.
2430
2431 DOT_CLEANUP            = YES