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