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