3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
9# All text after a single hash (#) is considered a comment and will be ignored.
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 (\" \").
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
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.
27DOXYFILE_ENCODING = UTF-8
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.
35PROJECT_NAME = "Unity 8"
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.
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.
49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50# the documentation. The maximum height of the logo should not exceed 55 pixels
51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52# to the output directory.
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.
61OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc
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.
73# The OUTPUT_LANGUAGE tag is used to specify the language in which all
74# documentation generated by doxygen is written. Doxygen will use this
75# information to generate all constant output in the proper language.
76# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
77# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
78# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
79# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
80# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
81# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
82# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
83# Ukrainian and Vietnamese.
84# The default value is: English.
86OUTPUT_LANGUAGE = English
88# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
89# descriptions after the members that are listed in the file and class
90# documentation (similar to Javadoc). Set to NO to disable this.
91# The default value is: YES.
93BRIEF_MEMBER_DESC = YES
95# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
96# description of a member or function before the detailed description
98# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
99# brief descriptions will be completely suppressed.
100# The default value is: YES.
104# This tag implements a quasi-intelligent brief description abbreviator that is
105# used to form the text in various listings. Each string in this list, if found
106# as the leading text of the brief description, will be stripped from the text
107# and the result, after processing the whole list, is used as the annotated
108# text. Otherwise, the brief description is used as-is. If left blank, the
109# following values are used ($name is automatically replaced with the name of
110# the entity):The $name class, The $name widget, The $name file, is, provides,
111# specifies, contains, represents, a, an and the.
113ABBREVIATE_BRIEF = "The $name class" \
125# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
126# doxygen will generate a detailed section even if there is only a brief
128# The default value is: NO.
130ALWAYS_DETAILED_SEC = NO
132# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
133# inherited members of a class in the documentation of that class as if those
134# members were ordinary class members. Constructors, destructors and assignment
135# operators of the base classes will not be shown.
136# The default value is: NO.
138INLINE_INHERITED_MEMB = NO
140# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
141# before files name in the file list and in the header files. If set to NO the
142# shortest path that makes the file name unique will be used
143# The default value is: YES.
147# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
148# Stripping is only done if one of the specified strings matches the left-hand
149# part of the path. The tag can be used to show relative paths in the file list.
150# If left blank the directory from which doxygen is run is used as the path to
153# Note that you can specify absolute paths here, but also relative paths, which
154# will be relative from the directory where doxygen is started.
155# This tag requires that the tag FULL_PATH_NAMES is set to YES.
157STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@
159# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
160# path mentioned in the documentation of a class, which tells the reader which
161# header file to include in order to use a class. If left blank only the name of
162# the header file containing the class definition is used. Otherwise one should
163# specify the list of include paths that are normally passed to the compiler
166STRIP_FROM_INC_PATH = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@
168# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
169# less readable) file names. This can be useful is your file systems doesn't
170# support long names like on DOS, Mac, or CD-ROM.
171# The default value is: NO.
175# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
176# first line (until the first dot) of a Javadoc-style comment as the brief
177# description. If set to NO, the Javadoc-style will behave just like regular Qt-
178# style comments (thus requiring an explicit @brief command for a brief
180# The default value is: NO.
182JAVADOC_AUTOBRIEF = NO
184# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
185# line (until the first dot) of a Qt-style comment as the brief description. If
186# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
187# requiring an explicit \brief command for a brief description.)
188# The default value is: NO.
192# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
193# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
194# a brief description. This used to be the default behavior. The new default is
195# to treat a multi-line C++ comment block as a detailed description. Set this
196# tag to YES if you prefer the old behavior instead.
198# Note that setting this tag to YES also means that rational rose comments are
199# not recognized any more.
200# The default value is: NO.
202MULTILINE_CPP_IS_BRIEF = NO
204# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
205# documentation from any documented member that it re-implements.
206# The default value is: YES.
210# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
211# new page for each member. If set to NO, the documentation of a member will be
212# part of the file/class/namespace that contains it.
213# The default value is: NO.
215SEPARATE_MEMBER_PAGES = NO
217# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
218# uses this value to replace tabs by spaces in code fragments.
219# Minimum value: 1, maximum value: 16, default value: 4.
223# This tag can be used to specify a number of aliases that act as commands in
224# the documentation. An alias has the form:
227# "sideeffect=@par Side Effects:\n"
228# will allow you to put the command \sideeffect (or @sideeffect) in the
229# documentation, which will result in a user-defined paragraph with heading
230# "Side Effects:". You can put \n's in the value part of an alias to insert
233ALIASES = "accessors=\par Accessors:\n" "notifier=\par Notifier:\n"
235# This tag can be used to specify a number of word-keyword mappings (TCL only).
236# A mapping has the form "name=value". For example adding "class=itcl::class"
237# will allow you to use the command class in the itcl::class meaning.
241# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
242# only. Doxygen will then generate output that is more tailored for C. For
243# instance, some of the names that are used will be different. The list of all
244# members will be omitted, etc.
245# The default value is: NO.
247OPTIMIZE_OUTPUT_FOR_C = NO
249# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
250# Python sources only. Doxygen will then generate output that is more tailored
251# for that language. For instance, namespaces will be presented as packages,
252# qualified scopes will look different, etc.
253# The default value is: NO.
255OPTIMIZE_OUTPUT_JAVA = NO
257# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
258# sources. Doxygen will then generate output that is tailored for Fortran.
259# The default value is: NO.
261OPTIMIZE_FOR_FORTRAN = NO
263# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
264# sources. Doxygen will then generate output that is tailored for VHDL.
265# The default value is: NO.
267OPTIMIZE_OUTPUT_VHDL = NO
269# Doxygen selects the parser to use depending on the extension of the files it
270# parses. With this tag you can assign which parser to use for a given
271# extension. Doxygen has a built-in mapping, but you can override or extend it
272# using this tag. The format is ext=language, where ext is a file extension, and
273# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
274# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
275# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
276# (default is Fortran), use: inc=Fortran f=C.
278# Note For files without extension you can use no_extension as a placeholder.
280# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
281# the files are not read by doxygen.
285# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
286# according to the Markdown format, which allows for more readable
287# documentation. See http://daringfireball.net/projects/markdown/ for details.
288# The output of markdown processing is further processed by doxygen, so you can
289# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
290# case of backward compatibilities issues.
291# The default value is: YES.
293MARKDOWN_SUPPORT = YES
295# When enabled doxygen tries to link words that correspond to documented
296# classes, or namespaces to their corresponding documentation. Such a link can
297# be prevented in individual cases by by putting a % sign in front of the word
298# or globally by setting AUTOLINK_SUPPORT to NO.
299# The default value is: YES.
301AUTOLINK_SUPPORT = YES
303# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
304# to include (a tag file for) the STL sources as input, then you should set this
305# tag to YES in order to let doxygen match functions declarations and
306# definitions whose arguments contain STL classes (e.g. func(std::string);
307# versus func(std::string) {}). This also make the inheritance and collaboration
308# diagrams that involve STL classes more complete and accurate.
309# The default value is: NO.
311BUILTIN_STL_SUPPORT = NO
313# If you use Microsoft's C++/CLI language, you should set this option to YES to
314# enable parsing support.
315# The default value is: NO.
319# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
320# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
321# will parse them like normal C++ but will assume all classes use public instead
322# of private inheritance when no explicit protection keyword is present.
323# The default value is: NO.
327# For Microsoft's IDL there are propget and propput attributes to indicate
328# getter and setter methods for a property. Setting this option to YES will make
329# doxygen to replace the get and set methods by a property in the documentation.
330# This will only work if the methods are indeed getting or setting a simple
331# type. If this is not the case, or you want to show the methods anyway, you
332# should set this option to NO.
333# The default value is: YES.
335IDL_PROPERTY_SUPPORT = YES
337# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
338# tag is set to YES, then doxygen will reuse the documentation of the first
339# member in the group (if any) for the other members of the group. By default
340# all members of a group must be documented explicitly.
341# The default value is: NO.
343DISTRIBUTE_GROUP_DOC = NO
345# Set the SUBGROUPING tag to YES to allow class member groups of the same type
346# (for instance a group of public functions) to be put as a subgroup of that
347# type (e.g. under the Public Functions section). Set it to NO to prevent
348# subgrouping. Alternatively, this can be done per class using the
349# \nosubgrouping command.
350# The default value is: YES.
354# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
355# are shown inside the group in which they are included (e.g. using \ingroup)
356# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
359# Note that this feature does not work in combination with
360# SEPARATE_MEMBER_PAGES.
361# The default value is: NO.
363INLINE_GROUPED_CLASSES = NO
365# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
366# with only public data fields or simple typedef fields will be shown inline in
367# the documentation of the scope in which they are defined (i.e. file,
368# namespace, or group documentation), provided this scope is documented. If set
369# to NO, structs, classes, and unions are shown on a separate page (for HTML and
370# Man pages) or section (for LaTeX and RTF).
371# The default value is: NO.
373INLINE_SIMPLE_STRUCTS = NO
375# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
376# enum is documented as struct, union, or enum with the name of the typedef. So
377# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
378# with name TypeT. When disabled the typedef will appear as a member of a file,
379# namespace, or class. And the struct will be named TypeS. This can typically be
380# useful for C code in case the coding convention dictates that all compound
381# types are typedef'ed and only the typedef is referenced, never the tag name.
382# The default value is: NO.
384TYPEDEF_HIDES_STRUCT = NO
386# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
387# cache is used to resolve symbols given their name and scope. Since this can be
388# an expensive process and often the same symbol appears multiple times in the
389# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
390# doxygen will become slower. If the cache is too large, memory is wasted. The
391# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
392# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
393# symbols. At the end of a run doxygen will report the cache usage and suggest
394# the optimal cache size from a speed point of view.
395# Minimum value: 0, maximum value: 9, default value: 0.
399#---------------------------------------------------------------------------
400# Build related configuration options
401#---------------------------------------------------------------------------
403# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
404# documentation are documented, even if no documentation was available. Private
405# class members and static file members will be hidden unless the
406# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
407# Note: This will also disable the warnings about undocumented members that are
408# normally produced when WARNINGS is set to YES.
409# The default value is: NO.
413# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
414# be included in the documentation.
415# The default value is: NO.
419# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
420# scope will be included in the documentation.
421# The default value is: NO.
425# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
426# included in the documentation.
427# The default value is: NO.
431# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
432# locally in source files will be included in the documentation. If set to NO
433# only classes defined in header files are included. Does not have any effect
435# The default value is: YES.
437EXTRACT_LOCAL_CLASSES = YES
439# This flag is only useful for Objective-C code. When set to YES local methods,
440# which are defined in the implementation section but not in the interface are
441# included in the documentation. If set to NO only methods in the interface are
443# The default value is: NO.
445EXTRACT_LOCAL_METHODS = NO
447# If this flag is set to YES, the members of anonymous namespaces will be
448# extracted and appear in the documentation as a namespace called
449# 'anonymous_namespace{file}', where file will be replaced with the base name of
450# the file that contains the anonymous namespace. By default anonymous namespace
452# The default value is: NO.
454EXTRACT_ANON_NSPACES = NO
456# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
457# undocumented members inside documented classes or files. If set to NO these
458# members will be included in the various overviews, but no documentation
459# section is generated. This option has no effect if EXTRACT_ALL is enabled.
460# The default value is: NO.
462HIDE_UNDOC_MEMBERS = NO
464# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
465# undocumented classes that are normally visible in the class hierarchy. If set
466# to NO these classes will be included in the various overviews. This option has
467# no effect if EXTRACT_ALL is enabled.
468# The default value is: NO.
470HIDE_UNDOC_CLASSES = YES
472# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
473# (class|struct|union) declarations. If set to NO these declarations will be
474# included in the documentation.
475# The default value is: NO.
477HIDE_FRIEND_COMPOUNDS = NO
479# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
480# documentation blocks found inside the body of a function. If set to NO these
481# blocks will be appended to the function's detailed documentation block.
482# The default value is: NO.
484HIDE_IN_BODY_DOCS = NO
486# The INTERNAL_DOCS tag determines if documentation that is typed after a
487# \internal command is included. If the tag is set to NO then the documentation
488# will be excluded. Set it to YES to include the internal documentation.
489# The default value is: NO.
493# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
494# names in lower-case letters. If set to YES upper-case letters are also
495# allowed. This is useful if you have classes or files whose names only differ
496# in case and if your file system supports case sensitive file names. Windows
497# and Mac users are advised to set this option to NO.
498# The default value is: system dependent.
502# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
503# their full class and namespace scopes in the documentation. If set to YES the
504# scope will be hidden.
505# The default value is: NO.
509# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
510# the files that are included by a file in the documentation of that file.
511# The default value is: YES.
513SHOW_INCLUDE_FILES = YES
515# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
516# grouped member an include statement to the documentation, telling the reader
517# which file to include in order to use the member.
518# The default value is: NO.
520SHOW_GROUPED_MEMB_INC = NO
522# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
523# files with double quotes in the documentation rather than with sharp brackets.
524# The default value is: NO.
526FORCE_LOCAL_INCLUDES = NO
528# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
529# documentation for inline members.
530# The default value is: YES.
534# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
535# (detailed) documentation of file and class members alphabetically by member
536# name. If set to NO the members will appear in declaration order.
537# The default value is: YES.
539SORT_MEMBER_DOCS = YES
541# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
542# descriptions of file, namespace and class members alphabetically by member
543# name. If set to NO the members will appear in declaration order. Note that
544# this will also influence the order of the classes in the class list.
545# The default value is: NO.
549# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
550# (brief and detailed) documentation of class members so that constructors and
551# destructors are listed first. If set to NO the constructors will appear in the
552# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
553# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
554# member documentation.
555# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
556# detailed member documentation.
557# The default value is: NO.
559SORT_MEMBERS_CTORS_1ST = NO
561# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
562# of group names into alphabetical order. If set to NO the group names will
563# appear in their defined order.
564# The default value is: NO.
568# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
569# fully-qualified names, including namespaces. If set to NO, the class list will
570# be sorted only by class name, not including the namespace part.
571# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
572# Note: This option applies only to the class list, not to the alphabetical
574# The default value is: NO.
576SORT_BY_SCOPE_NAME = NO
578# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
579# type resolution of all parameters of a function it will reject a match between
580# the prototype and the implementation of a member function even if there is
581# only one candidate or it is obvious which candidate to choose by doing a
582# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
583# accept a match between prototype and implementation in such cases.
584# The default value is: NO.
586STRICT_PROTO_MATCHING = NO
588# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
589# todo list. This list is created by putting \todo commands in the
591# The default value is: YES.
593GENERATE_TODOLIST = YES
595# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
596# test list. This list is created by putting \test commands in the
598# The default value is: YES.
600GENERATE_TESTLIST = YES
602# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
603# list. This list is created by putting \bug commands in the documentation.
604# The default value is: YES.
606GENERATE_BUGLIST = YES
608# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
609# the deprecated list. This list is created by putting \deprecated commands in
611# The default value is: YES.
613GENERATE_DEPRECATEDLIST= YES
615# The ENABLED_SECTIONS tag can be used to enable conditional documentation
616# sections, marked by \if <section_label> ... \endif and \cond <section_label>
617# ... \endcond blocks.
621# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
622# initial value of a variable or macro / define can have for it to appear in the
623# documentation. If the initializer consists of more lines than specified here
624# it will be hidden. Use a value of 0 to hide initializers completely. The
625# appearance of the value of individual variables and macros / defines can be
626# controlled using \showinitializer or \hideinitializer command in the
627# documentation regardless of this setting.
628# Minimum value: 0, maximum value: 10000, default value: 30.
630MAX_INITIALIZER_LINES = 30
632# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
633# the bottom of the documentation of classes and structs. If set to YES the list
634# will mention the files that were used to generate the documentation.
635# The default value is: YES.
639# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
640# will remove the Files entry from the Quick Index and from the Folder Tree View
642# The default value is: YES.
646# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
647# page. This will remove the Namespaces entry from the Quick Index and from the
648# Folder Tree View (if specified).
649# The default value is: YES.
653# The FILE_VERSION_FILTER tag can be used to specify a program or script that
654# doxygen should invoke to get the current version for each file (typically from
655# the version control system). Doxygen will invoke the program by executing (via
656# popen()) the command command input-file, where command is the value of the
657# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
658# by doxygen. Whatever the program writes to standard output is used as the file
659# version. For an example see the documentation.
663# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
664# by doxygen. The layout file controls the global structure of the generated
665# output files in an output format independent way. To create the layout file
666# that represents doxygen's defaults, run doxygen with the -l option. You can
667# optionally specify a file name after the option, if omitted DoxygenLayout.xml
668# will be used as the name of the layout file.
670# Note that if you run doxygen from a directory containing a file called
671# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
676# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
677# the reference definitions. This must be a list of .bib files. The .bib
678# extension is automatically appended if omitted. This requires the bibtex tool
679# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
680# For LaTeX the style of the bibliography can be controlled using
681# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
682# search path. Do not use file names with spaces, bibtex cannot handle them. See
683# also \cite for info how to create references.
687#---------------------------------------------------------------------------
688# Configuration options related to warning and progress messages
689#---------------------------------------------------------------------------
691# The QUIET tag can be used to turn on/off the messages that are generated to
692# standard output by doxygen. If QUIET is set to YES this implies that the
694# The default value is: NO.
698# The WARNINGS tag can be used to turn on/off the warning messages that are
699# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
700# this implies that the warnings are on.
702# Tip: Turn warnings on while writing the documentation.
703# The default value is: YES.
707# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
708# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
709# will automatically be disabled.
710# The default value is: YES.
712WARN_IF_UNDOCUMENTED = NO
714# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
715# potential errors in the documentation, such as not documenting some parameters
716# in a documented function, or documenting parameters that don't exist or using
717# markup commands wrongly.
718# The default value is: YES.
720WARN_IF_DOC_ERROR = YES
722# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
723# are documented, but have no documentation for their parameters or return
724# value. If set to NO doxygen will only warn about wrong or incomplete parameter
725# documentation, but not about the absence of documentation.
726# The default value is: NO.
730# The WARN_FORMAT tag determines the format of the warning messages that doxygen
731# can produce. The string should contain the $file, $line, and $text tags, which
732# will be replaced by the file and line number from which the warning originated
733# and the warning text. Optionally the format may contain $version, which will
734# be replaced by the version of the file (if it could be obtained via
735# FILE_VERSION_FILTER)
736# The default value is: $file:$line: $text.
738WARN_FORMAT = "$file:$line: $text"
740# The WARN_LOGFILE tag can be used to specify a file to which warning and error
741# messages should be written. If left blank the output is written to standard
746#---------------------------------------------------------------------------
747# Configuration options related to the input files
748#---------------------------------------------------------------------------
750# The INPUT tag is used to specify the files and/or directories that contain
751# documented source files. You may enter file names like myfile.cpp or
752# directories like /usr/src/myproject. Separate the files or directories with
754# Note: If this tag is empty the current directory is searched.
756INPUT = @DOXYGEN_INPUT@
758# This tag can be used to specify the character encoding of the source files
759# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
760# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
761# documentation (see: http://www.gnu.org/software/libiconv) for the list of
763# The default value is: UTF-8.
765INPUT_ENCODING = UTF-8
767# If the value of the INPUT tag contains directories, you can use the
768# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
769# *.h) to filter out the source-files in the directories. If left blank the
770# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
771# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
772# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
773# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
774# *.qsf, *.as and *.js.
776FILE_PATTERNS = *.cpp \
782# The RECURSIVE tag can be used to specify whether or not subdirectories should
783# be searched for input files as well.
784# The default value is: NO.
788# The EXCLUDE tag can be used to specify files and/or directories that should be
789# excluded from the INPUT source files. This way you can easily exclude a
790# subdirectory from a directory tree whose root is specified with the INPUT tag.
792# Note that relative paths are relative to the directory from which doxygen is
797# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
798# directories that are symbolic links (a Unix file system feature) are excluded
800# The default value is: NO.
804# If the value of the INPUT tag contains directories, you can use the
805# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
806# certain files from those directories.
808# Note that the wildcards are matched against the file with absolute path, so to
809# exclude all test directories for example use the pattern */test/*
813# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
814# (namespaces, classes, functions, etc.) that should be excluded from the
815# output. The symbol name can be a fully qualified name, a word, or if the
816# wildcard * is used, a substring. Examples: ANamespace, AClass,
817# AClass::ANamespace, ANamespace::*Test
819# Note that the wildcards are matched against the file with absolute path, so to
820# exclude all test directories use the pattern */test/*
824# The EXAMPLE_PATH tag can be used to specify one or more files or directories
825# that contain example code fragments that are included (see the \include
830# If the value of the EXAMPLE_PATH tag contains directories, you can use the
831# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
832# *.h) to filter out the source-files in the directories. If left blank all
837# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
838# searched for input files to be used with the \include or \dontinclude commands
839# irrespective of the value of the RECURSIVE tag.
840# The default value is: NO.
842EXAMPLE_RECURSIVE = NO
844# The IMAGE_PATH tag can be used to specify one or more files or directories
845# that contain images that are to be included in the documentation (see the
850# The INPUT_FILTER tag can be used to specify a program that doxygen should
851# invoke to filter for each input file. Doxygen will invoke the filter program
852# by executing (via popen()) the command:
854# <filter> <input-file>
856# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
857# name of an input file. Doxygen will then use the output that the filter
858# program writes to standard output. If FILTER_PATTERNS is specified, this tag
861# Note that the filter must not add or remove lines; it is applied before the
862# code is scanned, but not when the output code is generated. If lines are added
863# or removed, the anchors will not be placed correctly.
867# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
868# basis. Doxygen will compare the file name with each pattern and apply the
869# filter if there is a match. The filters are a list of the form: pattern=filter
870# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
871# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
872# patterns match the file name, INPUT_FILTER is applied.
874FILTER_PATTERNS = *.qml=doxyqml
876# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
877# INPUT_FILTER ) will also be used to filter the input files that are used for
878# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
879# The default value is: NO.
881FILTER_SOURCE_FILES = NO
883# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
884# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
885# it is also possible to disable source filtering for a specific pattern using
886# *.ext= (so without naming a filter).
887# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
889FILTER_SOURCE_PATTERNS =
891# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
892# is part of the input, its contents will be placed on the main page
893# (index.html). This can be useful if you have a project on for instance GitHub
894# and want to reuse the introduction page also for the doxygen output.
896USE_MDFILE_AS_MAINPAGE =
898#---------------------------------------------------------------------------
899# Configuration options related to source browsing
900#---------------------------------------------------------------------------
902# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
903# generated. Documented entities will be cross-referenced with these sources.
905# Note: To get rid of all source code in the generated output, make sure that
906# also VERBATIM_HEADERS is set to NO.
907# The default value is: NO.
911# Setting the INLINE_SOURCES tag to YES will include the body of functions,
912# classes and enums directly into the documentation.
913# The default value is: NO.
917# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
918# special comment blocks from generated source code fragments. Normal C, C++ and
919# Fortran comments will always remain visible.
920# The default value is: YES.
922STRIP_CODE_COMMENTS = YES
924# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
925# function all documented functions referencing it will be listed.
926# The default value is: NO.
928REFERENCED_BY_RELATION = NO
930# If the REFERENCES_RELATION tag is set to YES then for each documented function
931# all documented entities called/used by that function will be listed.
932# The default value is: NO.
934REFERENCES_RELATION = NO
936# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
937# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
938# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
939# link to the documentation.
940# The default value is: YES.
942REFERENCES_LINK_SOURCE = YES
944# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
945# source code will show a tooltip with additional information such as prototype,
946# brief description and links to the definition and documentation. Since this
947# will make the HTML file larger and loading of large files a bit slower, you
948# can opt to disable this feature.
949# The default value is: YES.
950# This tag requires that the tag SOURCE_BROWSER is set to YES.
954# If the USE_HTAGS tag is set to YES then the references to source code will
955# point to the HTML generated by the htags(1) tool instead of doxygen built-in
956# source browser. The htags tool is part of GNU's global source tagging system
957# (see http://www.gnu.org/software/global/global.html). You will need version
960# To use it do the following:
961# - Install the latest version of global
962# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
963# - Make sure the INPUT points to the root of the source tree
964# - Run doxygen as normal
966# Doxygen will invoke htags (and that will in turn invoke gtags), so these
967# tools must be available from the command line (i.e. in the search path).
969# The result: instead of the source browser generated by doxygen, the links to
970# source code will now point to the output of htags.
971# The default value is: NO.
972# This tag requires that the tag SOURCE_BROWSER is set to YES.
976# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
977# verbatim copy of the header file for each class for which an include is
978# specified. Set to NO to disable this.
979# See also: Section \class.
980# The default value is: YES.
982VERBATIM_HEADERS = YES
984#---------------------------------------------------------------------------
985# Configuration options related to the alphabetical class index
986#---------------------------------------------------------------------------
988# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
989# compounds will be generated. Enable this if the project contains a lot of
990# classes, structs, unions or interfaces.
991# The default value is: YES.
993ALPHABETICAL_INDEX = YES
995# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
996# which the alphabetical index list will be split.
997# Minimum value: 1, maximum value: 20, default value: 5.
998# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1000COLS_IN_ALPHA_INDEX = 5
1002# In case all classes in a project start with a common prefix, all classes will
1003# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1004# can be used to specify a prefix (or a list of prefixes) that should be ignored
1005# while generating the index headers.
1006# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1010#---------------------------------------------------------------------------
1011# Configuration options related to the HTML output
1012#---------------------------------------------------------------------------
1014# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1015# The default value is: YES.
1019# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1020# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1022# The default directory is: html.
1023# This tag requires that the tag GENERATE_HTML is set to YES.
1027# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1028# generated HTML page (for example: .htm, .php, .asp).
1029# The default value is: .html.
1030# This tag requires that the tag GENERATE_HTML is set to YES.
1032HTML_FILE_EXTENSION = .html
1034# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1035# each generated HTML page. If the tag is left blank doxygen will generate a
1038# To get valid HTML the header file that includes any scripts and style sheets
1039# that doxygen needs, which is dependent on the configuration options used (e.g.
1040# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1041# default header using
1042# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1044# and then modify the file new_header.html. See also section "Doxygen usage"
1045# for information on how to generate the default header that doxygen normally
1047# Note: The header is subject to change so you typically have to regenerate the
1048# default header when upgrading to a newer version of doxygen. For a description
1049# of the possible markers and block names see the documentation.
1050# This tag requires that the tag GENERATE_HTML is set to YES.
1054# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1055# generated HTML page. If the tag is left blank doxygen will generate a standard
1056# footer. See HTML_HEADER for more information on how to generate a default
1057# footer and what special commands can be used inside the footer. See also
1058# section "Doxygen usage" for information on how to generate the default footer
1059# that doxygen normally uses.
1060# This tag requires that the tag GENERATE_HTML is set to YES.
1064# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1065# sheet that is used by each HTML page. It can be used to fine-tune the look of
1066# the HTML output. If left blank doxygen will generate a default style sheet.
1067# See also section "Doxygen usage" for information on how to generate the style
1068# sheet that doxygen normally uses.
1069# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1070# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1072# This tag requires that the tag GENERATE_HTML is set to YES.
1076# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1077# defined cascading style sheet that is included after the standard style sheets
1078# created by doxygen. Using this option one can overrule certain style aspects.
1079# This is preferred over using HTML_STYLESHEET since it does not replace the
1080# standard style sheet and is therefor more robust against future updates.
1081# Doxygen will copy the style sheet file to the output directory. For an example
1082# see the documentation.
1083# This tag requires that the tag GENERATE_HTML is set to YES.
1085HTML_EXTRA_STYLESHEET =
1087# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1088# other source files which should be copied to the HTML output directory. Note
1089# that these files will be copied to the base HTML output directory. Use the
1090# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1091# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1092# files will be copied as-is; there are no commands or markers available.
1093# This tag requires that the tag GENERATE_HTML is set to YES.
1097# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1098# will adjust the colors in the stylesheet and background images according to
1099# this color. Hue is specified as an angle on a colorwheel, see
1100# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1101# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1102# purple, and 360 is red again.
1103# Minimum value: 0, maximum value: 359, default value: 220.
1104# This tag requires that the tag GENERATE_HTML is set to YES.
1106HTML_COLORSTYLE_HUE = 220
1108# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1109# in the HTML output. For a value of 0 the output will use grayscales only. A
1110# value of 255 will produce the most vivid colors.
1111# Minimum value: 0, maximum value: 255, default value: 100.
1112# This tag requires that the tag GENERATE_HTML is set to YES.
1114HTML_COLORSTYLE_SAT = 100
1116# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1117# luminance component of the colors in the HTML output. Values below 100
1118# gradually make the output lighter, whereas values above 100 make the output
1119# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1120# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1122# Minimum value: 40, maximum value: 240, default value: 80.
1123# This tag requires that the tag GENERATE_HTML is set to YES.
1125HTML_COLORSTYLE_GAMMA = 80
1127# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1128# page will contain the date and time when the page was generated. Setting this
1129# to NO can help when comparing the output of multiple runs.
1130# The default value is: YES.
1131# This tag requires that the tag GENERATE_HTML is set to YES.
1135# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1136# documentation will contain sections that can be hidden and shown after the
1138# The default value is: NO.
1139# This tag requires that the tag GENERATE_HTML is set to YES.
1141HTML_DYNAMIC_SECTIONS = NO
1143# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1144# shown in the various tree structured indices initially; the user can expand
1145# and collapse entries dynamically later on. Doxygen will expand the tree to
1146# such a level that at most the specified number of entries are visible (unless
1147# a fully collapsed tree already exceeds this amount). So setting the number of
1148# entries 1 will produce a full collapsed tree by default. 0 is a special value
1149# representing an infinite number of entries and will result in a full expanded
1151# Minimum value: 0, maximum value: 9999, default value: 100.
1152# This tag requires that the tag GENERATE_HTML is set to YES.
1154HTML_INDEX_NUM_ENTRIES = 100
1156# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1157# generated that can be used as input for Apple's Xcode 3 integrated development
1158# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1159# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1160# Makefile in the HTML output directory. Running make will produce the docset in
1161# that directory and running make install will install the docset in
1162# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1163# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1164# for more information.
1165# The default value is: NO.
1166# This tag requires that the tag GENERATE_HTML is set to YES.
1170# This tag determines the name of the docset feed. A documentation feed provides
1171# an umbrella under which multiple documentation sets from a single provider
1172# (such as a company or product suite) can be grouped.
1173# The default value is: Doxygen generated docs.
1174# This tag requires that the tag GENERATE_DOCSET is set to YES.
1176DOCSET_FEEDNAME = "Doxygen generated docs"
1178# This tag specifies a string that should uniquely identify the documentation
1179# set bundle. This should be a reverse domain-name style string, e.g.
1180# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1181# The default value is: org.doxygen.Project.
1182# This tag requires that the tag GENERATE_DOCSET is set to YES.
1184DOCSET_BUNDLE_ID = org.doxygen.Project
1186# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1187# the documentation publisher. This should be a reverse domain-name style
1188# string, e.g. com.mycompany.MyDocSet.documentation.
1189# The default value is: org.doxygen.Publisher.
1190# This tag requires that the tag GENERATE_DOCSET is set to YES.
1192DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1194# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1195# The default value is: Publisher.
1196# This tag requires that the tag GENERATE_DOCSET is set to YES.
1198DOCSET_PUBLISHER_NAME = Publisher
1200# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1201# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1202# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1203# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1206# The HTML Help Workshop contains a compiler that can convert all HTML output
1207# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1208# files are now used as the Windows 98 help format, and will replace the old
1209# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1210# HTML files also contain an index, a table of contents, and you can search for
1211# words in the documentation. The HTML workshop also contains a viewer for
1212# compressed HTML files.
1213# The default value is: NO.
1214# This tag requires that the tag GENERATE_HTML is set to YES.
1216GENERATE_HTMLHELP = NO
1218# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1219# file. You can add a path in front of the file if the result should not be
1220# written to the html output directory.
1221# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1225# The HHC_LOCATION tag can be used to specify the location (absolute path
1226# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1227# doxygen will try to run the HTML help compiler on the generated index.hhp.
1228# The file has to be specified with full path.
1229# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1233# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1234# YES) or that it should be included in the master .chm file ( NO).
1235# The default value is: NO.
1236# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1240# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1241# and project file content.
1242# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1246# The BINARY_TOC flag controls whether a binary table of contents is generated (
1247# YES) or a normal table of contents ( NO) in the .chm file.
1248# The default value is: NO.
1249# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1253# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1254# the table of contents of the HTML help documentation and to the tree view.
1255# The default value is: NO.
1256# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1260# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1261# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1262# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1263# (.qch) of the generated HTML documentation.
1264# The default value is: NO.
1265# This tag requires that the tag GENERATE_HTML is set to YES.
1269# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1270# the file name of the resulting .qch file. The path specified is relative to
1271# the HTML output folder.
1272# This tag requires that the tag GENERATE_QHP is set to YES.
1276# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1277# Project output. For more information please see Qt Help Project / Namespace
1278# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1279# The default value is: org.doxygen.Project.
1280# This tag requires that the tag GENERATE_QHP is set to YES.
1282QHP_NAMESPACE = org.doxygen.Project
1284# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1285# Help Project output. For more information please see Qt Help Project / Virtual
1286# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1288# The default value is: doc.
1289# This tag requires that the tag GENERATE_QHP is set to YES.
1291QHP_VIRTUAL_FOLDER = doc
1293# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1294# filter to add. For more information please see Qt Help Project / Custom
1295# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1297# This tag requires that the tag GENERATE_QHP is set to YES.
1299QHP_CUST_FILTER_NAME =
1301# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1302# custom filter to add. For more information please see Qt Help Project / Custom
1303# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1305# This tag requires that the tag GENERATE_QHP is set to YES.
1307QHP_CUST_FILTER_ATTRS =
1309# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1310# project's filter section matches. Qt Help Project / Filter Attributes (see:
1311# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1312# This tag requires that the tag GENERATE_QHP is set to YES.
1314QHP_SECT_FILTER_ATTRS =
1316# The QHG_LOCATION tag can be used to specify the location of Qt's
1317# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1318# generated .qhp file.
1319# This tag requires that the tag GENERATE_QHP is set to YES.
1323# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1324# generated, together with the HTML files, they form an Eclipse help plugin. To
1325# install this plugin and make it available under the help contents menu in
1326# Eclipse, the contents of the directory containing the HTML and XML files needs
1327# to be copied into the plugins directory of eclipse. The name of the directory
1328# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1329# After copying Eclipse needs to be restarted before the help appears.
1330# The default value is: NO.
1331# This tag requires that the tag GENERATE_HTML is set to YES.
1333GENERATE_ECLIPSEHELP = NO
1335# A unique identifier for the Eclipse help plugin. When installing the plugin
1336# the directory name containing the HTML and XML files should also have this
1337# name. Each documentation set should have its own identifier.
1338# The default value is: org.doxygen.Project.
1339# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1341ECLIPSE_DOC_ID = org.doxygen.Project
1343# If you want full control over the layout of the generated HTML pages it might
1344# be necessary to disable the index and replace it with your own. The
1345# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1346# of each HTML page. A value of NO enables the index and the value YES disables
1347# it. Since the tabs in the index contain the same information as the navigation
1348# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1349# The default value is: NO.
1350# This tag requires that the tag GENERATE_HTML is set to YES.
1354# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1355# structure should be generated to display hierarchical information. If the tag
1356# value is set to YES, a side panel will be generated containing a tree-like
1357# index structure (just like the one that is generated for HTML Help). For this
1358# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1359# (i.e. any modern browser). Windows users are probably better off using the
1360# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1361# further fine-tune the look of the index. As an example, the default style
1362# sheet generated by doxygen has an example that shows how to put an image at
1363# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1364# the same information as the tab index, you could consider setting
1365# DISABLE_INDEX to YES when enabling this option.
1366# The default value is: NO.
1367# This tag requires that the tag GENERATE_HTML is set to YES.
1369GENERATE_TREEVIEW = YES
1371# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1372# doxygen will group on one line in the generated HTML documentation.
1374# Note that a value of 0 will completely suppress the enum values from appearing
1375# in the overview section.
1376# Minimum value: 0, maximum value: 20, default value: 4.
1377# This tag requires that the tag GENERATE_HTML is set to YES.
1379ENUM_VALUES_PER_LINE = 4
1381# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1382# to set the initial width (in pixels) of the frame in which the tree is shown.
1383# Minimum value: 0, maximum value: 1500, default value: 250.
1384# This tag requires that the tag GENERATE_HTML is set to YES.
1388# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1389# external symbols imported via tag files in a separate window.
1390# The default value is: NO.
1391# This tag requires that the tag GENERATE_HTML is set to YES.
1393EXT_LINKS_IN_WINDOW = NO
1395# Use this tag to change the font size of LaTeX formulas included as images in
1396# the HTML documentation. When you change the font size after a successful
1397# doxygen run you need to manually remove any form_*.png images from the HTML
1398# output directory to force them to be regenerated.
1399# Minimum value: 8, maximum value: 50, default value: 10.
1400# This tag requires that the tag GENERATE_HTML is set to YES.
1402FORMULA_FONTSIZE = 10
1404# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1405# generated for formulas are transparent PNGs. Transparent PNGs are not
1406# supported properly for IE 6.0, but are supported on all modern browsers.
1408# Note that when changing this option you need to delete any form_*.png files in
1409# the HTML output directory before the changes have effect.
1410# The default value is: YES.
1411# This tag requires that the tag GENERATE_HTML is set to YES.
1413FORMULA_TRANSPARENT = YES
1415# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1416# http://www.mathjax.org) which uses client side Javascript for the rendering
1417# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1418# installed or if you want to formulas look prettier in the HTML output. When
1419# enabled you may also need to install MathJax separately and configure the path
1420# to it using the MATHJAX_RELPATH option.
1421# The default value is: NO.
1422# This tag requires that the tag GENERATE_HTML is set to YES.
1426# When MathJax is enabled you can set the default output format to be used for
1427# the MathJax output. See the MathJax site (see:
1428# http://docs.mathjax.org/en/latest/output.html) for more details.
1429# Possible values are: HTML-CSS (which is slower, but has the best
1430# compatibility), NativeMML (i.e. MathML) and SVG.
1431# The default value is: HTML-CSS.
1432# This tag requires that the tag USE_MATHJAX is set to YES.
1434MATHJAX_FORMAT = HTML-CSS
1436# When MathJax is enabled you need to specify the location relative to the HTML
1437# output directory using the MATHJAX_RELPATH option. The destination directory
1438# should contain the MathJax.js script. For instance, if the mathjax directory
1439# is located at the same level as the HTML output directory, then
1440# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1441# Content Delivery Network so you can quickly see the result without installing
1442# MathJax. However, it is strongly recommended to install a local copy of
1443# MathJax from http://www.mathjax.org before deployment.
1444# The default value is: http://cdn.mathjax.org/mathjax/latest.
1445# This tag requires that the tag USE_MATHJAX is set to YES.
1447MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1449# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1450# extension names that should be enabled during MathJax rendering. For example
1451# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1452# This tag requires that the tag USE_MATHJAX is set to YES.
1456# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1457# of code that will be used on startup of the MathJax code. See the MathJax site
1458# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1459# example see the documentation.
1460# This tag requires that the tag USE_MATHJAX is set to YES.
1464# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1465# the HTML output. The underlying search engine uses javascript and DHTML and
1466# should work on any modern browser. Note that when using HTML help
1467# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1468# there is already a search function so this one should typically be disabled.
1469# For large projects the javascript based search engine can be slow, then
1470# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1471# search using the keyboard; to jump to the search box use <access key> + S
1472# (what the <access key> is depends on the OS and browser, but it is typically
1473# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1474# key> to jump into the search results window, the results can be navigated
1475# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1476# the search. The filter options can be selected when the cursor is inside the
1477# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1478# to select a filter and <Enter> or <escape> to activate or cancel the filter
1480# The default value is: YES.
1481# This tag requires that the tag GENERATE_HTML is set to YES.
1485# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1486# implemented using a web server instead of a web client using Javascript. There
1487# are two flavours of web server based searching depending on the
1488# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1489# searching and an index file used by the script. When EXTERNAL_SEARCH is
1490# enabled the indexing and searching needs to be provided by external tools. See
1491# the section "External Indexing and Searching" for details.
1492# The default value is: NO.
1493# This tag requires that the tag SEARCHENGINE is set to YES.
1495SERVER_BASED_SEARCH = NO
1497# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1498# script for searching. Instead the search results are written to an XML file
1499# which needs to be processed by an external indexer. Doxygen will invoke an
1500# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1503# Doxygen ships with an example indexer ( doxyindexer) and search engine
1504# (doxysearch.cgi) which are based on the open source search engine library
1505# Xapian (see: http://xapian.org/).
1507# See the section "External Indexing and Searching" for details.
1508# The default value is: NO.
1509# This tag requires that the tag SEARCHENGINE is set to YES.
1513# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1514# which will return the search results when EXTERNAL_SEARCH is enabled.
1516# Doxygen ships with an example indexer ( doxyindexer) and search engine
1517# (doxysearch.cgi) which are based on the open source search engine library
1518# Xapian (see: http://xapian.org/). See the section "External Indexing and
1519# Searching" for details.
1520# This tag requires that the tag SEARCHENGINE is set to YES.
1524# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1525# search data is written to a file for indexing by an external tool. With the
1526# SEARCHDATA_FILE tag the name of this file can be specified.
1527# The default file is: searchdata.xml.
1528# This tag requires that the tag SEARCHENGINE is set to YES.
1530SEARCHDATA_FILE = searchdata.xml
1532# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1533# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1534# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1535# projects and redirect the results back to the right project.
1536# This tag requires that the tag SEARCHENGINE is set to YES.
1540# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1541# projects other than the one defined by this configuration file, but that are
1542# all added to the same external search index. Each project needs to have a
1543# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1544# to a relative location where the documentation can be found. The format is:
1545# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1546# This tag requires that the tag SEARCHENGINE is set to YES.
1548EXTRA_SEARCH_MAPPINGS =
1550#---------------------------------------------------------------------------
1551# Configuration options related to the LaTeX output
1552#---------------------------------------------------------------------------
1554# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1555# The default value is: YES.
1559# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1560# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1562# The default directory is: latex.
1563# This tag requires that the tag GENERATE_LATEX is set to YES.
1567# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1570# Note that when enabling USE_PDFLATEX this option is only used for generating
1571# bitmaps for formulas in the HTML output, but not in the Makefile that is
1572# written to the output directory.
1573# The default file is: latex.
1574# This tag requires that the tag GENERATE_LATEX is set to YES.
1576LATEX_CMD_NAME = latex
1578# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1580# The default file is: makeindex.
1581# This tag requires that the tag GENERATE_LATEX is set to YES.
1583MAKEINDEX_CMD_NAME = makeindex
1585# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1586# documents. This may be useful for small projects and may help to save some
1588# The default value is: NO.
1589# This tag requires that the tag GENERATE_LATEX is set to YES.
1593# The PAPER_TYPE tag can be used to set the paper type that is used by the
1595# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1596# 14 inches) and executive (7.25 x 10.5 inches).
1597# The default value is: a4.
1598# This tag requires that the tag GENERATE_LATEX is set to YES.
1602# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1603# that should be included in the LaTeX output. To get the times font for
1604# instance you can specify
1605# EXTRA_PACKAGES=times
1606# If left blank no extra packages will be included.
1607# This tag requires that the tag GENERATE_LATEX is set to YES.
1611# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1612# generated LaTeX document. The header should contain everything until the first
1613# chapter. If it is left blank doxygen will generate a standard header. See
1614# section "Doxygen usage" for information on how to let doxygen write the
1615# default header to a separate file.
1617# Note: Only use a user-defined header if you know what you are doing! The
1618# following commands have a special meaning inside the header: $title,
1619# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1620# replace them by respectively the title of the page, the current date and time,
1621# only the current date, the version number of doxygen, the project name (see
1622# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1623# This tag requires that the tag GENERATE_LATEX is set to YES.
1627# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1628# generated LaTeX document. The footer should contain everything after the last
1629# chapter. If it is left blank doxygen will generate a standard footer.
1631# Note: Only use a user-defined footer if you know what you are doing!
1632# This tag requires that the tag GENERATE_LATEX is set to YES.
1636# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1637# other source files which should be copied to the LATEX_OUTPUT output
1638# directory. Note that the files will be copied as-is; there are no commands or
1640# This tag requires that the tag GENERATE_LATEX is set to YES.
1644# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1645# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1646# contain links (just like the HTML output) instead of page references. This
1647# makes the output suitable for online browsing using a PDF viewer.
1648# The default value is: YES.
1649# This tag requires that the tag GENERATE_LATEX is set to YES.
1653# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1654# the PDF file directly from the LaTeX files. Set this option to YES to get a
1655# higher quality PDF documentation.
1656# The default value is: YES.
1657# This tag requires that the tag GENERATE_LATEX is set to YES.
1661# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1662# command to the generated LaTeX files. This will instruct LaTeX to keep running
1663# if errors occur, instead of asking the user for help. This option is also used
1664# when generating formulas in HTML.
1665# The default value is: NO.
1666# This tag requires that the tag GENERATE_LATEX is set to YES.
1670# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1671# index chapters (such as File Index, Compound Index, etc.) in the output.
1672# The default value is: NO.
1673# This tag requires that the tag GENERATE_LATEX is set to YES.
1675LATEX_HIDE_INDICES = NO
1677# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1678# code with syntax highlighting in the LaTeX output.
1680# Note that which sources are shown also depends on other settings such as
1682# The default value is: NO.
1683# This tag requires that the tag GENERATE_LATEX is set to YES.
1685LATEX_SOURCE_CODE = NO
1687# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1688# bibliography, e.g. plainnat, or ieeetr. See
1689# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1690# The default value is: plain.
1691# This tag requires that the tag GENERATE_LATEX is set to YES.
1693LATEX_BIB_STYLE = plain
1695#---------------------------------------------------------------------------
1696# Configuration options related to the RTF output
1697#---------------------------------------------------------------------------
1699# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1700# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1702# The default value is: NO.
1706# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1707# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1709# The default directory is: rtf.
1710# This tag requires that the tag GENERATE_RTF is set to YES.
1714# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1715# documents. This may be useful for small projects and may help to save some
1717# The default value is: NO.
1718# This tag requires that the tag GENERATE_RTF is set to YES.
1722# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1723# contain hyperlink fields. The RTF file will contain links (just like the HTML
1724# output) instead of page references. This makes the output suitable for online
1725# browsing using Word or some other Word compatible readers that support those
1728# Note: WordPad (write) and others do not support links.
1729# The default value is: NO.
1730# This tag requires that the tag GENERATE_RTF is set to YES.
1734# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1735# file, i.e. a series of assignments. You only have to provide replacements,
1736# missing definitions are set to their default value.
1738# See also section "Doxygen usage" for information on how to generate the
1739# default style sheet that doxygen normally uses.
1740# This tag requires that the tag GENERATE_RTF is set to YES.
1742RTF_STYLESHEET_FILE =
1744# Set optional variables used in the generation of an RTF document. Syntax is
1745# similar to doxygen's config file. A template extensions file can be generated
1746# using doxygen -e rtf extensionFile.
1747# This tag requires that the tag GENERATE_RTF is set to YES.
1749RTF_EXTENSIONS_FILE =
1751#---------------------------------------------------------------------------
1752# Configuration options related to the man page output
1753#---------------------------------------------------------------------------
1755# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1757# The default value is: NO.
1761# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1762# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1763# it. A directory man3 will be created inside the directory specified by
1765# The default directory is: man.
1766# This tag requires that the tag GENERATE_MAN is set to YES.
1770# The MAN_EXTENSION tag determines the extension that is added to the generated
1771# man pages. In case the manual section does not start with a number, the number
1772# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1774# The default value is: .3.
1775# This tag requires that the tag GENERATE_MAN is set to YES.
1779# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1780# will generate one additional man file for each entity documented in the real
1781# man page(s). These additional files only source the real man page, but without
1782# them the man command would be unable to find the correct page.
1783# The default value is: NO.
1784# This tag requires that the tag GENERATE_MAN is set to YES.
1788#---------------------------------------------------------------------------
1789# Configuration options related to the XML output
1790#---------------------------------------------------------------------------
1792# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1793# captures the structure of the code including all documentation.
1794# The default value is: NO.
1798# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1799# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1801# The default directory is: xml.
1802# This tag requires that the tag GENERATE_XML is set to YES.
1806# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1807# validating XML parser to check the syntax of the XML files.
1808# This tag requires that the tag GENERATE_XML is set to YES.
1812# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1813# validating XML parser to check the syntax of the XML files.
1814# This tag requires that the tag GENERATE_XML is set to YES.
1818# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1819# listings (including syntax highlighting and cross-referencing information) to
1820# the XML output. Note that enabling this will significantly increase the size
1822# The default value is: YES.
1823# This tag requires that the tag GENERATE_XML is set to YES.
1825XML_PROGRAMLISTING = YES
1827#---------------------------------------------------------------------------
1828# Configuration options related to the DOCBOOK output
1829#---------------------------------------------------------------------------
1831# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1832# that can be used to generate PDF.
1833# The default value is: NO.
1835GENERATE_DOCBOOK = NO
1837# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1838# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1840# The default directory is: docbook.
1841# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1843DOCBOOK_OUTPUT = docbook
1845#---------------------------------------------------------------------------
1846# Configuration options for the AutoGen Definitions output
1847#---------------------------------------------------------------------------
1849# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1850# Definitions (see http://autogen.sf.net) file that captures the structure of
1851# the code including all documentation. Note that this feature is still
1852# experimental and incomplete at the moment.
1853# The default value is: NO.
1855GENERATE_AUTOGEN_DEF = NO
1857#---------------------------------------------------------------------------
1858# Configuration options related to the Perl module output
1859#---------------------------------------------------------------------------
1861# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1862# file that captures the structure of the code including all documentation.
1864# Note that this feature is still experimental and incomplete at the moment.
1865# The default value is: NO.
1867GENERATE_PERLMOD = NO
1869# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1870# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1871# output from the Perl module output.
1872# The default value is: NO.
1873# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1877# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1878# formatted so it can be parsed by a human reader. This is useful if you want to
1879# understand what is going on. On the other hand, if this tag is set to NO the
1880# size of the Perl module output will be much smaller and Perl will parse it
1882# The default value is: YES.
1883# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1887# The names of the make variables in the generated doxyrules.make file are
1888# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1889# so different doxyrules.make files included by the same Makefile don't
1890# overwrite each other's variables.
1891# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1893PERLMOD_MAKEVAR_PREFIX =
1895#---------------------------------------------------------------------------
1896# Configuration options related to the preprocessor
1897#---------------------------------------------------------------------------
1899# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1900# C-preprocessor directives found in the sources and include files.
1901# The default value is: YES.
1903ENABLE_PREPROCESSING = YES
1905# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1906# in the source code. If set to NO only conditional compilation will be
1907# performed. Macro expansion can be done in a controlled way by setting
1908# EXPAND_ONLY_PREDEF to YES.
1909# The default value is: NO.
1910# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1914# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1915# the macro expansion is limited to the macros specified with the PREDEFINED and
1916# EXPAND_AS_DEFINED tags.
1917# The default value is: NO.
1918# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1920EXPAND_ONLY_PREDEF = NO
1922# If the SEARCH_INCLUDES tag is set to YES the includes files in the
1923# INCLUDE_PATH will be searched if a #include is found.
1924# The default value is: YES.
1925# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1927SEARCH_INCLUDES = YES
1929# The INCLUDE_PATH tag can be used to specify one or more directories that
1930# contain include files that are not input files but should be processed by the
1932# This tag requires that the tag SEARCH_INCLUDES is set to YES.
1936# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1937# patterns (like *.h and *.hpp) to filter out the header-files in the
1938# directories. If left blank, the patterns specified with FILE_PATTERNS will be
1940# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1942INCLUDE_FILE_PATTERNS =
1944# The PREDEFINED tag can be used to specify one or more macro names that are
1945# defined before the preprocessor is started (similar to the -D option of e.g.
1946# gcc). The argument of the tag is a list of macros of the form: name or
1947# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1948# is assumed. To prevent a macro definition from being undefined via #undef or
1949# recursively expanded use the := operator instead of the = operator.
1950# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1954# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1955# tag can be used to specify a list of macro names that should be expanded. The
1956# macro definition that is found in the sources will be used. Use the PREDEFINED
1957# tag if you want to use a different macro definition that overrules the
1958# definition found in the source code.
1959# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1963# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1964# remove all refrences to function-like macros that are alone on a line, have an
1965# all uppercase name, and do not end with a semicolon. Such function macros are
1966# typically used for boiler-plate code, and will confuse the parser if not
1968# The default value is: YES.
1969# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1971SKIP_FUNCTION_MACROS = YES
1973#---------------------------------------------------------------------------
1974# Configuration options related to external references
1975#---------------------------------------------------------------------------
1977# The TAGFILES tag can be used to specify one or more tag files. For each tag
1978# file the location of the external documentation should be added. The format of
1979# a tag file without this location is as follows:
1980# TAGFILES = file1 file2 ...
1981# Adding location for the tag files is done as follows:
1982# TAGFILES = file1=loc1 "file2 = loc2" ...
1983# where loc1 and loc2 can be relative or absolute paths or URLs. See the
1984# section "Linking to external documentation" for more information about the use
1986# Note: Each tag file must have an unique name (where the name does NOT include
1987# the path). If a tag file is not located in the directory in which doxygen is
1988# run, you must also specify the path to the tagfile here.
1992# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1993# tag file that is based on the input files it reads. See section "Linking to
1994# external documentation" for more information about the usage of tag files.
1998# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1999# class index. If set to NO only the inherited external classes will be listed.
2000# The default value is: NO.
2004# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2005# the modules index. If set to NO, only the current project's groups will be
2007# The default value is: YES.
2009EXTERNAL_GROUPS = YES
2011# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2012# the related pages index. If set to NO, only the current project's pages will
2014# The default value is: YES.
2018# The PERL_PATH should be the absolute path and name of the perl script
2019# interpreter (i.e. the result of 'which perl').
2020# The default file (with absolute path) is: /usr/bin/perl.
2022PERL_PATH = /usr/bin/perl
2024#---------------------------------------------------------------------------
2025# Configuration options related to the dot tool
2026#---------------------------------------------------------------------------
2028# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2029# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2030# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2031# disabled, but it is recommended to install and use dot, since it yields more
2033# The default value is: YES.
2037# You can define message sequence charts within doxygen comments using the \msc
2038# command. Doxygen will then run the mscgen tool (see:
2039# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2040# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2041# the mscgen tool resides. If left empty the tool is assumed to be found in the
2042# default search path.
2046# You can include diagrams made with dia in doxygen documentation. Doxygen will
2047# then run dia to produce the diagram and insert it in the documentation. The
2048# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2049# If left empty dia is assumed to be found in the default search path.
2053# If set to YES, the inheritance and collaboration graphs will hide inheritance
2054# and usage relations if the target is undocumented or is not a class.
2055# The default value is: YES.
2057HIDE_UNDOC_RELATIONS = YES
2059# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2060# available from the path. This tool is part of Graphviz (see:
2061# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2062# Bell Labs. The other options in this section have no effect if this option is
2064# The default value is: NO.
2068# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2069# to run in parallel. When set to 0 doxygen will base this on the number of
2070# processors available in the system. You can set it explicitly to a value
2071# larger than 0 to get control over the balance between CPU load and processing
2073# Minimum value: 0, maximum value: 32, default value: 0.
2074# This tag requires that the tag HAVE_DOT is set to YES.
2078# When you want a differently looking font n the dot files that doxygen
2079# generates you can specify the font name using DOT_FONTNAME. You need to make
2080# sure dot is able to find the font, which can be done by putting it in a
2081# standard location or by setting the DOTFONTPATH environment variable or by
2082# setting DOT_FONTPATH to the directory containing the font.
2083# The default value is: Helvetica.
2084# This tag requires that the tag HAVE_DOT is set to YES.
2086DOT_FONTNAME = Helvetica
2088# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2090# Minimum value: 4, maximum value: 24, default value: 10.
2091# This tag requires that the tag HAVE_DOT is set to YES.
2095# By default doxygen will tell dot to use the default font as specified with
2096# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2097# the path where dot can find it using this tag.
2098# This tag requires that the tag HAVE_DOT is set to YES.
2102# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2103# each documented class showing the direct and indirect inheritance relations.
2104# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2105# The default value is: YES.
2106# This tag requires that the tag HAVE_DOT is set to YES.
2110# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2111# graph for each documented class showing the direct and indirect implementation
2112# dependencies (inheritance, containment, and class references variables) of the
2113# class with other documented classes.
2114# The default value is: YES.
2115# This tag requires that the tag HAVE_DOT is set to YES.
2117COLLABORATION_GRAPH = YES
2119# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2120# groups, showing the direct groups dependencies.
2121# The default value is: YES.
2122# This tag requires that the tag HAVE_DOT is set to YES.
2126# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2127# collaboration diagrams in a style similar to the OMG's Unified Modeling
2129# The default value is: NO.
2130# This tag requires that the tag HAVE_DOT is set to YES.
2134# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2135# class node. If there are many fields or methods and many nodes the graph may
2136# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2137# number of items for each type to make the size more manageable. Set this to 0
2138# for no limit. Note that the threshold may be exceeded by 50% before the limit
2139# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2140# but if the number exceeds 15, the total amount of fields shown is limited to
2142# Minimum value: 0, maximum value: 100, default value: 10.
2143# This tag requires that the tag HAVE_DOT is set to YES.
2145UML_LIMIT_NUM_FIELDS = 10
2147# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2148# collaboration graphs will show the relations between templates and their
2150# The default value is: NO.
2151# This tag requires that the tag HAVE_DOT is set to YES.
2153TEMPLATE_RELATIONS = NO
2155# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2156# YES then doxygen will generate a graph for each documented file showing the
2157# direct and indirect include dependencies of the file with other documented
2159# The default value is: YES.
2160# This tag requires that the tag HAVE_DOT is set to YES.
2164# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2165# set to YES then doxygen will generate a graph for each documented file showing
2166# the direct and indirect include dependencies of the file with other documented
2168# The default value is: YES.
2169# This tag requires that the tag HAVE_DOT is set to YES.
2171INCLUDED_BY_GRAPH = YES
2173# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2174# dependency graph for every global function or class method.
2176# Note that enabling this option will significantly increase the time of a run.
2177# So in most cases it will be better to enable call graphs for selected
2178# functions only using the \callgraph command.
2179# The default value is: NO.
2180# This tag requires that the tag HAVE_DOT is set to YES.
2184# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2185# dependency graph for every global function or class method.
2187# Note that enabling this option will significantly increase the time of a run.
2188# So in most cases it will be better to enable caller graphs for selected
2189# functions only using the \callergraph command.
2190# The default value is: NO.
2191# This tag requires that the tag HAVE_DOT is set to YES.
2195# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2196# hierarchy of all classes instead of a textual one.
2197# The default value is: YES.
2198# This tag requires that the tag HAVE_DOT is set to YES.
2200GRAPHICAL_HIERARCHY = YES
2202# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2203# dependencies a directory has on other directories in a graphical way. The
2204# dependency relations are determined by the #include relations between the
2205# files in the directories.
2206# The default value is: YES.
2207# This tag requires that the tag HAVE_DOT is set to YES.
2209DIRECTORY_GRAPH = YES
2211# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2213# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2214# to make the SVG files visible in IE 9+ (other browsers do not have this
2216# Possible values are: png, jpg, gif and svg.
2217# The default value is: png.
2218# This tag requires that the tag HAVE_DOT is set to YES.
2220DOT_IMAGE_FORMAT = png
2222# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2223# enable generation of interactive SVG images that allow zooming and panning.
2225# Note that this requires a modern browser other than Internet Explorer. Tested
2226# and working are Firefox, Chrome, Safari, and Opera.
2227# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2228# the SVG files visible. Older versions of IE do not have SVG support.
2229# The default value is: NO.
2230# This tag requires that the tag HAVE_DOT is set to YES.
2234# The DOT_PATH tag can be used to specify the path where the dot tool can be
2235# found. If left blank, it is assumed the dot tool can be found in the path.
2236# This tag requires that the tag HAVE_DOT is set to YES.
2240# The DOTFILE_DIRS tag can be used to specify one or more directories that
2241# contain dot files that are included in the documentation (see the \dotfile
2243# This tag requires that the tag HAVE_DOT is set to YES.
2247# The MSCFILE_DIRS tag can be used to specify one or more directories that
2248# contain msc files that are included in the documentation (see the \mscfile
2253# The DIAFILE_DIRS tag can be used to specify one or more directories that
2254# contain dia files that are included in the documentation (see the \diafile
2259# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2260# that will be shown in the graph. If the number of nodes in a graph becomes
2261# larger than this value, doxygen will truncate the graph, which is visualized
2262# by representing a node as a red box. Note that doxygen if the number of direct
2263# children of the root node in a graph is already larger than
2264# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2265# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2266# Minimum value: 0, maximum value: 10000, default value: 50.
2267# This tag requires that the tag HAVE_DOT is set to YES.
2269DOT_GRAPH_MAX_NODES = 50
2271# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2272# generated by dot. A depth value of 3 means that only nodes reachable from the
2273# root by following a path via at most 3 edges will be shown. Nodes that lay
2274# further from the root node will be omitted. Note that setting this option to 1
2275# or 2 may greatly reduce the computation time needed for large code bases. Also
2276# note that the size of a graph can be further restricted by
2277# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2278# Minimum value: 0, maximum value: 1000, default value: 0.
2279# This tag requires that the tag HAVE_DOT is set to YES.
2281MAX_DOT_GRAPH_DEPTH = 0
2283# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2284# background. This is disabled by default, because dot on Windows does not seem
2285# to support this out of the box.
2287# Warning: Depending on the platform used, enabling this option may lead to
2288# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2290# The default value is: NO.
2291# This tag requires that the tag HAVE_DOT is set to YES.
2295# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2296# files in one run (i.e. multiple -o and -T options on the command line). This
2297# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2298# this, this feature is disabled by default.
2299# The default value is: NO.
2300# This tag requires that the tag HAVE_DOT is set to YES.
2302DOT_MULTI_TARGETS = YES
2304# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2305# explaining the meaning of the various boxes and arrows in the dot generated
2307# The default value is: YES.
2308# This tag requires that the tag HAVE_DOT is set to YES.
2310GENERATE_LEGEND = YES
2312# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2313# files that are used to generate the various graphs.
2314# The default value is: YES.
2315# This tag requires that the tag HAVE_DOT is set to YES.
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list