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