3 # Copyright (c) 2020 ARM Limited.
5 # SPDX-License-Identifier: MIT
7 # Permission is hereby granted, free of charge, to any person obtaining a copy
8 # of this software and associated documentation files (the "Software"), to deal
9 # in the Software without restriction, including without limitation the rights
10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 # copies of the Software, and to permit persons to whom the Software is
12 # furnished to do so, subject to the following conditions:
14 # The above copyright notice and this permission notice shall be included in all
15 # copies or substantial portions of the Software.
17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 # This file describes the settings to be used by the documentation system
27 # doxygen (www.doxygen.org) for a project.
29 # All text after a double hash (##) is considered a comment and is placed in
30 # front of the TAG it is preceding.
32 # All text after a single hash (#) is considered a comment and will be ignored.
34 # TAG = value [value, ...]
35 # For lists, items can also be appended using:
36 # TAG += value [value, ...]
37 # Values that contain spaces should be placed between quotes (\" \").
39 #---------------------------------------------------------------------------
40 # Project related configuration options
41 #---------------------------------------------------------------------------
43 # This tag specifies the encoding used for all characters in the config file
44 # that follow. The default is UTF-8 which is also the encoding used for all text
45 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
46 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
47 # for the list of possible encodings.
48 # The default value is: UTF-8.
50 DOXYFILE_ENCODING = UTF-8
52 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
53 # double-quotes, unless you are using Doxywizard) that should identify the
54 # project for which the documentation is generated. This name is used in the
55 # title of most generated pages and in a few other places.
56 # The default value is: My Project.
58 PROJECT_NAME = "ArmNN"
60 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
61 # could be handy for archiving the generated documentation or if some version
62 # control system is used.
64 PROJECT_NUMBER = 20.11
66 # Using the PROJECT_BRIEF tag one can provide an optional one line description
67 # for a project that appears at the top of each page and should give viewer a
68 # quick idea about the purpose of the project. Keep the description short.
72 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
73 # in the documentation. The maximum height of the logo should not exceed 55
74 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
75 # the logo to the output directory.
77 PROJECT_LOGO = ./docs/Arm_NN_horizontal_blue.png
79 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
80 # into which the generated documentation will be written. If a relative path is
81 # entered, it will be relative to the location where doxygen was started. If
82 # left blank the current directory will be used.
84 OUTPUT_DIRECTORY = docs/
86 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
87 # directories (in 2 levels) under the output directory of each output format and
88 # will distribute the generated files over these directories. Enabling this
89 # option can be useful when feeding doxygen a huge amount of source files, where
90 # putting all generated files in the same directory would otherwise causes
91 # performance problems for the file system.
92 # The default value is: NO.
96 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
97 # characters to appear in the names of generated files. If set to NO, non-ASCII
98 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
100 # The default value is: NO.
102 ALLOW_UNICODE_NAMES = NO
104 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
105 # documentation generated by doxygen is written. Doxygen will use this
106 # information to generate all constant output in the proper language.
107 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
108 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
109 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
110 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
111 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
112 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
113 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
114 # Ukrainian and Vietnamese.
115 # The default value is: English.
117 OUTPUT_LANGUAGE = English
119 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
120 # descriptions after the members that are listed in the file and class
121 # documentation (similar to Javadoc). Set to NO to disable this.
122 # The default value is: YES.
124 BRIEF_MEMBER_DESC = YES
126 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
127 # description of a member or function before the detailed description
129 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
130 # brief descriptions will be completely suppressed.
131 # The default value is: YES.
135 # This tag implements a quasi-intelligent brief description abbreviator that is
136 # used to form the text in various listings. Each string in this list, if found
137 # as the leading text of the brief description, will be stripped from the text
138 # and the result, after processing the whole list, is used as the annotated
139 # text. Otherwise, the brief description is used as-is. If left blank, the
140 # following values are used ($name is automatically replaced with the name of
141 # the entity):The $name class, The $name widget, The $name file, is, provides,
142 # specifies, contains, represents, a, an and the.
144 ABBREVIATE_BRIEF = "The $name class" \
156 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
157 # doxygen will generate a detailed section even if there is only a brief
159 # The default value is: NO.
161 ALWAYS_DETAILED_SEC = NO
163 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
164 # inherited members of a class in the documentation of that class as if those
165 # members were ordinary class members. Constructors, destructors and assignment
166 # operators of the base classes will not be shown.
167 # The default value is: NO.
169 INLINE_INHERITED_MEMB = NO
171 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
172 # before files name in the file list and in the header files. If set to NO the
173 # shortest path that makes the file name unique will be used
174 # The default value is: YES.
176 FULL_PATH_NAMES = YES
178 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
179 # Stripping is only done if one of the specified strings matches the left-hand
180 # part of the path. The tag can be used to show relative paths in the file list.
181 # If left blank the directory from which doxygen is run is used as the path to
184 # Note that you can specify absolute paths here, but also relative paths, which
185 # will be relative from the directory where doxygen is started.
186 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
190 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
191 # path mentioned in the documentation of a class, which tells the reader which
192 # header file to include in order to use a class. If left blank only the name of
193 # the header file containing the class definition is used. Otherwise one should
194 # specify the list of include paths that are normally passed to the compiler
197 STRIP_FROM_INC_PATH =
199 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
200 # less readable) file names. This can be useful is your file systems doesn't
201 # support long names like on DOS, Mac, or CD-ROM.
202 # The default value is: NO.
206 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
207 # first line (until the first dot) of a Javadoc-style comment as the brief
208 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
209 # style comments (thus requiring an explicit @brief command for a brief
211 # The default value is: NO.
213 JAVADOC_AUTOBRIEF = Yes
215 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
216 # line (until the first dot) of a Qt-style comment as the brief description. If
217 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
218 # requiring an explicit \brief command for a brief description.)
219 # The default value is: NO.
223 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
224 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
225 # a brief description. This used to be the default behavior. The new default is
226 # to treat a multi-line C++ comment block as a detailed description. Set this
227 # tag to YES if you prefer the old behavior instead.
229 # Note that setting this tag to YES also means that rational rose comments are
230 # not recognized any more.
231 # The default value is: NO.
233 MULTILINE_CPP_IS_BRIEF = NO
235 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
236 # documentation from any documented member that it re-implements.
237 # The default value is: YES.
241 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
242 # page for each member. If set to NO, the documentation of a member will be part
243 # of the file/class/namespace that contains it.
244 # The default value is: NO.
246 SEPARATE_MEMBER_PAGES = NO
248 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
249 # uses this value to replace tabs by spaces in code fragments.
250 # Minimum value: 1, maximum value: 16, default value: 4.
254 # This tag can be used to specify a number of aliases that act as commands in
255 # the documentation. An alias has the form:
258 # "sideeffect=@par Side Effects:\n"
259 # will allow you to put the command \sideeffect (or @sideeffect) in the
260 # documentation, which will result in a user-defined paragraph with heading
261 # "Side Effects:". You can put \n's in the value part of an alias to insert
266 # This tag can be used to specify a number of word-keyword mappings (TCL only).
267 # A mapping has the form "name=value". For example adding "class=itcl::class"
268 # will allow you to use the command class in the itcl::class meaning.
272 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
273 # only. Doxygen will then generate output that is more tailored for C. For
274 # instance, some of the names that are used will be different. The list of all
275 # members will be omitted, etc.
276 # The default value is: NO.
278 OPTIMIZE_OUTPUT_FOR_C = NO
280 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
281 # Python sources only. Doxygen will then generate output that is more tailored
282 # for that language. For instance, namespaces will be presented as packages,
283 # qualified scopes will look different, etc.
284 # The default value is: NO.
286 OPTIMIZE_OUTPUT_JAVA = NO
288 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
289 # sources. Doxygen will then generate output that is tailored for Fortran.
290 # The default value is: NO.
292 OPTIMIZE_FOR_FORTRAN = NO
294 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
295 # sources. Doxygen will then generate output that is tailored for VHDL.
296 # The default value is: NO.
298 OPTIMIZE_OUTPUT_VHDL = NO
300 # Doxygen selects the parser to use depending on the extension of the files it
301 # parses. With this tag you can assign which parser to use for a given
302 # extension. Doxygen has a built-in mapping, but you can override or extend it
303 # using this tag. The format is ext=language, where ext is a file extension, and
304 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
305 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
306 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
307 # Fortran. In the later case the parser tries to guess whether the code is fixed
308 # or free formatted code, this is the default for Fortran type files), VHDL. For
309 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
310 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
312 # Note: For files without extension you can use no_extension as a placeholder.
314 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
315 # the files are not read by doxygen.
319 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
320 # according to the Markdown format, which allows for more readable
321 # documentation. See http://daringfireball.net/projects/markdown/ for details.
322 # The output of markdown processing is further processed by doxygen, so you can
323 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
324 # case of backward compatibilities issues.
325 # The default value is: YES.
327 MARKDOWN_SUPPORT = YES
329 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
330 # to that level are automatically included in the table of contents, even if
331 # they do not have an id attribute.
332 # Note: This feature currently applies only to Markdown headings.
333 # Minimum value: 0, maximum value: 99, default value: 0.
334 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
336 TOC_INCLUDE_HEADINGS = 0
338 # When enabled doxygen tries to link words that correspond to documented
339 # classes, or namespaces to their corresponding documentation. Such a link can
340 # be prevented in individual cases by putting a % sign in front of the word or
341 # globally by setting AUTOLINK_SUPPORT to NO.
342 # The default value is: YES.
344 AUTOLINK_SUPPORT = YES
346 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
347 # to include (a tag file for) the STL sources as input, then you should set this
348 # tag to YES in order to let doxygen match functions declarations and
349 # definitions whose arguments contain STL classes (e.g. func(std::string);
350 # versus func(std::string) {}). This also make the inheritance and collaboration
351 # diagrams that involve STL classes more complete and accurate.
352 # The default value is: NO.
354 BUILTIN_STL_SUPPORT = NO
356 # If you use Microsoft's C++/CLI language, you should set this option to YES to
357 # enable parsing support.
358 # The default value is: NO.
362 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
363 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
364 # will parse them like normal C++ but will assume all classes use public instead
365 # of private inheritance when no explicit protection keyword is present.
366 # The default value is: NO.
370 # For Microsoft's IDL there are propget and propput attributes to indicate
371 # getter and setter methods for a property. Setting this option to YES will make
372 # doxygen to replace the get and set methods by a property in the documentation.
373 # This will only work if the methods are indeed getting or setting a simple
374 # type. If this is not the case, or you want to show the methods anyway, you
375 # should set this option to NO.
376 # The default value is: YES.
378 IDL_PROPERTY_SUPPORT = YES
380 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
381 # tag is set to YES then doxygen will reuse the documentation of the first
382 # member in the group (if any) for the other members of the group. By default
383 # all members of a group must be documented explicitly.
384 # The default value is: NO.
386 DISTRIBUTE_GROUP_DOC = NO
388 # If one adds a struct or class to a group and this option is enabled, then also
389 # any nested class or struct is added to the same group. By default this option
390 # is disabled and one has to add nested compounds explicitly via \ingroup.
391 # The default value is: NO.
393 GROUP_NESTED_COMPOUNDS = NO
395 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
396 # (for instance a group of public functions) to be put as a subgroup of that
397 # type (e.g. under the Public Functions section). Set it to NO to prevent
398 # subgrouping. Alternatively, this can be done per class using the
399 # \nosubgrouping command.
400 # The default value is: YES.
404 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
405 # are shown inside the group in which they are included (e.g. using \ingroup)
406 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
409 # Note that this feature does not work in combination with
410 # SEPARATE_MEMBER_PAGES.
411 # The default value is: NO.
413 INLINE_GROUPED_CLASSES = NO
415 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
416 # with only public data fields or simple typedef fields will be shown inline in
417 # the documentation of the scope in which they are defined (i.e. file,
418 # namespace, or group documentation), provided this scope is documented. If set
419 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
420 # Man pages) or section (for LaTeX and RTF).
421 # The default value is: NO.
423 INLINE_SIMPLE_STRUCTS = NO
425 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
426 # enum is documented as struct, union, or enum with the name of the typedef. So
427 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
428 # with name TypeT. When disabled the typedef will appear as a member of a file,
429 # namespace, or class. And the struct will be named TypeS. This can typically be
430 # useful for C code in case the coding convention dictates that all compound
431 # types are typedef'ed and only the typedef is referenced, never the tag name.
432 # The default value is: NO.
434 TYPEDEF_HIDES_STRUCT = NO
436 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
437 # cache is used to resolve symbols given their name and scope. Since this can be
438 # an expensive process and often the same symbol appears multiple times in the
439 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
440 # doxygen will become slower. If the cache is too large, memory is wasted. The
441 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
442 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
443 # symbols. At the end of a run doxygen will report the cache usage and suggest
444 # the optimal cache size from a speed point of view.
445 # Minimum value: 0, maximum value: 9, default value: 0.
447 LOOKUP_CACHE_SIZE = 0
449 #---------------------------------------------------------------------------
450 # Build related configuration options
451 #---------------------------------------------------------------------------
453 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
454 # documentation are documented, even if no documentation was available. Private
455 # class members and static file members will be hidden unless the
456 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
457 # Note: This will also disable the warnings about undocumented members that are
458 # normally produced when WARNINGS is set to YES.
459 # The default value is: NO.
463 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
464 # be included in the documentation.
465 # The default value is: NO.
469 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
470 # scope will be included in the documentation.
471 # The default value is: NO.
475 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
476 # included in the documentation.
477 # The default value is: NO.
481 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
482 # locally in source files will be included in the documentation. If set to NO,
483 # only classes defined in header files are included. Does not have any effect
485 # The default value is: YES.
487 EXTRACT_LOCAL_CLASSES = NO
489 # This flag is only useful for Objective-C code. If set to YES, local methods,
490 # which are defined in the implementation section but not in the interface are
491 # included in the documentation. If set to NO, only methods in the interface are
493 # The default value is: NO.
495 EXTRACT_LOCAL_METHODS = YES
497 # If this flag is set to YES, the members of anonymous namespaces will be
498 # extracted and appear in the documentation as a namespace called
499 # 'anonymous_namespace{file}', where file will be replaced with the base name of
500 # the file that contains the anonymous namespace. By default anonymous namespace
502 # The default value is: NO.
504 EXTRACT_ANON_NSPACES = NO
506 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
507 # undocumented members inside documented classes or files. If set to NO these
508 # members will be included in the various overviews, but no documentation
509 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
510 # The default value is: NO.
512 HIDE_UNDOC_MEMBERS = NO
514 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
515 # undocumented classes that are normally visible in the class hierarchy. If set
516 # to NO, these classes will be included in the various overviews. This option
517 # has no effect if EXTRACT_ALL is enabled.
518 # The default value is: NO.
520 HIDE_UNDOC_CLASSES = NO
522 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
523 # (class|struct|union) declarations. If set to NO, these declarations will be
524 # included in the documentation.
525 # The default value is: NO.
527 HIDE_FRIEND_COMPOUNDS = NO
529 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
530 # documentation blocks found inside the body of a function. If set to NO, these
531 # blocks will be appended to the function's detailed documentation block.
532 # The default value is: NO.
534 HIDE_IN_BODY_DOCS = NO
536 # The INTERNAL_DOCS tag determines if documentation that is typed after a
537 # \internal command is included. If the tag is set to NO then the documentation
538 # will be excluded. Set it to YES to include the internal documentation.
539 # The default value is: NO.
543 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
544 # names in lower-case letters. If set to YES, upper-case letters are also
545 # allowed. This is useful if you have classes or files whose names only differ
546 # in case and if your file system supports case sensitive file names. Windows
547 # and Mac users are advised to set this option to NO.
548 # The default value is: system dependent.
550 CASE_SENSE_NAMES = NO
552 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
553 # their full class and namespace scopes in the documentation. If set to YES, the
554 # scope will be hidden.
555 # The default value is: NO.
557 HIDE_SCOPE_NAMES = YES
559 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
560 # append additional text to a page's title, such as Class Reference. If set to
561 # YES the compound reference will be hidden.
562 # The default value is: NO.
564 #HIDE_COMPOUND_REFERENCE= NO
566 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
567 # the files that are included by a file in the documentation of that file.
568 # The default value is: YES.
570 SHOW_INCLUDE_FILES = YES
572 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
573 # grouped member an include statement to the documentation, telling the reader
574 # which file to include in order to use the member.
575 # The default value is: NO.
577 #SHOW_GROUPED_MEMB_INC = NO
579 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
580 # files with double quotes in the documentation rather than with sharp brackets.
581 # The default value is: NO.
583 FORCE_LOCAL_INCLUDES = NO
585 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
586 # documentation for inline members.
587 # The default value is: YES.
591 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
592 # (detailed) documentation of file and class members alphabetically by member
593 # name. If set to NO, the members will appear in declaration order.
594 # The default value is: YES.
596 SORT_MEMBER_DOCS = YES
598 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
599 # descriptions of file, namespace and class members alphabetically by member
600 # name. If set to NO, the members will appear in declaration order. Note that
601 # this will also influence the order of the classes in the class list.
602 # The default value is: NO.
606 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
607 # (brief and detailed) documentation of class members so that constructors and
608 # destructors are listed first. If set to NO the constructors will appear in the
609 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
610 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
611 # member documentation.
612 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
613 # detailed member documentation.
614 # The default value is: NO.
616 SORT_MEMBERS_CTORS_1ST = NO
618 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
619 # of group names into alphabetical order. If set to NO the group names will
620 # appear in their defined order.
621 # The default value is: NO.
623 SORT_GROUP_NAMES = NO
625 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
626 # fully-qualified names, including namespaces. If set to NO, the class list will
627 # be sorted only by class name, not including the namespace part.
628 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
629 # Note: This option applies only to the class list, not to the alphabetical
631 # The default value is: NO.
633 SORT_BY_SCOPE_NAME = NO
635 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
636 # type resolution of all parameters of a function it will reject a match between
637 # the prototype and the implementation of a member function even if there is
638 # only one candidate or it is obvious which candidate to choose by doing a
639 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
640 # accept a match between prototype and implementation in such cases.
641 # The default value is: NO.
643 STRICT_PROTO_MATCHING = NO
645 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
646 # list. This list is created by putting \todo commands in the documentation.
647 # The default value is: YES.
649 GENERATE_TODOLIST = YES
651 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
652 # list. This list is created by putting \test commands in the documentation.
653 # The default value is: YES.
655 GENERATE_TESTLIST = YES
657 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
658 # list. This list is created by putting \bug commands in the documentation.
659 # The default value is: YES.
661 GENERATE_BUGLIST = YES
663 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
664 # the deprecated list. This list is created by putting \deprecated commands in
666 # The default value is: YES.
668 GENERATE_DEPRECATEDLIST= NO
670 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
671 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
672 # ... \endcond blocks.
676 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
677 # initial value of a variable or macro / define can have for it to appear in the
678 # documentation. If the initializer consists of more lines than specified here
679 # it will be hidden. Use a value of 0 to hide initializers completely. The
680 # appearance of the value of individual variables and macros / defines can be
681 # controlled using \showinitializer or \hideinitializer command in the
682 # documentation regardless of this setting.
683 # Minimum value: 0, maximum value: 10000, default value: 30.
685 MAX_INITIALIZER_LINES = 30
687 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
688 # the bottom of the documentation of classes and structs. If set to YES, the
689 # list will mention the files that were used to generate the documentation.
690 # The default value is: YES.
692 SHOW_USED_FILES = YES
694 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
695 # will remove the Files entry from the Quick Index and from the Folder Tree View
697 # The default value is: YES.
701 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
702 # page. This will remove the Namespaces entry from the Quick Index and from the
703 # Folder Tree View (if specified).
704 # The default value is: YES.
706 SHOW_NAMESPACES = YES
708 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
709 # doxygen should invoke to get the current version for each file (typically from
710 # the version control system). Doxygen will invoke the program by executing (via
711 # popen()) the command command input-file, where command is the value of the
712 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
713 # by doxygen. Whatever the program writes to standard output is used as the file
714 # version. For an example see the documentation.
716 FILE_VERSION_FILTER =
718 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
719 # by doxygen. The layout file controls the global structure of the generated
720 # output files in an output format independent way. To create the layout file
721 # that represents doxygen's defaults, run doxygen with the -l option. You can
722 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
723 # will be used as the name of the layout file.
725 # Note that if you run doxygen from a directory containing a file called
726 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
731 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
732 # the reference definitions. This must be a list of .bib files. The .bib
733 # extension is automatically appended if omitted. This requires the bibtex tool
734 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
735 # For LaTeX the style of the bibliography can be controlled using
736 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
737 # search path. See also \cite for info how to create references.
741 #---------------------------------------------------------------------------
742 # Configuration options related to warning and progress messages
743 #---------------------------------------------------------------------------
745 # The QUIET tag can be used to turn on/off the messages that are generated to
746 # standard output by doxygen. If QUIET is set to YES this implies that the
748 # The default value is: NO.
752 # The WARNINGS tag can be used to turn on/off the warning messages that are
753 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
754 # this implies that the warnings are on.
756 # Tip: Turn warnings on while writing the documentation.
757 # The default value is: YES.
761 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
762 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
763 # will automatically be disabled.
764 # The default value is: YES.
766 WARN_IF_UNDOCUMENTED = YES
768 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
769 # potential errors in the documentation, such as not documenting some parameters
770 # in a documented function, or documenting parameters that don't exist or using
771 # markup commands wrongly.
772 # The default value is: YES.
774 WARN_IF_DOC_ERROR = YES
776 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
777 # are documented, but have no documentation for their parameters or return
778 # value. If set to NO, doxygen will only warn about wrong or incomplete
779 # parameter documentation, but not about the absence of documentation.
780 # The default value is: NO.
782 WARN_NO_PARAMDOC = YES
784 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
785 # a warning is encountered.
786 # The default value is: NO.
790 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
791 # can produce. The string should contain the $file, $line, and $text tags, which
792 # will be replaced by the file and line number from which the warning originated
793 # and the warning text. Optionally the format may contain $version, which will
794 # be replaced by the version of the file (if it could be obtained via
795 # FILE_VERSION_FILTER)
796 # The default value is: $file:$line: $text.
798 WARN_FORMAT = "$file:$line:[DOXY_WARN] $text"
800 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
801 # messages should be written. If left blank the output is written to standard
806 #---------------------------------------------------------------------------
807 # Configuration options related to the input files
808 #---------------------------------------------------------------------------
810 # The INPUT tag is used to specify the files and/or directories that contain
811 # documented source files. You may enter file names like myfile.cpp or
812 # directories like /usr/src/myproject. Separate the files or directories with
813 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
814 # Note: If this tag is empty the current directory is searched.
816 INPUT = ./docs/01_00_software_tools.dox \
817 ./docs/01_01_parsers.dox \
818 ./docs/01_03_delegate.dox \
819 ./docs/01_02_deserializer_serializer.dox \
820 ./docs/02_build_guides.dox \
821 ./docs/03_use_guides.dox \
822 ./docs/04_contributor.dox \
823 ./src/armnnQuantizer/README.md \
824 ./src/armnnConverter/README.md \
825 ./tests/ImageCSVFileGenerator/README.md \
826 ./tests/ImageTensorGenerator/README.md \
827 ./tests/ModelAccuracyTool-Armnn/README.md \
828 ./python/pyarmnn/README.md \
831 ./src/backends/README.md \
832 ./src/dynamic/README.md \
835 ./delegate/src/armnn_external_delegate.cpp \
836 ./delegate/BuildGuideNative.md \
837 ./delegate/IntegrateDelegateIntoPython.md \
840 ./ContributorGuide.md
842 # This tag can be used to specify the character encoding of the source files
843 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
844 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
845 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
846 # possible encodings.
847 # The default value is: UTF-8.
849 INPUT_ENCODING = UTF-8
851 # If the value of the INPUT tag contains directories, you can use the
852 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
853 # *.h) to filter out the source-files in the directories.
855 # Note that for custom extensions or not directly supported extensions you also
856 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
859 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
860 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
861 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
862 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
863 # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
865 FILE_PATTERNS = *.c \
910 # The RECURSIVE tag can be used to specify whether or not subdirectories should
911 # be searched for input files as well.
912 # The default value is: NO.
916 # The EXCLUDE tag can be used to specify files and/or directories that should be
917 # excluded from the INPUT source files. This way you can easily exclude a
918 # subdirectory from a directory tree whose root is specified with the INPUT tag.
920 # Note that relative paths are relative to the directory from which doxygen is
925 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
926 # directories that are symbolic links (a Unix file system feature) are excluded
928 # The default value is: NO.
930 EXCLUDE_SYMLINKS = NO
932 # If the value of the INPUT tag contains directories, you can use the
933 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
934 # certain files from those directories.
936 # Note that the wildcards are matched against the file with absolute path, so to
937 # exclude all test directories for example use the pattern */test/*
939 EXCLUDE_PATTERNS = *.md
941 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
942 # (namespaces, classes, functions, etc.) that should be excluded from the
943 # output. The symbol name can be a fully qualified name, a word, or if the
944 # wildcard * is used, a substring. Examples: ANamespace, AClass,
945 # AClass::ANamespace, ANamespace::*Test
947 # Note that the wildcards are matched against the file with absolute path, so to
948 # exclude all test directories use the pattern */test/*
950 EXCLUDE_SYMBOLS = caffe tensorflow cl armcomputetensorutils
952 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
953 # that contain example code fragments that are included (see the \include
956 EXAMPLE_PATH = ./samples/
958 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
959 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
960 # *.h) to filter out the source-files in the directories. If left blank all
961 # files are included.
965 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
966 # searched for input files to be used with the \include or \dontinclude commands
967 # irrespective of the value of the RECURSIVE tag.
968 # The default value is: NO.
970 EXAMPLE_RECURSIVE = NO
972 # The IMAGE_PATH tag can be used to specify one or more files or directories
973 # that contain images that are to be included in the documentation (see the
976 IMAGE_PATH = python/pyarmnn/
978 # The INPUT_FILTER tag can be used to specify a program that doxygen should
979 # invoke to filter for each input file. Doxygen will invoke the filter program
980 # by executing (via popen()) the command:
982 # <filter> <input-file>
984 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
985 # name of an input file. Doxygen will then use the output that the filter
986 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
989 # Note that the filter must not add or remove lines; it is applied before the
990 # code is scanned, but not when the output code is generated. If lines are added
991 # or removed, the anchors will not be placed correctly.
993 # Note that for custom extensions or not directly supported extensions you also
994 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
995 # properly processed by doxygen.
999 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1000 # basis. Doxygen will compare the file name with each pattern and apply the
1001 # filter if there is a match. The filters are a list of the form: pattern=filter
1002 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1003 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1004 # patterns match the file name, INPUT_FILTER is applied.
1006 # Note that for custom extensions or not directly supported extensions you also
1007 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
1008 # properly processed by doxygen.
1012 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1013 # INPUT_FILTER) will also be used to filter the input files that are used for
1014 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1015 # The default value is: NO.
1017 FILTER_SOURCE_FILES = NO
1019 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1020 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1021 # it is also possible to disable source filtering for a specific pattern using
1022 # *.ext= (so without naming a filter).
1023 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1025 FILTER_SOURCE_PATTERNS =
1027 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1028 # is part of the input, its contents will be placed on the main page
1029 # (index.html). This can be useful if you have a project on for instance GitHub
1030 # and want to reuse the introduction page also for the doxygen output.
1032 USE_MDFILE_AS_MAINPAGE = ./README.md
1034 #---------------------------------------------------------------------------
1035 # Configuration options related to source browsing
1036 #---------------------------------------------------------------------------
1038 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1039 # generated. Documented entities will be cross-referenced with these sources.
1041 # Note: To get rid of all source code in the generated output, make sure that
1042 # also VERBATIM_HEADERS is set to NO.
1043 # The default value is: NO.
1045 SOURCE_BROWSER = YES
1047 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
1048 # classes and enums directly into the documentation.
1049 # The default value is: NO.
1051 INLINE_SOURCES = YES
1053 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1054 # special comment blocks from generated source code fragments. Normal C, C++ and
1055 # Fortran comments will always remain visible.
1056 # The default value is: YES.
1058 STRIP_CODE_COMMENTS = NO
1060 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1061 # function all documented functions referencing it will be listed.
1062 # The default value is: NO.
1064 REFERENCED_BY_RELATION = YES
1066 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1067 # all documented entities called/used by that function will be listed.
1068 # The default value is: NO.
1070 REFERENCES_RELATION = YES
1072 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1073 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
1074 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1075 # link to the documentation.
1076 # The default value is: YES.
1078 REFERENCES_LINK_SOURCE = YES
1080 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1081 # source code will show a tooltip with additional information such as prototype,
1082 # brief description and links to the definition and documentation. Since this
1083 # will make the HTML file larger and loading of large files a bit slower, you
1084 # can opt to disable this feature.
1085 # The default value is: YES.
1086 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1088 SOURCE_TOOLTIPS = YES
1090 # If the USE_HTAGS tag is set to YES then the references to source code will
1091 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1092 # source browser. The htags tool is part of GNU's global source tagging system
1093 # (see http://www.gnu.org/software/global/global.html). You will need version
1096 # To use it do the following:
1097 # - Install the latest version of global
1098 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1099 # - Make sure the INPUT points to the root of the source tree
1100 # - Run doxygen as normal
1102 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1103 # tools must be available from the command line (i.e. in the search path).
1105 # The result: instead of the source browser generated by doxygen, the links to
1106 # source code will now point to the output of htags.
1107 # The default value is: NO.
1108 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1112 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1113 # verbatim copy of the header file for each class for which an include is
1114 # specified. Set to NO to disable this.
1115 # See also: Section \class.
1116 # The default value is: YES.
1118 VERBATIM_HEADERS = YES
1120 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1121 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1122 # cost of reduced performance. This can be particularly helpful with template
1123 # rich C++ code for which doxygen's built-in parser lacks the necessary type
1125 # Note: The availability of this option depends on whether or not doxygen was
1126 # generated with the -Duse-libclang=ON option for CMake.
1127 # The default value is: NO.
1129 CLANG_ASSISTED_PARSING = NO
1131 # If clang assisted parsing is enabled you can provide the compiler with command
1132 # line options that you would normally use when invoking the compiler. Note that
1133 # the include paths will already be set by doxygen for the files and directories
1134 # specified with INPUT and INCLUDE_PATH.
1135 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1137 CLANG_OPTIONS = -std=c++11
1139 #---------------------------------------------------------------------------
1140 # Configuration options related to the alphabetical class index
1141 #---------------------------------------------------------------------------
1143 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1144 # compounds will be generated. Enable this if the project contains a lot of
1145 # classes, structs, unions or interfaces.
1146 # The default value is: YES.
1148 ALPHABETICAL_INDEX = YES
1150 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1151 # which the alphabetical index list will be split.
1152 # Minimum value: 1, maximum value: 20, default value: 5.
1153 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1155 COLS_IN_ALPHA_INDEX = 5
1157 # In case all classes in a project start with a common prefix, all classes will
1158 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1159 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1160 # while generating the index headers.
1161 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1165 #---------------------------------------------------------------------------
1166 # Configuration options related to the HTML output
1167 #---------------------------------------------------------------------------
1169 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1170 # The default value is: YES.
1174 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1175 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1177 # The default directory is: html.
1178 # This tag requires that the tag GENERATE_HTML is set to YES.
1182 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1183 # generated HTML page (for example: .htm, .php, .asp).
1184 # The default value is: .html.
1185 # This tag requires that the tag GENERATE_HTML is set to YES.
1187 HTML_FILE_EXTENSION = .xhtml
1189 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1190 # each generated HTML page. If the tag is left blank doxygen will generate a
1193 # To get valid HTML the header file that includes any scripts and style sheets
1194 # that doxygen needs, which is dependent on the configuration options used (e.g.
1195 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1196 # default header using
1197 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1199 # and then modify the file new_header.html. See also section "Doxygen usage"
1200 # for information on how to generate the default header that doxygen normally
1202 # Note: The header is subject to change so you typically have to regenerate the
1203 # default header when upgrading to a newer version of doxygen. For a description
1204 # of the possible markers and block names see the documentation.
1205 # This tag requires that the tag GENERATE_HTML is set to YES.
1207 HTML_HEADER = ./docs/header.xhtml
1209 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1210 # generated HTML page. If the tag is left blank doxygen will generate a standard
1211 # footer. See HTML_HEADER for more information on how to generate a default
1212 # footer and what special commands can be used inside the footer. See also
1213 # section "Doxygen usage" for information on how to generate the default footer
1214 # that doxygen normally uses.
1215 # This tag requires that the tag GENERATE_HTML is set to YES.
1219 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1220 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1221 # the HTML output. If left blank doxygen will generate a default style sheet.
1222 # See also section "Doxygen usage" for information on how to generate the style
1223 # sheet that doxygen normally uses.
1224 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1225 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1227 # This tag requires that the tag GENERATE_HTML is set to YES.
1231 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1232 # cascading style sheets that are included after the standard style sheets
1233 # created by doxygen. Using this option one can overrule certain style aspects.
1234 # This is preferred over using HTML_STYLESHEET since it does not replace the
1235 # standard style sheet and is therefore more robust against future updates.
1236 # Doxygen will copy the style sheet files to the output directory.
1237 # Note: The order of the extra style sheet files is of importance (e.g. the last
1238 # style sheet in the list overrules the setting of the previous ones in the
1239 # list). For an example see the documentation.
1240 # This tag requires that the tag GENERATE_HTML is set to YES.
1242 HTML_EXTRA_STYLESHEET = ./docs/stylesheet.css
1244 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1245 # other source files which should be copied to the HTML output directory. Note
1246 # that these files will be copied to the base HTML output directory. Use the
1247 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1248 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1249 # files will be copied as-is; there are no commands or markers available.
1250 # This tag requires that the tag GENERATE_HTML is set to YES.
1254 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1255 # will adjust the colors in the style sheet and background images according to
1256 # this color. Hue is specified as an angle on a colorwheel, see
1257 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1258 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1259 # purple, and 360 is red again.
1260 # Minimum value: 0, maximum value: 359, default value: 220.
1261 # This tag requires that the tag GENERATE_HTML is set to YES.
1263 HTML_COLORSTYLE_HUE = 220
1265 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1266 # in the HTML output. For a value of 0 the output will use grayscales only. A
1267 # value of 255 will produce the most vivid colors.
1268 # Minimum value: 0, maximum value: 255, default value: 100.
1269 # This tag requires that the tag GENERATE_HTML is set to YES.
1271 HTML_COLORSTYLE_SAT = 100
1273 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1274 # luminance component of the colors in the HTML output. Values below 100
1275 # gradually make the output lighter, whereas values above 100 make the output
1276 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1277 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1279 # Minimum value: 40, maximum value: 240, default value: 80.
1280 # This tag requires that the tag GENERATE_HTML is set to YES.
1282 HTML_COLORSTYLE_GAMMA = 80
1284 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1285 # page will contain the date and time when the page was generated. Setting this
1286 # to YES can help to show when doxygen was last run and thus if the
1287 # documentation is up to date.
1288 # The default value is: NO.
1289 # This tag requires that the tag GENERATE_HTML is set to YES.
1291 HTML_TIMESTAMP = YES
1293 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1294 # documentation will contain sections that can be hidden and shown after the
1296 # The default value is: NO.
1297 # This tag requires that the tag GENERATE_HTML is set to YES.
1299 HTML_DYNAMIC_SECTIONS = NO
1301 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1302 # shown in the various tree structured indices initially; the user can expand
1303 # and collapse entries dynamically later on. Doxygen will expand the tree to
1304 # such a level that at most the specified number of entries are visible (unless
1305 # a fully collapsed tree already exceeds this amount). So setting the number of
1306 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1307 # representing an infinite number of entries and will result in a full expanded
1309 # Minimum value: 0, maximum value: 9999, default value: 100.
1310 # This tag requires that the tag GENERATE_HTML is set to YES.
1312 HTML_INDEX_NUM_ENTRIES = 100
1314 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1315 # generated that can be used as input for Apple's Xcode 3 integrated development
1316 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1317 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1318 # Makefile in the HTML output directory. Running make will produce the docset in
1319 # that directory and running make install will install the docset in
1320 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1321 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1322 # for more information.
1323 # The default value is: NO.
1324 # This tag requires that the tag GENERATE_HTML is set to YES.
1326 GENERATE_DOCSET = NO
1328 # This tag determines the name of the docset feed. A documentation feed provides
1329 # an umbrella under which multiple documentation sets from a single provider
1330 # (such as a company or product suite) can be grouped.
1331 # The default value is: Doxygen generated docs.
1332 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1334 DOCSET_FEEDNAME = "Doxygen generated docs"
1336 # This tag specifies a string that should uniquely identify the documentation
1337 # set bundle. This should be a reverse domain-name style string, e.g.
1338 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1339 # The default value is: org.doxygen.Project.
1340 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1342 DOCSET_BUNDLE_ID = org.doxygen.Project
1344 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1345 # the documentation publisher. This should be a reverse domain-name style
1346 # string, e.g. com.mycompany.MyDocSet.documentation.
1347 # The default value is: org.doxygen.Publisher.
1348 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1350 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1352 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1353 # The default value is: Publisher.
1354 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1356 DOCSET_PUBLISHER_NAME = Publisher
1358 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1359 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1360 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1361 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1364 # The HTML Help Workshop contains a compiler that can convert all HTML output
1365 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1366 # files are now used as the Windows 98 help format, and will replace the old
1367 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1368 # HTML files also contain an index, a table of contents, and you can search for
1369 # words in the documentation. The HTML workshop also contains a viewer for
1370 # compressed HTML files.
1371 # The default value is: NO.
1372 # This tag requires that the tag GENERATE_HTML is set to YES.
1374 GENERATE_HTMLHELP = NO
1376 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1377 # file. You can add a path in front of the file if the result should not be
1378 # written to the html output directory.
1379 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1383 # The HHC_LOCATION tag can be used to specify the location (absolute path
1384 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1385 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1386 # The file has to be specified with full path.
1387 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1391 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1392 # (YES) or that it should be included in the master .chm file (NO).
1393 # The default value is: NO.
1394 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1398 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1399 # and project file content.
1400 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1402 CHM_INDEX_ENCODING =
1404 # The BINARY_TOC flag controls whether a binary table of contents is generated
1405 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1406 # enables the Previous and Next buttons.
1407 # The default value is: NO.
1408 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1412 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1413 # the table of contents of the HTML help documentation and to the tree view.
1414 # The default value is: NO.
1415 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1419 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1420 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1421 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1422 # (.qch) of the generated HTML documentation.
1423 # The default value is: NO.
1424 # This tag requires that the tag GENERATE_HTML is set to YES.
1428 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1429 # the file name of the resulting .qch file. The path specified is relative to
1430 # the HTML output folder.
1431 # This tag requires that the tag GENERATE_QHP is set to YES.
1435 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1436 # Project output. For more information please see Qt Help Project / Namespace
1437 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1438 # The default value is: org.doxygen.Project.
1439 # This tag requires that the tag GENERATE_QHP is set to YES.
1441 QHP_NAMESPACE = org.doxygen.Project
1443 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1444 # Help Project output. For more information please see Qt Help Project / Virtual
1445 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1447 # The default value is: doc.
1448 # This tag requires that the tag GENERATE_QHP is set to YES.
1450 QHP_VIRTUAL_FOLDER = doc
1452 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1453 # filter to add. For more information please see Qt Help Project / Custom
1454 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1456 # This tag requires that the tag GENERATE_QHP is set to YES.
1458 QHP_CUST_FILTER_NAME =
1460 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1461 # custom filter to add. For more information please see Qt Help Project / Custom
1462 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1464 # This tag requires that the tag GENERATE_QHP is set to YES.
1466 QHP_CUST_FILTER_ATTRS =
1468 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1469 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1470 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1471 # This tag requires that the tag GENERATE_QHP is set to YES.
1473 QHP_SECT_FILTER_ATTRS =
1475 # The QHG_LOCATION tag can be used to specify the location of Qt's
1476 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1477 # generated .qhp file.
1478 # This tag requires that the tag GENERATE_QHP is set to YES.
1482 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1483 # generated, together with the HTML files, they form an Eclipse help plugin. To
1484 # install this plugin and make it available under the help contents menu in
1485 # Eclipse, the contents of the directory containing the HTML and XML files needs
1486 # to be copied into the plugins directory of eclipse. The name of the directory
1487 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1488 # After copying Eclipse needs to be restarted before the help appears.
1489 # The default value is: NO.
1490 # This tag requires that the tag GENERATE_HTML is set to YES.
1492 GENERATE_ECLIPSEHELP = NO
1494 # A unique identifier for the Eclipse help plugin. When installing the plugin
1495 # the directory name containing the HTML and XML files should also have this
1496 # name. Each documentation set should have its own identifier.
1497 # The default value is: org.doxygen.Project.
1498 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1500 ECLIPSE_DOC_ID = org.doxygen.Project
1502 # If you want full control over the layout of the generated HTML pages it might
1503 # be necessary to disable the index and replace it with your own. The
1504 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1505 # of each HTML page. A value of NO enables the index and the value YES disables
1506 # it. Since the tabs in the index contain the same information as the navigation
1507 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1508 # The default value is: NO.
1509 # This tag requires that the tag GENERATE_HTML is set to YES.
1513 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1514 # structure should be generated to display hierarchical information. If the tag
1515 # value is set to YES, a side panel will be generated containing a tree-like
1516 # index structure (just like the one that is generated for HTML Help). For this
1517 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1518 # (i.e. any modern browser). Windows users are probably better off using the
1519 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1520 # further fine-tune the look of the index. As an example, the default style
1521 # sheet generated by doxygen has an example that shows how to put an image at
1522 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1523 # the same information as the tab index, you could consider setting
1524 # DISABLE_INDEX to YES when enabling this option.
1525 # The default value is: NO.
1526 # This tag requires that the tag GENERATE_HTML is set to YES.
1528 GENERATE_TREEVIEW = YES
1530 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1531 # doxygen will group on one line in the generated HTML documentation.
1533 # Note that a value of 0 will completely suppress the enum values from appearing
1534 # in the overview section.
1535 # Minimum value: 0, maximum value: 20, default value: 4.
1536 # This tag requires that the tag GENERATE_HTML is set to YES.
1538 ENUM_VALUES_PER_LINE = 4
1540 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1541 # to set the initial width (in pixels) of the frame in which the tree is shown.
1542 # Minimum value: 0, maximum value: 1500, default value: 250.
1543 # This tag requires that the tag GENERATE_HTML is set to YES.
1545 TREEVIEW_WIDTH = 250
1547 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1548 # external symbols imported via tag files in a separate window.
1549 # The default value is: NO.
1550 # This tag requires that the tag GENERATE_HTML is set to YES.
1552 EXT_LINKS_IN_WINDOW = NO
1554 # Use this tag to change the font size of LaTeX formulas included as images in
1555 # the HTML documentation. When you change the font size after a successful
1556 # doxygen run you need to manually remove any form_*.png images from the HTML
1557 # output directory to force them to be regenerated.
1558 # Minimum value: 8, maximum value: 50, default value: 10.
1559 # This tag requires that the tag GENERATE_HTML is set to YES.
1561 FORMULA_FONTSIZE = 10
1563 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1564 # generated for formulas are transparent PNGs. Transparent PNGs are not
1565 # supported properly for IE 6.0, but are supported on all modern browsers.
1567 # Note that when changing this option you need to delete any form_*.png files in
1568 # the HTML output directory before the changes have effect.
1569 # The default value is: YES.
1570 # This tag requires that the tag GENERATE_HTML is set to YES.
1572 FORMULA_TRANSPARENT = YES
1574 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1575 # http://www.mathjax.org) which uses client side Javascript for the rendering
1576 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1577 # installed or if you want to formulas look prettier in the HTML output. When
1578 # enabled you may also need to install MathJax separately and configure the path
1579 # to it using the MATHJAX_RELPATH option.
1580 # The default value is: NO.
1581 # This tag requires that the tag GENERATE_HTML is set to YES.
1585 # When MathJax is enabled you can set the default output format to be used for
1586 # the MathJax output. See the MathJax site (see:
1587 # http://docs.mathjax.org/en/latest/output.html) for more details.
1588 # Possible values are: HTML-CSS (which is slower, but has the best
1589 # compatibility), NativeMML (i.e. MathML) and SVG.
1590 # The default value is: HTML-CSS.
1591 # This tag requires that the tag USE_MATHJAX is set to YES.
1593 MATHJAX_FORMAT = HTML-CSS
1595 # When MathJax is enabled you need to specify the location relative to the HTML
1596 # output directory using the MATHJAX_RELPATH option. The destination directory
1597 # should contain the MathJax.js script. For instance, if the mathjax directory
1598 # is located at the same level as the HTML output directory, then
1599 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1600 # Content Delivery Network so you can quickly see the result without installing
1601 # MathJax. However, it is strongly recommended to install a local copy of
1602 # MathJax from http://www.mathjax.org before deployment.
1603 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1604 # This tag requires that the tag USE_MATHJAX is set to YES.
1606 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1608 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1609 # extension names that should be enabled during MathJax rendering. For example
1610 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1611 # This tag requires that the tag USE_MATHJAX is set to YES.
1613 MATHJAX_EXTENSIONS =
1615 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1616 # of code that will be used on startup of the MathJax code. See the MathJax site
1617 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1618 # example see the documentation.
1619 # This tag requires that the tag USE_MATHJAX is set to YES.
1623 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1624 # the HTML output. The underlying search engine uses javascript and DHTML and
1625 # should work on any modern browser. Note that when using HTML help
1626 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1627 # there is already a search function so this one should typically be disabled.
1628 # For large projects the javascript based search engine can be slow, then
1629 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1630 # search using the keyboard; to jump to the search box use <access key> + S
1631 # (what the <access key> is depends on the OS and browser, but it is typically
1632 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1633 # key> to jump into the search results window, the results can be navigated
1634 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1635 # the search. The filter options can be selected when the cursor is inside the
1636 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1637 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1639 # The default value is: YES.
1640 # This tag requires that the tag GENERATE_HTML is set to YES.
1644 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1645 # implemented using a web server instead of a web client using Javascript. There
1646 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1647 # setting. When disabled, doxygen will generate a PHP script for searching and
1648 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1649 # and searching needs to be provided by external tools. See the section
1650 # "External Indexing and Searching" for details.
1651 # The default value is: NO.
1652 # This tag requires that the tag SEARCHENGINE is set to YES.
1654 SERVER_BASED_SEARCH = NO
1656 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1657 # script for searching. Instead the search results are written to an XML file
1658 # which needs to be processed by an external indexer. Doxygen will invoke an
1659 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1662 # Doxygen ships with an example indexer (doxyindexer) and search engine
1663 # (doxysearch.cgi) which are based on the open source search engine library
1664 # Xapian (see: http://xapian.org/).
1666 # See the section "External Indexing and Searching" for details.
1667 # The default value is: NO.
1668 # This tag requires that the tag SEARCHENGINE is set to YES.
1670 EXTERNAL_SEARCH = NO
1672 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1673 # which will return the search results when EXTERNAL_SEARCH is enabled.
1675 # Doxygen ships with an example indexer (doxyindexer) and search engine
1676 # (doxysearch.cgi) which are based on the open source search engine library
1677 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1678 # Searching" for details.
1679 # This tag requires that the tag SEARCHENGINE is set to YES.
1683 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1684 # search data is written to a file for indexing by an external tool. With the
1685 # SEARCHDATA_FILE tag the name of this file can be specified.
1686 # The default file is: searchdata.xml.
1687 # This tag requires that the tag SEARCHENGINE is set to YES.
1689 SEARCHDATA_FILE = searchdata.xml
1691 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1692 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1693 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1694 # projects and redirect the results back to the right project.
1695 # This tag requires that the tag SEARCHENGINE is set to YES.
1697 EXTERNAL_SEARCH_ID =
1699 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1700 # projects other than the one defined by this configuration file, but that are
1701 # all added to the same external search index. Each project needs to have a
1702 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1703 # to a relative location where the documentation can be found. The format is:
1704 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1705 # This tag requires that the tag SEARCHENGINE is set to YES.
1707 EXTRA_SEARCH_MAPPINGS =
1709 #---------------------------------------------------------------------------
1710 # Configuration options related to the LaTeX output
1711 #---------------------------------------------------------------------------
1713 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1714 # The default value is: YES.
1718 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1719 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1721 # The default directory is: latex.
1722 # This tag requires that the tag GENERATE_LATEX is set to YES.
1724 LATEX_OUTPUT = latex
1726 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1729 # Note that when enabling USE_PDFLATEX this option is only used for generating
1730 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1731 # written to the output directory.
1732 # The default file is: latex.
1733 # This tag requires that the tag GENERATE_LATEX is set to YES.
1735 LATEX_CMD_NAME = latex
1737 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1739 # The default file is: makeindex.
1740 # This tag requires that the tag GENERATE_LATEX is set to YES.
1742 MAKEINDEX_CMD_NAME = makeindex
1744 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1745 # documents. This may be useful for small projects and may help to save some
1747 # The default value is: NO.
1748 # This tag requires that the tag GENERATE_LATEX is set to YES.
1752 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1754 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1755 # 14 inches) and executive (7.25 x 10.5 inches).
1756 # The default value is: a4.
1757 # This tag requires that the tag GENERATE_LATEX is set to YES.
1761 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1762 # that should be included in the LaTeX output. The package can be specified just
1763 # by its name or with the correct syntax as to be used with the LaTeX
1764 # \usepackage command. To get the times font for instance you can specify :
1765 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1766 # To use the option intlimits with the amsmath package you can specify:
1767 # EXTRA_PACKAGES=[intlimits]{amsmath}
1768 # If left blank no extra packages will be included.
1769 # This tag requires that the tag GENERATE_LATEX is set to YES.
1773 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1774 # generated LaTeX document. The header should contain everything until the first
1775 # chapter. If it is left blank doxygen will generate a standard header. See
1776 # section "Doxygen usage" for information on how to let doxygen write the
1777 # default header to a separate file.
1779 # Note: Only use a user-defined header if you know what you are doing! The
1780 # following commands have a special meaning inside the header: $title,
1781 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1782 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1783 # string, for the replacement values of the other commands the user is referred
1785 # This tag requires that the tag GENERATE_LATEX is set to YES.
1789 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1790 # generated LaTeX document. The footer should contain everything after the last
1791 # chapter. If it is left blank doxygen will generate a standard footer. See
1792 # LATEX_HEADER for more information on how to generate a default footer and what
1793 # special commands can be used inside the footer.
1795 # Note: Only use a user-defined footer if you know what you are doing!
1796 # This tag requires that the tag GENERATE_LATEX is set to YES.
1800 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1801 # LaTeX style sheets that are included after the standard style sheets created
1802 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1803 # will copy the style sheet files to the output directory.
1804 # Note: The order of the extra style sheet files is of importance (e.g. the last
1805 # style sheet in the list overrules the setting of the previous ones in the
1807 # This tag requires that the tag GENERATE_LATEX is set to YES.
1809 LATEX_EXTRA_STYLESHEET =
1811 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1812 # other source files which should be copied to the LATEX_OUTPUT output
1813 # directory. Note that the files will be copied as-is; there are no commands or
1814 # markers available.
1815 # This tag requires that the tag GENERATE_LATEX is set to YES.
1819 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1820 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1821 # contain links (just like the HTML output) instead of page references. This
1822 # makes the output suitable for online browsing using a PDF viewer.
1823 # The default value is: YES.
1824 # This tag requires that the tag GENERATE_LATEX is set to YES.
1826 PDF_HYPERLINKS = YES
1828 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1829 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1830 # higher quality PDF documentation.
1831 # The default value is: YES.
1832 # This tag requires that the tag GENERATE_LATEX is set to YES.
1836 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1837 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1838 # if errors occur, instead of asking the user for help. This option is also used
1839 # when generating formulas in HTML.
1840 # The default value is: NO.
1841 # This tag requires that the tag GENERATE_LATEX is set to YES.
1843 LATEX_BATCHMODE = NO
1845 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1846 # index chapters (such as File Index, Compound Index, etc.) in the output.
1847 # The default value is: NO.
1848 # This tag requires that the tag GENERATE_LATEX is set to YES.
1850 LATEX_HIDE_INDICES = NO
1852 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1853 # code with syntax highlighting in the LaTeX output.
1855 # Note that which sources are shown also depends on other settings such as
1857 # The default value is: NO.
1858 # This tag requires that the tag GENERATE_LATEX is set to YES.
1860 LATEX_SOURCE_CODE = NO
1862 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1863 # bibliography, e.g. plainnat, or ieeetr. See
1864 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1865 # The default value is: plain.
1866 # This tag requires that the tag GENERATE_LATEX is set to YES.
1868 LATEX_BIB_STYLE = plain
1870 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1871 # page will contain the date and time when the page was generated. Setting this
1872 # to NO can help when comparing the output of multiple runs.
1873 # The default value is: NO.
1874 # This tag requires that the tag GENERATE_LATEX is set to YES.
1876 LATEX_TIMESTAMP = NO
1878 #---------------------------------------------------------------------------
1879 # Configuration options related to the RTF output
1880 #---------------------------------------------------------------------------
1882 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1883 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1885 # The default value is: NO.
1889 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1890 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1892 # The default directory is: rtf.
1893 # This tag requires that the tag GENERATE_RTF is set to YES.
1897 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1898 # documents. This may be useful for small projects and may help to save some
1900 # The default value is: NO.
1901 # This tag requires that the tag GENERATE_RTF is set to YES.
1905 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1906 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1907 # output) instead of page references. This makes the output suitable for online
1908 # browsing using Word or some other Word compatible readers that support those
1911 # Note: WordPad (write) and others do not support links.
1912 # The default value is: NO.
1913 # This tag requires that the tag GENERATE_RTF is set to YES.
1917 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1918 # file, i.e. a series of assignments. You only have to provide replacements,
1919 # missing definitions are set to their default value.
1921 # See also section "Doxygen usage" for information on how to generate the
1922 # default style sheet that doxygen normally uses.
1923 # This tag requires that the tag GENERATE_RTF is set to YES.
1925 RTF_STYLESHEET_FILE =
1927 # Set optional variables used in the generation of an RTF document. Syntax is
1928 # similar to doxygen's config file. A template extensions file can be generated
1929 # using doxygen -e rtf extensionFile.
1930 # This tag requires that the tag GENERATE_RTF is set to YES.
1932 RTF_EXTENSIONS_FILE =
1934 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1935 # with syntax highlighting in the RTF output.
1937 # Note that which sources are shown also depends on other settings such as
1939 # The default value is: NO.
1940 # This tag requires that the tag GENERATE_RTF is set to YES.
1942 RTF_SOURCE_CODE = NO
1944 #---------------------------------------------------------------------------
1945 # Configuration options related to the man page output
1946 #---------------------------------------------------------------------------
1948 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1949 # classes and files.
1950 # The default value is: NO.
1954 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1955 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1956 # it. A directory man3 will be created inside the directory specified by
1958 # The default directory is: man.
1959 # This tag requires that the tag GENERATE_MAN is set to YES.
1963 # The MAN_EXTENSION tag determines the extension that is added to the generated
1964 # man pages. In case the manual section does not start with a number, the number
1965 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1967 # The default value is: .3.
1968 # This tag requires that the tag GENERATE_MAN is set to YES.
1972 # The MAN_SUBDIR tag determines the name of the directory created within
1973 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1974 # MAN_EXTENSION with the initial . removed.
1975 # This tag requires that the tag GENERATE_MAN is set to YES.
1979 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1980 # will generate one additional man file for each entity documented in the real
1981 # man page(s). These additional files only source the real man page, but without
1982 # them the man command would be unable to find the correct page.
1983 # The default value is: NO.
1984 # This tag requires that the tag GENERATE_MAN is set to YES.
1988 #---------------------------------------------------------------------------
1989 # Configuration options related to the XML output
1990 #---------------------------------------------------------------------------
1992 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1993 # captures the structure of the code including all documentation.
1994 # The default value is: NO.
1998 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1999 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2001 # The default directory is: xml.
2002 # This tag requires that the tag GENERATE_XML is set to YES.
2006 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2007 # listings (including syntax highlighting and cross-referencing information) to
2008 # the XML output. Note that enabling this will significantly increase the size
2009 # of the XML output.
2010 # The default value is: YES.
2011 # This tag requires that the tag GENERATE_XML is set to YES.
2013 XML_PROGRAMLISTING = YES
2015 #---------------------------------------------------------------------------
2016 # Configuration options related to the DOCBOOK output
2017 #---------------------------------------------------------------------------
2019 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2020 # that can be used to generate PDF.
2021 # The default value is: NO.
2023 GENERATE_DOCBOOK = NO
2025 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2026 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2028 # The default directory is: docbook.
2029 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2031 DOCBOOK_OUTPUT = docbook
2033 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2034 # program listings (including syntax highlighting and cross-referencing
2035 # information) to the DOCBOOK output. Note that enabling this will significantly
2036 # increase the size of the DOCBOOK output.
2037 # The default value is: NO.
2038 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2040 DOCBOOK_PROGRAMLISTING = NO
2042 #---------------------------------------------------------------------------
2043 # Configuration options for the AutoGen Definitions output
2044 #---------------------------------------------------------------------------
2046 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2047 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
2048 # structure of the code including all documentation. Note that this feature is
2049 # still experimental and incomplete at the moment.
2050 # The default value is: NO.
2052 GENERATE_AUTOGEN_DEF = NO
2054 #---------------------------------------------------------------------------
2055 # Configuration options related to the Perl module output
2056 #---------------------------------------------------------------------------
2058 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2059 # file that captures the structure of the code including all documentation.
2061 # Note that this feature is still experimental and incomplete at the moment.
2062 # The default value is: NO.
2064 GENERATE_PERLMOD = NO
2066 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2067 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2068 # output from the Perl module output.
2069 # The default value is: NO.
2070 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2074 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2075 # formatted so it can be parsed by a human reader. This is useful if you want to
2076 # understand what is going on. On the other hand, if this tag is set to NO, the
2077 # size of the Perl module output will be much smaller and Perl will parse it
2079 # The default value is: YES.
2080 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2082 PERLMOD_PRETTY = YES
2084 # The names of the make variables in the generated doxyrules.make file are
2085 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2086 # so different doxyrules.make files included by the same Makefile don't
2087 # overwrite each other's variables.
2088 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2090 PERLMOD_MAKEVAR_PREFIX =
2092 #---------------------------------------------------------------------------
2093 # Configuration options related to the preprocessor
2094 #---------------------------------------------------------------------------
2096 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2097 # C-preprocessor directives found in the sources and include files.
2098 # The default value is: YES.
2100 ENABLE_PREPROCESSING = YES
2102 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2103 # in the source code. If set to NO, only conditional compilation will be
2104 # performed. Macro expansion can be done in a controlled way by setting
2105 # EXPAND_ONLY_PREDEF to YES.
2106 # The default value is: NO.
2107 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2109 MACRO_EXPANSION = YES
2111 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2112 # the macro expansion is limited to the macros specified with the PREDEFINED and
2113 # EXPAND_AS_DEFINED tags.
2114 # The default value is: NO.
2115 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2117 EXPAND_ONLY_PREDEF = NO
2119 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2120 # INCLUDE_PATH will be searched if a #include is found.
2121 # The default value is: YES.
2122 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2124 SEARCH_INCLUDES = YES
2126 # The INCLUDE_PATH tag can be used to specify one or more directories that
2127 # contain include files that are not input files but should be processed by the
2129 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2133 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2134 # patterns (like *.h and *.hpp) to filter out the header-files in the
2135 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2137 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2139 INCLUDE_FILE_PATTERNS =
2141 # The PREDEFINED tag can be used to specify one or more macro names that are
2142 # defined before the preprocessor is started (similar to the -D option of e.g.
2143 # gcc). The argument of the tag is a list of macros of the form: name or
2144 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2145 # is assumed. To prevent a macro definition from being undefined via #undef or
2146 # recursively expanded use the := operator instead of the = operator.
2147 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2149 PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
2150 ARMCOMPUTECL_ENABLED \
2151 ARMCOMPUTENEON_ENABLED
2153 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2154 # tag can be used to specify a list of macro names that should be expanded. The
2155 # macro definition that is found in the sources will be used. Use the PREDEFINED
2156 # tag if you want to use a different macro definition that overrules the
2157 # definition found in the source code.
2158 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2162 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2163 # remove all references to function-like macros that are alone on a line, have
2164 # an all uppercase name, and do not end with a semicolon. Such function macros
2165 # are typically used for boiler-plate code, and will confuse the parser if not
2167 # The default value is: YES.
2168 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2170 SKIP_FUNCTION_MACROS = YES
2172 #---------------------------------------------------------------------------
2173 # Configuration options related to external references
2174 #---------------------------------------------------------------------------
2176 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2177 # file the location of the external documentation should be added. The format of
2178 # a tag file without this location is as follows:
2179 # TAGFILES = file1 file2 ...
2180 # Adding location for the tag files is done as follows:
2181 # TAGFILES = file1=loc1 "file2 = loc2" ...
2182 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2183 # section "Linking to external documentation" for more information about the use
2185 # Note: Each tag file must have a unique name (where the name does NOT include
2186 # the path). If a tag file is not located in the directory in which doxygen is
2187 # run, you must also specify the path to the tagfile here.
2191 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2192 # tag file that is based on the input files it reads. See section "Linking to
2193 # external documentation" for more information about the usage of tag files.
2197 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2198 # the class index. If set to NO, only the inherited external classes will be
2200 # The default value is: NO.
2204 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2205 # in the modules index. If set to NO, only the current project's groups will be
2207 # The default value is: YES.
2209 EXTERNAL_GROUPS = YES
2211 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2212 # the related pages index. If set to NO, only the current project's pages will
2214 # The default value is: YES.
2216 EXTERNAL_PAGES = YES
2218 # The PERL_PATH should be the absolute path and name of the perl script
2219 # interpreter (i.e. the result of 'which perl').
2220 # The default file (with absolute path) is: /usr/bin/perl.
2222 PERL_PATH = /usr/bin/perl
2224 #---------------------------------------------------------------------------
2225 # Configuration options related to the dot tool
2226 #---------------------------------------------------------------------------
2228 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2229 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2230 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2231 # disabled, but it is recommended to install and use dot, since it yields more
2233 # The default value is: YES.
2235 CLASS_DIAGRAMS = YES
2237 # You can define message sequence charts within doxygen comments using the \msc
2238 # command. Doxygen will then run the mscgen tool (see:
2239 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2240 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2241 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2242 # default search path.
2246 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2247 # then run dia to produce the diagram and insert it in the documentation. The
2248 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2249 # If left empty dia is assumed to be found in the default search path.
2253 # If set to YES the inheritance and collaboration graphs will hide inheritance
2254 # and usage relations if the target is undocumented or is not a class.
2255 # The default value is: YES.
2257 HIDE_UNDOC_RELATIONS = YES
2259 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2260 # available from the path. This tool is part of Graphviz (see:
2261 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2262 # Bell Labs. The other options in this section have no effect if this option is
2264 # The default value is: NO.
2268 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2269 # to run in parallel. When set to 0 doxygen will base this on the number of
2270 # processors available in the system. You can set it explicitly to a value
2271 # larger than 0 to get control over the balance between CPU load and processing
2273 # Minimum value: 0, maximum value: 32, default value: 0.
2274 # This tag requires that the tag HAVE_DOT is set to YES.
2278 # When you want a differently looking font in the dot files that doxygen
2279 # generates you can specify the font name using DOT_FONTNAME. You need to make
2280 # sure dot is able to find the font, which can be done by putting it in a
2281 # standard location or by setting the DOTFONTPATH environment variable or by
2282 # setting DOT_FONTPATH to the directory containing the font.
2283 # The default value is: Helvetica.
2284 # This tag requires that the tag HAVE_DOT is set to YES.
2286 DOT_FONTNAME = Helvetica
2288 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2290 # Minimum value: 4, maximum value: 24, default value: 10.
2291 # This tag requires that the tag HAVE_DOT is set to YES.
2295 # By default doxygen will tell dot to use the default font as specified with
2296 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2297 # the path where dot can find it using this tag.
2298 # This tag requires that the tag HAVE_DOT is set to YES.
2302 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2303 # each documented class showing the direct and indirect inheritance relations.
2304 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2305 # The default value is: YES.
2306 # This tag requires that the tag HAVE_DOT is set to YES.
2310 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2311 # graph for each documented class showing the direct and indirect implementation
2312 # dependencies (inheritance, containment, and class references variables) of the
2313 # class with other documented classes.
2314 # The default value is: YES.
2315 # This tag requires that the tag HAVE_DOT is set to YES.
2317 COLLABORATION_GRAPH = YES
2319 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2320 # groups, showing the direct groups dependencies.
2321 # The default value is: YES.
2322 # This tag requires that the tag HAVE_DOT is set to YES.
2326 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2327 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2329 # The default value is: NO.
2330 # This tag requires that the tag HAVE_DOT is set to YES.
2334 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2335 # class node. If there are many fields or methods and many nodes the graph may
2336 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2337 # number of items for each type to make the size more manageable. Set this to 0
2338 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2339 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2340 # but if the number exceeds 15, the total amount of fields shown is limited to
2342 # Minimum value: 0, maximum value: 100, default value: 10.
2343 # This tag requires that the tag HAVE_DOT is set to YES.
2345 UML_LIMIT_NUM_FIELDS = 10
2347 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2348 # collaboration graphs will show the relations between templates and their
2350 # The default value is: NO.
2351 # This tag requires that the tag HAVE_DOT is set to YES.
2353 TEMPLATE_RELATIONS = YES
2355 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2356 # YES then doxygen will generate a graph for each documented file showing the
2357 # direct and indirect include dependencies of the file with other documented
2359 # The default value is: YES.
2360 # This tag requires that the tag HAVE_DOT is set to YES.
2364 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2365 # set to YES then doxygen will generate a graph for each documented file showing
2366 # the direct and indirect include dependencies of the file with other documented
2368 # The default value is: YES.
2369 # This tag requires that the tag HAVE_DOT is set to YES.
2371 INCLUDED_BY_GRAPH = YES
2373 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2374 # dependency graph for every global function or class method.
2376 # Note that enabling this option will significantly increase the time of a run.
2377 # So in most cases it will be better to enable call graphs for selected
2378 # functions only using the \callgraph command. Disabling a call graph can be
2379 # accomplished by means of the command \hidecallgraph.
2380 # The default value is: NO.
2381 # This tag requires that the tag HAVE_DOT is set to YES.
2385 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2386 # dependency graph for every global function or class method.
2388 # Note that enabling this option will significantly increase the time of a run.
2389 # So in most cases it will be better to enable caller graphs for selected
2390 # functions only using the \callergraph command. Disabling a caller graph can be
2391 # accomplished by means of the command \hidecallergraph.
2392 # The default value is: NO.
2393 # This tag requires that the tag HAVE_DOT is set to YES.
2397 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2398 # hierarchy of all classes instead of a textual one.
2399 # The default value is: YES.
2400 # This tag requires that the tag HAVE_DOT is set to YES.
2402 GRAPHICAL_HIERARCHY = YES
2404 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2405 # dependencies a directory has on other directories in a graphical way. The
2406 # dependency relations are determined by the #include relations between the
2407 # files in the directories.
2408 # The default value is: YES.
2409 # This tag requires that the tag HAVE_DOT is set to YES.
2411 DIRECTORY_GRAPH = YES
2413 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2414 # generated by dot. For an explanation of the image formats see the section
2415 # output formats in the documentation of the dot tool (Graphviz (see:
2416 # http://www.graphviz.org/)).
2417 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2418 # to make the SVG files visible in IE 9+ (other browsers do not have this
2420 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2421 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2422 # png:gdiplus:gdiplus.
2423 # The default value is: png.
2424 # This tag requires that the tag HAVE_DOT is set to YES.
2426 DOT_IMAGE_FORMAT = svg
2428 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2429 # enable generation of interactive SVG images that allow zooming and panning.
2431 # Note that this requires a modern browser other than Internet Explorer. Tested
2432 # and working are Firefox, Chrome, Safari, and Opera.
2433 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2434 # the SVG files visible. Older versions of IE do not have SVG support.
2435 # The default value is: NO.
2436 # This tag requires that the tag HAVE_DOT is set to YES.
2438 INTERACTIVE_SVG = NO
2440 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2441 # found. If left blank, it is assumed the dot tool can be found in the path.
2442 # This tag requires that the tag HAVE_DOT is set to YES.
2446 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2447 # contain dot files that are included in the documentation (see the \dotfile
2449 # This tag requires that the tag HAVE_DOT is set to YES.
2453 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2454 # contain msc files that are included in the documentation (see the \mscfile
2459 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2460 # contain dia files that are included in the documentation (see the \diafile
2465 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2466 # path where java can find the plantuml.jar file. If left blank, it is assumed
2467 # PlantUML is not used or called during a preprocessing step. Doxygen will
2468 # generate a warning when it encounters a \startuml command in this case and
2469 # will not generate output for the diagram.
2473 # When using plantuml, the specified paths are searched for files specified by
2474 # the !include statement in a plantuml block.
2476 PLANTUML_INCLUDE_PATH =
2478 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2479 # that will be shown in the graph. If the number of nodes in a graph becomes
2480 # larger than this value, doxygen will truncate the graph, which is visualized
2481 # by representing a node as a red box. Note that doxygen if the number of direct
2482 # children of the root node in a graph is already larger than
2483 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2484 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2485 # Minimum value: 0, maximum value: 10000, default value: 50.
2486 # This tag requires that the tag HAVE_DOT is set to YES.
2488 DOT_GRAPH_MAX_NODES = 500
2490 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2491 # generated by dot. A depth value of 3 means that only nodes reachable from the
2492 # root by following a path via at most 3 edges will be shown. Nodes that lay
2493 # further from the root node will be omitted. Note that setting this option to 1
2494 # or 2 may greatly reduce the computation time needed for large code bases. Also
2495 # note that the size of a graph can be further restricted by
2496 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2497 # Minimum value: 0, maximum value: 1000, default value: 0.
2498 # This tag requires that the tag HAVE_DOT is set to YES.
2500 MAX_DOT_GRAPH_DEPTH = 0
2502 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2503 # background. This is disabled by default, because dot on Windows does not seem
2504 # to support this out of the box.
2506 # Warning: Depending on the platform used, enabling this option may lead to
2507 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2509 # The default value is: NO.
2510 # This tag requires that the tag HAVE_DOT is set to YES.
2512 DOT_TRANSPARENT = NO
2514 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2515 # files in one run (i.e. multiple -o and -T options on the command line). This
2516 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2517 # this, this feature is disabled by default.
2518 # The default value is: NO.
2519 # This tag requires that the tag HAVE_DOT is set to YES.
2521 DOT_MULTI_TARGETS = NO
2523 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2524 # explaining the meaning of the various boxes and arrows in the dot generated
2526 # The default value is: YES.
2527 # This tag requires that the tag HAVE_DOT is set to YES.
2529 GENERATE_LEGEND = YES
2531 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2532 # files that are used to generate the various graphs.
2533 # The default value is: YES.
2534 # This tag requires that the tag HAVE_DOT is set to YES.