<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>doc_inner/Doxyfile</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.6.5' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='../style.css' />
</head>
<body>
<a id='TOP' name='TOP'></a><h2 class='header'><a href='../mains.html'>root</a>/<a href='../files/2927.html'>doc_inner</a>/Doxyfile</h2>
<em class='comment'>/* [<][>][^][v][top]<a href='#BOTTOM'>[bottom]</a><a href='../mains.html'>[index]</a><a href='../help.html'>[help]</a> */</em>
<hr />
<pre>
<a id='L1' name='L1'></a># Doxyfile 1.9.1
<a id='L2' name='L2'></a>
<a id='L3' name='L3'></a># This file describes the settings to be used by the documentation system
<a id='L4' name='L4'></a># doxygen (www.doxygen.org) for a project.
<a id='L5' name='L5'></a>#
<a id='L6' name='L6'></a># All text after a double hash (##) is considered a comment and is placed in
<a id='L7' name='L7'></a># front of the TAG it is preceding.
<a id='L8' name='L8'></a>#
<a id='L9' name='L9'></a># All text after a single hash (#) is considered a comment and will be ignored.
<a id='L10' name='L10'></a># The format is:
<a id='L11' name='L11'></a># TAG = value [value, ...]
<a id='L12' name='L12'></a># For lists, items can also be appended using:
<a id='L13' name='L13'></a># TAG += value [value, ...]
<a id='L14' name='L14'></a># Values that contain spaces should be placed between quotes (\" \").
<a id='L15' name='L15'></a>
<a id='L16' name='L16'></a>#---------------------------------------------------------------------------
<a id='L17' name='L17'></a># Project related configuration options
<a id='L18' name='L18'></a>#---------------------------------------------------------------------------
<a id='L19' name='L19'></a>
<a id='L20' name='L20'></a># This tag specifies the encoding used for all characters in the configuration
<a id='L21' name='L21'></a># file that follow. The default is UTF-8 which is also the encoding used for all
<a id='L22' name='L22'></a># text before the first occurrence of this tag. Doxygen uses libiconv (or the
<a id='L23' name='L23'></a># iconv built into libc) for the transcoding. See
<a id='L24' name='L24'></a># https://www.gnu.org/software/libiconv/ for the list of possible encodings.
<a id='L25' name='L25'></a># The default value is: UTF-8.
<a id='L26' name='L26'></a>
<a id='L27' name='L27'></a>DOXYFILE_ENCODING = UTF-8
<a id='L28' name='L28'></a>
<a id='L29' name='L29'></a># The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
<a id='L30' name='L30'></a># double-quotes, unless you are using Doxywizard) that should identify the
<a id='L31' name='L31'></a># project for which the documentation is generated. This name is used in the
<a id='L32' name='L32'></a># title of most generated pages and in a few other places.
<a id='L33' name='L33'></a># The default value is: My Project.
<a id='L34' name='L34'></a>
<a id='L35' name='L35'></a>PROJECT_NAME = YACASL2
<a id='L36' name='L36'></a>
<a id='L37' name='L37'></a># The PROJECT_NUMBER tag can be used to enter a project or revision number. This
<a id='L38' name='L38'></a># could be handy for archiving the generated documentation or if some version
<a id='L39' name='L39'></a># control system is used.
<a id='L40' name='L40'></a>
<a id='L41' name='L41'></a>PROJECT_NUMBER =
<a id='L42' name='L42'></a>
<a id='L43' name='L43'></a># Using the PROJECT_BRIEF tag one can provide an optional one line description
<a id='L44' name='L44'></a># for a project that appears at the top of each page and should give viewer a
<a id='L45' name='L45'></a># quick idea about the purpose of the project. Keep the description short.
<a id='L46' name='L46'></a>
<a id='L47' name='L47'></a>PROJECT_BRIEF =
<a id='L48' name='L48'></a>
<a id='L49' name='L49'></a># With the PROJECT_LOGO tag one can specify a logo or an icon that is included
<a id='L50' name='L50'></a># in the documentation. The maximum height of the logo should not exceed 55
<a id='L51' name='L51'></a># pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
<a id='L52' name='L52'></a># the logo to the output directory.
<a id='L53' name='L53'></a>
<a id='L54' name='L54'></a>PROJECT_LOGO =
<a id='L55' name='L55'></a>
<a id='L56' name='L56'></a># The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
<a id='L57' name='L57'></a># into which the generated documentation will be written. If a relative path is
<a id='L58' name='L58'></a># entered, it will be relative to the location where doxygen was started. If
<a id='L59' name='L59'></a># left blank the current directory will be used.
<a id='L60' name='L60'></a>
<a id='L61' name='L61'></a>OUTPUT_DIRECTORY = doc_inner/doxygen
<a id='L62' name='L62'></a>
<a id='L63' name='L63'></a># If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
<a id='L64' name='L64'></a># directories (in 2 levels) under the output directory of each output format and
<a id='L65' name='L65'></a># will distribute the generated files over these directories. Enabling this
<a id='L66' name='L66'></a># option can be useful when feeding doxygen a huge amount of source files, where
<a id='L67' name='L67'></a># putting all generated files in the same directory would otherwise causes
<a id='L68' name='L68'></a># performance problems for the file system.
<a id='L69' name='L69'></a># The default value is: NO.
<a id='L70' name='L70'></a>
<a id='L71' name='L71'></a>CREATE_SUBDIRS = NO
<a id='L72' name='L72'></a>
<a id='L73' name='L73'></a># If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
<a id='L74' name='L74'></a># characters to appear in the names of generated files. If set to NO, non-ASCII
<a id='L75' name='L75'></a># characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
<a id='L76' name='L76'></a># U+3044.
<a id='L77' name='L77'></a># The default value is: NO.
<a id='L78' name='L78'></a>
<a id='L79' name='L79'></a>ALLOW_UNICODE_NAMES = NO
<a id='L80' name='L80'></a>
<a id='L81' name='L81'></a># The OUTPUT_LANGUAGE tag is used to specify the language in which all
<a id='L82' name='L82'></a># documentation generated by doxygen is written. Doxygen will use this
<a id='L83' name='L83'></a># information to generate all constant output in the proper language.
<a id='L84' name='L84'></a># Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
<a id='L85' name='L85'></a># Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
<a id='L86' name='L86'></a># Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
<a id='L87' name='L87'></a># Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
<a id='L88' name='L88'></a># Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
<a id='L89' name='L89'></a># Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
<a id='L90' name='L90'></a># Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
<a id='L91' name='L91'></a># Ukrainian and Vietnamese.
<a id='L92' name='L92'></a># The default value is: English.
<a id='L93' name='L93'></a>
<a id='L94' name='L94'></a>OUTPUT_LANGUAGE = Japanese-en
<a id='L95' name='L95'></a>
<a id='L96' name='L96'></a># The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
<a id='L97' name='L97'></a># documentation generated by doxygen is written. Doxygen will use this
<a id='L98' name='L98'></a># information to generate all generated output in the proper direction.
<a id='L99' name='L99'></a># Possible values are: None, LTR, RTL and Context.
<a id='L100' name='L100'></a># The default value is: None.
<a id='L101' name='L101'></a>
<a id='L102' name='L102'></a>OUTPUT_TEXT_DIRECTION = None
<a id='L103' name='L103'></a>
<a id='L104' name='L104'></a># If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
<a id='L105' name='L105'></a># descriptions after the members that are listed in the file and class
<a id='L106' name='L106'></a># documentation (similar to Javadoc). Set to NO to disable this.
<a id='L107' name='L107'></a># The default value is: YES.
<a id='L108' name='L108'></a>
<a id='L109' name='L109'></a>BRIEF_MEMBER_DESC = YES
<a id='L110' name='L110'></a>
<a id='L111' name='L111'></a># If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
<a id='L112' name='L112'></a># description of a member or function before the detailed description
<a id='L113' name='L113'></a>#
<a id='L114' name='L114'></a># Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
<a id='L115' name='L115'></a># brief descriptions will be completely suppressed.
<a id='L116' name='L116'></a># The default value is: YES.
<a id='L117' name='L117'></a>
<a id='L118' name='L118'></a>REPEAT_BRIEF = YES
<a id='L119' name='L119'></a>
<a id='L120' name='L120'></a># This tag implements a quasi-intelligent brief description abbreviator that is
<a id='L121' name='L121'></a># used to form the text in various listings. Each string in this list, if found
<a id='L122' name='L122'></a># as the leading text of the brief description, will be stripped from the text
<a id='L123' name='L123'></a># and the result, after processing the whole list, is used as the annotated
<a id='L124' name='L124'></a># text. Otherwise, the brief description is used as-is. If left blank, the
<a id='L125' name='L125'></a># following values are used ($name is automatically replaced with the name of
<a id='L126' name='L126'></a># the entity):The $name class, The $name widget, The $name file, is, provides,
<a id='L127' name='L127'></a># specifies, contains, represents, a, an and the.
<a id='L128' name='L128'></a>
<a id='L129' name='L129'></a>ABBREVIATE_BRIEF =
<a id='L130' name='L130'></a>
<a id='L131' name='L131'></a># If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
<a id='L132' name='L132'></a># doxygen will generate a detailed section even if there is only a brief
<a id='L133' name='L133'></a># description.
<a id='L134' name='L134'></a># The default value is: NO.
<a id='L135' name='L135'></a>
<a id='L136' name='L136'></a>ALWAYS_DETAILED_SEC = NO
<a id='L137' name='L137'></a>
<a id='L138' name='L138'></a># If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
<a id='L139' name='L139'></a># inherited members of a class in the documentation of that class as if those
<a id='L140' name='L140'></a># members were ordinary class members. Constructors, destructors and assignment
<a id='L141' name='L141'></a># operators of the base classes will not be shown.
<a id='L142' name='L142'></a># The default value is: NO.
<a id='L143' name='L143'></a>
<a id='L144' name='L144'></a>INLINE_INHERITED_MEMB = NO
<a id='L145' name='L145'></a>
<a id='L146' name='L146'></a># If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
<a id='L147' name='L147'></a># before files name in the file list and in the header files. If set to NO the
<a id='L148' name='L148'></a># shortest path that makes the file name unique will be used
<a id='L149' name='L149'></a># The default value is: YES.
<a id='L150' name='L150'></a>
<a id='L151' name='L151'></a>FULL_PATH_NAMES = YES
<a id='L152' name='L152'></a>
<a id='L153' name='L153'></a># The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
<a id='L154' name='L154'></a># Stripping is only done if one of the specified strings matches the left-hand
<a id='L155' name='L155'></a># part of the path. The tag can be used to show relative paths in the file list.
<a id='L156' name='L156'></a># If left blank the directory from which doxygen is run is used as the path to
<a id='L157' name='L157'></a># strip.
<a id='L158' name='L158'></a>#
<a id='L159' name='L159'></a># Note that you can specify absolute paths here, but also relative paths, which
<a id='L160' name='L160'></a># will be relative from the directory where doxygen is started.
<a id='L161' name='L161'></a># This tag requires that the tag FULL_PATH_NAMES is set to YES.
<a id='L162' name='L162'></a>
<a id='L163' name='L163'></a>STRIP_FROM_PATH =
<a id='L164' name='L164'></a>
<a id='L165' name='L165'></a># The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
<a id='L166' name='L166'></a># path mentioned in the documentation of a class, which tells the reader which
<a id='L167' name='L167'></a># header file to include in order to use a class. If left blank only the name of
<a id='L168' name='L168'></a># the header file containing the class definition is used. Otherwise one should
<a id='L169' name='L169'></a># specify the list of include paths that are normally passed to the compiler
<a id='L170' name='L170'></a># using the -I flag.
<a id='L171' name='L171'></a>
<a id='L172' name='L172'></a>STRIP_FROM_INC_PATH =
<a id='L173' name='L173'></a>
<a id='L174' name='L174'></a># If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
<a id='L175' name='L175'></a># less readable) file names. This can be useful is your file systems doesn't
<a id='L176' name='L176'></a># support long names like on DOS, Mac, or CD-ROM.
<a id='L177' name='L177'></a># The default value is: NO.
<a id='L178' name='L178'></a>
<a id='L179' name='L179'></a>SHORT_NAMES = NO
<a id='L180' name='L180'></a>
<a id='L181' name='L181'></a># If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
<a id='L182' name='L182'></a># first line (until the first dot) of a Javadoc-style comment as the brief
<a id='L183' name='L183'></a># description. If set to NO, the Javadoc-style will behave just like regular Qt-
<a id='L184' name='L184'></a># style comments (thus requiring an explicit @brief command for a brief
<a id='L185' name='L185'></a># description.)
<a id='L186' name='L186'></a># The default value is: NO.
<a id='L187' name='L187'></a>
<a id='L188' name='L188'></a>JAVADOC_AUTOBRIEF = NO
<a id='L189' name='L189'></a>
<a id='L190' name='L190'></a># If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
<a id='L191' name='L191'></a># such as
<a id='L192' name='L192'></a># /***************
<a id='L193' name='L193'></a># as being the beginning of a Javadoc-style comment "banner". If set to NO, the
<a id='L194' name='L194'></a># Javadoc-style will behave just like regular comments and it will not be
<a id='L195' name='L195'></a># interpreted by doxygen.
<a id='L196' name='L196'></a># The default value is: NO.
<a id='L197' name='L197'></a>
<a id='L198' name='L198'></a>JAVADOC_BANNER = NO
<a id='L199' name='L199'></a>
<a id='L200' name='L200'></a># If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
<a id='L201' name='L201'></a># line (until the first dot) of a Qt-style comment as the brief description. If
<a id='L202' name='L202'></a># set to NO, the Qt-style will behave just like regular Qt-style comments (thus
<a id='L203' name='L203'></a># requiring an explicit \brief command for a brief description.)
<a id='L204' name='L204'></a># The default value is: NO.
<a id='L205' name='L205'></a>
<a id='L206' name='L206'></a>QT_AUTOBRIEF = NO
<a id='L207' name='L207'></a>
<a id='L208' name='L208'></a># The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
<a id='L209' name='L209'></a># multi-line C++ special comment block (i.e. a block of //! or /// comments) as
<a id='L210' name='L210'></a># a brief description. This used to be the default behavior. The new default is
<a id='L211' name='L211'></a># to treat a multi-line C++ comment block as a detailed description. Set this
<a id='L212' name='L212'></a># tag to YES if you prefer the old behavior instead.
<a id='L213' name='L213'></a>#
<a id='L214' name='L214'></a># Note that setting this tag to YES also means that rational rose comments are
<a id='L215' name='L215'></a># not recognized any more.
<a id='L216' name='L216'></a># The default value is: NO.
<a id='L217' name='L217'></a>
<a id='L218' name='L218'></a>MULTILINE_CPP_IS_BRIEF = NO
<a id='L219' name='L219'></a>
<a id='L220' name='L220'></a># By default Python docstrings are displayed as preformatted text and doxygen's
<a id='L221' name='L221'></a># special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
<a id='L222' name='L222'></a># doxygen's special commands can be used and the contents of the docstring
<a id='L223' name='L223'></a># documentation blocks is shown as doxygen documentation.
<a id='L224' name='L224'></a># The default value is: YES.
<a id='L225' name='L225'></a>
<a id='L226' name='L226'></a>PYTHON_DOCSTRING = YES
<a id='L227' name='L227'></a>
<a id='L228' name='L228'></a># If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
<a id='L229' name='L229'></a># documentation from any documented member that it re-implements.
<a id='L230' name='L230'></a># The default value is: YES.
<a id='L231' name='L231'></a>
<a id='L232' name='L232'></a>INHERIT_DOCS = YES
<a id='L233' name='L233'></a>
<a id='L234' name='L234'></a># If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
<a id='L235' name='L235'></a># page for each member. If set to NO, the documentation of a member will be part
<a id='L236' name='L236'></a># of the file/class/namespace that contains it.
<a id='L237' name='L237'></a># The default value is: NO.
<a id='L238' name='L238'></a>
<a id='L239' name='L239'></a>SEPARATE_MEMBER_PAGES = NO
<a id='L240' name='L240'></a>
<a id='L241' name='L241'></a># The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
<a id='L242' name='L242'></a># uses this value to replace tabs by spaces in code fragments.
<a id='L243' name='L243'></a># Minimum value: 1, maximum value: 16, default value: 4.
<a id='L244' name='L244'></a>
<a id='L245' name='L245'></a>TAB_SIZE = 4
<a id='L246' name='L246'></a>
<a id='L247' name='L247'></a># This tag can be used to specify a number of aliases that act as commands in
<a id='L248' name='L248'></a># the documentation. An alias has the form:
<a id='L249' name='L249'></a># name=value
<a id='L250' name='L250'></a># For example adding
<a id='L251' name='L251'></a># "sideeffect=@par Side Effects:\n"
<a id='L252' name='L252'></a># will allow you to put the command \sideeffect (or @sideeffect) in the
<a id='L253' name='L253'></a># documentation, which will result in a user-defined paragraph with heading
<a id='L254' name='L254'></a># "Side Effects:". You can put \n's in the value part of an alias to insert
<a id='L255' name='L255'></a># newlines (in the resulting output). You can put ^^ in the value part of an
<a id='L256' name='L256'></a># alias to insert a newline as if a physical newline was in the original file.
<a id='L257' name='L257'></a># When you need a literal { or } or , in the value part of an alias you have to
<a id='L258' name='L258'></a># escape them by means of a backslash (\), this can lead to conflicts with the
<a id='L259' name='L259'></a># commands \{ and \} for these it is advised to use the version @{ and @} or use
<a id='L260' name='L260'></a># a double escape (\\{ and \\})
<a id='L261' name='L261'></a>
<a id='L262' name='L262'></a>ALIASES =
<a id='L263' name='L263'></a>
<a id='L264' name='L264'></a># Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
<a id='L265' name='L265'></a># only. Doxygen will then generate output that is more tailored for C. For
<a id='L266' name='L266'></a># instance, some of the names that are used will be different. The list of all
<a id='L267' name='L267'></a># members will be omitted, etc.
<a id='L268' name='L268'></a># The default value is: NO.
<a id='L269' name='L269'></a>
<a id='L270' name='L270'></a>OPTIMIZE_OUTPUT_FOR_C = YES
<a id='L271' name='L271'></a>
<a id='L272' name='L272'></a># Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
<a id='L273' name='L273'></a># Python sources only. Doxygen will then generate output that is more tailored
<a id='L274' name='L274'></a># for that language. For instance, namespaces will be presented as packages,
<a id='L275' name='L275'></a># qualified scopes will look different, etc.
<a id='L276' name='L276'></a># The default value is: NO.
<a id='L277' name='L277'></a>
<a id='L278' name='L278'></a>OPTIMIZE_OUTPUT_JAVA = NO
<a id='L279' name='L279'></a>
<a id='L280' name='L280'></a># Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
<a id='L281' name='L281'></a># sources. Doxygen will then generate output that is tailored for Fortran.
<a id='L282' name='L282'></a># The default value is: NO.
<a id='L283' name='L283'></a>
<a id='L284' name='L284'></a>OPTIMIZE_FOR_FORTRAN = NO
<a id='L285' name='L285'></a>
<a id='L286' name='L286'></a># Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
<a id='L287' name='L287'></a># sources. Doxygen will then generate output that is tailored for VHDL.
<a id='L288' name='L288'></a># The default value is: NO.
<a id='L289' name='L289'></a>
<a id='L290' name='L290'></a>OPTIMIZE_OUTPUT_VHDL = NO
<a id='L291' name='L291'></a>
<a id='L292' name='L292'></a># Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
<a id='L293' name='L293'></a># sources only. Doxygen will then generate output that is more tailored for that
<a id='L294' name='L294'></a># language. For instance, namespaces will be presented as modules, types will be
<a id='L295' name='L295'></a># separated into more groups, etc.
<a id='L296' name='L296'></a># The default value is: NO.
<a id='L297' name='L297'></a>
<a id='L298' name='L298'></a>OPTIMIZE_OUTPUT_SLICE = NO
<a id='L299' name='L299'></a>
<a id='L300' name='L300'></a># Doxygen selects the parser to use depending on the extension of the files it
<a id='L301' name='L301'></a># parses. With this tag you can assign which parser to use for a given
<a id='L302' name='L302'></a># extension. Doxygen has a built-in mapping, but you can override or extend it
<a id='L303' name='L303'></a># using this tag. The format is ext=language, where ext is a file extension, and
<a id='L304' name='L304'></a># language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
<a id='L305' name='L305'></a># Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
<a id='L306' name='L306'></a># Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
<a id='L307' name='L307'></a># FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
<a id='L308' name='L308'></a># tries to guess whether the code is fixed or free formatted code, this is the
<a id='L309' name='L309'></a># default for Fortran type files). For instance to make doxygen treat .inc files
<a id='L310' name='L310'></a># as Fortran files (default is PHP), and .f files as C (default is Fortran),
<a id='L311' name='L311'></a># use: inc=Fortran f=C.
<a id='L312' name='L312'></a>#
<a id='L313' name='L313'></a># Note: For files without extension you can use no_extension as a placeholder.
<a id='L314' name='L314'></a>#
<a id='L315' name='L315'></a># Note that for custom extensions you also need to set FILE_PATTERNS otherwise
<a id='L316' name='L316'></a># the files are not read by doxygen. When specifying no_extension you should add
<a id='L317' name='L317'></a># * to the FILE_PATTERNS.
<a id='L318' name='L318'></a>#
<a id='L319' name='L319'></a># Note see also the list of default file extension mappings.
<a id='L320' name='L320'></a>
<a id='L321' name='L321'></a>EXTENSION_MAPPING =
<a id='L322' name='L322'></a>
<a id='L323' name='L323'></a># If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
<a id='L324' name='L324'></a># according to the Markdown format, which allows for more readable
<a id='L325' name='L325'></a># documentation. See https://daringfireball.net/projects/markdown/ for details.
<a id='L326' name='L326'></a># The output of markdown processing is further processed by doxygen, so you can
<a id='L327' name='L327'></a># mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
<a id='L328' name='L328'></a># case of backward compatibilities issues.
<a id='L329' name='L329'></a># The default value is: YES.
<a id='L330' name='L330'></a>
<a id='L331' name='L331'></a>MARKDOWN_SUPPORT = YES
<a id='L332' name='L332'></a>
<a id='L333' name='L333'></a># When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
<a id='L334' name='L334'></a># to that level are automatically included in the table of contents, even if
<a id='L335' name='L335'></a># they do not have an id attribute.
<a id='L336' name='L336'></a># Note: This feature currently applies only to Markdown headings.
<a id='L337' name='L337'></a># Minimum value: 0, maximum value: 99, default value: 5.
<a id='L338' name='L338'></a># This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
<a id='L339' name='L339'></a>
<a id='L340' name='L340'></a>TOC_INCLUDE_HEADINGS = 0
<a id='L341' name='L341'></a>
<a id='L342' name='L342'></a># When enabled doxygen tries to link words that correspond to documented
<a id='L343' name='L343'></a># classes, or namespaces to their corresponding documentation. Such a link can
<a id='L344' name='L344'></a># be prevented in individual cases by putting a % sign in front of the word or
<a id='L345' name='L345'></a># globally by setting AUTOLINK_SUPPORT to NO.
<a id='L346' name='L346'></a># The default value is: YES.
<a id='L347' name='L347'></a>
<a id='L348' name='L348'></a>AUTOLINK_SUPPORT = YES
<a id='L349' name='L349'></a>
<a id='L350' name='L350'></a># If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
<a id='L351' name='L351'></a># to include (a tag file for) the STL sources as input, then you should set this
<a id='L352' name='L352'></a># tag to YES in order to let doxygen match functions declarations and
<a id='L353' name='L353'></a># definitions whose arguments contain STL classes (e.g. func(std::string);
<a id='L354' name='L354'></a># versus func(std::string) {}). This also make the inheritance and collaboration
<a id='L355' name='L355'></a># diagrams that involve STL classes more complete and accurate.
<a id='L356' name='L356'></a># The default value is: NO.
<a id='L357' name='L357'></a>
<a id='L358' name='L358'></a>BUILTIN_STL_SUPPORT = NO
<a id='L359' name='L359'></a>
<a id='L360' name='L360'></a># If you use Microsoft's C++/CLI language, you should set this option to YES to
<a id='L361' name='L361'></a># enable parsing support.
<a id='L362' name='L362'></a># The default value is: NO.
<a id='L363' name='L363'></a>
<a id='L364' name='L364'></a>CPP_CLI_SUPPORT = NO
<a id='L365' name='L365'></a>
<a id='L366' name='L366'></a># Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
<a id='L367' name='L367'></a># https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
<a id='L368' name='L368'></a># will parse them like normal C++ but will assume all classes use public instead
<a id='L369' name='L369'></a># of private inheritance when no explicit protection keyword is present.
<a id='L370' name='L370'></a># The default value is: NO.
<a id='L371' name='L371'></a>
<a id='L372' name='L372'></a>SIP_SUPPORT = NO
<a id='L373' name='L373'></a>
<a id='L374' name='L374'></a># For Microsoft's IDL there are propget and propput attributes to indicate
<a id='L375' name='L375'></a># getter and setter methods for a property. Setting this option to YES will make
<a id='L376' name='L376'></a># doxygen to replace the get and set methods by a property in the documentation.
<a id='L377' name='L377'></a># This will only work if the methods are indeed getting or setting a simple
<a id='L378' name='L378'></a># type. If this is not the case, or you want to show the methods anyway, you
<a id='L379' name='L379'></a># should set this option to NO.
<a id='L380' name='L380'></a># The default value is: YES.
<a id='L381' name='L381'></a>
<a id='L382' name='L382'></a>IDL_PROPERTY_SUPPORT = YES
<a id='L383' name='L383'></a>
<a id='L384' name='L384'></a># If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
<a id='L385' name='L385'></a># tag is set to YES then doxygen will reuse the documentation of the first
<a id='L386' name='L386'></a># member in the group (if any) for the other members of the group. By default
<a id='L387' name='L387'></a># all members of a group must be documented explicitly.
<a id='L388' name='L388'></a># The default value is: NO.
<a id='L389' name='L389'></a>
<a id='L390' name='L390'></a>DISTRIBUTE_GROUP_DOC = NO
<a id='L391' name='L391'></a>
<a id='L392' name='L392'></a># If one adds a struct or class to a group and this option is enabled, then also
<a id='L393' name='L393'></a># any nested class or struct is added to the same group. By default this option
<a id='L394' name='L394'></a># is disabled and one has to add nested compounds explicitly via \ingroup.
<a id='L395' name='L395'></a># The default value is: NO.
<a id='L396' name='L396'></a>
<a id='L397' name='L397'></a>GROUP_NESTED_COMPOUNDS = NO
<a id='L398' name='L398'></a>
<a id='L399' name='L399'></a># Set the SUBGROUPING tag to YES to allow class member groups of the same type
<a id='L400' name='L400'></a># (for instance a group of public functions) to be put as a subgroup of that
<a id='L401' name='L401'></a># type (e.g. under the Public Functions section). Set it to NO to prevent
<a id='L402' name='L402'></a># subgrouping. Alternatively, this can be done per class using the
<a id='L403' name='L403'></a># \nosubgrouping command.
<a id='L404' name='L404'></a># The default value is: YES.
<a id='L405' name='L405'></a>
<a id='L406' name='L406'></a>SUBGROUPING = YES
<a id='L407' name='L407'></a>
<a id='L408' name='L408'></a># When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
<a id='L409' name='L409'></a># are shown inside the group in which they are included (e.g. using \ingroup)
<a id='L410' name='L410'></a># instead of on a separate page (for HTML and Man pages) or section (for LaTeX
<a id='L411' name='L411'></a># and RTF).
<a id='L412' name='L412'></a>#
<a id='L413' name='L413'></a># Note that this feature does not work in combination with
<a id='L414' name='L414'></a># SEPARATE_MEMBER_PAGES.
<a id='L415' name='L415'></a># The default value is: NO.
<a id='L416' name='L416'></a>
<a id='L417' name='L417'></a>INLINE_GROUPED_CLASSES = NO
<a id='L418' name='L418'></a>
<a id='L419' name='L419'></a># When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
<a id='L420' name='L420'></a># with only public data fields or simple typedef fields will be shown inline in
<a id='L421' name='L421'></a># the documentation of the scope in which they are defined (i.e. file,
<a id='L422' name='L422'></a># namespace, or group documentation), provided this scope is documented. If set
<a id='L423' name='L423'></a># to NO, structs, classes, and unions are shown on a separate page (for HTML and
<a id='L424' name='L424'></a># Man pages) or section (for LaTeX and RTF).
<a id='L425' name='L425'></a># The default value is: NO.
<a id='L426' name='L426'></a>
<a id='L427' name='L427'></a>INLINE_SIMPLE_STRUCTS = NO
<a id='L428' name='L428'></a>
<a id='L429' name='L429'></a># When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
<a id='L430' name='L430'></a># enum is documented as struct, union, or enum with the name of the typedef. So
<a id='L431' name='L431'></a># typedef struct TypeS {} TypeT, will appear in the documentation as a struct
<a id='L432' name='L432'></a># with name TypeT. When disabled the typedef will appear as a member of a file,
<a id='L433' name='L433'></a># namespace, or class. And the struct will be named TypeS. This can typically be
<a id='L434' name='L434'></a># useful for C code in case the coding convention dictates that all compound
<a id='L435' name='L435'></a># types are typedef'ed and only the typedef is referenced, never the tag name.
<a id='L436' name='L436'></a># The default value is: NO.
<a id='L437' name='L437'></a>
<a id='L438' name='L438'></a>TYPEDEF_HIDES_STRUCT = NO
<a id='L439' name='L439'></a>
<a id='L440' name='L440'></a># The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
<a id='L441' name='L441'></a># cache is used to resolve symbols given their name and scope. Since this can be
<a id='L442' name='L442'></a># an expensive process and often the same symbol appears multiple times in the
<a id='L443' name='L443'></a># code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
<a id='L444' name='L444'></a># doxygen will become slower. If the cache is too large, memory is wasted. The
<a id='L445' name='L445'></a># cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
<a id='L446' name='L446'></a># is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
<a id='L447' name='L447'></a># symbols. At the end of a run doxygen will report the cache usage and suggest
<a id='L448' name='L448'></a># the optimal cache size from a speed point of view.
<a id='L449' name='L449'></a># Minimum value: 0, maximum value: 9, default value: 0.
<a id='L450' name='L450'></a>
<a id='L451' name='L451'></a>LOOKUP_CACHE_SIZE = 0
<a id='L452' name='L452'></a>
<a id='L453' name='L453'></a># The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
<a id='L454' name='L454'></a># during processing. When set to 0 doxygen will based this on the number of
<a id='L455' name='L455'></a># cores available in the system. You can set it explicitly to a value larger
<a id='L456' name='L456'></a># than 0 to get more control over the balance between CPU load and processing
<a id='L457' name='L457'></a># speed. At this moment only the input processing can be done using multiple
<a id='L458' name='L458'></a># threads. Since this is still an experimental feature the default is set to 1,
<a id='L459' name='L459'></a># which efficively disables parallel processing. Please report any issues you
<a id='L460' name='L460'></a># encounter. Generating dot graphs in parallel is controlled by the
<a id='L461' name='L461'></a># DOT_NUM_THREADS setting.
<a id='L462' name='L462'></a># Minimum value: 0, maximum value: 32, default value: 1.
<a id='L463' name='L463'></a>
<a id='L464' name='L464'></a>NUM_PROC_THREADS = 1
<a id='L465' name='L465'></a>
<a id='L466' name='L466'></a>#---------------------------------------------------------------------------
<a id='L467' name='L467'></a># Build related configuration options
<a id='L468' name='L468'></a>#---------------------------------------------------------------------------
<a id='L469' name='L469'></a>
<a id='L470' name='L470'></a># If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
<a id='L471' name='L471'></a># documentation are documented, even if no documentation was available. Private
<a id='L472' name='L472'></a># class members and static file members will be hidden unless the
<a id='L473' name='L473'></a># EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
<a id='L474' name='L474'></a># Note: This will also disable the warnings about undocumented members that are
<a id='L475' name='L475'></a># normally produced when WARNINGS is set to YES.
<a id='L476' name='L476'></a># The default value is: NO.
<a id='L477' name='L477'></a>
<a id='L478' name='L478'></a>EXTRACT_ALL = YES
<a id='L479' name='L479'></a>
<a id='L480' name='L480'></a># If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
<a id='L481' name='L481'></a># be included in the documentation.
<a id='L482' name='L482'></a># The default value is: NO.
<a id='L483' name='L483'></a>
<a id='L484' name='L484'></a>EXTRACT_PRIVATE = NO
<a id='L485' name='L485'></a>
<a id='L486' name='L486'></a># If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
<a id='L487' name='L487'></a># methods of a class will be included in the documentation.
<a id='L488' name='L488'></a># The default value is: NO.
<a id='L489' name='L489'></a>
<a id='L490' name='L490'></a>EXTRACT_PRIV_VIRTUAL = NO
<a id='L491' name='L491'></a>
<a id='L492' name='L492'></a># If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
<a id='L493' name='L493'></a># scope will be included in the documentation.
<a id='L494' name='L494'></a># The default value is: NO.
<a id='L495' name='L495'></a>
<a id='L496' name='L496'></a>EXTRACT_PACKAGE = NO
<a id='L497' name='L497'></a>
<a id='L498' name='L498'></a># If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
<a id='L499' name='L499'></a># included in the documentation.
<a id='L500' name='L500'></a># The default value is: NO.
<a id='L501' name='L501'></a>
<a id='L502' name='L502'></a>EXTRACT_STATIC = YES
<a id='L503' name='L503'></a>
<a id='L504' name='L504'></a># If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
<a id='L505' name='L505'></a># locally in source files will be included in the documentation. If set to NO,
<a id='L506' name='L506'></a># only classes defined in header files are included. Does not have any effect
<a id='L507' name='L507'></a># for Java sources.
<a id='L508' name='L508'></a># The default value is: YES.
<a id='L509' name='L509'></a>
<a id='L510' name='L510'></a>EXTRACT_LOCAL_CLASSES = YES
<a id='L511' name='L511'></a>
<a id='L512' name='L512'></a># This flag is only useful for Objective-C code. If set to YES, local methods,
<a id='L513' name='L513'></a># which are defined in the implementation section but not in the interface are
<a id='L514' name='L514'></a># included in the documentation. If set to NO, only methods in the interface are
<a id='L515' name='L515'></a># included.
<a id='L516' name='L516'></a># The default value is: NO.
<a id='L517' name='L517'></a>
<a id='L518' name='L518'></a>EXTRACT_LOCAL_METHODS = NO
<a id='L519' name='L519'></a>
<a id='L520' name='L520'></a># If this flag is set to YES, the members of anonymous namespaces will be
<a id='L521' name='L521'></a># extracted and appear in the documentation as a namespace called
<a id='L522' name='L522'></a># 'anonymous_namespace{file}', where file will be replaced with the base name of
<a id='L523' name='L523'></a># the file that contains the anonymous namespace. By default anonymous namespace
<a id='L524' name='L524'></a># are hidden.
<a id='L525' name='L525'></a># The default value is: NO.
<a id='L526' name='L526'></a>
<a id='L527' name='L527'></a>EXTRACT_ANON_NSPACES = NO
<a id='L528' name='L528'></a>
<a id='L529' name='L529'></a># If this flag is set to YES, the name of an unnamed parameter in a declaration
<a id='L530' name='L530'></a># will be determined by the corresponding definition. By default unnamed
<a id='L531' name='L531'></a># parameters remain unnamed in the output.
<a id='L532' name='L532'></a># The default value is: YES.
<a id='L533' name='L533'></a>
<a id='L534' name='L534'></a>RESOLVE_UNNAMED_PARAMS = YES
<a id='L535' name='L535'></a>
<a id='L536' name='L536'></a># If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
<a id='L537' name='L537'></a># undocumented members inside documented classes or files. If set to NO these
<a id='L538' name='L538'></a># members will be included in the various overviews, but no documentation
<a id='L539' name='L539'></a># section is generated. This option has no effect if EXTRACT_ALL is enabled.
<a id='L540' name='L540'></a># The default value is: NO.
<a id='L541' name='L541'></a>
<a id='L542' name='L542'></a>HIDE_UNDOC_MEMBERS = NO
<a id='L543' name='L543'></a>
<a id='L544' name='L544'></a># If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
<a id='L545' name='L545'></a># undocumented classes that are normally visible in the class hierarchy. If set
<a id='L546' name='L546'></a># to NO, these classes will be included in the various overviews. This option
<a id='L547' name='L547'></a># has no effect if EXTRACT_ALL is enabled.
<a id='L548' name='L548'></a># The default value is: NO.
<a id='L549' name='L549'></a>
<a id='L550' name='L550'></a>HIDE_UNDOC_CLASSES = NO
<a id='L551' name='L551'></a>
<a id='L552' name='L552'></a># If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
<a id='L553' name='L553'></a># declarations. If set to NO, these declarations will be included in the
<a id='L554' name='L554'></a># documentation.
<a id='L555' name='L555'></a># The default value is: NO.
<a id='L556' name='L556'></a>
<a id='L557' name='L557'></a>HIDE_FRIEND_COMPOUNDS = NO
<a id='L558' name='L558'></a>
<a id='L559' name='L559'></a># If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
<a id='L560' name='L560'></a># documentation blocks found inside the body of a function. If set to NO, these
<a id='L561' name='L561'></a># blocks will be appended to the function's detailed documentation block.
<a id='L562' name='L562'></a># The default value is: NO.
<a id='L563' name='L563'></a>
<a id='L564' name='L564'></a>HIDE_IN_BODY_DOCS = NO
<a id='L565' name='L565'></a>
<a id='L566' name='L566'></a># The INTERNAL_DOCS tag determines if documentation that is typed after a
<a id='L567' name='L567'></a># \internal command is included. If the tag is set to NO then the documentation
<a id='L568' name='L568'></a># will be excluded. Set it to YES to include the internal documentation.
<a id='L569' name='L569'></a># The default value is: NO.
<a id='L570' name='L570'></a>
<a id='L571' name='L571'></a>INTERNAL_DOCS = NO
<a id='L572' name='L572'></a>
<a id='L573' name='L573'></a># With the correct setting of option CASE_SENSE_NAMES doxygen will better be
<a id='L574' name='L574'></a># able to match the capabilities of the underlying filesystem. In case the
<a id='L575' name='L575'></a># filesystem is case sensitive (i.e. it supports files in the same directory
<a id='L576' name='L576'></a># whose names only differ in casing), the option must be set to YES to properly
<a id='L577' name='L577'></a># deal with such files in case they appear in the input. For filesystems that
<a id='L578' name='L578'></a># are not case sensitive the option should be be set to NO to properly deal with
<a id='L579' name='L579'></a># output files written for symbols that only differ in casing, such as for two
<a id='L580' name='L580'></a># classes, one named CLASS and the other named Class, and to also support
<a id='L581' name='L581'></a># references to files without having to specify the exact matching casing. On
<a id='L582' name='L582'></a># Windows (including Cygwin) and MacOS, users should typically set this option
<a id='L583' name='L583'></a># to NO, whereas on Linux or other Unix flavors it should typically be set to
<a id='L584' name='L584'></a># YES.
<a id='L585' name='L585'></a># The default value is: system dependent.
<a id='L586' name='L586'></a>
<a id='L587' name='L587'></a>CASE_SENSE_NAMES = NO
<a id='L588' name='L588'></a>
<a id='L589' name='L589'></a># If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
<a id='L590' name='L590'></a># their full class and namespace scopes in the documentation. If set to YES, the
<a id='L591' name='L591'></a># scope will be hidden.
<a id='L592' name='L592'></a># The default value is: NO.
<a id='L593' name='L593'></a>
<a id='L594' name='L594'></a>HIDE_SCOPE_NAMES = NO
<a id='L595' name='L595'></a>
<a id='L596' name='L596'></a># If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
<a id='L597' name='L597'></a># append additional text to a page's title, such as Class Reference. If set to
<a id='L598' name='L598'></a># YES the compound reference will be hidden.
<a id='L599' name='L599'></a># The default value is: NO.
<a id='L600' name='L600'></a>
<a id='L601' name='L601'></a>HIDE_COMPOUND_REFERENCE= NO
<a id='L602' name='L602'></a>
<a id='L603' name='L603'></a># If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
<a id='L604' name='L604'></a># the files that are included by a file in the documentation of that file.
<a id='L605' name='L605'></a># The default value is: YES.
<a id='L606' name='L606'></a>
<a id='L607' name='L607'></a>SHOW_INCLUDE_FILES = YES
<a id='L608' name='L608'></a>
<a id='L609' name='L609'></a># If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
<a id='L610' name='L610'></a># grouped member an include statement to the documentation, telling the reader
<a id='L611' name='L611'></a># which file to include in order to use the member.
<a id='L612' name='L612'></a># The default value is: NO.
<a id='L613' name='L613'></a>
<a id='L614' name='L614'></a>SHOW_GROUPED_MEMB_INC = NO
<a id='L615' name='L615'></a>
<a id='L616' name='L616'></a># If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
<a id='L617' name='L617'></a># files with double quotes in the documentation rather than with sharp brackets.
<a id='L618' name='L618'></a># The default value is: NO.
<a id='L619' name='L619'></a>
<a id='L620' name='L620'></a>FORCE_LOCAL_INCLUDES = NO
<a id='L621' name='L621'></a>
<a id='L622' name='L622'></a># If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
<a id='L623' name='L623'></a># documentation for inline members.
<a id='L624' name='L624'></a># The default value is: YES.
<a id='L625' name='L625'></a>
<a id='L626' name='L626'></a>INLINE_INFO = YES
<a id='L627' name='L627'></a>
<a id='L628' name='L628'></a># If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
<a id='L629' name='L629'></a># (detailed) documentation of file and class members alphabetically by member
<a id='L630' name='L630'></a># name. If set to NO, the members will appear in declaration order.
<a id='L631' name='L631'></a># The default value is: YES.
<a id='L632' name='L632'></a>
<a id='L633' name='L633'></a>SORT_MEMBER_DOCS = YES
<a id='L634' name='L634'></a>
<a id='L635' name='L635'></a># If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
<a id='L636' name='L636'></a># descriptions of file, namespace and class members alphabetically by member
<a id='L637' name='L637'></a># name. If set to NO, the members will appear in declaration order. Note that
<a id='L638' name='L638'></a># this will also influence the order of the classes in the class list.
<a id='L639' name='L639'></a># The default value is: NO.
<a id='L640' name='L640'></a>
<a id='L641' name='L641'></a>SORT_BRIEF_DOCS = NO
<a id='L642' name='L642'></a>
<a id='L643' name='L643'></a># If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
<a id='L644' name='L644'></a># (brief and detailed) documentation of class members so that constructors and
<a id='L645' name='L645'></a># destructors are listed first. If set to NO the constructors will appear in the
<a id='L646' name='L646'></a># respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
<a id='L647' name='L647'></a># Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
<a id='L648' name='L648'></a># member documentation.
<a id='L649' name='L649'></a># Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
<a id='L650' name='L650'></a># detailed member documentation.
<a id='L651' name='L651'></a># The default value is: NO.
<a id='L652' name='L652'></a>
<a id='L653' name='L653'></a>SORT_MEMBERS_CTORS_1ST = NO
<a id='L654' name='L654'></a>
<a id='L655' name='L655'></a># If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
<a id='L656' name='L656'></a># of group names into alphabetical order. If set to NO the group names will
<a id='L657' name='L657'></a># appear in their defined order.
<a id='L658' name='L658'></a># The default value is: NO.
<a id='L659' name='L659'></a>
<a id='L660' name='L660'></a>SORT_GROUP_NAMES = NO
<a id='L661' name='L661'></a>
<a id='L662' name='L662'></a># If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
<a id='L663' name='L663'></a># fully-qualified names, including namespaces. If set to NO, the class list will
<a id='L664' name='L664'></a># be sorted only by class name, not including the namespace part.
<a id='L665' name='L665'></a># Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
<a id='L666' name='L666'></a># Note: This option applies only to the class list, not to the alphabetical
<a id='L667' name='L667'></a># list.
<a id='L668' name='L668'></a># The default value is: NO.
<a id='L669' name='L669'></a>
<a id='L670' name='L670'></a>SORT_BY_SCOPE_NAME = NO
<a id='L671' name='L671'></a>
<a id='L672' name='L672'></a># If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
<a id='L673' name='L673'></a># type resolution of all parameters of a function it will reject a match between
<a id='L674' name='L674'></a># the prototype and the implementation of a member function even if there is
<a id='L675' name='L675'></a># only one candidate or it is obvious which candidate to choose by doing a
<a id='L676' name='L676'></a># simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
<a id='L677' name='L677'></a># accept a match between prototype and implementation in such cases.
<a id='L678' name='L678'></a># The default value is: NO.
<a id='L679' name='L679'></a>
<a id='L680' name='L680'></a>STRICT_PROTO_MATCHING = NO
<a id='L681' name='L681'></a>
<a id='L682' name='L682'></a># The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
<a id='L683' name='L683'></a># list. This list is created by putting \todo commands in the documentation.
<a id='L684' name='L684'></a># The default value is: YES.
<a id='L685' name='L685'></a>
<a id='L686' name='L686'></a>GENERATE_TODOLIST = YES
<a id='L687' name='L687'></a>
<a id='L688' name='L688'></a># The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
<a id='L689' name='L689'></a># list. This list is created by putting \test commands in the documentation.
<a id='L690' name='L690'></a># The default value is: YES.
<a id='L691' name='L691'></a>
<a id='L692' name='L692'></a>GENERATE_TESTLIST = YES
<a id='L693' name='L693'></a>
<a id='L694' name='L694'></a># The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
<a id='L695' name='L695'></a># list. This list is created by putting \bug commands in the documentation.
<a id='L696' name='L696'></a># The default value is: YES.
<a id='L697' name='L697'></a>
<a id='L698' name='L698'></a>GENERATE_BUGLIST = YES
<a id='L699' name='L699'></a>
<a id='L700' name='L700'></a># The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
<a id='L701' name='L701'></a># the deprecated list. This list is created by putting \deprecated commands in
<a id='L702' name='L702'></a># the documentation.
<a id='L703' name='L703'></a># The default value is: YES.
<a id='L704' name='L704'></a>
<a id='L705' name='L705'></a>GENERATE_DEPRECATEDLIST= YES
<a id='L706' name='L706'></a>
<a id='L707' name='L707'></a># The ENABLED_SECTIONS tag can be used to enable conditional documentation
<a id='L708' name='L708'></a># sections, marked by \if <section_label> ... \endif and \cond <section_label>
<a id='L709' name='L709'></a># ... \endcond blocks.
<a id='L710' name='L710'></a>
<a id='L711' name='L711'></a>ENABLED_SECTIONS =
<a id='L712' name='L712'></a>
<a id='L713' name='L713'></a># The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
<a id='L714' name='L714'></a># initial value of a variable or macro / define can have for it to appear in the
<a id='L715' name='L715'></a># documentation. If the initializer consists of more lines than specified here
<a id='L716' name='L716'></a># it will be hidden. Use a value of 0 to hide initializers completely. The
<a id='L717' name='L717'></a># appearance of the value of individual variables and macros / defines can be
<a id='L718' name='L718'></a># controlled using \showinitializer or \hideinitializer command in the
<a id='L719' name='L719'></a># documentation regardless of this setting.
<a id='L720' name='L720'></a># Minimum value: 0, maximum value: 10000, default value: 30.
<a id='L721' name='L721'></a>
<a id='L722' name='L722'></a>MAX_INITIALIZER_LINES = 30
<a id='L723' name='L723'></a>
<a id='L724' name='L724'></a># Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
<a id='L725' name='L725'></a># the bottom of the documentation of classes and structs. If set to YES, the
<a id='L726' name='L726'></a># list will mention the files that were used to generate the documentation.
<a id='L727' name='L727'></a># The default value is: YES.
<a id='L728' name='L728'></a>
<a id='L729' name='L729'></a>SHOW_USED_FILES = YES
<a id='L730' name='L730'></a>
<a id='L731' name='L731'></a># Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
<a id='L732' name='L732'></a># will remove the Files entry from the Quick Index and from the Folder Tree View
<a id='L733' name='L733'></a># (if specified).
<a id='L734' name='L734'></a># The default value is: YES.
<a id='L735' name='L735'></a>
<a id='L736' name='L736'></a>SHOW_FILES = YES
<a id='L737' name='L737'></a>
<a id='L738' name='L738'></a># Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
<a id='L739' name='L739'></a># page. This will remove the Namespaces entry from the Quick Index and from the
<a id='L740' name='L740'></a># Folder Tree View (if specified).
<a id='L741' name='L741'></a># The default value is: YES.
<a id='L742' name='L742'></a>
<a id='L743' name='L743'></a>SHOW_NAMESPACES = YES
<a id='L744' name='L744'></a>
<a id='L745' name='L745'></a># The FILE_VERSION_FILTER tag can be used to specify a program or script that
<a id='L746' name='L746'></a># doxygen should invoke to get the current version for each file (typically from
<a id='L747' name='L747'></a># the version control system). Doxygen will invoke the program by executing (via
<a id='L748' name='L748'></a># popen()) the command command input-file, where command is the value of the
<a id='L749' name='L749'></a># FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
<a id='L750' name='L750'></a># by doxygen. Whatever the program writes to standard output is used as the file
<a id='L751' name='L751'></a># version. For an example see the documentation.
<a id='L752' name='L752'></a>
<a id='L753' name='L753'></a>FILE_VERSION_FILTER =
<a id='L754' name='L754'></a>
<a id='L755' name='L755'></a># The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
<a id='L756' name='L756'></a># by doxygen. The layout file controls the global structure of the generated
<a id='L757' name='L757'></a># output files in an output format independent way. To create the layout file
<a id='L758' name='L758'></a># that represents doxygen's defaults, run doxygen with the -l option. You can
<a id='L759' name='L759'></a># optionally specify a file name after the option, if omitted DoxygenLayout.xml
<a id='L760' name='L760'></a># will be used as the name of the layout file.
<a id='L761' name='L761'></a>#
<a id='L762' name='L762'></a># Note that if you run doxygen from a directory containing a file called
<a id='L763' name='L763'></a># DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
<a id='L764' name='L764'></a># tag is left empty.
<a id='L765' name='L765'></a>
<a id='L766' name='L766'></a>LAYOUT_FILE =
<a id='L767' name='L767'></a>
<a id='L768' name='L768'></a># The CITE_BIB_FILES tag can be used to specify one or more bib files containing
<a id='L769' name='L769'></a># the reference definitions. This must be a list of .bib files. The .bib
<a id='L770' name='L770'></a># extension is automatically appended if omitted. This requires the bibtex tool
<a id='L771' name='L771'></a># to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
<a id='L772' name='L772'></a># For LaTeX the style of the bibliography can be controlled using
<a id='L773' name='L773'></a># LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
<a id='L774' name='L774'></a># search path. See also \cite for info how to create references.
<a id='L775' name='L775'></a>
<a id='L776' name='L776'></a>CITE_BIB_FILES =
<a id='L777' name='L777'></a>
<a id='L778' name='L778'></a>#---------------------------------------------------------------------------
<a id='L779' name='L779'></a># Configuration options related to warning and progress messages
<a id='L780' name='L780'></a>#---------------------------------------------------------------------------
<a id='L781' name='L781'></a>
<a id='L782' name='L782'></a># The QUIET tag can be used to turn on/off the messages that are generated to
<a id='L783' name='L783'></a># standard output by doxygen. If QUIET is set to YES this implies that the
<a id='L784' name='L784'></a># messages are off.
<a id='L785' name='L785'></a># The default value is: NO.
<a id='L786' name='L786'></a>
<a id='L787' name='L787'></a>QUIET = YES
<a id='L788' name='L788'></a>
<a id='L789' name='L789'></a># The WARNINGS tag can be used to turn on/off the warning messages that are
<a id='L790' name='L790'></a># generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
<a id='L791' name='L791'></a># this implies that the warnings are on.
<a id='L792' name='L792'></a>#
<a id='L793' name='L793'></a># Tip: Turn warnings on while writing the documentation.
<a id='L794' name='L794'></a># The default value is: YES.
<a id='L795' name='L795'></a>
<a id='L796' name='L796'></a>WARNINGS = YES
<a id='L797' name='L797'></a>
<a id='L798' name='L798'></a># If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
<a id='L799' name='L799'></a># warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
<a id='L800' name='L800'></a># will automatically be disabled.
<a id='L801' name='L801'></a># The default value is: YES.
<a id='L802' name='L802'></a>
<a id='L803' name='L803'></a>WARN_IF_UNDOCUMENTED = YES
<a id='L804' name='L804'></a>
<a id='L805' name='L805'></a># If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
<a id='L806' name='L806'></a># potential errors in the documentation, such as not documenting some parameters
<a id='L807' name='L807'></a># in a documented function, or documenting parameters that don't exist or using
<a id='L808' name='L808'></a># markup commands wrongly.
<a id='L809' name='L809'></a># The default value is: YES.
<a id='L810' name='L810'></a>
<a id='L811' name='L811'></a>WARN_IF_DOC_ERROR = YES
<a id='L812' name='L812'></a>
<a id='L813' name='L813'></a># This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
<a id='L814' name='L814'></a># are documented, but have no documentation for their parameters or return
<a id='L815' name='L815'></a># value. If set to NO, doxygen will only warn about wrong or incomplete
<a id='L816' name='L816'></a># parameter documentation, but not about the absence of documentation. If
<a id='L817' name='L817'></a># EXTRACT_ALL is set to YES then this flag will automatically be disabled.
<a id='L818' name='L818'></a># The default value is: NO.
<a id='L819' name='L819'></a>
<a id='L820' name='L820'></a>WARN_NO_PARAMDOC = NO
<a id='L821' name='L821'></a>
<a id='L822' name='L822'></a># If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
<a id='L823' name='L823'></a># a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
<a id='L824' name='L824'></a># then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
<a id='L825' name='L825'></a># at the end of the doxygen process doxygen will return with a non-zero status.
<a id='L826' name='L826'></a># Possible values are: NO, YES and FAIL_ON_WARNINGS.
<a id='L827' name='L827'></a># The default value is: NO.
<a id='L828' name='L828'></a>
<a id='L829' name='L829'></a>WARN_AS_ERROR = NO
<a id='L830' name='L830'></a>
<a id='L831' name='L831'></a># The WARN_FORMAT tag determines the format of the warning messages that doxygen
<a id='L832' name='L832'></a># can produce. The string should contain the $file, $line, and $text tags, which
<a id='L833' name='L833'></a># will be replaced by the file and line number from which the warning originated
<a id='L834' name='L834'></a># and the warning text. Optionally the format may contain $version, which will
<a id='L835' name='L835'></a># be replaced by the version of the file (if it could be obtained via
<a id='L836' name='L836'></a># FILE_VERSION_FILTER)
<a id='L837' name='L837'></a># The default value is: $file:$line: $text.
<a id='L838' name='L838'></a>
<a id='L839' name='L839'></a>WARN_FORMAT = "$file:$line: $text"
<a id='L840' name='L840'></a>
<a id='L841' name='L841'></a># The WARN_LOGFILE tag can be used to specify a file to which warning and error
<a id='L842' name='L842'></a># messages should be written. If left blank the output is written to standard
<a id='L843' name='L843'></a># error (stderr).
<a id='L844' name='L844'></a>
<a id='L845' name='L845'></a>WARN_LOGFILE =
<a id='L846' name='L846'></a>
<a id='L847' name='L847'></a>#---------------------------------------------------------------------------
<a id='L848' name='L848'></a># Configuration options related to the input files
<a id='L849' name='L849'></a>#---------------------------------------------------------------------------
<a id='L850' name='L850'></a>
<a id='L851' name='L851'></a># The INPUT tag is used to specify the files and/or directories that contain
<a id='L852' name='L852'></a># documented source files. You may enter file names like myfile.cpp or
<a id='L853' name='L853'></a># directories like /usr/src/myproject. Separate the files or directories with
<a id='L854' name='L854'></a># spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
<a id='L855' name='L855'></a># Note: If this tag is empty the current directory is searched.
<a id='L856' name='L856'></a>
<a id='L857' name='L857'></a>INPUT = .
<a id='L858' name='L858'></a>
<a id='L859' name='L859'></a># This tag can be used to specify the character encoding of the source files
<a id='L860' name='L860'></a># that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
<a id='L861' name='L861'></a># libiconv (or the iconv built into libc) for the transcoding. See the libiconv
<a id='L862' name='L862'></a># documentation (see:
<a id='L863' name='L863'></a># https://www.gnu.org/software/libiconv/) for the list of possible encodings.
<a id='L864' name='L864'></a># The default value is: UTF-8.
<a id='L865' name='L865'></a>
<a id='L866' name='L866'></a>INPUT_ENCODING = UTF-8
<a id='L867' name='L867'></a>
<a id='L868' name='L868'></a># If the value of the INPUT tag contains directories, you can use the
<a id='L869' name='L869'></a># FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
<a id='L870' name='L870'></a># *.h) to filter out the source-files in the directories.
<a id='L871' name='L871'></a>#
<a id='L872' name='L872'></a># Note that for custom extensions or not directly supported extensions you also
<a id='L873' name='L873'></a># need to set EXTENSION_MAPPING for the extension otherwise the files are not
<a id='L874' name='L874'></a># read by doxygen.
<a id='L875' name='L875'></a>#
<a id='L876' name='L876'></a># Note the list of default checked file patterns might differ from the list of
<a id='L877' name='L877'></a># default file extension mappings.
<a id='L878' name='L878'></a>#
<a id='L879' name='L879'></a># If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
<a id='L880' name='L880'></a># *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
<a id='L881' name='L881'></a># *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
<a id='L882' name='L882'></a># *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
<a id='L883' name='L883'></a># *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
<a id='L884' name='L884'></a># *.ucf, *.qsf and *.ice.
<a id='L885' name='L885'></a>
<a id='L886' name='L886'></a>FILE_PATTERNS = *.c \
<a id='L887' name='L887'></a> *.h
<a id='L888' name='L888'></a>
<a id='L889' name='L889'></a># The RECURSIVE tag can be used to specify whether or not subdirectories should
<a id='L890' name='L890'></a># be searched for input files as well.
<a id='L891' name='L891'></a># The default value is: NO.
<a id='L892' name='L892'></a>
<a id='L893' name='L893'></a>RECURSIVE = YES
<a id='L894' name='L894'></a>
<a id='L895' name='L895'></a># The EXCLUDE tag can be used to specify files and/or directories that should be
<a id='L896' name='L896'></a># excluded from the INPUT source files. This way you can easily exclude a
<a id='L897' name='L897'></a># subdirectory from a directory tree whose root is specified with the INPUT tag.
<a id='L898' name='L898'></a>#
<a id='L899' name='L899'></a># Note that relative paths are relative to the directory from which doxygen is
<a id='L900' name='L900'></a># run.
<a id='L901' name='L901'></a>
<a id='L902' name='L902'></a>EXCLUDE =
<a id='L903' name='L903'></a>
<a id='L904' name='L904'></a># The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
<a id='L905' name='L905'></a># directories that are symbolic links (a Unix file system feature) are excluded
<a id='L906' name='L906'></a># from the input.
<a id='L907' name='L907'></a># The default value is: NO.
<a id='L908' name='L908'></a>
<a id='L909' name='L909'></a>EXCLUDE_SYMLINKS = NO
<a id='L910' name='L910'></a>
<a id='L911' name='L911'></a># If the value of the INPUT tag contains directories, you can use the
<a id='L912' name='L912'></a># EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
<a id='L913' name='L913'></a># certain files from those directories.
<a id='L914' name='L914'></a>#
<a id='L915' name='L915'></a># Note that the wildcards are matched against the file with absolute path, so to
<a id='L916' name='L916'></a># exclude all test directories for example use the pattern */test/*
<a id='L917' name='L917'></a>
<a id='L918' name='L918'></a>EXCLUDE_PATTERNS = */test/*
<a id='L919' name='L919'></a>
<a id='L920' name='L920'></a># The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
<a id='L921' name='L921'></a># (namespaces, classes, functions, etc.) that should be excluded from the
<a id='L922' name='L922'></a># output. The symbol name can be a fully qualified name, a word, or if the
<a id='L923' name='L923'></a># wildcard * is used, a substring. Examples: ANamespace, AClass,
<a id='L924' name='L924'></a># AClass::ANamespace, ANamespace::*Test
<a id='L925' name='L925'></a>#
<a id='L926' name='L926'></a># Note that the wildcards are matched against the file with absolute path, so to
<a id='L927' name='L927'></a># exclude all test directories use the pattern */test/*
<a id='L928' name='L928'></a>
<a id='L929' name='L929'></a>EXCLUDE_SYMBOLS =
<a id='L930' name='L930'></a>
<a id='L931' name='L931'></a># The EXAMPLE_PATH tag can be used to specify one or more files or directories
<a id='L932' name='L932'></a># that contain example code fragments that are included (see the \include
<a id='L933' name='L933'></a># command).
<a id='L934' name='L934'></a>
<a id='L935' name='L935'></a>EXAMPLE_PATH =
<a id='L936' name='L936'></a>
<a id='L937' name='L937'></a># If the value of the EXAMPLE_PATH tag contains directories, you can use the
<a id='L938' name='L938'></a># EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
<a id='L939' name='L939'></a># *.h) to filter out the source-files in the directories. If left blank all
<a id='L940' name='L940'></a># files are included.
<a id='L941' name='L941'></a>
<a id='L942' name='L942'></a>EXAMPLE_PATTERNS =
<a id='L943' name='L943'></a>
<a id='L944' name='L944'></a># If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
<a id='L945' name='L945'></a># searched for input files to be used with the \include or \dontinclude commands
<a id='L946' name='L946'></a># irrespective of the value of the RECURSIVE tag.
<a id='L947' name='L947'></a># The default value is: NO.
<a id='L948' name='L948'></a>
<a id='L949' name='L949'></a>EXAMPLE_RECURSIVE = NO
<a id='L950' name='L950'></a>
<a id='L951' name='L951'></a># The IMAGE_PATH tag can be used to specify one or more files or directories
<a id='L952' name='L952'></a># that contain images that are to be included in the documentation (see the
<a id='L953' name='L953'></a># \image command).
<a id='L954' name='L954'></a>
<a id='L955' name='L955'></a>IMAGE_PATH =
<a id='L956' name='L956'></a>
<a id='L957' name='L957'></a># The INPUT_FILTER tag can be used to specify a program that doxygen should
<a id='L958' name='L958'></a># invoke to filter for each input file. Doxygen will invoke the filter program
<a id='L959' name='L959'></a># by executing (via popen()) the command:
<a id='L960' name='L960'></a>#
<a id='L961' name='L961'></a># <filter> <input-file>
<a id='L962' name='L962'></a>#
<a id='L963' name='L963'></a># where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
<a id='L964' name='L964'></a># name of an input file. Doxygen will then use the output that the filter
<a id='L965' name='L965'></a># program writes to standard output. If FILTER_PATTERNS is specified, this tag
<a id='L966' name='L966'></a># will be ignored.
<a id='L967' name='L967'></a>#
<a id='L968' name='L968'></a># Note that the filter must not add or remove lines; it is applied before the
<a id='L969' name='L969'></a># code is scanned, but not when the output code is generated. If lines are added
<a id='L970' name='L970'></a># or removed, the anchors will not be placed correctly.
<a id='L971' name='L971'></a>#
<a id='L972' name='L972'></a># Note that for custom extensions or not directly supported extensions you also
<a id='L973' name='L973'></a># need to set EXTENSION_MAPPING for the extension otherwise the files are not
<a id='L974' name='L974'></a># properly processed by doxygen.
<a id='L975' name='L975'></a>
<a id='L976' name='L976'></a>INPUT_FILTER =
<a id='L977' name='L977'></a>
<a id='L978' name='L978'></a># The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
<a id='L979' name='L979'></a># basis. Doxygen will compare the file name with each pattern and apply the
<a id='L980' name='L980'></a># filter if there is a match. The filters are a list of the form: pattern=filter
<a id='L981' name='L981'></a># (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
<a id='L982' name='L982'></a># filters are used. If the FILTER_PATTERNS tag is empty or if none of the
<a id='L983' name='L983'></a># patterns match the file name, INPUT_FILTER is applied.
<a id='L984' name='L984'></a>#
<a id='L985' name='L985'></a># Note that for custom extensions or not directly supported extensions you also
<a id='L986' name='L986'></a># need to set EXTENSION_MAPPING for the extension otherwise the files are not
<a id='L987' name='L987'></a># properly processed by doxygen.
<a id='L988' name='L988'></a>
<a id='L989' name='L989'></a>FILTER_PATTERNS =
<a id='L990' name='L990'></a>
<a id='L991' name='L991'></a># If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
<a id='L992' name='L992'></a># INPUT_FILTER) will also be used to filter the input files that are used for
<a id='L993' name='L993'></a># producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
<a id='L994' name='L994'></a># The default value is: NO.
<a id='L995' name='L995'></a>
<a id='L996' name='L996'></a>FILTER_SOURCE_FILES = NO
<a id='L997' name='L997'></a>
<a id='L998' name='L998'></a># The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
<a id='L999' name='L999'></a># pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
<a id='L1000' name='L1000'></a># it is also possible to disable source filtering for a specific pattern using
<a id='L1001' name='L1001'></a># *.ext= (so without naming a filter).
<a id='L1002' name='L1002'></a># This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
<a id='L1003' name='L1003'></a>
<a id='L1004' name='L1004'></a>FILTER_SOURCE_PATTERNS =
<a id='L1005' name='L1005'></a>
<a id='L1006' name='L1006'></a># If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
<a id='L1007' name='L1007'></a># is part of the input, its contents will be placed on the main page
<a id='L1008' name='L1008'></a># (index.html). This can be useful if you have a project on for instance GitHub
<a id='L1009' name='L1009'></a># and want to reuse the introduction page also for the doxygen output.
<a id='L1010' name='L1010'></a>
<a id='L1011' name='L1011'></a>USE_MDFILE_AS_MAINPAGE =
<a id='L1012' name='L1012'></a>
<a id='L1013' name='L1013'></a>#---------------------------------------------------------------------------
<a id='L1014' name='L1014'></a># Configuration options related to source browsing
<a id='L1015' name='L1015'></a>#---------------------------------------------------------------------------
<a id='L1016' name='L1016'></a>
<a id='L1017' name='L1017'></a># If the SOURCE_BROWSER tag is set to YES then a list of source files will be
<a id='L1018' name='L1018'></a># generated. Documented entities will be cross-referenced with these sources.
<a id='L1019' name='L1019'></a>#
<a id='L1020' name='L1020'></a># Note: To get rid of all source code in the generated output, make sure that
<a id='L1021' name='L1021'></a># also VERBATIM_HEADERS is set to NO.
<a id='L1022' name='L1022'></a># The default value is: NO.
<a id='L1023' name='L1023'></a>
<a id='L1024' name='L1024'></a>SOURCE_BROWSER = YES
<a id='L1025' name='L1025'></a>
<a id='L1026' name='L1026'></a># Setting the INLINE_SOURCES tag to YES will include the body of functions,
<a id='L1027' name='L1027'></a># classes and enums directly into the documentation.
<a id='L1028' name='L1028'></a># The default value is: NO.
<a id='L1029' name='L1029'></a>
<a id='L1030' name='L1030'></a>INLINE_SOURCES = NO
<a id='L1031' name='L1031'></a>
<a id='L1032' name='L1032'></a># Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
<a id='L1033' name='L1033'></a># special comment blocks from generated source code fragments. Normal C, C++ and
<a id='L1034' name='L1034'></a># Fortran comments will always remain visible.
<a id='L1035' name='L1035'></a># The default value is: YES.
<a id='L1036' name='L1036'></a>
<a id='L1037' name='L1037'></a>STRIP_CODE_COMMENTS = YES
<a id='L1038' name='L1038'></a>
<a id='L1039' name='L1039'></a># If the REFERENCED_BY_RELATION tag is set to YES then for each documented
<a id='L1040' name='L1040'></a># entity all documented functions referencing it will be listed.
<a id='L1041' name='L1041'></a># The default value is: NO.
<a id='L1042' name='L1042'></a>
<a id='L1043' name='L1043'></a>REFERENCED_BY_RELATION = NO
<a id='L1044' name='L1044'></a>
<a id='L1045' name='L1045'></a># If the REFERENCES_RELATION tag is set to YES then for each documented function
<a id='L1046' name='L1046'></a># all documented entities called/used by that function will be listed.
<a id='L1047' name='L1047'></a># The default value is: NO.
<a id='L1048' name='L1048'></a>
<a id='L1049' name='L1049'></a>REFERENCES_RELATION = NO
<a id='L1050' name='L1050'></a>
<a id='L1051' name='L1051'></a># If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
<a id='L1052' name='L1052'></a># to YES then the hyperlinks from functions in REFERENCES_RELATION and
<a id='L1053' name='L1053'></a># REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
<a id='L1054' name='L1054'></a># link to the documentation.
<a id='L1055' name='L1055'></a># The default value is: YES.
<a id='L1056' name='L1056'></a>
<a id='L1057' name='L1057'></a>REFERENCES_LINK_SOURCE = YES
<a id='L1058' name='L1058'></a>
<a id='L1059' name='L1059'></a># If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
<a id='L1060' name='L1060'></a># source code will show a tooltip with additional information such as prototype,
<a id='L1061' name='L1061'></a># brief description and links to the definition and documentation. Since this
<a id='L1062' name='L1062'></a># will make the HTML file larger and loading of large files a bit slower, you
<a id='L1063' name='L1063'></a># can opt to disable this feature.
<a id='L1064' name='L1064'></a># The default value is: YES.
<a id='L1065' name='L1065'></a># This tag requires that the tag SOURCE_BROWSER is set to YES.
<a id='L1066' name='L1066'></a>
<a id='L1067' name='L1067'></a>SOURCE_TOOLTIPS = YES
<a id='L1068' name='L1068'></a>
<a id='L1069' name='L1069'></a># If the USE_HTAGS tag is set to YES then the references to source code will
<a id='L1070' name='L1070'></a># point to the HTML generated by the htags(1) tool instead of doxygen built-in
<a id='L1071' name='L1071'></a># source browser. The htags tool is part of GNU's global source tagging system
<a id='L1072' name='L1072'></a># (see https://www.gnu.org/software/global/global.html). You will need version
<a id='L1073' name='L1073'></a># 4.8.6 or higher.
<a id='L1074' name='L1074'></a>#
<a id='L1075' name='L1075'></a># To use it do the following:
<a id='L1076' name='L1076'></a># - Install the latest version of global
<a id='L1077' name='L1077'></a># - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
<a id='L1078' name='L1078'></a># - Make sure the INPUT points to the root of the source tree
<a id='L1079' name='L1079'></a># - Run doxygen as normal
<a id='L1080' name='L1080'></a>#
<a id='L1081' name='L1081'></a># Doxygen will invoke htags (and that will in turn invoke gtags), so these
<a id='L1082' name='L1082'></a># tools must be available from the command line (i.e. in the search path).
<a id='L1083' name='L1083'></a>#
<a id='L1084' name='L1084'></a># The result: instead of the source browser generated by doxygen, the links to
<a id='L1085' name='L1085'></a># source code will now point to the output of htags.
<a id='L1086' name='L1086'></a># The default value is: NO.
<a id='L1087' name='L1087'></a># This tag requires that the tag SOURCE_BROWSER is set to YES.
<a id='L1088' name='L1088'></a>
<a id='L1089' name='L1089'></a>USE_HTAGS = NO
<a id='L1090' name='L1090'></a>
<a id='L1091' name='L1091'></a># If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
<a id='L1092' name='L1092'></a># verbatim copy of the header file for each class for which an include is
<a id='L1093' name='L1093'></a># specified. Set to NO to disable this.
<a id='L1094' name='L1094'></a># See also: Section \class.
<a id='L1095' name='L1095'></a># The default value is: YES.
<a id='L1096' name='L1096'></a>
<a id='L1097' name='L1097'></a>VERBATIM_HEADERS = YES
<a id='L1098' name='L1098'></a>
<a id='L1099' name='L1099'></a>#---------------------------------------------------------------------------
<a id='L1100' name='L1100'></a># Configuration options related to the alphabetical class index
<a id='L1101' name='L1101'></a>#---------------------------------------------------------------------------
<a id='L1102' name='L1102'></a>
<a id='L1103' name='L1103'></a># If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
<a id='L1104' name='L1104'></a># compounds will be generated. Enable this if the project contains a lot of
<a id='L1105' name='L1105'></a># classes, structs, unions or interfaces.
<a id='L1106' name='L1106'></a># The default value is: YES.
<a id='L1107' name='L1107'></a>
<a id='L1108' name='L1108'></a>ALPHABETICAL_INDEX = YES
<a id='L1109' name='L1109'></a>
<a id='L1110' name='L1110'></a># In case all classes in a project start with a common prefix, all classes will
<a id='L1111' name='L1111'></a># be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
<a id='L1112' name='L1112'></a># can be used to specify a prefix (or a list of prefixes) that should be ignored
<a id='L1113' name='L1113'></a># while generating the index headers.
<a id='L1114' name='L1114'></a># This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
<a id='L1115' name='L1115'></a>
<a id='L1116' name='L1116'></a>IGNORE_PREFIX =
<a id='L1117' name='L1117'></a>
<a id='L1118' name='L1118'></a>#---------------------------------------------------------------------------
<a id='L1119' name='L1119'></a># Configuration options related to the HTML output
<a id='L1120' name='L1120'></a>#---------------------------------------------------------------------------
<a id='L1121' name='L1121'></a>
<a id='L1122' name='L1122'></a># If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
<a id='L1123' name='L1123'></a># The default value is: YES.
<a id='L1124' name='L1124'></a>
<a id='L1125' name='L1125'></a>GENERATE_HTML = YES
<a id='L1126' name='L1126'></a>
<a id='L1127' name='L1127'></a># The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
<a id='L1128' name='L1128'></a># relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
<a id='L1129' name='L1129'></a># it.
<a id='L1130' name='L1130'></a># The default directory is: html.
<a id='L1131' name='L1131'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1132' name='L1132'></a>
<a id='L1133' name='L1133'></a>HTML_OUTPUT = html
<a id='L1134' name='L1134'></a>
<a id='L1135' name='L1135'></a># The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
<a id='L1136' name='L1136'></a># generated HTML page (for example: .htm, .php, .asp).
<a id='L1137' name='L1137'></a># The default value is: .html.
<a id='L1138' name='L1138'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1139' name='L1139'></a>
<a id='L1140' name='L1140'></a>HTML_FILE_EXTENSION = .html
<a id='L1141' name='L1141'></a>
<a id='L1142' name='L1142'></a># The HTML_HEADER tag can be used to specify a user-defined HTML header file for
<a id='L1143' name='L1143'></a># each generated HTML page. If the tag is left blank doxygen will generate a
<a id='L1144' name='L1144'></a># standard header.
<a id='L1145' name='L1145'></a>#
<a id='L1146' name='L1146'></a># To get valid HTML the header file that includes any scripts and style sheets
<a id='L1147' name='L1147'></a># that doxygen needs, which is dependent on the configuration options used (e.g.
<a id='L1148' name='L1148'></a># the setting GENERATE_TREEVIEW). It is highly recommended to start with a
<a id='L1149' name='L1149'></a># default header using
<a id='L1150' name='L1150'></a># doxygen -w html new_header.html new_footer.html new_stylesheet.css
<a id='L1151' name='L1151'></a># YourConfigFile
<a id='L1152' name='L1152'></a># and then modify the file new_header.html. See also section "Doxygen usage"
<a id='L1153' name='L1153'></a># for information on how to generate the default header that doxygen normally
<a id='L1154' name='L1154'></a># uses.
<a id='L1155' name='L1155'></a># Note: The header is subject to change so you typically have to regenerate the
<a id='L1156' name='L1156'></a># default header when upgrading to a newer version of doxygen. For a description
<a id='L1157' name='L1157'></a># of the possible markers and block names see the documentation.
<a id='L1158' name='L1158'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1159' name='L1159'></a>
<a id='L1160' name='L1160'></a>HTML_HEADER =
<a id='L1161' name='L1161'></a>
<a id='L1162' name='L1162'></a># The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
<a id='L1163' name='L1163'></a># generated HTML page. If the tag is left blank doxygen will generate a standard
<a id='L1164' name='L1164'></a># footer. See HTML_HEADER for more information on how to generate a default
<a id='L1165' name='L1165'></a># footer and what special commands can be used inside the footer. See also
<a id='L1166' name='L1166'></a># section "Doxygen usage" for information on how to generate the default footer
<a id='L1167' name='L1167'></a># that doxygen normally uses.
<a id='L1168' name='L1168'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1169' name='L1169'></a>
<a id='L1170' name='L1170'></a>HTML_FOOTER =
<a id='L1171' name='L1171'></a>
<a id='L1172' name='L1172'></a># The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
<a id='L1173' name='L1173'></a># sheet that is used by each HTML page. It can be used to fine-tune the look of
<a id='L1174' name='L1174'></a># the HTML output. If left blank doxygen will generate a default style sheet.
<a id='L1175' name='L1175'></a># See also section "Doxygen usage" for information on how to generate the style
<a id='L1176' name='L1176'></a># sheet that doxygen normally uses.
<a id='L1177' name='L1177'></a># Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
<a id='L1178' name='L1178'></a># it is more robust and this tag (HTML_STYLESHEET) will in the future become
<a id='L1179' name='L1179'></a># obsolete.
<a id='L1180' name='L1180'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1181' name='L1181'></a>
<a id='L1182' name='L1182'></a>HTML_STYLESHEET =
<a id='L1183' name='L1183'></a>
<a id='L1184' name='L1184'></a># The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
<a id='L1185' name='L1185'></a># cascading style sheets that are included after the standard style sheets
<a id='L1186' name='L1186'></a># created by doxygen. Using this option one can overrule certain style aspects.
<a id='L1187' name='L1187'></a># This is preferred over using HTML_STYLESHEET since it does not replace the
<a id='L1188' name='L1188'></a># standard style sheet and is therefore more robust against future updates.
<a id='L1189' name='L1189'></a># Doxygen will copy the style sheet files to the output directory.
<a id='L1190' name='L1190'></a># Note: The order of the extra style sheet files is of importance (e.g. the last
<a id='L1191' name='L1191'></a># style sheet in the list overrules the setting of the previous ones in the
<a id='L1192' name='L1192'></a># list). For an example see the documentation.
<a id='L1193' name='L1193'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1194' name='L1194'></a>
<a id='L1195' name='L1195'></a>HTML_EXTRA_STYLESHEET =
<a id='L1196' name='L1196'></a>
<a id='L1197' name='L1197'></a># The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
<a id='L1198' name='L1198'></a># other source files which should be copied to the HTML output directory. Note
<a id='L1199' name='L1199'></a># that these files will be copied to the base HTML output directory. Use the
<a id='L1200' name='L1200'></a># $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
<a id='L1201' name='L1201'></a># files. In the HTML_STYLESHEET file, use the file name only. Also note that the
<a id='L1202' name='L1202'></a># files will be copied as-is; there are no commands or markers available.
<a id='L1203' name='L1203'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1204' name='L1204'></a>
<a id='L1205' name='L1205'></a>HTML_EXTRA_FILES =
<a id='L1206' name='L1206'></a>
<a id='L1207' name='L1207'></a># The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
<a id='L1208' name='L1208'></a># will adjust the colors in the style sheet and background images according to
<a id='L1209' name='L1209'></a># this color. Hue is specified as an angle on a colorwheel, see
<a id='L1210' name='L1210'></a># https://en.wikipedia.org/wiki/Hue for more information. For instance the value
<a id='L1211' name='L1211'></a># 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
<a id='L1212' name='L1212'></a># purple, and 360 is red again.
<a id='L1213' name='L1213'></a># Minimum value: 0, maximum value: 359, default value: 220.
<a id='L1214' name='L1214'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1215' name='L1215'></a>
<a id='L1216' name='L1216'></a>HTML_COLORSTYLE_HUE = 220
<a id='L1217' name='L1217'></a>
<a id='L1218' name='L1218'></a># The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
<a id='L1219' name='L1219'></a># in the HTML output. For a value of 0 the output will use grayscales only. A
<a id='L1220' name='L1220'></a># value of 255 will produce the most vivid colors.
<a id='L1221' name='L1221'></a># Minimum value: 0, maximum value: 255, default value: 100.
<a id='L1222' name='L1222'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1223' name='L1223'></a>
<a id='L1224' name='L1224'></a>HTML_COLORSTYLE_SAT = 100
<a id='L1225' name='L1225'></a>
<a id='L1226' name='L1226'></a># The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
<a id='L1227' name='L1227'></a># luminance component of the colors in the HTML output. Values below 100
<a id='L1228' name='L1228'></a># gradually make the output lighter, whereas values above 100 make the output
<a id='L1229' name='L1229'></a># darker. The value divided by 100 is the actual gamma applied, so 80 represents
<a id='L1230' name='L1230'></a># a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
<a id='L1231' name='L1231'></a># change the gamma.
<a id='L1232' name='L1232'></a># Minimum value: 40, maximum value: 240, default value: 80.
<a id='L1233' name='L1233'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1234' name='L1234'></a>
<a id='L1235' name='L1235'></a>HTML_COLORSTYLE_GAMMA = 80
<a id='L1236' name='L1236'></a>
<a id='L1237' name='L1237'></a># If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
<a id='L1238' name='L1238'></a># page will contain the date and time when the page was generated. Setting this
<a id='L1239' name='L1239'></a># to YES can help to show when doxygen was last run and thus if the
<a id='L1240' name='L1240'></a># documentation is up to date.
<a id='L1241' name='L1241'></a># The default value is: NO.
<a id='L1242' name='L1242'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1243' name='L1243'></a>
<a id='L1244' name='L1244'></a>HTML_TIMESTAMP = YES
<a id='L1245' name='L1245'></a>
<a id='L1246' name='L1246'></a># If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
<a id='L1247' name='L1247'></a># documentation will contain a main index with vertical navigation menus that
<a id='L1248' name='L1248'></a># are dynamically created via JavaScript. If disabled, the navigation index will
<a id='L1249' name='L1249'></a># consists of multiple levels of tabs that are statically embedded in every HTML
<a id='L1250' name='L1250'></a># page. Disable this option to support browsers that do not have JavaScript,
<a id='L1251' name='L1251'></a># like the Qt help browser.
<a id='L1252' name='L1252'></a># The default value is: YES.
<a id='L1253' name='L1253'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1254' name='L1254'></a>
<a id='L1255' name='L1255'></a>HTML_DYNAMIC_MENUS = YES
<a id='L1256' name='L1256'></a>
<a id='L1257' name='L1257'></a># If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
<a id='L1258' name='L1258'></a># documentation will contain sections that can be hidden and shown after the
<a id='L1259' name='L1259'></a># page has loaded.
<a id='L1260' name='L1260'></a># The default value is: NO.
<a id='L1261' name='L1261'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1262' name='L1262'></a>
<a id='L1263' name='L1263'></a>HTML_DYNAMIC_SECTIONS = NO
<a id='L1264' name='L1264'></a>
<a id='L1265' name='L1265'></a># With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
<a id='L1266' name='L1266'></a># shown in the various tree structured indices initially; the user can expand
<a id='L1267' name='L1267'></a># and collapse entries dynamically later on. Doxygen will expand the tree to
<a id='L1268' name='L1268'></a># such a level that at most the specified number of entries are visible (unless
<a id='L1269' name='L1269'></a># a fully collapsed tree already exceeds this amount). So setting the number of
<a id='L1270' name='L1270'></a># entries 1 will produce a full collapsed tree by default. 0 is a special value
<a id='L1271' name='L1271'></a># representing an infinite number of entries and will result in a full expanded
<a id='L1272' name='L1272'></a># tree by default.
<a id='L1273' name='L1273'></a># Minimum value: 0, maximum value: 9999, default value: 100.
<a id='L1274' name='L1274'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1275' name='L1275'></a>
<a id='L1276' name='L1276'></a>HTML_INDEX_NUM_ENTRIES = 100
<a id='L1277' name='L1277'></a>
<a id='L1278' name='L1278'></a># If the GENERATE_DOCSET tag is set to YES, additional index files will be
<a id='L1279' name='L1279'></a># generated that can be used as input for Apple's Xcode 3 integrated development
<a id='L1280' name='L1280'></a># environment (see:
<a id='L1281' name='L1281'></a># https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
<a id='L1282' name='L1282'></a># create a documentation set, doxygen will generate a Makefile in the HTML
<a id='L1283' name='L1283'></a># output directory. Running make will produce the docset in that directory and
<a id='L1284' name='L1284'></a># running make install will install the docset in
<a id='L1285' name='L1285'></a># ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
<a id='L1286' name='L1286'></a># startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
<a id='L1287' name='L1287'></a># genXcode/_index.html for more information.
<a id='L1288' name='L1288'></a># The default value is: NO.
<a id='L1289' name='L1289'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1290' name='L1290'></a>
<a id='L1291' name='L1291'></a>GENERATE_DOCSET = NO
<a id='L1292' name='L1292'></a>
<a id='L1293' name='L1293'></a># This tag determines the name of the docset feed. A documentation feed provides
<a id='L1294' name='L1294'></a># an umbrella under which multiple documentation sets from a single provider
<a id='L1295' name='L1295'></a># (such as a company or product suite) can be grouped.
<a id='L1296' name='L1296'></a># The default value is: Doxygen generated docs.
<a id='L1297' name='L1297'></a># This tag requires that the tag GENERATE_DOCSET is set to YES.
<a id='L1298' name='L1298'></a>
<a id='L1299' name='L1299'></a>DOCSET_FEEDNAME = "Doxygen generated docs"
<a id='L1300' name='L1300'></a>
<a id='L1301' name='L1301'></a># This tag specifies a string that should uniquely identify the documentation
<a id='L1302' name='L1302'></a># set bundle. This should be a reverse domain-name style string, e.g.
<a id='L1303' name='L1303'></a># com.mycompany.MyDocSet. Doxygen will append .docset to the name.
<a id='L1304' name='L1304'></a># The default value is: org.doxygen.Project.
<a id='L1305' name='L1305'></a># This tag requires that the tag GENERATE_DOCSET is set to YES.
<a id='L1306' name='L1306'></a>
<a id='L1307' name='L1307'></a>DOCSET_BUNDLE_ID = org.doxygen.Project
<a id='L1308' name='L1308'></a>
<a id='L1309' name='L1309'></a># The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
<a id='L1310' name='L1310'></a># the documentation publisher. This should be a reverse domain-name style
<a id='L1311' name='L1311'></a># string, e.g. com.mycompany.MyDocSet.documentation.
<a id='L1312' name='L1312'></a># The default value is: org.doxygen.Publisher.
<a id='L1313' name='L1313'></a># This tag requires that the tag GENERATE_DOCSET is set to YES.
<a id='L1314' name='L1314'></a>
<a id='L1315' name='L1315'></a>DOCSET_PUBLISHER_ID = org.doxygen.Publisher
<a id='L1316' name='L1316'></a>
<a id='L1317' name='L1317'></a># The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<a id='L1318' name='L1318'></a># The default value is: Publisher.
<a id='L1319' name='L1319'></a># This tag requires that the tag GENERATE_DOCSET is set to YES.
<a id='L1320' name='L1320'></a>
<a id='L1321' name='L1321'></a>DOCSET_PUBLISHER_NAME = Publisher
<a id='L1322' name='L1322'></a>
<a id='L1323' name='L1323'></a># If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
<a id='L1324' name='L1324'></a># additional HTML index files: index.hhp, index.hhc, and index.hhk. The
<a id='L1325' name='L1325'></a># index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
<a id='L1326' name='L1326'></a># (see:
<a id='L1327' name='L1327'></a># https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
<a id='L1328' name='L1328'></a>#
<a id='L1329' name='L1329'></a># The HTML Help Workshop contains a compiler that can convert all HTML output
<a id='L1330' name='L1330'></a># generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
<a id='L1331' name='L1331'></a># files are now used as the Windows 98 help format, and will replace the old
<a id='L1332' name='L1332'></a># Windows help format (.hlp) on all Windows platforms in the future. Compressed
<a id='L1333' name='L1333'></a># HTML files also contain an index, a table of contents, and you can search for
<a id='L1334' name='L1334'></a># words in the documentation. The HTML workshop also contains a viewer for
<a id='L1335' name='L1335'></a># compressed HTML files.
<a id='L1336' name='L1336'></a># The default value is: NO.
<a id='L1337' name='L1337'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1338' name='L1338'></a>
<a id='L1339' name='L1339'></a>GENERATE_HTMLHELP = NO
<a id='L1340' name='L1340'></a>
<a id='L1341' name='L1341'></a># The CHM_FILE tag can be used to specify the file name of the resulting .chm
<a id='L1342' name='L1342'></a># file. You can add a path in front of the file if the result should not be
<a id='L1343' name='L1343'></a># written to the html output directory.
<a id='L1344' name='L1344'></a># This tag requires that the tag GENERATE_HTMLHELP is set to YES.
<a id='L1345' name='L1345'></a>
<a id='L1346' name='L1346'></a>CHM_FILE =
<a id='L1347' name='L1347'></a>
<a id='L1348' name='L1348'></a># The HHC_LOCATION tag can be used to specify the location (absolute path
<a id='L1349' name='L1349'></a># including file name) of the HTML help compiler (hhc.exe). If non-empty,
<a id='L1350' name='L1350'></a># doxygen will try to run the HTML help compiler on the generated index.hhp.
<a id='L1351' name='L1351'></a># The file has to be specified with full path.
<a id='L1352' name='L1352'></a># This tag requires that the tag GENERATE_HTMLHELP is set to YES.
<a id='L1353' name='L1353'></a>
<a id='L1354' name='L1354'></a>HHC_LOCATION =
<a id='L1355' name='L1355'></a>
<a id='L1356' name='L1356'></a># The GENERATE_CHI flag controls if a separate .chi index file is generated
<a id='L1357' name='L1357'></a># (YES) or that it should be included in the main .chm file (NO).
<a id='L1358' name='L1358'></a># The default value is: NO.
<a id='L1359' name='L1359'></a># This tag requires that the tag GENERATE_HTMLHELP is set to YES.
<a id='L1360' name='L1360'></a>
<a id='L1361' name='L1361'></a>GENERATE_CHI = NO
<a id='L1362' name='L1362'></a>
<a id='L1363' name='L1363'></a># The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
<a id='L1364' name='L1364'></a># and project file content.
<a id='L1365' name='L1365'></a># This tag requires that the tag GENERATE_HTMLHELP is set to YES.
<a id='L1366' name='L1366'></a>
<a id='L1367' name='L1367'></a>CHM_INDEX_ENCODING =
<a id='L1368' name='L1368'></a>
<a id='L1369' name='L1369'></a># The BINARY_TOC flag controls whether a binary table of contents is generated
<a id='L1370' name='L1370'></a># (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
<a id='L1371' name='L1371'></a># enables the Previous and Next buttons.
<a id='L1372' name='L1372'></a># The default value is: NO.
<a id='L1373' name='L1373'></a># This tag requires that the tag GENERATE_HTMLHELP is set to YES.
<a id='L1374' name='L1374'></a>
<a id='L1375' name='L1375'></a>BINARY_TOC = NO
<a id='L1376' name='L1376'></a>
<a id='L1377' name='L1377'></a># The TOC_EXPAND flag can be set to YES to add extra items for group members to
<a id='L1378' name='L1378'></a># the table of contents of the HTML help documentation and to the tree view.
<a id='L1379' name='L1379'></a># The default value is: NO.
<a id='L1380' name='L1380'></a># This tag requires that the tag GENERATE_HTMLHELP is set to YES.
<a id='L1381' name='L1381'></a>
<a id='L1382' name='L1382'></a>TOC_EXPAND = NO
<a id='L1383' name='L1383'></a>
<a id='L1384' name='L1384'></a># If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
<a id='L1385' name='L1385'></a># QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
<a id='L1386' name='L1386'></a># can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
<a id='L1387' name='L1387'></a># (.qch) of the generated HTML documentation.
<a id='L1388' name='L1388'></a># The default value is: NO.
<a id='L1389' name='L1389'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1390' name='L1390'></a>
<a id='L1391' name='L1391'></a>GENERATE_QHP = NO
<a id='L1392' name='L1392'></a>
<a id='L1393' name='L1393'></a># If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
<a id='L1394' name='L1394'></a># the file name of the resulting .qch file. The path specified is relative to
<a id='L1395' name='L1395'></a># the HTML output folder.
<a id='L1396' name='L1396'></a># This tag requires that the tag GENERATE_QHP is set to YES.
<a id='L1397' name='L1397'></a>
<a id='L1398' name='L1398'></a>QCH_FILE =
<a id='L1399' name='L1399'></a>
<a id='L1400' name='L1400'></a># The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
<a id='L1401' name='L1401'></a># Project output. For more information please see Qt Help Project / Namespace
<a id='L1402' name='L1402'></a># (see:
<a id='L1403' name='L1403'></a># https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
<a id='L1404' name='L1404'></a># The default value is: org.doxygen.Project.
<a id='L1405' name='L1405'></a># This tag requires that the tag GENERATE_QHP is set to YES.
<a id='L1406' name='L1406'></a>
<a id='L1407' name='L1407'></a>QHP_NAMESPACE = org.doxygen.Project
<a id='L1408' name='L1408'></a>
<a id='L1409' name='L1409'></a># The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
<a id='L1410' name='L1410'></a># Help Project output. For more information please see Qt Help Project / Virtual
<a id='L1411' name='L1411'></a># Folders (see:
<a id='L1412' name='L1412'></a># https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
<a id='L1413' name='L1413'></a># The default value is: doc.
<a id='L1414' name='L1414'></a># This tag requires that the tag GENERATE_QHP is set to YES.
<a id='L1415' name='L1415'></a>
<a id='L1416' name='L1416'></a>QHP_VIRTUAL_FOLDER = doc
<a id='L1417' name='L1417'></a>
<a id='L1418' name='L1418'></a># If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
<a id='L1419' name='L1419'></a># filter to add. For more information please see Qt Help Project / Custom
<a id='L1420' name='L1420'></a># Filters (see:
<a id='L1421' name='L1421'></a># https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
<a id='L1422' name='L1422'></a># This tag requires that the tag GENERATE_QHP is set to YES.
<a id='L1423' name='L1423'></a>
<a id='L1424' name='L1424'></a>QHP_CUST_FILTER_NAME =
<a id='L1425' name='L1425'></a>
<a id='L1426' name='L1426'></a># The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
<a id='L1427' name='L1427'></a># custom filter to add. For more information please see Qt Help Project / Custom
<a id='L1428' name='L1428'></a># Filters (see:
<a id='L1429' name='L1429'></a># https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
<a id='L1430' name='L1430'></a># This tag requires that the tag GENERATE_QHP is set to YES.
<a id='L1431' name='L1431'></a>
<a id='L1432' name='L1432'></a>QHP_CUST_FILTER_ATTRS =
<a id='L1433' name='L1433'></a>
<a id='L1434' name='L1434'></a># The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
<a id='L1435' name='L1435'></a># project's filter section matches. Qt Help Project / Filter Attributes (see:
<a id='L1436' name='L1436'></a># https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
<a id='L1437' name='L1437'></a># This tag requires that the tag GENERATE_QHP is set to YES.
<a id='L1438' name='L1438'></a>
<a id='L1439' name='L1439'></a>QHP_SECT_FILTER_ATTRS =
<a id='L1440' name='L1440'></a>
<a id='L1441' name='L1441'></a># The QHG_LOCATION tag can be used to specify the location (absolute path
<a id='L1442' name='L1442'></a># including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
<a id='L1443' name='L1443'></a># run qhelpgenerator on the generated .qhp file.
<a id='L1444' name='L1444'></a># This tag requires that the tag GENERATE_QHP is set to YES.
<a id='L1445' name='L1445'></a>
<a id='L1446' name='L1446'></a>QHG_LOCATION =
<a id='L1447' name='L1447'></a>
<a id='L1448' name='L1448'></a># If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
<a id='L1449' name='L1449'></a># generated, together with the HTML files, they form an Eclipse help plugin. To
<a id='L1450' name='L1450'></a># install this plugin and make it available under the help contents menu in
<a id='L1451' name='L1451'></a># Eclipse, the contents of the directory containing the HTML and XML files needs
<a id='L1452' name='L1452'></a># to be copied into the plugins directory of eclipse. The name of the directory
<a id='L1453' name='L1453'></a># within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
<a id='L1454' name='L1454'></a># After copying Eclipse needs to be restarted before the help appears.
<a id='L1455' name='L1455'></a># The default value is: NO.
<a id='L1456' name='L1456'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1457' name='L1457'></a>
<a id='L1458' name='L1458'></a>GENERATE_ECLIPSEHELP = NO
<a id='L1459' name='L1459'></a>
<a id='L1460' name='L1460'></a># A unique identifier for the Eclipse help plugin. When installing the plugin
<a id='L1461' name='L1461'></a># the directory name containing the HTML and XML files should also have this
<a id='L1462' name='L1462'></a># name. Each documentation set should have its own identifier.
<a id='L1463' name='L1463'></a># The default value is: org.doxygen.Project.
<a id='L1464' name='L1464'></a># This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
<a id='L1465' name='L1465'></a>
<a id='L1466' name='L1466'></a>ECLIPSE_DOC_ID = org.doxygen.Project
<a id='L1467' name='L1467'></a>
<a id='L1468' name='L1468'></a># If you want full control over the layout of the generated HTML pages it might
<a id='L1469' name='L1469'></a># be necessary to disable the index and replace it with your own. The
<a id='L1470' name='L1470'></a># DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
<a id='L1471' name='L1471'></a># of each HTML page. A value of NO enables the index and the value YES disables
<a id='L1472' name='L1472'></a># it. Since the tabs in the index contain the same information as the navigation
<a id='L1473' name='L1473'></a># tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
<a id='L1474' name='L1474'></a># The default value is: NO.
<a id='L1475' name='L1475'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1476' name='L1476'></a>
<a id='L1477' name='L1477'></a>DISABLE_INDEX = NO
<a id='L1478' name='L1478'></a>
<a id='L1479' name='L1479'></a># The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
<a id='L1480' name='L1480'></a># structure should be generated to display hierarchical information. If the tag
<a id='L1481' name='L1481'></a># value is set to YES, a side panel will be generated containing a tree-like
<a id='L1482' name='L1482'></a># index structure (just like the one that is generated for HTML Help). For this
<a id='L1483' name='L1483'></a># to work a browser that supports JavaScript, DHTML, CSS and frames is required
<a id='L1484' name='L1484'></a># (i.e. any modern browser). Windows users are probably better off using the
<a id='L1485' name='L1485'></a># HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
<a id='L1486' name='L1486'></a># further fine-tune the look of the index. As an example, the default style
<a id='L1487' name='L1487'></a># sheet generated by doxygen has an example that shows how to put an image at
<a id='L1488' name='L1488'></a># the root of the tree instead of the PROJECT_NAME. Since the tree basically has
<a id='L1489' name='L1489'></a># the same information as the tab index, you could consider setting
<a id='L1490' name='L1490'></a># DISABLE_INDEX to YES when enabling this option.
<a id='L1491' name='L1491'></a># The default value is: NO.
<a id='L1492' name='L1492'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1493' name='L1493'></a>
<a id='L1494' name='L1494'></a>GENERATE_TREEVIEW = NO
<a id='L1495' name='L1495'></a>
<a id='L1496' name='L1496'></a># The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
<a id='L1497' name='L1497'></a># doxygen will group on one line in the generated HTML documentation.
<a id='L1498' name='L1498'></a>#
<a id='L1499' name='L1499'></a># Note that a value of 0 will completely suppress the enum values from appearing
<a id='L1500' name='L1500'></a># in the overview section.
<a id='L1501' name='L1501'></a># Minimum value: 0, maximum value: 20, default value: 4.
<a id='L1502' name='L1502'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1503' name='L1503'></a>
<a id='L1504' name='L1504'></a>ENUM_VALUES_PER_LINE = 4
<a id='L1505' name='L1505'></a>
<a id='L1506' name='L1506'></a># If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
<a id='L1507' name='L1507'></a># to set the initial width (in pixels) of the frame in which the tree is shown.
<a id='L1508' name='L1508'></a># Minimum value: 0, maximum value: 1500, default value: 250.
<a id='L1509' name='L1509'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1510' name='L1510'></a>
<a id='L1511' name='L1511'></a>TREEVIEW_WIDTH = 250
<a id='L1512' name='L1512'></a>
<a id='L1513' name='L1513'></a># If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
<a id='L1514' name='L1514'></a># external symbols imported via tag files in a separate window.
<a id='L1515' name='L1515'></a># The default value is: NO.
<a id='L1516' name='L1516'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1517' name='L1517'></a>
<a id='L1518' name='L1518'></a>EXT_LINKS_IN_WINDOW = NO
<a id='L1519' name='L1519'></a>
<a id='L1520' name='L1520'></a># If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
<a id='L1521' name='L1521'></a># tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
<a id='L1522' name='L1522'></a># https://inkscape.org) to generate formulas as SVG images instead of PNGs for
<a id='L1523' name='L1523'></a># the HTML output. These images will generally look nicer at scaled resolutions.
<a id='L1524' name='L1524'></a># Possible values are: png (the default) and svg (looks nicer but requires the
<a id='L1525' name='L1525'></a># pdf2svg or inkscape tool).
<a id='L1526' name='L1526'></a># The default value is: png.
<a id='L1527' name='L1527'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1528' name='L1528'></a>
<a id='L1529' name='L1529'></a>HTML_FORMULA_FORMAT = png
<a id='L1530' name='L1530'></a>
<a id='L1531' name='L1531'></a># Use this tag to change the font size of LaTeX formulas included as images in
<a id='L1532' name='L1532'></a># the HTML documentation. When you change the font size after a successful
<a id='L1533' name='L1533'></a># doxygen run you need to manually remove any form_*.png images from the HTML
<a id='L1534' name='L1534'></a># output directory to force them to be regenerated.
<a id='L1535' name='L1535'></a># Minimum value: 8, maximum value: 50, default value: 10.
<a id='L1536' name='L1536'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1537' name='L1537'></a>
<a id='L1538' name='L1538'></a>FORMULA_FONTSIZE = 10
<a id='L1539' name='L1539'></a>
<a id='L1540' name='L1540'></a># Use the FORMULA_TRANSPARENT tag to determine whether or not the images
<a id='L1541' name='L1541'></a># generated for formulas are transparent PNGs. Transparent PNGs are not
<a id='L1542' name='L1542'></a># supported properly for IE 6.0, but are supported on all modern browsers.
<a id='L1543' name='L1543'></a>#
<a id='L1544' name='L1544'></a># Note that when changing this option you need to delete any form_*.png files in
<a id='L1545' name='L1545'></a># the HTML output directory before the changes have effect.
<a id='L1546' name='L1546'></a># The default value is: YES.
<a id='L1547' name='L1547'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1548' name='L1548'></a>
<a id='L1549' name='L1549'></a>FORMULA_TRANSPARENT = YES
<a id='L1550' name='L1550'></a>
<a id='L1551' name='L1551'></a># The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
<a id='L1552' name='L1552'></a># to create new LaTeX commands to be used in formulas as building blocks. See
<a id='L1553' name='L1553'></a># the section "Including formulas" for details.
<a id='L1554' name='L1554'></a>
<a id='L1555' name='L1555'></a>FORMULA_MACROFILE =
<a id='L1556' name='L1556'></a>
<a id='L1557' name='L1557'></a># Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
<a id='L1558' name='L1558'></a># https://www.mathjax.org) which uses client side JavaScript for the rendering
<a id='L1559' name='L1559'></a># instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
<a id='L1560' name='L1560'></a># installed or if you want to formulas look prettier in the HTML output. When
<a id='L1561' name='L1561'></a># enabled you may also need to install MathJax separately and configure the path
<a id='L1562' name='L1562'></a># to it using the MATHJAX_RELPATH option.
<a id='L1563' name='L1563'></a># The default value is: NO.
<a id='L1564' name='L1564'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1565' name='L1565'></a>
<a id='L1566' name='L1566'></a>USE_MATHJAX = YES
<a id='L1567' name='L1567'></a>
<a id='L1568' name='L1568'></a># When MathJax is enabled you can set the default output format to be used for
<a id='L1569' name='L1569'></a># the MathJax output. See the MathJax site (see:
<a id='L1570' name='L1570'></a># http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
<a id='L1571' name='L1571'></a># Possible values are: HTML-CSS (which is slower, but has the best
<a id='L1572' name='L1572'></a># compatibility), NativeMML (i.e. MathML) and SVG.
<a id='L1573' name='L1573'></a># The default value is: HTML-CSS.
<a id='L1574' name='L1574'></a># This tag requires that the tag USE_MATHJAX is set to YES.
<a id='L1575' name='L1575'></a>
<a id='L1576' name='L1576'></a>MATHJAX_FORMAT = HTML-CSS
<a id='L1577' name='L1577'></a>
<a id='L1578' name='L1578'></a># When MathJax is enabled you need to specify the location relative to the HTML
<a id='L1579' name='L1579'></a># output directory using the MATHJAX_RELPATH option. The destination directory
<a id='L1580' name='L1580'></a># should contain the MathJax.js script. For instance, if the mathjax directory
<a id='L1581' name='L1581'></a># is located at the same level as the HTML output directory, then
<a id='L1582' name='L1582'></a># MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
<a id='L1583' name='L1583'></a># Content Delivery Network so you can quickly see the result without installing
<a id='L1584' name='L1584'></a># MathJax. However, it is strongly recommended to install a local copy of
<a id='L1585' name='L1585'></a># MathJax from https://www.mathjax.org before deployment.
<a id='L1586' name='L1586'></a># The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
<a id='L1587' name='L1587'></a># This tag requires that the tag USE_MATHJAX is set to YES.
<a id='L1588' name='L1588'></a>
<a id='L1589' name='L1589'></a>MATHJAX_RELPATH = http://www.mathjax.org/mathjax
<a id='L1590' name='L1590'></a>
<a id='L1591' name='L1591'></a># The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
<a id='L1592' name='L1592'></a># extension names that should be enabled during MathJax rendering. For example
<a id='L1593' name='L1593'></a># MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
<a id='L1594' name='L1594'></a># This tag requires that the tag USE_MATHJAX is set to YES.
<a id='L1595' name='L1595'></a>
<a id='L1596' name='L1596'></a>MATHJAX_EXTENSIONS =
<a id='L1597' name='L1597'></a>
<a id='L1598' name='L1598'></a># The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
<a id='L1599' name='L1599'></a># of code that will be used on startup of the MathJax code. See the MathJax site
<a id='L1600' name='L1600'></a># (see:
<a id='L1601' name='L1601'></a># http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
<a id='L1602' name='L1602'></a># example see the documentation.
<a id='L1603' name='L1603'></a># This tag requires that the tag USE_MATHJAX is set to YES.
<a id='L1604' name='L1604'></a>
<a id='L1605' name='L1605'></a>MATHJAX_CODEFILE =
<a id='L1606' name='L1606'></a>
<a id='L1607' name='L1607'></a># When the SEARCHENGINE tag is enabled doxygen will generate a search box for
<a id='L1608' name='L1608'></a># the HTML output. The underlying search engine uses javascript and DHTML and
<a id='L1609' name='L1609'></a># should work on any modern browser. Note that when using HTML help
<a id='L1610' name='L1610'></a># (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
<a id='L1611' name='L1611'></a># there is already a search function so this one should typically be disabled.
<a id='L1612' name='L1612'></a># For large projects the javascript based search engine can be slow, then
<a id='L1613' name='L1613'></a># enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
<a id='L1614' name='L1614'></a># search using the keyboard; to jump to the search box use <access key> + S
<a id='L1615' name='L1615'></a># (what the <access key> is depends on the OS and browser, but it is typically
<a id='L1616' name='L1616'></a># <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
<a id='L1617' name='L1617'></a># key> to jump into the search results window, the results can be navigated
<a id='L1618' name='L1618'></a># using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
<a id='L1619' name='L1619'></a># the search. The filter options can be selected when the cursor is inside the
<a id='L1620' name='L1620'></a># search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
<a id='L1621' name='L1621'></a># to select a filter and <Enter> or <escape> to activate or cancel the filter
<a id='L1622' name='L1622'></a># option.
<a id='L1623' name='L1623'></a># The default value is: YES.
<a id='L1624' name='L1624'></a># This tag requires that the tag GENERATE_HTML is set to YES.
<a id='L1625' name='L1625'></a>
<a id='L1626' name='L1626'></a>SEARCHENGINE = YES
<a id='L1627' name='L1627'></a>
<a id='L1628' name='L1628'></a># When the SERVER_BASED_SEARCH tag is enabled the search engine will be
<a id='L1629' name='L1629'></a># implemented using a web server instead of a web client using JavaScript. There
<a id='L1630' name='L1630'></a># are two flavors of web server based searching depending on the EXTERNAL_SEARCH
<a id='L1631' name='L1631'></a># setting. When disabled, doxygen will generate a PHP script for searching and
<a id='L1632' name='L1632'></a># an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
<a id='L1633' name='L1633'></a># and searching needs to be provided by external tools. See the section
<a id='L1634' name='L1634'></a># "External Indexing and Searching" for details.
<a id='L1635' name='L1635'></a># The default value is: NO.
<a id='L1636' name='L1636'></a># This tag requires that the tag SEARCHENGINE is set to YES.
<a id='L1637' name='L1637'></a>
<a id='L1638' name='L1638'></a>SERVER_BASED_SEARCH = NO
<a id='L1639' name='L1639'></a>
<a id='L1640' name='L1640'></a># When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
<a id='L1641' name='L1641'></a># script for searching. Instead the search results are written to an XML file
<a id='L1642' name='L1642'></a># which needs to be processed by an external indexer. Doxygen will invoke an
<a id='L1643' name='L1643'></a># external search engine pointed to by the SEARCHENGINE_URL option to obtain the
<a id='L1644' name='L1644'></a># search results.
<a id='L1645' name='L1645'></a>#
<a id='L1646' name='L1646'></a># Doxygen ships with an example indexer (doxyindexer) and search engine
<a id='L1647' name='L1647'></a># (doxysearch.cgi) which are based on the open source search engine library
<a id='L1648' name='L1648'></a># Xapian (see:
<a id='L1649' name='L1649'></a># https://xapian.org/).
<a id='L1650' name='L1650'></a>#
<a id='L1651' name='L1651'></a># See the section "External Indexing and Searching" for details.
<a id='L1652' name='L1652'></a># The default value is: NO.
<a id='L1653' name='L1653'></a># This tag requires that the tag SEARCHENGINE is set to YES.
<a id='L1654' name='L1654'></a>
<a id='L1655' name='L1655'></a>EXTERNAL_SEARCH = NO
<a id='L1656' name='L1656'></a>
<a id='L1657' name='L1657'></a># The SEARCHENGINE_URL should point to a search engine hosted by a web server
<a id='L1658' name='L1658'></a># which will return the search results when EXTERNAL_SEARCH is enabled.
<a id='L1659' name='L1659'></a>#
<a id='L1660' name='L1660'></a># Doxygen ships with an example indexer (doxyindexer) and search engine
<a id='L1661' name='L1661'></a># (doxysearch.cgi) which are based on the open source search engine library
<a id='L1662' name='L1662'></a># Xapian (see:
<a id='L1663' name='L1663'></a># https://xapian.org/). See the section "External Indexing and Searching" for
<a id='L1664' name='L1664'></a># details.
<a id='L1665' name='L1665'></a># This tag requires that the tag SEARCHENGINE is set to YES.
<a id='L1666' name='L1666'></a>
<a id='L1667' name='L1667'></a>SEARCHENGINE_URL =
<a id='L1668' name='L1668'></a>
<a id='L1669' name='L1669'></a># When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
<a id='L1670' name='L1670'></a># search data is written to a file for indexing by an external tool. With the
<a id='L1671' name='L1671'></a># SEARCHDATA_FILE tag the name of this file can be specified.
<a id='L1672' name='L1672'></a># The default file is: searchdata.xml.
<a id='L1673' name='L1673'></a># This tag requires that the tag SEARCHENGINE is set to YES.
<a id='L1674' name='L1674'></a>
<a id='L1675' name='L1675'></a>SEARCHDATA_FILE = searchdata.xml
<a id='L1676' name='L1676'></a>
<a id='L1677' name='L1677'></a># When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
<a id='L1678' name='L1678'></a># EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
<a id='L1679' name='L1679'></a># useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
<a id='L1680' name='L1680'></a># projects and redirect the results back to the right project.
<a id='L1681' name='L1681'></a># This tag requires that the tag SEARCHENGINE is set to YES.
<a id='L1682' name='L1682'></a>
<a id='L1683' name='L1683'></a>EXTERNAL_SEARCH_ID =
<a id='L1684' name='L1684'></a>
<a id='L1685' name='L1685'></a># The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
<a id='L1686' name='L1686'></a># projects other than the one defined by this configuration file, but that are
<a id='L1687' name='L1687'></a># all added to the same external search index. Each project needs to have a
<a id='L1688' name='L1688'></a># unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
<a id='L1689' name='L1689'></a># to a relative location where the documentation can be found. The format is:
<a id='L1690' name='L1690'></a># EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
<a id='L1691' name='L1691'></a># This tag requires that the tag SEARCHENGINE is set to YES.
<a id='L1692' name='L1692'></a>
<a id='L1693' name='L1693'></a>EXTRA_SEARCH_MAPPINGS =
<a id='L1694' name='L1694'></a>
<a id='L1695' name='L1695'></a>#---------------------------------------------------------------------------
<a id='L1696' name='L1696'></a># Configuration options related to the LaTeX output
<a id='L1697' name='L1697'></a>#---------------------------------------------------------------------------
<a id='L1698' name='L1698'></a>
<a id='L1699' name='L1699'></a># If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
<a id='L1700' name='L1700'></a># The default value is: YES.
<a id='L1701' name='L1701'></a>
<a id='L1702' name='L1702'></a>GENERATE_LATEX = YES
<a id='L1703' name='L1703'></a>
<a id='L1704' name='L1704'></a># The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
<a id='L1705' name='L1705'></a># relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
<a id='L1706' name='L1706'></a># it.
<a id='L1707' name='L1707'></a># The default directory is: latex.
<a id='L1708' name='L1708'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1709' name='L1709'></a>
<a id='L1710' name='L1710'></a>LATEX_OUTPUT = latex
<a id='L1711' name='L1711'></a>
<a id='L1712' name='L1712'></a># The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
<a id='L1713' name='L1713'></a># invoked.
<a id='L1714' name='L1714'></a>#
<a id='L1715' name='L1715'></a># Note that when not enabling USE_PDFLATEX the default is latex when enabling
<a id='L1716' name='L1716'></a># USE_PDFLATEX the default is pdflatex and when in the later case latex is
<a id='L1717' name='L1717'></a># chosen this is overwritten by pdflatex. For specific output languages the
<a id='L1718' name='L1718'></a># default can have been set differently, this depends on the implementation of
<a id='L1719' name='L1719'></a># the output language.
<a id='L1720' name='L1720'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1721' name='L1721'></a>
<a id='L1722' name='L1722'></a>LATEX_CMD_NAME = uplatex
<a id='L1723' name='L1723'></a>
<a id='L1724' name='L1724'></a># The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
<a id='L1725' name='L1725'></a># index for LaTeX.
<a id='L1726' name='L1726'></a># Note: This tag is used in the Makefile / make.bat.
<a id='L1727' name='L1727'></a># See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
<a id='L1728' name='L1728'></a># (.tex).
<a id='L1729' name='L1729'></a># The default file is: makeindex.
<a id='L1730' name='L1730'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1731' name='L1731'></a>
<a id='L1732' name='L1732'></a>MAKEINDEX_CMD_NAME = makeindex
<a id='L1733' name='L1733'></a>
<a id='L1734' name='L1734'></a># The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
<a id='L1735' name='L1735'></a># generate index for LaTeX. In case there is no backslash (\) as first character
<a id='L1736' name='L1736'></a># it will be automatically added in the LaTeX code.
<a id='L1737' name='L1737'></a># Note: This tag is used in the generated output file (.tex).
<a id='L1738' name='L1738'></a># See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
<a id='L1739' name='L1739'></a># The default value is: makeindex.
<a id='L1740' name='L1740'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1741' name='L1741'></a>
<a id='L1742' name='L1742'></a>LATEX_MAKEINDEX_CMD = \makeindex
<a id='L1743' name='L1743'></a>
<a id='L1744' name='L1744'></a># If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
<a id='L1745' name='L1745'></a># documents. This may be useful for small projects and may help to save some
<a id='L1746' name='L1746'></a># trees in general.
<a id='L1747' name='L1747'></a># The default value is: NO.
<a id='L1748' name='L1748'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1749' name='L1749'></a>
<a id='L1750' name='L1750'></a>COMPACT_LATEX = NO
<a id='L1751' name='L1751'></a>
<a id='L1752' name='L1752'></a># The PAPER_TYPE tag can be used to set the paper type that is used by the
<a id='L1753' name='L1753'></a># printer.
<a id='L1754' name='L1754'></a># Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
<a id='L1755' name='L1755'></a># 14 inches) and executive (7.25 x 10.5 inches).
<a id='L1756' name='L1756'></a># The default value is: a4.
<a id='L1757' name='L1757'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1758' name='L1758'></a>
<a id='L1759' name='L1759'></a>PAPER_TYPE = a4
<a id='L1760' name='L1760'></a>
<a id='L1761' name='L1761'></a># The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
<a id='L1762' name='L1762'></a># that should be included in the LaTeX output. The package can be specified just
<a id='L1763' name='L1763'></a># by its name or with the correct syntax as to be used with the LaTeX
<a id='L1764' name='L1764'></a># \usepackage command. To get the times font for instance you can specify :
<a id='L1765' name='L1765'></a># EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
<a id='L1766' name='L1766'></a># To use the option intlimits with the amsmath package you can specify:
<a id='L1767' name='L1767'></a># EXTRA_PACKAGES=[intlimits]{amsmath}
<a id='L1768' name='L1768'></a># If left blank no extra packages will be included.
<a id='L1769' name='L1769'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1770' name='L1770'></a>
<a id='L1771' name='L1771'></a>EXTRA_PACKAGES =
<a id='L1772' name='L1772'></a>
<a id='L1773' name='L1773'></a># The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
<a id='L1774' name='L1774'></a># generated LaTeX document. The header should contain everything until the first
<a id='L1775' name='L1775'></a># chapter. If it is left blank doxygen will generate a standard header. See
<a id='L1776' name='L1776'></a># section "Doxygen usage" for information on how to let doxygen write the
<a id='L1777' name='L1777'></a># default header to a separate file.
<a id='L1778' name='L1778'></a>#
<a id='L1779' name='L1779'></a># Note: Only use a user-defined header if you know what you are doing! The
<a id='L1780' name='L1780'></a># following commands have a special meaning inside the header: $title,
<a id='L1781' name='L1781'></a># $datetime, $date, $doxygenversion, $projectname, $projectnumber,
<a id='L1782' name='L1782'></a># $projectbrief, $projectlogo. Doxygen will replace $title with the empty
<a id='L1783' name='L1783'></a># string, for the replacement values of the other commands the user is referred
<a id='L1784' name='L1784'></a># to HTML_HEADER.
<a id='L1785' name='L1785'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1786' name='L1786'></a>
<a id='L1787' name='L1787'></a>LATEX_HEADER =
<a id='L1788' name='L1788'></a>
<a id='L1789' name='L1789'></a># The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
<a id='L1790' name='L1790'></a># generated LaTeX document. The footer should contain everything after the last
<a id='L1791' name='L1791'></a># chapter. If it is left blank doxygen will generate a standard footer. See
<a id='L1792' name='L1792'></a># LATEX_HEADER for more information on how to generate a default footer and what
<a id='L1793' name='L1793'></a># special commands can be used inside the footer.
<a id='L1794' name='L1794'></a>#
<a id='L1795' name='L1795'></a># Note: Only use a user-defined footer if you know what you are doing!
<a id='L1796' name='L1796'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1797' name='L1797'></a>
<a id='L1798' name='L1798'></a>LATEX_FOOTER =
<a id='L1799' name='L1799'></a>
<a id='L1800' name='L1800'></a># The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
<a id='L1801' name='L1801'></a># LaTeX style sheets that are included after the standard style sheets created
<a id='L1802' name='L1802'></a># by doxygen. Using this option one can overrule certain style aspects. Doxygen
<a id='L1803' name='L1803'></a># will copy the style sheet files to the output directory.
<a id='L1804' name='L1804'></a># Note: The order of the extra style sheet files is of importance (e.g. the last
<a id='L1805' name='L1805'></a># style sheet in the list overrules the setting of the previous ones in the
<a id='L1806' name='L1806'></a># list).
<a id='L1807' name='L1807'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1808' name='L1808'></a>
<a id='L1809' name='L1809'></a>LATEX_EXTRA_STYLESHEET =
<a id='L1810' name='L1810'></a>
<a id='L1811' name='L1811'></a># The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
<a id='L1812' name='L1812'></a># other source files which should be copied to the LATEX_OUTPUT output
<a id='L1813' name='L1813'></a># directory. Note that the files will be copied as-is; there are no commands or
<a id='L1814' name='L1814'></a># markers available.
<a id='L1815' name='L1815'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1816' name='L1816'></a>
<a id='L1817' name='L1817'></a>LATEX_EXTRA_FILES =
<a id='L1818' name='L1818'></a>
<a id='L1819' name='L1819'></a># If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
<a id='L1820' name='L1820'></a># prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
<a id='L1821' name='L1821'></a># contain links (just like the HTML output) instead of page references. This
<a id='L1822' name='L1822'></a># makes the output suitable for online browsing using a PDF viewer.
<a id='L1823' name='L1823'></a># The default value is: YES.
<a id='L1824' name='L1824'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1825' name='L1825'></a>
<a id='L1826' name='L1826'></a>PDF_HYPERLINKS = NO
<a id='L1827' name='L1827'></a>
<a id='L1828' name='L1828'></a># If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
<a id='L1829' name='L1829'></a># specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
<a id='L1830' name='L1830'></a># files. Set this option to YES, to get a higher quality PDF documentation.
<a id='L1831' name='L1831'></a>#
<a id='L1832' name='L1832'></a># See also section LATEX_CMD_NAME for selecting the engine.
<a id='L1833' name='L1833'></a># The default value is: YES.
<a id='L1834' name='L1834'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1835' name='L1835'></a>
<a id='L1836' name='L1836'></a>USE_PDFLATEX = NO
<a id='L1837' name='L1837'></a>
<a id='L1838' name='L1838'></a># If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
<a id='L1839' name='L1839'></a># command to the generated LaTeX files. This will instruct LaTeX to keep running
<a id='L1840' name='L1840'></a># if errors occur, instead of asking the user for help. This option is also used
<a id='L1841' name='L1841'></a># when generating formulas in HTML.
<a id='L1842' name='L1842'></a># The default value is: NO.
<a id='L1843' name='L1843'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1844' name='L1844'></a>
<a id='L1845' name='L1845'></a>LATEX_BATCHMODE = YES
<a id='L1846' name='L1846'></a>
<a id='L1847' name='L1847'></a># If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
<a id='L1848' name='L1848'></a># index chapters (such as File Index, Compound Index, etc.) in the output.
<a id='L1849' name='L1849'></a># The default value is: NO.
<a id='L1850' name='L1850'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1851' name='L1851'></a>
<a id='L1852' name='L1852'></a>LATEX_HIDE_INDICES = NO
<a id='L1853' name='L1853'></a>
<a id='L1854' name='L1854'></a># If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
<a id='L1855' name='L1855'></a># code with syntax highlighting in the LaTeX output.
<a id='L1856' name='L1856'></a>#
<a id='L1857' name='L1857'></a># Note that which sources are shown also depends on other settings such as
<a id='L1858' name='L1858'></a># SOURCE_BROWSER.
<a id='L1859' name='L1859'></a># The default value is: NO.
<a id='L1860' name='L1860'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1861' name='L1861'></a>
<a id='L1862' name='L1862'></a>LATEX_SOURCE_CODE = NO
<a id='L1863' name='L1863'></a>
<a id='L1864' name='L1864'></a># The LATEX_BIB_STYLE tag can be used to specify the style to use for the
<a id='L1865' name='L1865'></a># bibliography, e.g. plainnat, or ieeetr. See
<a id='L1866' name='L1866'></a># https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
<a id='L1867' name='L1867'></a># The default value is: plain.
<a id='L1868' name='L1868'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1869' name='L1869'></a>
<a id='L1870' name='L1870'></a>LATEX_BIB_STYLE = plain
<a id='L1871' name='L1871'></a>
<a id='L1872' name='L1872'></a># If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
<a id='L1873' name='L1873'></a># page will contain the date and time when the page was generated. Setting this
<a id='L1874' name='L1874'></a># to NO can help when comparing the output of multiple runs.
<a id='L1875' name='L1875'></a># The default value is: NO.
<a id='L1876' name='L1876'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1877' name='L1877'></a>
<a id='L1878' name='L1878'></a>LATEX_TIMESTAMP = NO
<a id='L1879' name='L1879'></a>
<a id='L1880' name='L1880'></a># The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
<a id='L1881' name='L1881'></a># path from which the emoji images will be read. If a relative path is entered,
<a id='L1882' name='L1882'></a># it will be relative to the LATEX_OUTPUT directory. If left blank the
<a id='L1883' name='L1883'></a># LATEX_OUTPUT directory will be used.
<a id='L1884' name='L1884'></a># This tag requires that the tag GENERATE_LATEX is set to YES.
<a id='L1885' name='L1885'></a>
<a id='L1886' name='L1886'></a>LATEX_EMOJI_DIRECTORY =
<a id='L1887' name='L1887'></a>
<a id='L1888' name='L1888'></a>#---------------------------------------------------------------------------
<a id='L1889' name='L1889'></a># Configuration options related to the RTF output
<a id='L1890' name='L1890'></a>#---------------------------------------------------------------------------
<a id='L1891' name='L1891'></a>
<a id='L1892' name='L1892'></a># If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
<a id='L1893' name='L1893'></a># RTF output is optimized for Word 97 and may not look too pretty with other RTF
<a id='L1894' name='L1894'></a># readers/editors.
<a id='L1895' name='L1895'></a># The default value is: NO.
<a id='L1896' name='L1896'></a>
<a id='L1897' name='L1897'></a>GENERATE_RTF = NO
<a id='L1898' name='L1898'></a>
<a id='L1899' name='L1899'></a># The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
<a id='L1900' name='L1900'></a># relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
<a id='L1901' name='L1901'></a># it.
<a id='L1902' name='L1902'></a># The default directory is: rtf.
<a id='L1903' name='L1903'></a># This tag requires that the tag GENERATE_RTF is set to YES.
<a id='L1904' name='L1904'></a>
<a id='L1905' name='L1905'></a>RTF_OUTPUT = rtf
<a id='L1906' name='L1906'></a>
<a id='L1907' name='L1907'></a># If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
<a id='L1908' name='L1908'></a># documents. This may be useful for small projects and may help to save some
<a id='L1909' name='L1909'></a># trees in general.
<a id='L1910' name='L1910'></a># The default value is: NO.
<a id='L1911' name='L1911'></a># This tag requires that the tag GENERATE_RTF is set to YES.
<a id='L1912' name='L1912'></a>
<a id='L1913' name='L1913'></a>COMPACT_RTF = NO
<a id='L1914' name='L1914'></a>
<a id='L1915' name='L1915'></a># If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
<a id='L1916' name='L1916'></a># contain hyperlink fields. The RTF file will contain links (just like the HTML
<a id='L1917' name='L1917'></a># output) instead of page references. This makes the output suitable for online
<a id='L1918' name='L1918'></a># browsing using Word or some other Word compatible readers that support those
<a id='L1919' name='L1919'></a># fields.
<a id='L1920' name='L1920'></a>#
<a id='L1921' name='L1921'></a># Note: WordPad (write) and others do not support links.
<a id='L1922' name='L1922'></a># The default value is: NO.
<a id='L1923' name='L1923'></a># This tag requires that the tag GENERATE_RTF is set to YES.
<a id='L1924' name='L1924'></a>
<a id='L1925' name='L1925'></a>RTF_HYPERLINKS = NO
<a id='L1926' name='L1926'></a>
<a id='L1927' name='L1927'></a># Load stylesheet definitions from file. Syntax is similar to doxygen's
<a id='L1928' name='L1928'></a># configuration file, i.e. a series of assignments. You only have to provide
<a id='L1929' name='L1929'></a># replacements, missing definitions are set to their default value.
<a id='L1930' name='L1930'></a>#
<a id='L1931' name='L1931'></a># See also section "Doxygen usage" for information on how to generate the
<a id='L1932' name='L1932'></a># default style sheet that doxygen normally uses.
<a id='L1933' name='L1933'></a># This tag requires that the tag GENERATE_RTF is set to YES.
<a id='L1934' name='L1934'></a>
<a id='L1935' name='L1935'></a>RTF_STYLESHEET_FILE =
<a id='L1936' name='L1936'></a>
<a id='L1937' name='L1937'></a># Set optional variables used in the generation of an RTF document. Syntax is
<a id='L1938' name='L1938'></a># similar to doxygen's configuration file. A template extensions file can be
<a id='L1939' name='L1939'></a># generated using doxygen -e rtf extensionFile.
<a id='L1940' name='L1940'></a># This tag requires that the tag GENERATE_RTF is set to YES.
<a id='L1941' name='L1941'></a>
<a id='L1942' name='L1942'></a>RTF_EXTENSIONS_FILE =
<a id='L1943' name='L1943'></a>
<a id='L1944' name='L1944'></a># If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
<a id='L1945' name='L1945'></a># with syntax highlighting in the RTF output.
<a id='L1946' name='L1946'></a>#
<a id='L1947' name='L1947'></a># Note that which sources are shown also depends on other settings such as
<a id='L1948' name='L1948'></a># SOURCE_BROWSER.
<a id='L1949' name='L1949'></a># The default value is: NO.
<a id='L1950' name='L1950'></a># This tag requires that the tag GENERATE_RTF is set to YES.
<a id='L1951' name='L1951'></a>
<a id='L1952' name='L1952'></a>RTF_SOURCE_CODE = NO
<a id='L1953' name='L1953'></a>
<a id='L1954' name='L1954'></a>#---------------------------------------------------------------------------
<a id='L1955' name='L1955'></a># Configuration options related to the man page output
<a id='L1956' name='L1956'></a>#---------------------------------------------------------------------------
<a id='L1957' name='L1957'></a>
<a id='L1958' name='L1958'></a># If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
<a id='L1959' name='L1959'></a># classes and files.
<a id='L1960' name='L1960'></a># The default value is: NO.
<a id='L1961' name='L1961'></a>
<a id='L1962' name='L1962'></a>GENERATE_MAN = NO
<a id='L1963' name='L1963'></a>
<a id='L1964' name='L1964'></a># The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
<a id='L1965' name='L1965'></a># relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
<a id='L1966' name='L1966'></a># it. A directory man3 will be created inside the directory specified by
<a id='L1967' name='L1967'></a># MAN_OUTPUT.
<a id='L1968' name='L1968'></a># The default directory is: man.
<a id='L1969' name='L1969'></a># This tag requires that the tag GENERATE_MAN is set to YES.
<a id='L1970' name='L1970'></a>
<a id='L1971' name='L1971'></a>MAN_OUTPUT = man
<a id='L1972' name='L1972'></a>
<a id='L1973' name='L1973'></a># The MAN_EXTENSION tag determines the extension that is added to the generated
<a id='L1974' name='L1974'></a># man pages. In case the manual section does not start with a number, the number
<a id='L1975' name='L1975'></a># 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
<a id='L1976' name='L1976'></a># optional.
<a id='L1977' name='L1977'></a># The default value is: .3.
<a id='L1978' name='L1978'></a># This tag requires that the tag GENERATE_MAN is set to YES.
<a id='L1979' name='L1979'></a>
<a id='L1980' name='L1980'></a>MAN_EXTENSION = .3
<a id='L1981' name='L1981'></a>
<a id='L1982' name='L1982'></a># The MAN_SUBDIR tag determines the name of the directory created within
<a id='L1983' name='L1983'></a># MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
<a id='L1984' name='L1984'></a># MAN_EXTENSION with the initial . removed.
<a id='L1985' name='L1985'></a># This tag requires that the tag GENERATE_MAN is set to YES.
<a id='L1986' name='L1986'></a>
<a id='L1987' name='L1987'></a>MAN_SUBDIR =
<a id='L1988' name='L1988'></a>
<a id='L1989' name='L1989'></a># If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
<a id='L1990' name='L1990'></a># will generate one additional man file for each entity documented in the real
<a id='L1991' name='L1991'></a># man page(s). These additional files only source the real man page, but without
<a id='L1992' name='L1992'></a># them the man command would be unable to find the correct page.
<a id='L1993' name='L1993'></a># The default value is: NO.
<a id='L1994' name='L1994'></a># This tag requires that the tag GENERATE_MAN is set to YES.
<a id='L1995' name='L1995'></a>
<a id='L1996' name='L1996'></a>MAN_LINKS = NO
<a id='L1997' name='L1997'></a>
<a id='L1998' name='L1998'></a>#---------------------------------------------------------------------------
<a id='L1999' name='L1999'></a># Configuration options related to the XML output
<a id='L2000' name='L2000'></a>#---------------------------------------------------------------------------
<a id='L2001' name='L2001'></a>
<a id='L2002' name='L2002'></a># If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
<a id='L2003' name='L2003'></a># captures the structure of the code including all documentation.
<a id='L2004' name='L2004'></a># The default value is: NO.
<a id='L2005' name='L2005'></a>
<a id='L2006' name='L2006'></a>GENERATE_XML = NO
<a id='L2007' name='L2007'></a>
<a id='L2008' name='L2008'></a># The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
<a id='L2009' name='L2009'></a># relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
<a id='L2010' name='L2010'></a># it.
<a id='L2011' name='L2011'></a># The default directory is: xml.
<a id='L2012' name='L2012'></a># This tag requires that the tag GENERATE_XML is set to YES.
<a id='L2013' name='L2013'></a>
<a id='L2014' name='L2014'></a>XML_OUTPUT = xml
<a id='L2015' name='L2015'></a>
<a id='L2016' name='L2016'></a># If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
<a id='L2017' name='L2017'></a># listings (including syntax highlighting and cross-referencing information) to
<a id='L2018' name='L2018'></a># the XML output. Note that enabling this will significantly increase the size
<a id='L2019' name='L2019'></a># of the XML output.
<a id='L2020' name='L2020'></a># The default value is: YES.
<a id='L2021' name='L2021'></a># This tag requires that the tag GENERATE_XML is set to YES.
<a id='L2022' name='L2022'></a>
<a id='L2023' name='L2023'></a>XML_PROGRAMLISTING = YES
<a id='L2024' name='L2024'></a>
<a id='L2025' name='L2025'></a># If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
<a id='L2026' name='L2026'></a># namespace members in file scope as well, matching the HTML output.
<a id='L2027' name='L2027'></a># The default value is: NO.
<a id='L2028' name='L2028'></a># This tag requires that the tag GENERATE_XML is set to YES.
<a id='L2029' name='L2029'></a>
<a id='L2030' name='L2030'></a>XML_NS_MEMB_FILE_SCOPE = NO
<a id='L2031' name='L2031'></a>
<a id='L2032' name='L2032'></a>#---------------------------------------------------------------------------
<a id='L2033' name='L2033'></a># Configuration options related to the DOCBOOK output
<a id='L2034' name='L2034'></a>#---------------------------------------------------------------------------
<a id='L2035' name='L2035'></a>
<a id='L2036' name='L2036'></a># If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
<a id='L2037' name='L2037'></a># that can be used to generate PDF.
<a id='L2038' name='L2038'></a># The default value is: NO.
<a id='L2039' name='L2039'></a>
<a id='L2040' name='L2040'></a>GENERATE_DOCBOOK = NO
<a id='L2041' name='L2041'></a>
<a id='L2042' name='L2042'></a># The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
<a id='L2043' name='L2043'></a># If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
<a id='L2044' name='L2044'></a># front of it.
<a id='L2045' name='L2045'></a># The default directory is: docbook.
<a id='L2046' name='L2046'></a># This tag requires that the tag GENERATE_DOCBOOK is set to YES.
<a id='L2047' name='L2047'></a>
<a id='L2048' name='L2048'></a>DOCBOOK_OUTPUT = docbook
<a id='L2049' name='L2049'></a>
<a id='L2050' name='L2050'></a># If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
<a id='L2051' name='L2051'></a># program listings (including syntax highlighting and cross-referencing
<a id='L2052' name='L2052'></a># information) to the DOCBOOK output. Note that enabling this will significantly
<a id='L2053' name='L2053'></a># increase the size of the DOCBOOK output.
<a id='L2054' name='L2054'></a># The default value is: NO.
<a id='L2055' name='L2055'></a># This tag requires that the tag GENERATE_DOCBOOK is set to YES.
<a id='L2056' name='L2056'></a>
<a id='L2057' name='L2057'></a>DOCBOOK_PROGRAMLISTING = NO
<a id='L2058' name='L2058'></a>
<a id='L2059' name='L2059'></a>#---------------------------------------------------------------------------
<a id='L2060' name='L2060'></a># Configuration options for the AutoGen Definitions output
<a id='L2061' name='L2061'></a>#---------------------------------------------------------------------------
<a id='L2062' name='L2062'></a>
<a id='L2063' name='L2063'></a># If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
<a id='L2064' name='L2064'></a># AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
<a id='L2065' name='L2065'></a># the structure of the code including all documentation. Note that this feature
<a id='L2066' name='L2066'></a># is still experimental and incomplete at the moment.
<a id='L2067' name='L2067'></a># The default value is: NO.
<a id='L2068' name='L2068'></a>
<a id='L2069' name='L2069'></a>GENERATE_AUTOGEN_DEF = NO
<a id='L2070' name='L2070'></a>
<a id='L2071' name='L2071'></a>#---------------------------------------------------------------------------
<a id='L2072' name='L2072'></a># Configuration options related to the Perl module output
<a id='L2073' name='L2073'></a>#---------------------------------------------------------------------------
<a id='L2074' name='L2074'></a>
<a id='L2075' name='L2075'></a># If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
<a id='L2076' name='L2076'></a># file that captures the structure of the code including all documentation.
<a id='L2077' name='L2077'></a>#
<a id='L2078' name='L2078'></a># Note that this feature is still experimental and incomplete at the moment.
<a id='L2079' name='L2079'></a># The default value is: NO.
<a id='L2080' name='L2080'></a>
<a id='L2081' name='L2081'></a>GENERATE_PERLMOD = NO
<a id='L2082' name='L2082'></a>
<a id='L2083' name='L2083'></a># If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
<a id='L2084' name='L2084'></a># Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
<a id='L2085' name='L2085'></a># output from the Perl module output.
<a id='L2086' name='L2086'></a># The default value is: NO.
<a id='L2087' name='L2087'></a># This tag requires that the tag GENERATE_PERLMOD is set to YES.
<a id='L2088' name='L2088'></a>
<a id='L2089' name='L2089'></a>PERLMOD_LATEX = NO
<a id='L2090' name='L2090'></a>
<a id='L2091' name='L2091'></a># If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
<a id='L2092' name='L2092'></a># formatted so it can be parsed by a human reader. This is useful if you want to
<a id='L2093' name='L2093'></a># understand what is going on. On the other hand, if this tag is set to NO, the
<a id='L2094' name='L2094'></a># size of the Perl module output will be much smaller and Perl will parse it
<a id='L2095' name='L2095'></a># just the same.
<a id='L2096' name='L2096'></a># The default value is: YES.
<a id='L2097' name='L2097'></a># This tag requires that the tag GENERATE_PERLMOD is set to YES.
<a id='L2098' name='L2098'></a>
<a id='L2099' name='L2099'></a>PERLMOD_PRETTY = YES
<a id='L2100' name='L2100'></a>
<a id='L2101' name='L2101'></a># The names of the make variables in the generated doxyrules.make file are
<a id='L2102' name='L2102'></a># prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
<a id='L2103' name='L2103'></a># so different doxyrules.make files included by the same Makefile don't
<a id='L2104' name='L2104'></a># overwrite each other's variables.
<a id='L2105' name='L2105'></a># This tag requires that the tag GENERATE_PERLMOD is set to YES.
<a id='L2106' name='L2106'></a>
<a id='L2107' name='L2107'></a>PERLMOD_MAKEVAR_PREFIX =
<a id='L2108' name='L2108'></a>
<a id='L2109' name='L2109'></a>#---------------------------------------------------------------------------
<a id='L2110' name='L2110'></a># Configuration options related to the preprocessor
<a id='L2111' name='L2111'></a>#---------------------------------------------------------------------------
<a id='L2112' name='L2112'></a>
<a id='L2113' name='L2113'></a># If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
<a id='L2114' name='L2114'></a># C-preprocessor directives found in the sources and include files.
<a id='L2115' name='L2115'></a># The default value is: YES.
<a id='L2116' name='L2116'></a>
<a id='L2117' name='L2117'></a>ENABLE_PREPROCESSING = YES
<a id='L2118' name='L2118'></a>
<a id='L2119' name='L2119'></a># If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
<a id='L2120' name='L2120'></a># in the source code. If set to NO, only conditional compilation will be
<a id='L2121' name='L2121'></a># performed. Macro expansion can be done in a controlled way by setting
<a id='L2122' name='L2122'></a># EXPAND_ONLY_PREDEF to YES.
<a id='L2123' name='L2123'></a># The default value is: NO.
<a id='L2124' name='L2124'></a># This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
<a id='L2125' name='L2125'></a>
<a id='L2126' name='L2126'></a>MACRO_EXPANSION = NO
<a id='L2127' name='L2127'></a>
<a id='L2128' name='L2128'></a># If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
<a id='L2129' name='L2129'></a># the macro expansion is limited to the macros specified with the PREDEFINED and
<a id='L2130' name='L2130'></a># EXPAND_AS_DEFINED tags.
<a id='L2131' name='L2131'></a># The default value is: NO.
<a id='L2132' name='L2132'></a># This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
<a id='L2133' name='L2133'></a>
<a id='L2134' name='L2134'></a>EXPAND_ONLY_PREDEF = NO
<a id='L2135' name='L2135'></a>
<a id='L2136' name='L2136'></a># If the SEARCH_INCLUDES tag is set to YES, the include files in the
<a id='L2137' name='L2137'></a># INCLUDE_PATH will be searched if a #include is found.
<a id='L2138' name='L2138'></a># The default value is: YES.
<a id='L2139' name='L2139'></a># This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
<a id='L2140' name='L2140'></a>
<a id='L2141' name='L2141'></a>SEARCH_INCLUDES = YES
<a id='L2142' name='L2142'></a>
<a id='L2143' name='L2143'></a># The INCLUDE_PATH tag can be used to specify one or more directories that
<a id='L2144' name='L2144'></a># contain include files that are not input files but should be processed by the
<a id='L2145' name='L2145'></a># preprocessor.
<a id='L2146' name='L2146'></a># This tag requires that the tag SEARCH_INCLUDES is set to YES.
<a id='L2147' name='L2147'></a>
<a id='L2148' name='L2148'></a>INCLUDE_PATH =
<a id='L2149' name='L2149'></a>
<a id='L2150' name='L2150'></a># You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
<a id='L2151' name='L2151'></a># patterns (like *.h and *.hpp) to filter out the header-files in the
<a id='L2152' name='L2152'></a># directories. If left blank, the patterns specified with FILE_PATTERNS will be
<a id='L2153' name='L2153'></a># used.
<a id='L2154' name='L2154'></a># This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
<a id='L2155' name='L2155'></a>
<a id='L2156' name='L2156'></a>INCLUDE_FILE_PATTERNS =
<a id='L2157' name='L2157'></a>
<a id='L2158' name='L2158'></a># The PREDEFINED tag can be used to specify one or more macro names that are
<a id='L2159' name='L2159'></a># defined before the preprocessor is started (similar to the -D option of e.g.
<a id='L2160' name='L2160'></a># gcc). The argument of the tag is a list of macros of the form: name or
<a id='L2161' name='L2161'></a># name=definition (no spaces). If the definition and the "=" are omitted, "=1"
<a id='L2162' name='L2162'></a># is assumed. To prevent a macro definition from being undefined via #undef or
<a id='L2163' name='L2163'></a># recursively expanded use the := operator instead of the = operator.
<a id='L2164' name='L2164'></a># This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
<a id='L2165' name='L2165'></a>
<a id='L2166' name='L2166'></a>PREDEFINED =
<a id='L2167' name='L2167'></a>
<a id='L2168' name='L2168'></a># If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
<a id='L2169' name='L2169'></a># tag can be used to specify a list of macro names that should be expanded. The
<a id='L2170' name='L2170'></a># macro definition that is found in the sources will be used. Use the PREDEFINED
<a id='L2171' name='L2171'></a># tag if you want to use a different macro definition that overrules the
<a id='L2172' name='L2172'></a># definition found in the source code.
<a id='L2173' name='L2173'></a># This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
<a id='L2174' name='L2174'></a>
<a id='L2175' name='L2175'></a>EXPAND_AS_DEFINED =
<a id='L2176' name='L2176'></a>
<a id='L2177' name='L2177'></a># If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
<a id='L2178' name='L2178'></a># remove all references to function-like macros that are alone on a line, have
<a id='L2179' name='L2179'></a># an all uppercase name, and do not end with a semicolon. Such function macros
<a id='L2180' name='L2180'></a># are typically used for boiler-plate code, and will confuse the parser if not
<a id='L2181' name='L2181'></a># removed.
<a id='L2182' name='L2182'></a># The default value is: YES.
<a id='L2183' name='L2183'></a># This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
<a id='L2184' name='L2184'></a>
<a id='L2185' name='L2185'></a>SKIP_FUNCTION_MACROS = YES
<a id='L2186' name='L2186'></a>
<a id='L2187' name='L2187'></a>#---------------------------------------------------------------------------
<a id='L2188' name='L2188'></a># Configuration options related to external references
<a id='L2189' name='L2189'></a>#---------------------------------------------------------------------------
<a id='L2190' name='L2190'></a>
<a id='L2191' name='L2191'></a># The TAGFILES tag can be used to specify one or more tag files. For each tag
<a id='L2192' name='L2192'></a># file the location of the external documentation should be added. The format of
<a id='L2193' name='L2193'></a># a tag file without this location is as follows:
<a id='L2194' name='L2194'></a># TAGFILES = file1 file2 ...
<a id='L2195' name='L2195'></a># Adding location for the tag files is done as follows:
<a id='L2196' name='L2196'></a># TAGFILES = file1=loc1 "file2 = loc2" ...
<a id='L2197' name='L2197'></a># where loc1 and loc2 can be relative or absolute paths or URLs. See the
<a id='L2198' name='L2198'></a># section "Linking to external documentation" for more information about the use
<a id='L2199' name='L2199'></a># of tag files.
<a id='L2200' name='L2200'></a># Note: Each tag file must have a unique name (where the name does NOT include
<a id='L2201' name='L2201'></a># the path). If a tag file is not located in the directory in which doxygen is
<a id='L2202' name='L2202'></a># run, you must also specify the path to the tagfile here.
<a id='L2203' name='L2203'></a>
<a id='L2204' name='L2204'></a>TAGFILES =
<a id='L2205' name='L2205'></a>
<a id='L2206' name='L2206'></a># When a file name is specified after GENERATE_TAGFILE, doxygen will create a
<a id='L2207' name='L2207'></a># tag file that is based on the input files it reads. See section "Linking to
<a id='L2208' name='L2208'></a># external documentation" for more information about the usage of tag files.
<a id='L2209' name='L2209'></a>
<a id='L2210' name='L2210'></a>GENERATE_TAGFILE =
<a id='L2211' name='L2211'></a>
<a id='L2212' name='L2212'></a># If the ALLEXTERNALS tag is set to YES, all external class will be listed in
<a id='L2213' name='L2213'></a># the class index. If set to NO, only the inherited external classes will be
<a id='L2214' name='L2214'></a># listed.
<a id='L2215' name='L2215'></a># The default value is: NO.
<a id='L2216' name='L2216'></a>
<a id='L2217' name='L2217'></a>ALLEXTERNALS = NO
<a id='L2218' name='L2218'></a>
<a id='L2219' name='L2219'></a># If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
<a id='L2220' name='L2220'></a># in the modules index. If set to NO, only the current project's groups will be
<a id='L2221' name='L2221'></a># listed.
<a id='L2222' name='L2222'></a># The default value is: YES.
<a id='L2223' name='L2223'></a>
<a id='L2224' name='L2224'></a>EXTERNAL_GROUPS = YES
<a id='L2225' name='L2225'></a>
<a id='L2226' name='L2226'></a># If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
<a id='L2227' name='L2227'></a># the related pages index. If set to NO, only the current project's pages will
<a id='L2228' name='L2228'></a># be listed.
<a id='L2229' name='L2229'></a># The default value is: YES.
<a id='L2230' name='L2230'></a>
<a id='L2231' name='L2231'></a>EXTERNAL_PAGES = YES
<a id='L2232' name='L2232'></a>
<a id='L2233' name='L2233'></a>#---------------------------------------------------------------------------
<a id='L2234' name='L2234'></a># Configuration options related to the dot tool
<a id='L2235' name='L2235'></a>#---------------------------------------------------------------------------
<a id='L2236' name='L2236'></a>
<a id='L2237' name='L2237'></a># If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
<a id='L2238' name='L2238'></a># (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
<a id='L2239' name='L2239'></a># NO turns the diagrams off. Note that this option also works with HAVE_DOT
<a id='L2240' name='L2240'></a># disabled, but it is recommended to install and use dot, since it yields more
<a id='L2241' name='L2241'></a># powerful graphs.
<a id='L2242' name='L2242'></a># The default value is: YES.
<a id='L2243' name='L2243'></a>
<a id='L2244' name='L2244'></a>CLASS_DIAGRAMS = YES
<a id='L2245' name='L2245'></a>
<a id='L2246' name='L2246'></a># You can include diagrams made with dia in doxygen documentation. Doxygen will
<a id='L2247' name='L2247'></a># then run dia to produce the diagram and insert it in the documentation. The
<a id='L2248' name='L2248'></a># DIA_PATH tag allows you to specify the directory where the dia binary resides.
<a id='L2249' name='L2249'></a># If left empty dia is assumed to be found in the default search path.
<a id='L2250' name='L2250'></a>
<a id='L2251' name='L2251'></a>DIA_PATH =
<a id='L2252' name='L2252'></a>
<a id='L2253' name='L2253'></a># If set to YES the inheritance and collaboration graphs will hide inheritance
<a id='L2254' name='L2254'></a># and usage relations if the target is undocumented or is not a class.
<a id='L2255' name='L2255'></a># The default value is: YES.
<a id='L2256' name='L2256'></a>
<a id='L2257' name='L2257'></a>HIDE_UNDOC_RELATIONS = YES
<a id='L2258' name='L2258'></a>
<a id='L2259' name='L2259'></a># If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
<a id='L2260' name='L2260'></a># available from the path. This tool is part of Graphviz (see:
<a id='L2261' name='L2261'></a># http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
<a id='L2262' name='L2262'></a># Bell Labs. The other options in this section have no effect if this option is
<a id='L2263' name='L2263'></a># set to NO
<a id='L2264' name='L2264'></a># The default value is: NO.
<a id='L2265' name='L2265'></a>
<a id='L2266' name='L2266'></a>HAVE_DOT = YES
<a id='L2267' name='L2267'></a>
<a id='L2268' name='L2268'></a># The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
<a id='L2269' name='L2269'></a># to run in parallel. When set to 0 doxygen will base this on the number of
<a id='L2270' name='L2270'></a># processors available in the system. You can set it explicitly to a value
<a id='L2271' name='L2271'></a># larger than 0 to get control over the balance between CPU load and processing
<a id='L2272' name='L2272'></a># speed.
<a id='L2273' name='L2273'></a># Minimum value: 0, maximum value: 32, default value: 0.
<a id='L2274' name='L2274'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2275' name='L2275'></a>
<a id='L2276' name='L2276'></a>DOT_NUM_THREADS = 0
<a id='L2277' name='L2277'></a>
<a id='L2278' name='L2278'></a># When you want a differently looking font in the dot files that doxygen
<a id='L2279' name='L2279'></a># generates you can specify the font name using DOT_FONTNAME. You need to make
<a id='L2280' name='L2280'></a># sure dot is able to find the font, which can be done by putting it in a
<a id='L2281' name='L2281'></a># standard location or by setting the DOTFONTPATH environment variable or by
<a id='L2282' name='L2282'></a># setting DOT_FONTPATH to the directory containing the font.
<a id='L2283' name='L2283'></a># The default value is: Helvetica.
<a id='L2284' name='L2284'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2285' name='L2285'></a>
<a id='L2286' name='L2286'></a>DOT_FONTNAME = Helvetica
<a id='L2287' name='L2287'></a>
<a id='L2288' name='L2288'></a># The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
<a id='L2289' name='L2289'></a># dot graphs.
<a id='L2290' name='L2290'></a># Minimum value: 4, maximum value: 24, default value: 10.
<a id='L2291' name='L2291'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2292' name='L2292'></a>
<a id='L2293' name='L2293'></a>DOT_FONTSIZE = 10
<a id='L2294' name='L2294'></a>
<a id='L2295' name='L2295'></a># By default doxygen will tell dot to use the default font as specified with
<a id='L2296' name='L2296'></a># DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
<a id='L2297' name='L2297'></a># the path where dot can find it using this tag.
<a id='L2298' name='L2298'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2299' name='L2299'></a>
<a id='L2300' name='L2300'></a>DOT_FONTPATH = fontconfig
<a id='L2301' name='L2301'></a>
<a id='L2302' name='L2302'></a># If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
<a id='L2303' name='L2303'></a># each documented class showing the direct and indirect inheritance relations.
<a id='L2304' name='L2304'></a># Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
<a id='L2305' name='L2305'></a># The default value is: YES.
<a id='L2306' name='L2306'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2307' name='L2307'></a>
<a id='L2308' name='L2308'></a>CLASS_GRAPH = YES
<a id='L2309' name='L2309'></a>
<a id='L2310' name='L2310'></a># If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
<a id='L2311' name='L2311'></a># graph for each documented class showing the direct and indirect implementation
<a id='L2312' name='L2312'></a># dependencies (inheritance, containment, and class references variables) of the
<a id='L2313' name='L2313'></a># class with other documented classes.
<a id='L2314' name='L2314'></a># The default value is: YES.
<a id='L2315' name='L2315'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2316' name='L2316'></a>
<a id='L2317' name='L2317'></a>COLLABORATION_GRAPH = YES
<a id='L2318' name='L2318'></a>
<a id='L2319' name='L2319'></a># If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
<a id='L2320' name='L2320'></a># groups, showing the direct groups dependencies.
<a id='L2321' name='L2321'></a># The default value is: YES.
<a id='L2322' name='L2322'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2323' name='L2323'></a>
<a id='L2324' name='L2324'></a>GROUP_GRAPHS = YES
<a id='L2325' name='L2325'></a>
<a id='L2326' name='L2326'></a># If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
<a id='L2327' name='L2327'></a># collaboration diagrams in a style similar to the OMG's Unified Modeling
<a id='L2328' name='L2328'></a># Language.
<a id='L2329' name='L2329'></a># The default value is: NO.
<a id='L2330' name='L2330'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2331' name='L2331'></a>
<a id='L2332' name='L2332'></a>UML_LOOK = YES
<a id='L2333' name='L2333'></a>
<a id='L2334' name='L2334'></a># If the UML_LOOK tag is enabled, the fields and methods are shown inside the
<a id='L2335' name='L2335'></a># class node. If there are many fields or methods and many nodes the graph may
<a id='L2336' name='L2336'></a># become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
<a id='L2337' name='L2337'></a># number of items for each type to make the size more manageable. Set this to 0
<a id='L2338' name='L2338'></a># for no limit. Note that the threshold may be exceeded by 50% before the limit
<a id='L2339' name='L2339'></a># is enforced. So when you set the threshold to 10, up to 15 fields may appear,
<a id='L2340' name='L2340'></a># but if the number exceeds 15, the total amount of fields shown is limited to
<a id='L2341' name='L2341'></a># 10.
<a id='L2342' name='L2342'></a># Minimum value: 0, maximum value: 100, default value: 10.
<a id='L2343' name='L2343'></a># This tag requires that the tag UML_LOOK is set to YES.
<a id='L2344' name='L2344'></a>
<a id='L2345' name='L2345'></a>UML_LIMIT_NUM_FIELDS = 10
<a id='L2346' name='L2346'></a>
<a id='L2347' name='L2347'></a># If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
<a id='L2348' name='L2348'></a># methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
<a id='L2349' name='L2349'></a># tag is set to YES, doxygen will add type and arguments for attributes and
<a id='L2350' name='L2350'></a># methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
<a id='L2351' name='L2351'></a># will not generate fields with class member information in the UML graphs. The
<a id='L2352' name='L2352'></a># class diagrams will look similar to the default class diagrams but using UML
<a id='L2353' name='L2353'></a># notation for the relationships.
<a id='L2354' name='L2354'></a># Possible values are: NO, YES and NONE.
<a id='L2355' name='L2355'></a># The default value is: NO.
<a id='L2356' name='L2356'></a># This tag requires that the tag UML_LOOK is set to YES.
<a id='L2357' name='L2357'></a>
<a id='L2358' name='L2358'></a>DOT_UML_DETAILS = NO
<a id='L2359' name='L2359'></a>
<a id='L2360' name='L2360'></a># The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
<a id='L2361' name='L2361'></a># to display on a single line. If the actual line length exceeds this threshold
<a id='L2362' name='L2362'></a># significantly it will wrapped across multiple lines. Some heuristics are apply
<a id='L2363' name='L2363'></a># to avoid ugly line breaks.
<a id='L2364' name='L2364'></a># Minimum value: 0, maximum value: 1000, default value: 17.
<a id='L2365' name='L2365'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2366' name='L2366'></a>
<a id='L2367' name='L2367'></a>DOT_WRAP_THRESHOLD = 17
<a id='L2368' name='L2368'></a>
<a id='L2369' name='L2369'></a># If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
<a id='L2370' name='L2370'></a># collaboration graphs will show the relations between templates and their
<a id='L2371' name='L2371'></a># instances.
<a id='L2372' name='L2372'></a># The default value is: NO.
<a id='L2373' name='L2373'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2374' name='L2374'></a>
<a id='L2375' name='L2375'></a>TEMPLATE_RELATIONS = NO
<a id='L2376' name='L2376'></a>
<a id='L2377' name='L2377'></a># If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
<a id='L2378' name='L2378'></a># YES then doxygen will generate a graph for each documented file showing the
<a id='L2379' name='L2379'></a># direct and indirect include dependencies of the file with other documented
<a id='L2380' name='L2380'></a># files.
<a id='L2381' name='L2381'></a># The default value is: YES.
<a id='L2382' name='L2382'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2383' name='L2383'></a>
<a id='L2384' name='L2384'></a>INCLUDE_GRAPH = YES
<a id='L2385' name='L2385'></a>
<a id='L2386' name='L2386'></a># If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
<a id='L2387' name='L2387'></a># set to YES then doxygen will generate a graph for each documented file showing
<a id='L2388' name='L2388'></a># the direct and indirect include dependencies of the file with other documented
<a id='L2389' name='L2389'></a># files.
<a id='L2390' name='L2390'></a># The default value is: YES.
<a id='L2391' name='L2391'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2392' name='L2392'></a>
<a id='L2393' name='L2393'></a>INCLUDED_BY_GRAPH = YES
<a id='L2394' name='L2394'></a>
<a id='L2395' name='L2395'></a># If the CALL_GRAPH tag is set to YES then doxygen will generate a call
<a id='L2396' name='L2396'></a># dependency graph for every global function or class method.
<a id='L2397' name='L2397'></a>#
<a id='L2398' name='L2398'></a># Note that enabling this option will significantly increase the time of a run.
<a id='L2399' name='L2399'></a># So in most cases it will be better to enable call graphs for selected
<a id='L2400' name='L2400'></a># functions only using the \callgraph command. Disabling a call graph can be
<a id='L2401' name='L2401'></a># accomplished by means of the command \hidecallgraph.
<a id='L2402' name='L2402'></a># The default value is: NO.
<a id='L2403' name='L2403'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2404' name='L2404'></a>
<a id='L2405' name='L2405'></a>CALL_GRAPH = YES
<a id='L2406' name='L2406'></a>
<a id='L2407' name='L2407'></a># If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
<a id='L2408' name='L2408'></a># dependency graph for every global function or class method.
<a id='L2409' name='L2409'></a>#
<a id='L2410' name='L2410'></a># Note that enabling this option will significantly increase the time of a run.
<a id='L2411' name='L2411'></a># So in most cases it will be better to enable caller graphs for selected
<a id='L2412' name='L2412'></a># functions only using the \callergraph command. Disabling a caller graph can be
<a id='L2413' name='L2413'></a># accomplished by means of the command \hidecallergraph.
<a id='L2414' name='L2414'></a># The default value is: NO.
<a id='L2415' name='L2415'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2416' name='L2416'></a>
<a id='L2417' name='L2417'></a>CALLER_GRAPH = YES
<a id='L2418' name='L2418'></a>
<a id='L2419' name='L2419'></a># If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
<a id='L2420' name='L2420'></a># hierarchy of all classes instead of a textual one.
<a id='L2421' name='L2421'></a># The default value is: YES.
<a id='L2422' name='L2422'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2423' name='L2423'></a>
<a id='L2424' name='L2424'></a>GRAPHICAL_HIERARCHY = YES
<a id='L2425' name='L2425'></a>
<a id='L2426' name='L2426'></a># If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
<a id='L2427' name='L2427'></a># dependencies a directory has on other directories in a graphical way. The
<a id='L2428' name='L2428'></a># dependency relations are determined by the #include relations between the
<a id='L2429' name='L2429'></a># files in the directories.
<a id='L2430' name='L2430'></a># The default value is: YES.
<a id='L2431' name='L2431'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2432' name='L2432'></a>
<a id='L2433' name='L2433'></a>DIRECTORY_GRAPH = YES
<a id='L2434' name='L2434'></a>
<a id='L2435' name='L2435'></a># The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
<a id='L2436' name='L2436'></a># generated by dot. For an explanation of the image formats see the section
<a id='L2437' name='L2437'></a># output formats in the documentation of the dot tool (Graphviz (see:
<a id='L2438' name='L2438'></a># http://www.graphviz.org/)).
<a id='L2439' name='L2439'></a># Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
<a id='L2440' name='L2440'></a># to make the SVG files visible in IE 9+ (other browsers do not have this
<a id='L2441' name='L2441'></a># requirement).
<a id='L2442' name='L2442'></a># Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
<a id='L2443' name='L2443'></a># png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
<a id='L2444' name='L2444'></a># png:gdiplus:gdiplus.
<a id='L2445' name='L2445'></a># The default value is: png.
<a id='L2446' name='L2446'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2447' name='L2447'></a>
<a id='L2448' name='L2448'></a>DOT_IMAGE_FORMAT = svg
<a id='L2449' name='L2449'></a>
<a id='L2450' name='L2450'></a># If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
<a id='L2451' name='L2451'></a># enable generation of interactive SVG images that allow zooming and panning.
<a id='L2452' name='L2452'></a>#
<a id='L2453' name='L2453'></a># Note that this requires a modern browser other than Internet Explorer. Tested
<a id='L2454' name='L2454'></a># and working are Firefox, Chrome, Safari, and Opera.
<a id='L2455' name='L2455'></a># Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
<a id='L2456' name='L2456'></a># the SVG files visible. Older versions of IE do not have SVG support.
<a id='L2457' name='L2457'></a># The default value is: NO.
<a id='L2458' name='L2458'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2459' name='L2459'></a>
<a id='L2460' name='L2460'></a>INTERACTIVE_SVG = YES
<a id='L2461' name='L2461'></a>
<a id='L2462' name='L2462'></a># The DOT_PATH tag can be used to specify the path where the dot tool can be
<a id='L2463' name='L2463'></a># found. If left blank, it is assumed the dot tool can be found in the path.
<a id='L2464' name='L2464'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2465' name='L2465'></a>
<a id='L2466' name='L2466'></a>DOT_PATH =
<a id='L2467' name='L2467'></a>
<a id='L2468' name='L2468'></a># The DOTFILE_DIRS tag can be used to specify one or more directories that
<a id='L2469' name='L2469'></a># contain dot files that are included in the documentation (see the \dotfile
<a id='L2470' name='L2470'></a># command).
<a id='L2471' name='L2471'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2472' name='L2472'></a>
<a id='L2473' name='L2473'></a>DOTFILE_DIRS =
<a id='L2474' name='L2474'></a>
<a id='L2475' name='L2475'></a># The MSCFILE_DIRS tag can be used to specify one or more directories that
<a id='L2476' name='L2476'></a># contain msc files that are included in the documentation (see the \mscfile
<a id='L2477' name='L2477'></a># command).
<a id='L2478' name='L2478'></a>
<a id='L2479' name='L2479'></a>MSCFILE_DIRS =
<a id='L2480' name='L2480'></a>
<a id='L2481' name='L2481'></a># The DIAFILE_DIRS tag can be used to specify one or more directories that
<a id='L2482' name='L2482'></a># contain dia files that are included in the documentation (see the \diafile
<a id='L2483' name='L2483'></a># command).
<a id='L2484' name='L2484'></a>
<a id='L2485' name='L2485'></a>DIAFILE_DIRS =
<a id='L2486' name='L2486'></a>
<a id='L2487' name='L2487'></a># When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
<a id='L2488' name='L2488'></a># path where java can find the plantuml.jar file. If left blank, it is assumed
<a id='L2489' name='L2489'></a># PlantUML is not used or called during a preprocessing step. Doxygen will
<a id='L2490' name='L2490'></a># generate a warning when it encounters a \startuml command in this case and
<a id='L2491' name='L2491'></a># will not generate output for the diagram.
<a id='L2492' name='L2492'></a>
<a id='L2493' name='L2493'></a>PLANTUML_JAR_PATH =
<a id='L2494' name='L2494'></a>
<a id='L2495' name='L2495'></a># When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
<a id='L2496' name='L2496'></a># configuration file for plantuml.
<a id='L2497' name='L2497'></a>
<a id='L2498' name='L2498'></a>PLANTUML_CFG_FILE =
<a id='L2499' name='L2499'></a>
<a id='L2500' name='L2500'></a># When using plantuml, the specified paths are searched for files specified by
<a id='L2501' name='L2501'></a># the !include statement in a plantuml block.
<a id='L2502' name='L2502'></a>
<a id='L2503' name='L2503'></a>PLANTUML_INCLUDE_PATH =
<a id='L2504' name='L2504'></a>
<a id='L2505' name='L2505'></a># The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
<a id='L2506' name='L2506'></a># that will be shown in the graph. If the number of nodes in a graph becomes
<a id='L2507' name='L2507'></a># larger than this value, doxygen will truncate the graph, which is visualized
<a id='L2508' name='L2508'></a># by representing a node as a red box. Note that doxygen if the number of direct
<a id='L2509' name='L2509'></a># children of the root node in a graph is already larger than
<a id='L2510' name='L2510'></a># DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
<a id='L2511' name='L2511'></a># the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
<a id='L2512' name='L2512'></a># Minimum value: 0, maximum value: 10000, default value: 50.
<a id='L2513' name='L2513'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2514' name='L2514'></a>
<a id='L2515' name='L2515'></a>DOT_GRAPH_MAX_NODES = 50
<a id='L2516' name='L2516'></a>
<a id='L2517' name='L2517'></a># The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
<a id='L2518' name='L2518'></a># generated by dot. A depth value of 3 means that only nodes reachable from the
<a id='L2519' name='L2519'></a># root by following a path via at most 3 edges will be shown. Nodes that lay
<a id='L2520' name='L2520'></a># further from the root node will be omitted. Note that setting this option to 1
<a id='L2521' name='L2521'></a># or 2 may greatly reduce the computation time needed for large code bases. Also
<a id='L2522' name='L2522'></a># note that the size of a graph can be further restricted by
<a id='L2523' name='L2523'></a># DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
<a id='L2524' name='L2524'></a># Minimum value: 0, maximum value: 1000, default value: 0.
<a id='L2525' name='L2525'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2526' name='L2526'></a>
<a id='L2527' name='L2527'></a>MAX_DOT_GRAPH_DEPTH = 0
<a id='L2528' name='L2528'></a>
<a id='L2529' name='L2529'></a># Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
<a id='L2530' name='L2530'></a># background. This is disabled by default, because dot on Windows does not seem
<a id='L2531' name='L2531'></a># to support this out of the box.
<a id='L2532' name='L2532'></a>#
<a id='L2533' name='L2533'></a># Warning: Depending on the platform used, enabling this option may lead to
<a id='L2534' name='L2534'></a># badly anti-aliased labels on the edges of a graph (i.e. they become hard to
<a id='L2535' name='L2535'></a># read).
<a id='L2536' name='L2536'></a># The default value is: NO.
<a id='L2537' name='L2537'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2538' name='L2538'></a>
<a id='L2539' name='L2539'></a>DOT_TRANSPARENT = YES
<a id='L2540' name='L2540'></a>
<a id='L2541' name='L2541'></a># Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
<a id='L2542' name='L2542'></a># files in one run (i.e. multiple -o and -T options on the command line). This
<a id='L2543' name='L2543'></a># makes dot run faster, but since only newer versions of dot (>1.8.10) support
<a id='L2544' name='L2544'></a># this, this feature is disabled by default.
<a id='L2545' name='L2545'></a># The default value is: NO.
<a id='L2546' name='L2546'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2547' name='L2547'></a>
<a id='L2548' name='L2548'></a>DOT_MULTI_TARGETS = YES
<a id='L2549' name='L2549'></a>
<a id='L2550' name='L2550'></a># If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
<a id='L2551' name='L2551'></a># explaining the meaning of the various boxes and arrows in the dot generated
<a id='L2552' name='L2552'></a># graphs.
<a id='L2553' name='L2553'></a># The default value is: YES.
<a id='L2554' name='L2554'></a># This tag requires that the tag HAVE_DOT is set to YES.
<a id='L2555' name='L2555'></a>
<a id='L2556' name='L2556'></a>GENERATE_LEGEND = YES
<a id='L2557' name='L2557'></a>
<a id='L2558' name='L2558'></a># If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
<a id='L2559' name='L2559'></a># files that are used to generate the various graphs.
<a id='L2560' name='L2560'></a>#
<a id='L2561' name='L2561'></a># Note: This setting is not only used for dot files but also for msc and
<a id='L2562' name='L2562'></a># plantuml temporary files.
<a id='L2563' name='L2563'></a># The default value is: YES.
<a id='L2564' name='L2564'></a>
<a id='L2565' name='L2565'></a>DOT_CLEANUP = YES
</pre>
<hr />
<a id='BOTTOM' name='BOTTOM'></a>
<em class='comment'>/* [<][>][^][v]<a href='#TOP'>[top]</a>[bottom]<a href='../mains.html'>[index]</a><a href='../help.html'>[help]</a> */</em>
</body>
</html>