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