Debian Codegraph @

docs/source/doxyfile

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