2414 lines
224 KiB
HTML
2414 lines
224 KiB
HTML
<!DOCTYPE html>
|
|
<html><head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
<title>Doxyfile.example</title>
|
|
<meta name="generator" content="KF5::SyntaxHighlighting - Definition (Doxyfile) - Theme (Breeze Light)"/>
|
|
</head><body style="background-color:#ffffff;color:#1f1c1b"><pre>
|
|
<span style="color:#898887"># Doxyfile 1.8.11</span>
|
|
|
|
<span style="color:#898887"># This file describes the settings to be used by the documentation system</span>
|
|
<span style="color:#898887"># doxygen (www.doxygen.org) for a project.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># All text after a double hash (##) is considered a comment and is placed in</span>
|
|
<span style="color:#898887"># front of the TAG it is preceding.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># All text after a single hash (#) is considered a comment and will be ignored.</span>
|
|
<span style="color:#898887"># The format is:</span>
|
|
<span style="color:#898887"># TAG = value [value, ...]</span>
|
|
<span style="color:#898887"># For lists, items can also be appended using:</span>
|
|
<span style="color:#898887"># TAG += value [value, ...]</span>
|
|
<span style="color:#898887"># Values that contain spaces should be placed between quotes (\" \").</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Project related configuration options</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># This tag specifies the encoding used for all characters in the config file</span>
|
|
<span style="color:#898887"># that follow. The default is UTF-8 which is also the encoding used for all text</span>
|
|
<span style="color:#898887"># before the first occurrence of this tag. Doxygen uses libiconv (or the iconv</span>
|
|
<span style="color:#898887"># built into libc) for the transcoding. See http://www.gnu.org/software/libiconv</span>
|
|
<span style="color:#898887"># for the list of possible encodings.</span>
|
|
<span style="color:#898887"># The default value is: UTF-8.</span>
|
|
|
|
<span style="font-weight:bold">DOXYFILE_ENCODING</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> UTF-8</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">PROJECT_NAME</span><span style="color:#898887"> tag is a single word (or a sequence of words surrounded by</span>
|
|
<span style="color:#898887"># double-quotes, unless you are using Doxywizard) that should identify the</span>
|
|
<span style="color:#898887"># project for which the documentation is generated. This name is used in the</span>
|
|
<span style="color:#898887"># title of most generated pages and in a few other places.</span>
|
|
<span style="color:#898887"># The default value is: My Project.</span>
|
|
|
|
<span style="font-weight:bold">PROJECT_NAME</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> "My Project"</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">PROJECT_NUMBER</span><span style="color:#898887"> tag can be used to enter a project or revision number. This</span>
|
|
<span style="color:#898887"># could be handy for archiving the generated documentation or if some version</span>
|
|
<span style="color:#898887"># control system is used.</span>
|
|
|
|
<span style="font-weight:bold">PROJECT_NUMBER</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># Using the </span><span style="color:#0095ff">PROJECT_BRIEF</span><span style="color:#898887"> tag one can provide an optional one line description</span>
|
|
<span style="color:#898887"># for a project that appears at the top of each page and should give viewer a</span>
|
|
<span style="color:#898887"># quick idea about the purpose of the project. Keep the description short.</span>
|
|
|
|
<span style="font-weight:bold">PROJECT_BRIEF</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># With the </span><span style="color:#0095ff">PROJECT_LOGO</span><span style="color:#898887"> tag one can specify a logo or an icon that is included</span>
|
|
<span style="color:#898887"># in the documentation. The maximum height of the logo should not exceed 55</span>
|
|
<span style="color:#898887"># pixels and the maximum width should not exceed 200 pixels. Doxygen will copy</span>
|
|
<span style="color:#898887"># the logo to the output directory.</span>
|
|
|
|
<span style="font-weight:bold">PROJECT_LOGO</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">OUTPUT_DIRECTORY</span><span style="color:#898887"> tag is used to specify the (relative or absolute) path</span>
|
|
<span style="color:#898887"># into which the generated documentation will be written. If a relative path is</span>
|
|
<span style="color:#898887"># entered, it will be relative to the location where doxygen was started. If</span>
|
|
<span style="color:#898887"># left blank the current directory will be used.</span>
|
|
|
|
<span style="font-weight:bold">OUTPUT_DIRECTORY</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">CREATE_SUBDIRS</span><span style="color:#898887"> tag is set to YES then doxygen will create 4096 sub-</span>
|
|
<span style="color:#898887"># directories (in 2 levels) under the output directory of each output format and</span>
|
|
<span style="color:#898887"># will distribute the generated files over these directories. Enabling this</span>
|
|
<span style="color:#898887"># option can be useful when feeding doxygen a huge amount of source files, where</span>
|
|
<span style="color:#898887"># putting all generated files in the same directory would otherwise causes</span>
|
|
<span style="color:#898887"># performance problems for the file system.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">CREATE_SUBDIRS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">ALLOW_UNICODE_NAMES</span><span style="color:#898887"> tag is set to YES, doxygen will allow non-ASCII</span>
|
|
<span style="color:#898887"># characters to appear in the names of generated files. If set to NO, non-ASCII</span>
|
|
<span style="color:#898887"># characters will be escaped, for example _xE3_x81_x84 will be used for Unicode</span>
|
|
<span style="color:#898887"># U+3044.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">ALLOW_UNICODE_NAMES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">OUTPUT_LANGUAGE</span><span style="color:#898887"> tag is used to specify the language in which all</span>
|
|
<span style="color:#898887"># documentation generated by doxygen is written. Doxygen will use this</span>
|
|
<span style="color:#898887"># information to generate all constant output in the proper language.</span>
|
|
<span style="color:#898887"># Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,</span>
|
|
<span style="color:#898887"># Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),</span>
|
|
<span style="color:#898887"># Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,</span>
|
|
<span style="color:#898887"># Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),</span>
|
|
<span style="color:#898887"># Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,</span>
|
|
<span style="color:#898887"># Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,</span>
|
|
<span style="color:#898887"># Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,</span>
|
|
<span style="color:#898887"># Ukrainian and Vietnamese.</span>
|
|
<span style="color:#898887"># The default value is: English.</span>
|
|
|
|
<span style="font-weight:bold">OUTPUT_LANGUAGE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> English</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">BRIEF_MEMBER_DESC</span><span style="color:#898887"> tag is set to YES, doxygen will include brief member</span>
|
|
<span style="color:#898887"># descriptions after the members that are listed in the file and class</span>
|
|
<span style="color:#898887"># documentation (similar to Javadoc). Set to NO to disable this.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">BRIEF_MEMBER_DESC</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">REPEAT_BRIEF</span><span style="color:#898887"> tag is set to YES, doxygen will prepend the brief</span>
|
|
<span style="color:#898887"># description of a member or function before the detailed description</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note: If both </span><span style="color:#0095ff">HIDE_UNDOC_MEMBERS</span><span style="color:#898887"> and </span><span style="color:#0095ff">BRIEF_MEMBER_DESC</span><span style="color:#898887"> are set to NO, the</span>
|
|
<span style="color:#898887"># brief descriptions will be completely suppressed.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">REPEAT_BRIEF</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># This tag implements a quasi-intelligent brief description abbreviator that is</span>
|
|
<span style="color:#898887"># used to form the text in various listings. Each string in this list, if found</span>
|
|
<span style="color:#898887"># as the leading text of the brief description, will be stripped from the text</span>
|
|
<span style="color:#898887"># and the result, after processing the whole list, is used as the annotated</span>
|
|
<span style="color:#898887"># text. Otherwise, the brief description is used as-is. If left blank, the</span>
|
|
<span style="color:#898887"># following values are used ($name is automatically replaced with the name of</span>
|
|
<span style="color:#898887"># the entity):The $name class, The $name widget, The $name file, is, provides,</span>
|
|
<span style="color:#898887"># specifies, contains, represents, a, an and the.</span>
|
|
|
|
<span style="font-weight:bold">ABBREVIATE_BRIEF</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">ALWAYS_DETAILED_SEC</span><span style="color:#898887"> and </span><span style="color:#0095ff">REPEAT_BRIEF</span><span style="color:#898887"> tags are both set to YES then</span>
|
|
<span style="color:#898887"># doxygen will generate a detailed section even if there is only a brief</span>
|
|
<span style="color:#898887"># description.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">ALWAYS_DETAILED_SEC</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">INLINE_INHERITED_MEMB</span><span style="color:#898887"> tag is set to YES, doxygen will show all</span>
|
|
<span style="color:#898887"># inherited members of a class in the documentation of that class as if those</span>
|
|
<span style="color:#898887"># members were ordinary class members. Constructors, destructors and assignment</span>
|
|
<span style="color:#898887"># operators of the base classes will not be shown.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">INLINE_INHERITED_MEMB</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">FULL_PATH_NAMES</span><span style="color:#898887"> tag is set to YES, doxygen will prepend the full path</span>
|
|
<span style="color:#898887"># before files name in the file list and in the header files. If set to NO the</span>
|
|
<span style="color:#898887"># shortest path that makes the file name unique will be used</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">FULL_PATH_NAMES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">STRIP_FROM_PATH</span><span style="color:#898887"> tag can be used to strip a user-defined part of the path.</span>
|
|
<span style="color:#898887"># Stripping is only done if one of the specified strings matches the left-hand</span>
|
|
<span style="color:#898887"># part of the path. The tag can be used to show relative paths in the file list.</span>
|
|
<span style="color:#898887"># If left blank the directory from which doxygen is run is used as the path to</span>
|
|
<span style="color:#898887"># strip.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that you can specify absolute paths here, but also relative paths, which</span>
|
|
<span style="color:#898887"># will be relative from the directory where doxygen is started.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">FULL_PATH_NAMES</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">STRIP_FROM_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">STRIP_FROM_INC_PATH</span><span style="color:#898887"> tag can be used to strip a user-defined part of the</span>
|
|
<span style="color:#898887"># path mentioned in the documentation of a class, which tells the reader which</span>
|
|
<span style="color:#898887"># header file to include in order to use a class. If left blank only the name of</span>
|
|
<span style="color:#898887"># the header file containing the class definition is used. Otherwise one should</span>
|
|
<span style="color:#898887"># specify the list of include paths that are normally passed to the compiler</span>
|
|
<span style="color:#898887"># using the -I flag.</span>
|
|
|
|
<span style="font-weight:bold">STRIP_FROM_INC_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SHORT_NAMES</span><span style="color:#898887"> tag is set to YES, doxygen will generate much shorter (but</span>
|
|
<span style="color:#898887"># less readable) file names. This can be useful is your file systems doesn't</span>
|
|
<span style="color:#898887"># support long names like on DOS, Mac, or CD-ROM.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">SHORT_NAMES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">JAVADOC_AUTOBRIEF</span><span style="color:#898887"> tag is set to YES then doxygen will interpret the</span>
|
|
<span style="color:#898887"># first line (until the first dot) of a Javadoc-style comment as the brief</span>
|
|
<span style="color:#898887"># description. If set to NO, the Javadoc-style will behave just like regular Qt-</span>
|
|
<span style="color:#898887"># style comments (thus requiring an explicit @brief command for a brief</span>
|
|
<span style="color:#898887"># description.)</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">JAVADOC_AUTOBRIEF</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">QT_AUTOBRIEF</span><span style="color:#898887"> tag is set to YES then doxygen will interpret the first</span>
|
|
<span style="color:#898887"># line (until the first dot) of a Qt-style comment as the brief description. If</span>
|
|
<span style="color:#898887"># set to NO, the Qt-style will behave just like regular Qt-style comments (thus</span>
|
|
<span style="color:#898887"># requiring an explicit \brief command for a brief description.)</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">QT_AUTOBRIEF</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MULTILINE_CPP_IS_BRIEF</span><span style="color:#898887"> tag can be set to YES to make doxygen treat a</span>
|
|
<span style="color:#898887"># multi-line C++ special comment block (i.e. a block of //! or /// comments) as</span>
|
|
<span style="color:#898887"># a brief description. This used to be the default behavior. The new default is</span>
|
|
<span style="color:#898887"># to treat a multi-line C++ comment block as a detailed description. Set this</span>
|
|
<span style="color:#898887"># tag to YES if you prefer the old behavior instead.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that setting this tag to YES also means that rational rose comments are</span>
|
|
<span style="color:#898887"># not recognized any more.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">MULTILINE_CPP_IS_BRIEF</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">INHERIT_DOCS</span><span style="color:#898887"> tag is set to YES then an undocumented member inherits the</span>
|
|
<span style="color:#898887"># documentation from any documented member that it re-implements.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">INHERIT_DOCS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SEPARATE_MEMBER_PAGES</span><span style="color:#898887"> tag is set to YES then doxygen will produce a new</span>
|
|
<span style="color:#898887"># page for each member. If set to NO, the documentation of a member will be part</span>
|
|
<span style="color:#898887"># of the file/class/namespace that contains it.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">SEPARATE_MEMBER_PAGES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">TAB_SIZE</span><span style="color:#898887"> tag can be used to set the number of spaces in a tab. Doxygen</span>
|
|
<span style="color:#898887"># uses this value to replace tabs by spaces in code fragments.</span>
|
|
<span style="color:#898887"># Minimum value: 1, maximum value: 16, default value: 4.</span>
|
|
|
|
<span style="font-weight:bold">TAB_SIZE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 4</span>
|
|
|
|
<span style="color:#898887"># This tag can be used to specify a number of </span><span style="color:#0095ff">aliases</span><span style="color:#898887"> that act as commands in</span>
|
|
<span style="color:#898887"># the documentation. An alias has the form:</span>
|
|
<span style="color:#898887"># name=value</span>
|
|
<span style="color:#898887"># For example adding</span>
|
|
<span style="color:#898887"># "sideeffect=@par Side Effects:\n"</span>
|
|
<span style="color:#898887"># will allow you to put the command \sideeffect (or @sideeffect) in the</span>
|
|
<span style="color:#898887"># documentation, which will result in a user-defined paragraph with heading</span>
|
|
<span style="color:#898887"># "Side Effects:". You can put \n's in the value part of an alias to insert</span>
|
|
<span style="color:#898887"># newlines.</span>
|
|
|
|
<span style="font-weight:bold">ALIASES</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># This tag can be used to specify a number of word-keyword mappings (TCL only).</span>
|
|
<span style="color:#898887"># A mapping has the form "name=value". For example adding "class=itcl::class"</span>
|
|
<span style="color:#898887"># will allow you to use the command class in the itcl::class meaning.</span>
|
|
|
|
<span style="font-weight:bold">TCL_SUBST</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">OPTIMIZE_OUTPUT_FOR_C</span><span style="color:#898887"> tag to YES if your project consists of C sources</span>
|
|
<span style="color:#898887"># only. Doxygen will then generate output that is more tailored for C. For</span>
|
|
<span style="color:#898887"># instance, some of the names that are used will be different. The list of all</span>
|
|
<span style="color:#898887"># members will be omitted, etc.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">OPTIMIZE_OUTPUT_FOR_C</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">OPTIMIZE_OUTPUT_JAVA</span><span style="color:#898887"> tag to YES if your project consists of Java or</span>
|
|
<span style="color:#898887"># Python sources only. Doxygen will then generate output that is more tailored</span>
|
|
<span style="color:#898887"># for that language. For instance, namespaces will be presented as packages,</span>
|
|
<span style="color:#898887"># qualified scopes will look different, etc.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">OPTIMIZE_OUTPUT_JAVA</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">OPTIMIZE_FOR_FORTRAN</span><span style="color:#898887"> tag to YES if your project consists of Fortran</span>
|
|
<span style="color:#898887"># sources. Doxygen will then generate output that is tailored for Fortran.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">OPTIMIZE_FOR_FORTRAN</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">OPTIMIZE_OUTPUT_VHDL</span><span style="color:#898887"> tag to YES if your project consists of VHDL</span>
|
|
<span style="color:#898887"># sources. Doxygen will then generate output that is tailored for VHDL.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">OPTIMIZE_OUTPUT_VHDL</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Doxygen selects the parser to use depending on the extension of the files it</span>
|
|
<span style="color:#898887"># parses. With this tag you can assign which parser to use for a given</span>
|
|
<span style="color:#898887"># extension. Doxygen has a built-in mapping, but you can override or extend it</span>
|
|
<span style="color:#898887"># using this tag. The format is ext=language, where ext is a file extension, and</span>
|
|
<span style="color:#898887"># language is one of the parsers supported by doxygen: IDL, Java, Javascript,</span>
|
|
<span style="color:#898887"># C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:</span>
|
|
<span style="color:#898887"># FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:</span>
|
|
<span style="color:#898887"># Fortran. In the later case the parser tries to guess whether the code is fixed</span>
|
|
<span style="color:#898887"># or free formatted code, this is the default for Fortran type files), VHDL. For</span>
|
|
<span style="color:#898887"># instance to make doxygen treat .inc files as Fortran files (default is PHP),</span>
|
|
<span style="color:#898887"># and .f files as C (default is Fortran), use: inc=Fortran f=C.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note: For files without extension you can use no_extension as a placeholder.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that for custom extensions you also need to set </span><span style="color:#0095ff">FILE_PATTERNS</span><span style="color:#898887"> otherwise</span>
|
|
<span style="color:#898887"># the files are not read by doxygen.</span>
|
|
|
|
<span style="font-weight:bold">EXTENSION_MAPPING</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">MARKDOWN_SUPPORT</span><span style="color:#898887"> tag is enabled then doxygen pre-processes all comments</span>
|
|
<span style="color:#898887"># according to the Markdown format, which allows for more readable</span>
|
|
<span style="color:#898887"># documentation. See http://daringfireball.net/projects/markdown/ for details.</span>
|
|
<span style="color:#898887"># The output of markdown processing is further processed by doxygen, so you can</span>
|
|
<span style="color:#898887"># mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in</span>
|
|
<span style="color:#898887"># case of backward compatibilities issues.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">MARKDOWN_SUPPORT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># When enabled doxygen tries to link words that correspond to documented</span>
|
|
<span style="color:#898887"># classes, or namespaces to their corresponding documentation. Such a link can</span>
|
|
<span style="color:#898887"># be prevented in individual cases by putting a % sign in front of the word or</span>
|
|
<span style="color:#898887"># globally by setting </span><span style="color:#0095ff">AUTOLINK_SUPPORT</span><span style="color:#898887"> to NO.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">AUTOLINK_SUPPORT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If you use STL classes (i.e. std::string, std::vector, etc.) but do not want</span>
|
|
<span style="color:#898887"># to include (a tag file for) the STL sources as </span><span style="color:#0095ff">input</span><span style="color:#898887">, then you should set this</span>
|
|
<span style="color:#898887"># tag to YES in order to let doxygen match functions declarations and</span>
|
|
<span style="color:#898887"># definitions whose arguments contain STL classes (e.g. func(std::string);</span>
|
|
<span style="color:#898887"># versus func(std::string) {}). This also make the inheritance and collaboration</span>
|
|
<span style="color:#898887"># diagrams that involve STL classes more complete and accurate.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">BUILTIN_STL_SUPPORT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If you use Microsoft's C++/CLI language, you should set this option to YES to</span>
|
|
<span style="color:#898887"># enable parsing support.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">CPP_CLI_SUPPORT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">SIP_SUPPORT</span><span style="color:#898887"> tag to YES if your project consists of sip (see:</span>
|
|
<span style="color:#898887"># http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen</span>
|
|
<span style="color:#898887"># will parse them like normal C++ but will assume all classes use public instead</span>
|
|
<span style="color:#898887"># of private inheritance when no explicit protection keyword is present.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">SIP_SUPPORT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># For Microsoft's IDL there are propget and propput attributes to indicate</span>
|
|
<span style="color:#898887"># getter and setter methods for a property. Setting this option to YES will make</span>
|
|
<span style="color:#898887"># doxygen to replace the get and set methods by a property in the documentation.</span>
|
|
<span style="color:#898887"># This will only work if the methods are indeed getting or setting a simple</span>
|
|
<span style="color:#898887"># type. If this is not the case, or you want to show the methods anyway, you</span>
|
|
<span style="color:#898887"># should set this option to NO.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">IDL_PROPERTY_SUPPORT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If member grouping is used in the documentation and the </span><span style="color:#0095ff">DISTRIBUTE_GROUP_DOC</span>
|
|
<span style="color:#898887"># tag is set to YES then doxygen will reuse the documentation of the first</span>
|
|
<span style="color:#898887"># member in the group (if any) for the other members of the group. By default</span>
|
|
<span style="color:#898887"># all members of a group must be documented explicitly.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">DISTRIBUTE_GROUP_DOC</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If one adds a struct or class to a group and this option is enabled, then also</span>
|
|
<span style="color:#898887"># any nested class or struct is added to the same group. By default this option</span>
|
|
<span style="color:#898887"># is disabled and one has to add nested compounds explicitly via \ingroup.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">GROUP_NESTED_COMPOUNDS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">SUBGROUPING</span><span style="color:#898887"> tag to YES to allow class member groups of the same type</span>
|
|
<span style="color:#898887"># (for instance a group of public functions) to be put as a subgroup of that</span>
|
|
<span style="color:#898887"># type (e.g. under the Public Functions section). Set it to NO to prevent</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">subgrouping</span><span style="color:#898887">. Alternatively, this can be done per class using the</span>
|
|
<span style="color:#898887"># \nosubgrouping command.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">SUBGROUPING</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># When the </span><span style="color:#0095ff">INLINE_GROUPED_CLASSES</span><span style="color:#898887"> tag is set to YES, classes, structs and unions</span>
|
|
<span style="color:#898887"># are shown inside the group in which they are included (e.g. using \ingroup)</span>
|
|
<span style="color:#898887"># instead of on a separate page (for HTML and Man pages) or section (for LaTeX</span>
|
|
<span style="color:#898887"># and RTF).</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that this feature does not work in combination with</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">SEPARATE_MEMBER_PAGES</span><span style="color:#898887">.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">INLINE_GROUPED_CLASSES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># When the </span><span style="color:#0095ff">INLINE_SIMPLE_STRUCTS</span><span style="color:#898887"> tag is set to YES, structs, classes, and unions</span>
|
|
<span style="color:#898887"># with only public data fields or simple typedef fields will be shown inline in</span>
|
|
<span style="color:#898887"># the documentation of the scope in which they are defined (i.e. file,</span>
|
|
<span style="color:#898887"># namespace, or group documentation), provided this scope is documented. If set</span>
|
|
<span style="color:#898887"># to NO, structs, classes, and unions are shown on a separate page (for HTML and</span>
|
|
<span style="color:#898887"># Man pages) or section (for LaTeX and RTF).</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">INLINE_SIMPLE_STRUCTS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># When </span><span style="color:#0095ff">TYPEDEF_HIDES_STRUCT</span><span style="color:#898887"> tag is enabled, a typedef of a struct, union, or</span>
|
|
<span style="color:#898887"># enum is documented as struct, union, or enum with the name of the typedef. So</span>
|
|
<span style="color:#898887"># typedef struct TypeS {} TypeT, will appear in the documentation as a struct</span>
|
|
<span style="color:#898887"># with name TypeT. When disabled the typedef will appear as a member of a file,</span>
|
|
<span style="color:#898887"># namespace, or class. And the struct will be named TypeS. This can typically be</span>
|
|
<span style="color:#898887"># useful for C code in case the coding convention dictates that all compound</span>
|
|
<span style="color:#898887"># types are typedef'ed and only the typedef is referenced, never the tag name.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">TYPEDEF_HIDES_STRUCT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The size of the symbol lookup cache can be set using </span><span style="color:#0095ff">LOOKUP_CACHE_SIZE</span><span style="color:#898887">. This</span>
|
|
<span style="color:#898887"># cache is used to resolve symbols given their name and scope. Since this can be</span>
|
|
<span style="color:#898887"># an expensive process and often the same symbol appears multiple times in the</span>
|
|
<span style="color:#898887"># code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small</span>
|
|
<span style="color:#898887"># doxygen will become slower. If the cache is too large, memory is wasted. The</span>
|
|
<span style="color:#898887"># cache size is given by this formula: 2^(16+</span><span style="color:#0095ff">LOOKUP_CACHE_SIZE</span><span style="color:#898887">). The valid range</span>
|
|
<span style="color:#898887"># is 0..9, the default is 0, corresponding to a cache size of 2^16=65536</span>
|
|
<span style="color:#898887"># symbols. At the end of a run doxygen will report the cache usage and suggest</span>
|
|
<span style="color:#898887"># the optimal cache size from a speed point of view.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 9, default value: 0.</span>
|
|
|
|
<span style="font-weight:bold">LOOKUP_CACHE_SIZE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 0</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Build related configuration options</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXTRACT_ALL</span><span style="color:#898887"> tag is set to YES, doxygen will assume all entities in</span>
|
|
<span style="color:#898887"># documentation are documented, even if no documentation was available. Private</span>
|
|
<span style="color:#898887"># class members and static file members will be hidden unless the</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">EXTRACT_PRIVATE</span><span style="color:#898887"> respectively </span><span style="color:#0095ff">EXTRACT_STATIC</span><span style="color:#898887"> tags are set to YES.</span>
|
|
<span style="color:#898887"># Note: This will also disable the </span><span style="color:#0095ff">warnings</span><span style="color:#898887"> about undocumented members that are</span>
|
|
<span style="color:#898887"># normally produced when </span><span style="color:#0095ff">WARNINGS</span><span style="color:#898887"> is set to YES.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">EXTRACT_ALL</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXTRACT_PRIVATE</span><span style="color:#898887"> tag is set to YES, all private members of a class will</span>
|
|
<span style="color:#898887"># be included in the documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">EXTRACT_PRIVATE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXTRACT_PACKAGE</span><span style="color:#898887"> tag is set to YES, all members with package or internal</span>
|
|
<span style="color:#898887"># scope will be included in the documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">EXTRACT_PACKAGE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXTRACT_STATIC</span><span style="color:#898887"> tag is set to YES, all static members of a file will be</span>
|
|
<span style="color:#898887"># included in the documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">EXTRACT_STATIC</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXTRACT_LOCAL_CLASSES</span><span style="color:#898887"> tag is set to YES, classes (and structs) defined</span>
|
|
<span style="color:#898887"># locally in source files will be included in the documentation. If set to NO,</span>
|
|
<span style="color:#898887"># only classes defined in header files are included. Does not have any effect</span>
|
|
<span style="color:#898887"># for Java sources.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">EXTRACT_LOCAL_CLASSES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># This flag is only useful for Objective-C code. If set to YES, local methods,</span>
|
|
<span style="color:#898887"># which are defined in the implementation section but not in the interface are</span>
|
|
<span style="color:#898887"># included in the documentation. If set to NO, only methods in the interface are</span>
|
|
<span style="color:#898887"># included.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">EXTRACT_LOCAL_METHODS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If this flag is set to YES, the members of anonymous namespaces will be</span>
|
|
<span style="color:#898887"># extracted and appear in the documentation as a namespace called</span>
|
|
<span style="color:#898887"># 'anonymous_namespace{file}', where file will be replaced with the base name of</span>
|
|
<span style="color:#898887"># the file that contains the anonymous namespace. By default anonymous namespace</span>
|
|
<span style="color:#898887"># are hidden.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">EXTRACT_ANON_NSPACES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">HIDE_UNDOC_MEMBERS</span><span style="color:#898887"> tag is set to YES, doxygen will hide all</span>
|
|
<span style="color:#898887"># undocumented members inside documented classes or files. If set to NO these</span>
|
|
<span style="color:#898887"># members will be included in the various overviews, but no documentation</span>
|
|
<span style="color:#898887"># section is generated. This option has no effect if </span><span style="color:#0095ff">EXTRACT_ALL</span><span style="color:#898887"> is enabled.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">HIDE_UNDOC_MEMBERS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">HIDE_UNDOC_CLASSES</span><span style="color:#898887"> tag is set to YES, doxygen will hide all</span>
|
|
<span style="color:#898887"># undocumented classes that are normally visible in the class hierarchy. If set</span>
|
|
<span style="color:#898887"># to NO, these classes will be included in the various overviews. This option</span>
|
|
<span style="color:#898887"># has no effect if </span><span style="color:#0095ff">EXTRACT_ALL</span><span style="color:#898887"> is enabled.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">HIDE_UNDOC_CLASSES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">HIDE_FRIEND_COMPOUNDS</span><span style="color:#898887"> tag is set to YES, doxygen will hide all friend</span>
|
|
<span style="color:#898887"># (class|struct|union) declarations. If set to NO, these declarations will be</span>
|
|
<span style="color:#898887"># included in the documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">HIDE_FRIEND_COMPOUNDS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">HIDE_IN_BODY_DOCS</span><span style="color:#898887"> tag is set to YES, doxygen will hide any</span>
|
|
<span style="color:#898887"># documentation blocks found inside the body of a function. If set to NO, these</span>
|
|
<span style="color:#898887"># blocks will be appended to the function's detailed documentation block.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">HIDE_IN_BODY_DOCS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">INTERNAL_DOCS</span><span style="color:#898887"> tag determines if documentation that is typed after a</span>
|
|
<span style="color:#898887"># \internal command is included. If the tag is set to NO then the documentation</span>
|
|
<span style="color:#898887"># will be excluded. Set it to YES to include the internal documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">INTERNAL_DOCS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">CASE_SENSE_NAMES</span><span style="color:#898887"> tag is set to NO then doxygen will only generate file</span>
|
|
<span style="color:#898887"># names in lower-case letters. If set to YES, upper-case letters are also</span>
|
|
<span style="color:#898887"># allowed. This is useful if you have classes or files whose names only differ</span>
|
|
<span style="color:#898887"># in case and if your file system supports case sensitive file names. Windows</span>
|
|
<span style="color:#898887"># and Mac users are advised to set this option to NO.</span>
|
|
<span style="color:#898887"># The default value is: system dependent.</span>
|
|
|
|
<span style="font-weight:bold">CASE_SENSE_NAMES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">HIDE_SCOPE_NAMES</span><span style="color:#898887"> tag is set to NO then doxygen will show members with</span>
|
|
<span style="color:#898887"># their full class and namespace scopes in the documentation. If set to YES, the</span>
|
|
<span style="color:#898887"># scope will be hidden.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">HIDE_SCOPE_NAMES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">HIDE_COMPOUND_REFERENCE</span><span style="color:#898887"> tag is set to NO (default) then doxygen will</span>
|
|
<span style="color:#898887"># append additional text to a page's title, such as Class Reference. If set to</span>
|
|
<span style="color:#898887"># YES the compound reference will be hidden.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">HIDE_COMPOUND_REFERENCE</span><span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SHOW_INCLUDE_FILES</span><span style="color:#898887"> tag is set to YES then doxygen will put a list of</span>
|
|
<span style="color:#898887"># the files that are included by a file in the documentation of that file.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">SHOW_INCLUDE_FILES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SHOW_GROUPED_MEMB_INC</span><span style="color:#898887"> tag is set to YES then Doxygen will add for each</span>
|
|
<span style="color:#898887"># grouped member an include statement to the documentation, telling the reader</span>
|
|
<span style="color:#898887"># which file to include in order to use the member.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">SHOW_GROUPED_MEMB_INC</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">FORCE_LOCAL_INCLUDES</span><span style="color:#898887"> tag is set to YES then doxygen will list include</span>
|
|
<span style="color:#898887"># files with double quotes in the documentation rather than with sharp brackets.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">FORCE_LOCAL_INCLUDES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">INLINE_INFO</span><span style="color:#898887"> tag is set to YES then a tag [inline] is inserted in the</span>
|
|
<span style="color:#898887"># documentation for inline members.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">INLINE_INFO</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SORT_MEMBER_DOCS</span><span style="color:#898887"> tag is set to YES then doxygen will sort the</span>
|
|
<span style="color:#898887"># (detailed) documentation of file and class members alphabetically by member</span>
|
|
<span style="color:#898887"># name. If set to NO, the members will appear in declaration order.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">SORT_MEMBER_DOCS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SORT_BRIEF_DOCS</span><span style="color:#898887"> tag is set to YES then doxygen will sort the brief</span>
|
|
<span style="color:#898887"># descriptions of file, namespace and class members alphabetically by member</span>
|
|
<span style="color:#898887"># name. If set to NO, the members will appear in declaration order. Note that</span>
|
|
<span style="color:#898887"># this will also influence the order of the classes in the class list.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">SORT_BRIEF_DOCS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SORT_MEMBERS_CTORS_1ST</span><span style="color:#898887"> tag is set to YES then doxygen will sort the</span>
|
|
<span style="color:#898887"># (brief and detailed) documentation of class members so that constructors and</span>
|
|
<span style="color:#898887"># destructors are listed first. If set to NO the constructors will appear in the</span>
|
|
<span style="color:#898887"># respective orders defined by </span><span style="color:#0095ff">SORT_BRIEF_DOCS</span><span style="color:#898887"> and </span><span style="color:#0095ff">SORT_MEMBER_DOCS</span><span style="color:#898887">.</span>
|
|
<span style="color:#898887"># Note: If </span><span style="color:#0095ff">SORT_BRIEF_DOCS</span><span style="color:#898887"> is set to NO this option is ignored for sorting brief</span>
|
|
<span style="color:#898887"># member documentation.</span>
|
|
<span style="color:#898887"># Note: If </span><span style="color:#0095ff">SORT_MEMBER_DOCS</span><span style="color:#898887"> is set to NO this option is ignored for sorting</span>
|
|
<span style="color:#898887"># detailed member documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">SORT_MEMBERS_CTORS_1ST</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SORT_GROUP_NAMES</span><span style="color:#898887"> tag is set to YES then doxygen will sort the hierarchy</span>
|
|
<span style="color:#898887"># of group names into alphabetical order. If set to NO the group names will</span>
|
|
<span style="color:#898887"># appear in their defined order.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">SORT_GROUP_NAMES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SORT_BY_SCOPE_NAME</span><span style="color:#898887"> tag is set to YES, the class list will be sorted by</span>
|
|
<span style="color:#898887"># fully-qualified names, including namespaces. If set to NO, the class list will</span>
|
|
<span style="color:#898887"># be sorted only by class name, not including the namespace part.</span>
|
|
<span style="color:#898887"># Note: This option is not very useful if </span><span style="color:#0095ff">HIDE_SCOPE_NAMES</span><span style="color:#898887"> is set to YES.</span>
|
|
<span style="color:#898887"># Note: This option applies only to the class list, not to the alphabetical</span>
|
|
<span style="color:#898887"># list.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">SORT_BY_SCOPE_NAME</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">STRICT_PROTO_MATCHING</span><span style="color:#898887"> option is enabled and doxygen fails to do proper</span>
|
|
<span style="color:#898887"># type resolution of all parameters of a function it will reject a match between</span>
|
|
<span style="color:#898887"># the prototype and the implementation of a member function even if there is</span>
|
|
<span style="color:#898887"># only one candidate or it is obvious which candidate to choose by doing a</span>
|
|
<span style="color:#898887"># simple string match. By disabling </span><span style="color:#0095ff">STRICT_PROTO_MATCHING</span><span style="color:#898887"> doxygen will still</span>
|
|
<span style="color:#898887"># accept a match between prototype and implementation in such cases.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">STRICT_PROTO_MATCHING</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">GENERATE_TODOLIST</span><span style="color:#898887"> tag can be used to enable (YES) or disable (NO) the todo</span>
|
|
<span style="color:#898887"># list. This list is created by putting \todo commands in the documentation.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_TODOLIST</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">GENERATE_TESTLIST</span><span style="color:#898887"> tag can be used to enable (YES) or disable (NO) the test</span>
|
|
<span style="color:#898887"># list. This list is created by putting \test commands in the documentation.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_TESTLIST</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">GENERATE_BUGLIST</span><span style="color:#898887"> tag can be used to enable (YES) or disable (NO) the bug</span>
|
|
<span style="color:#898887"># list. This list is created by putting \bug commands in the documentation.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_BUGLIST</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">GENERATE_DEPRECATEDLIST</span><span style="color:#898887"> tag can be used to enable (YES) or disable (NO)</span>
|
|
<span style="color:#898887"># the deprecated list. This list is created by putting \deprecated commands in</span>
|
|
<span style="color:#898887"># the documentation.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_DEPRECATEDLIST</span><span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">ENABLED_SECTIONS</span><span style="color:#898887"> tag can be used to enable conditional documentation</span>
|
|
<span style="color:#898887"># sections, marked by \if <section_label> ... \endif and \cond <section_label></span>
|
|
<span style="color:#898887"># ... \endcond blocks.</span>
|
|
|
|
<span style="font-weight:bold">ENABLED_SECTIONS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MAX_INITIALIZER_LINES</span><span style="color:#898887"> tag determines the maximum number of lines that the</span>
|
|
<span style="color:#898887"># initial value of a variable or macro / define can have for it to appear in the</span>
|
|
<span style="color:#898887"># documentation. If the initializer consists of more lines than specified here</span>
|
|
<span style="color:#898887"># it will be hidden. Use a value of 0 to hide initializers completely. The</span>
|
|
<span style="color:#898887"># appearance of the value of individual variables and macros / defines can be</span>
|
|
<span style="color:#898887"># controlled using \showinitializer or \hideinitializer command in the</span>
|
|
<span style="color:#898887"># documentation regardless of this setting.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 10000, default value: 30.</span>
|
|
|
|
<span style="font-weight:bold">MAX_INITIALIZER_LINES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 30</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">SHOW_USED_FILES</span><span style="color:#898887"> tag to NO to disable the list of files generated at</span>
|
|
<span style="color:#898887"># the bottom of the documentation of classes and structs. If set to YES, the</span>
|
|
<span style="color:#898887"># list will mention the files that were used to generate the documentation.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">SHOW_USED_FILES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">SHOW_FILES</span><span style="color:#898887"> tag to NO to disable the generation of the Files page. This</span>
|
|
<span style="color:#898887"># will remove the Files entry from the Quick Index and from the Folder Tree View</span>
|
|
<span style="color:#898887"># (if specified).</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">SHOW_FILES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">SHOW_NAMESPACES</span><span style="color:#898887"> tag to NO to disable the generation of the Namespaces</span>
|
|
<span style="color:#898887"># page. This will remove the Namespaces entry from the Quick Index and from the</span>
|
|
<span style="color:#898887"># Folder Tree View (if specified).</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">SHOW_NAMESPACES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">FILE_VERSION_FILTER</span><span style="color:#898887"> tag can be used to specify a program or script that</span>
|
|
<span style="color:#898887"># doxygen should invoke to get the current version for each file (typically from</span>
|
|
<span style="color:#898887"># the version control system). Doxygen will invoke the program by executing (via</span>
|
|
<span style="color:#898887"># popen()) the command command </span><span style="color:#0095ff">input</span><span style="color:#898887">-file, where command is the value of the</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">FILE_VERSION_FILTER</span><span style="color:#898887"> tag, and </span><span style="color:#0095ff">input</span><span style="color:#898887">-file is the name of an </span><span style="color:#0095ff">input</span><span style="color:#898887"> file provided</span>
|
|
<span style="color:#898887"># by doxygen. Whatever the program writes to standard output is used as the file</span>
|
|
<span style="color:#898887"># version. For an example see the documentation.</span>
|
|
|
|
<span style="font-weight:bold">FILE_VERSION_FILTER</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">LAYOUT_FILE</span><span style="color:#898887"> tag can be used to specify a layout file which will be parsed</span>
|
|
<span style="color:#898887"># by doxygen. The layout file controls the global structure of the generated</span>
|
|
<span style="color:#898887"># output files in an output format independent way. To create the layout file</span>
|
|
<span style="color:#898887"># that represents doxygen's defaults, run doxygen with the -l option. You can</span>
|
|
<span style="color:#898887"># optionally specify a file name after the option, if omitted DoxygenLayout.xml</span>
|
|
<span style="color:#898887"># will be used as the name of the layout file.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that if you run doxygen from a directory containing a file called</span>
|
|
<span style="color:#898887"># DoxygenLayout.xml, doxygen will parse it automatically even if the </span><span style="color:#0095ff">LAYOUT_FILE</span>
|
|
<span style="color:#898887"># tag is left empty.</span>
|
|
|
|
<span style="font-weight:bold">LAYOUT_FILE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">CITE_BIB_FILES</span><span style="color:#898887"> tag can be used to specify one or more bib files containing</span>
|
|
<span style="color:#898887"># the reference definitions. This must be a list of .bib files. The .bib</span>
|
|
<span style="color:#898887"># extension is automatically appended if omitted. This requires the bibtex tool</span>
|
|
<span style="color:#898887"># to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.</span>
|
|
<span style="color:#898887"># For LaTeX the style of the bibliography can be controlled using</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">LATEX_BIB_STYLE</span><span style="color:#898887">. To use this feature you need bibtex and perl available in the</span>
|
|
<span style="color:#898887"># search path. See also \cite for info how to create references.</span>
|
|
|
|
<span style="font-weight:bold">CITE_BIB_FILES</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to warning and progress messages</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">QUIET</span><span style="color:#898887"> tag can be used to turn on/off the messages that are generated to</span>
|
|
<span style="color:#898887"># standard output by doxygen. If </span><span style="color:#0095ff">QUIET</span><span style="color:#898887"> is set to YES this implies that the</span>
|
|
<span style="color:#898887"># messages are off.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">QUIET</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">WARNINGS</span><span style="color:#898887"> tag can be used to turn on/off the warning messages that are</span>
|
|
<span style="color:#898887"># generated to standard error (stderr) by doxygen. If </span><span style="color:#0095ff">WARNINGS</span><span style="color:#898887"> is set to YES</span>
|
|
<span style="color:#898887"># this implies that the </span><span style="color:#0095ff">warnings</span><span style="color:#898887"> are on.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Tip: Turn </span><span style="color:#0095ff">warnings</span><span style="color:#898887"> on while writing the documentation.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">WARNINGS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">WARN_IF_UNDOCUMENTED</span><span style="color:#898887"> tag is set to YES then doxygen will generate</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">warnings</span><span style="color:#898887"> for undocumented members. If </span><span style="color:#0095ff">EXTRACT_ALL</span><span style="color:#898887"> is set to YES then this flag</span>
|
|
<span style="color:#898887"># will automatically be disabled.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">WARN_IF_UNDOCUMENTED</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">WARN_IF_DOC_ERROR</span><span style="color:#898887"> tag is set to YES, doxygen will generate </span><span style="color:#0095ff">warnings</span><span style="color:#898887"> for</span>
|
|
<span style="color:#898887"># potential errors in the documentation, such as not documenting some parameters</span>
|
|
<span style="color:#898887"># in a documented function, or documenting parameters that don't exist or using</span>
|
|
<span style="color:#898887"># markup commands wrongly.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">WARN_IF_DOC_ERROR</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># This </span><span style="color:#0095ff">WARN_NO_PARAMDOC</span><span style="color:#898887"> option can be enabled to get </span><span style="color:#0095ff">warnings</span><span style="color:#898887"> for functions that</span>
|
|
<span style="color:#898887"># are documented, but have no documentation for their parameters or return</span>
|
|
<span style="color:#898887"># value. If set to NO, doxygen will only warn about wrong or incomplete</span>
|
|
<span style="color:#898887"># parameter documentation, but not about the absence of documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">WARN_NO_PARAMDOC</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">WARN_AS_ERROR</span><span style="color:#898887"> tag is set to YES then doxygen will immediately stop when</span>
|
|
<span style="color:#898887"># a warning is encountered.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">WARN_AS_ERROR</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">WARN_FORMAT</span><span style="color:#898887"> tag determines the format of the warning messages that doxygen</span>
|
|
<span style="color:#898887"># can produce. The string should contain the $file, $line, and $text tags, which</span>
|
|
<span style="color:#898887"># will be replaced by the file and line number from which the warning originated</span>
|
|
<span style="color:#898887"># and the warning text. Optionally the format may contain $version, which will</span>
|
|
<span style="color:#898887"># be replaced by the version of the file (if it could be obtained via</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">FILE_VERSION_FILTER</span><span style="color:#898887">)</span>
|
|
<span style="color:#898887"># The default value is: $file:$line: $text.</span>
|
|
|
|
<span style="font-weight:bold">WARN_FORMAT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> "$file:$line: $text"</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">WARN_LOGFILE</span><span style="color:#898887"> tag can be used to specify a file to which warning and error</span>
|
|
<span style="color:#898887"># messages should be written. If left blank the output is written to standard</span>
|
|
<span style="color:#898887"># error (stderr).</span>
|
|
|
|
<span style="font-weight:bold">WARN_LOGFILE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the </span><span style="color:#0095ff">input</span><span style="color:#898887"> files</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">INPUT</span><span style="color:#898887"> tag is used to specify the files and/or directories that contain</span>
|
|
<span style="color:#898887"># documented source files. You may enter file names like myfile.cpp or</span>
|
|
<span style="color:#898887"># directories like /usr/src/myproject. Separate the files or directories with</span>
|
|
<span style="color:#898887"># spaces. See also </span><span style="color:#0095ff">FILE_PATTERNS</span><span style="color:#898887"> and </span><span style="color:#0095ff">EXTENSION_MAPPING</span>
|
|
<span style="color:#898887"># Note: If this tag is empty the current directory is searched.</span>
|
|
|
|
<span style="font-weight:bold">INPUT</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># This tag can be used to specify the character encoding of the source files</span>
|
|
<span style="color:#898887"># that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses</span>
|
|
<span style="color:#898887"># libiconv (or the iconv built into libc) for the transcoding. See the libiconv</span>
|
|
<span style="color:#898887"># documentation (see: http://www.gnu.org/software/libiconv) for the list of</span>
|
|
<span style="color:#898887"># possible encodings.</span>
|
|
<span style="color:#898887"># The default value is: UTF-8.</span>
|
|
|
|
<span style="font-weight:bold">INPUT_ENCODING</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> UTF-8</span>
|
|
|
|
<span style="color:#898887"># If the value of the </span><span style="color:#0095ff">INPUT</span><span style="color:#898887"> tag contains directories, you can use the</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">FILE_PATTERNS</span><span style="color:#898887"> tag to specify one or more wildcard patterns (like *.cpp and</span>
|
|
<span style="color:#898887"># *.h) to filter out the source-files in the directories.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that for custom extensions or not directly supported extensions you also</span>
|
|
<span style="color:#898887"># need to set </span><span style="color:#0095ff">EXTENSION_MAPPING</span><span style="color:#898887"> for the extension otherwise the files are not</span>
|
|
<span style="color:#898887"># read by doxygen.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,</span>
|
|
<span style="color:#898887"># *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,</span>
|
|
<span style="color:#898887"># *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,</span>
|
|
<span style="color:#898887"># *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,</span>
|
|
<span style="color:#898887"># *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.</span>
|
|
|
|
<span style="font-weight:bold">FILE_PATTERNS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">RECURSIVE</span><span style="color:#898887"> tag can be used to specify whether or not subdirectories should</span>
|
|
<span style="color:#898887"># be searched for </span><span style="color:#0095ff">input</span><span style="color:#898887"> files as well.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">RECURSIVE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">EXCLUDE</span><span style="color:#898887"> tag can be used to specify files and/or directories that should be</span>
|
|
<span style="color:#898887"># excluded from the </span><span style="color:#0095ff">INPUT</span><span style="color:#898887"> source files. This way you can easily </span><span style="color:#0095ff">exclude</span><span style="color:#898887"> a</span>
|
|
<span style="color:#898887"># subdirectory from a directory tree whose root is specified with the </span><span style="color:#0095ff">INPUT</span><span style="color:#898887"> tag.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that relative paths are relative to the directory from which doxygen is</span>
|
|
<span style="color:#898887"># run.</span>
|
|
|
|
<span style="font-weight:bold">EXCLUDE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">EXCLUDE_SYMLINKS</span><span style="color:#898887"> tag can be used to select whether or not files or</span>
|
|
<span style="color:#898887"># directories that are symbolic links (a Unix file system feature) are excluded</span>
|
|
<span style="color:#898887"># from the </span><span style="color:#0095ff">input</span><span style="color:#898887">.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">EXCLUDE_SYMLINKS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the value of the </span><span style="color:#0095ff">INPUT</span><span style="color:#898887"> tag contains directories, you can use the</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">EXCLUDE_PATTERNS</span><span style="color:#898887"> tag to specify one or more wildcard patterns to </span><span style="color:#0095ff">exclude</span>
|
|
<span style="color:#898887"># certain files from those directories.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that the wildcards are matched against the file with absolute path, so to</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">exclude</span><span style="color:#898887"> all test directories for example use the pattern */test/*</span>
|
|
|
|
<span style="font-weight:bold">EXCLUDE_PATTERNS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">EXCLUDE_SYMBOLS</span><span style="color:#898887"> tag can be used to specify one or more symbol names</span>
|
|
<span style="color:#898887"># (namespaces, classes, functions, etc.) that should be excluded from the</span>
|
|
<span style="color:#898887"># output. The symbol name can be a fully qualified name, a word, or if the</span>
|
|
<span style="color:#898887"># wildcard * is used, a substring. Examples: ANamespace, AClass,</span>
|
|
<span style="color:#898887"># AClass::ANamespace, ANamespace::*Test</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that the wildcards are matched against the file with absolute path, so to</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">exclude</span><span style="color:#898887"> all test directories use the pattern */test/*</span>
|
|
|
|
<span style="font-weight:bold">EXCLUDE_SYMBOLS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">EXAMPLE_PATH</span><span style="color:#898887"> tag can be used to specify one or more files or directories</span>
|
|
<span style="color:#898887"># that contain example code fragments that are included (see the \include</span>
|
|
<span style="color:#898887"># command).</span>
|
|
|
|
<span style="font-weight:bold">EXAMPLE_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the value of the </span><span style="color:#0095ff">EXAMPLE_PATH</span><span style="color:#898887"> tag contains directories, you can use the</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">EXAMPLE_PATTERNS</span><span style="color:#898887"> tag to specify one or more wildcard pattern (like *.cpp and</span>
|
|
<span style="color:#898887"># *.h) to filter out the source-files in the directories. If left blank all</span>
|
|
<span style="color:#898887"># files are included.</span>
|
|
|
|
<span style="font-weight:bold">EXAMPLE_PATTERNS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXAMPLE_RECURSIVE</span><span style="color:#898887"> tag is set to YES then subdirectories will be</span>
|
|
<span style="color:#898887"># searched for </span><span style="color:#0095ff">input</span><span style="color:#898887"> files to be used with the \include or \dontinclude commands</span>
|
|
<span style="color:#898887"># irrespective of the value of the </span><span style="color:#0095ff">RECURSIVE</span><span style="color:#898887"> tag.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">EXAMPLE_RECURSIVE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">IMAGE_PATH</span><span style="color:#898887"> tag can be used to specify one or more files or directories</span>
|
|
<span style="color:#898887"># that contain images that are to be included in the documentation (see the</span>
|
|
<span style="color:#898887"># \image command).</span>
|
|
|
|
<span style="font-weight:bold">IMAGE_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">INPUT_FILTER</span><span style="color:#898887"> tag can be used to specify a program that doxygen should</span>
|
|
<span style="color:#898887"># invoke to filter for each </span><span style="color:#0095ff">input</span><span style="color:#898887"> file. Doxygen will invoke the filter program</span>
|
|
<span style="color:#898887"># by executing (via popen()) the command:</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># <filter> <</span><span style="color:#0095ff">input</span><span style="color:#898887">-file></span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># where <filter> is the value of the </span><span style="color:#0095ff">INPUT_FILTER</span><span style="color:#898887"> tag, and <</span><span style="color:#0095ff">input</span><span style="color:#898887">-file> is the</span>
|
|
<span style="color:#898887"># name of an </span><span style="color:#0095ff">input</span><span style="color:#898887"> file. Doxygen will then use the output that the filter</span>
|
|
<span style="color:#898887"># program writes to standard output. If </span><span style="color:#0095ff">FILTER_PATTERNS</span><span style="color:#898887"> is specified, this tag</span>
|
|
<span style="color:#898887"># will be ignored.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that the filter must not add or remove lines; it is applied before the</span>
|
|
<span style="color:#898887"># code is scanned, but not when the output code is generated. If lines are added</span>
|
|
<span style="color:#898887"># or removed, the anchors will not be placed correctly.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that for custom extensions or not directly supported extensions you also</span>
|
|
<span style="color:#898887"># need to set </span><span style="color:#0095ff">EXTENSION_MAPPING</span><span style="color:#898887"> for the extension otherwise the files are not</span>
|
|
<span style="color:#898887"># properly processed by doxygen.</span>
|
|
|
|
<span style="font-weight:bold">INPUT_FILTER</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">FILTER_PATTERNS</span><span style="color:#898887"> tag can be used to specify filters on a per file pattern</span>
|
|
<span style="color:#898887"># basis. Doxygen will compare the file name with each pattern and apply the</span>
|
|
<span style="color:#898887"># filter if there is a match. The filters are a list of the form: pattern=filter</span>
|
|
<span style="color:#898887"># (like *.cpp=my_cpp_filter). See </span><span style="color:#0095ff">INPUT_FILTER</span><span style="color:#898887"> for further information on how</span>
|
|
<span style="color:#898887"># filters are used. If the </span><span style="color:#0095ff">FILTER_PATTERNS</span><span style="color:#898887"> tag is empty or if none of the</span>
|
|
<span style="color:#898887"># patterns match the file name, </span><span style="color:#0095ff">INPUT_FILTER</span><span style="color:#898887"> is applied.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that for custom extensions or not directly supported extensions you also</span>
|
|
<span style="color:#898887"># need to set </span><span style="color:#0095ff">EXTENSION_MAPPING</span><span style="color:#898887"> for the extension otherwise the files are not</span>
|
|
<span style="color:#898887"># properly processed by doxygen.</span>
|
|
|
|
<span style="font-weight:bold">FILTER_PATTERNS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">FILTER_SOURCE_FILES</span><span style="color:#898887"> tag is set to YES, the </span><span style="color:#0095ff">input</span><span style="color:#898887"> filter (if set using</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">INPUT_FILTER</span><span style="color:#898887">) will also be used to filter the </span><span style="color:#0095ff">input</span><span style="color:#898887"> files that are used for</span>
|
|
<span style="color:#898887"># producing the source files to browse (i.e. when </span><span style="color:#0095ff">SOURCE_BROWSER</span><span style="color:#898887"> is set to YES).</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">FILTER_SOURCE_FILES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">FILTER_SOURCE_PATTERNS</span><span style="color:#898887"> tag can be used to specify source filters per file</span>
|
|
<span style="color:#898887"># pattern. A pattern will override the setting for FILTER_PATTERN (if any) and</span>
|
|
<span style="color:#898887"># it is also possible to disable source filtering for a specific pattern using</span>
|
|
<span style="color:#898887"># *.ext= (so without naming a filter).</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">FILTER_SOURCE_FILES</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">FILTER_SOURCE_PATTERNS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">USE_MDFILE_AS_MAINPAGE</span><span style="color:#898887"> tag refers to the name of a markdown file that</span>
|
|
<span style="color:#898887"># is part of the </span><span style="color:#0095ff">input</span><span style="color:#898887">, its contents will be placed on the main page</span>
|
|
<span style="color:#898887"># (index.html). This can be useful if you have a project on for instance GitHub</span>
|
|
<span style="color:#898887"># and want to reuse the introduction page also for the doxygen output.</span>
|
|
|
|
<span style="font-weight:bold">USE_MDFILE_AS_MAINPAGE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to source browsing</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SOURCE_BROWSER</span><span style="color:#898887"> tag is set to YES then a list of source files will be</span>
|
|
<span style="color:#898887"># generated. Documented entities will be cross-referenced with these sources.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note: To get rid of all source code in the generated output, make sure that</span>
|
|
<span style="color:#898887"># also </span><span style="color:#0095ff">VERBATIM_HEADERS</span><span style="color:#898887"> is set to NO.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">SOURCE_BROWSER</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Setting the </span><span style="color:#0095ff">INLINE_SOURCES</span><span style="color:#898887"> tag to YES will include the body of functions,</span>
|
|
<span style="color:#898887"># classes and enums directly into the documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">INLINE_SOURCES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Setting the </span><span style="color:#0095ff">STRIP_CODE_COMMENTS</span><span style="color:#898887"> tag to YES will instruct doxygen to hide any</span>
|
|
<span style="color:#898887"># special comment blocks from generated source code fragments. Normal C, C++ and</span>
|
|
<span style="color:#898887"># Fortran comments will always remain visible.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">STRIP_CODE_COMMENTS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">REFERENCED_BY_RELATION</span><span style="color:#898887"> tag is set to YES then for each documented</span>
|
|
<span style="color:#898887"># function all documented functions referencing it will be listed.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">REFERENCED_BY_RELATION</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">REFERENCES_RELATION</span><span style="color:#898887"> tag is set to YES then for each documented function</span>
|
|
<span style="color:#898887"># all documented entities called/used by that function will be listed.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">REFERENCES_RELATION</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">REFERENCES_LINK_SOURCE</span><span style="color:#898887"> tag is set to YES and </span><span style="color:#0095ff">SOURCE_BROWSER</span><span style="color:#898887"> tag is set</span>
|
|
<span style="color:#898887"># to YES then the hyperlinks from functions in </span><span style="color:#0095ff">REFERENCES_RELATION</span><span style="color:#898887"> and</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">REFERENCED_BY_RELATION</span><span style="color:#898887"> lists will link to the source code. Otherwise they will</span>
|
|
<span style="color:#898887"># link to the documentation.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">REFERENCES_LINK_SOURCE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If </span><span style="color:#0095ff">SOURCE_TOOLTIPS</span><span style="color:#898887"> is enabled (the default) then hovering a hyperlink in the</span>
|
|
<span style="color:#898887"># source code will show a tooltip with additional information such as prototype,</span>
|
|
<span style="color:#898887"># brief description and links to the definition and documentation. Since this</span>
|
|
<span style="color:#898887"># will make the HTML file larger and loading of large files a bit slower, you</span>
|
|
<span style="color:#898887"># can opt to disable this feature.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">SOURCE_BROWSER</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">SOURCE_TOOLTIPS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">USE_HTAGS</span><span style="color:#898887"> tag is set to YES then the references to source code will</span>
|
|
<span style="color:#898887"># point to the HTML generated by the htags(1) tool instead of doxygen built-in</span>
|
|
<span style="color:#898887"># source browser. The htags tool is part of GNU's global source tagging system</span>
|
|
<span style="color:#898887"># (see http://www.gnu.org/software/global/global.html). You will need version</span>
|
|
<span style="color:#898887"># 4.8.6 or higher.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># To use it do the following:</span>
|
|
<span style="color:#898887"># - Install the latest version of global</span>
|
|
<span style="color:#898887"># - Enable </span><span style="color:#0095ff">SOURCE_BROWSER</span><span style="color:#898887"> and </span><span style="color:#0095ff">USE_HTAGS</span><span style="color:#898887"> in the config file</span>
|
|
<span style="color:#898887"># - Make sure the </span><span style="color:#0095ff">INPUT</span><span style="color:#898887"> points to the root of the source tree</span>
|
|
<span style="color:#898887"># - Run doxygen as normal</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Doxygen will invoke htags (and that will in turn invoke gtags), so these</span>
|
|
<span style="color:#898887"># tools must be available from the command line (i.e. in the search path).</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># The result: instead of the source browser generated by doxygen, the links to</span>
|
|
<span style="color:#898887"># source code will now point to the output of htags.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">SOURCE_BROWSER</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">USE_HTAGS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">VERBATIM_HEADERS</span><span style="color:#898887"> tag is set the YES then doxygen will generate a</span>
|
|
<span style="color:#898887"># verbatim copy of the header file for each class for which an include is</span>
|
|
<span style="color:#898887"># specified. Set to NO to disable this.</span>
|
|
<span style="color:#898887"># See also: Section \class.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">VERBATIM_HEADERS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the alphabetical class index</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">ALPHABETICAL_INDEX</span><span style="color:#898887"> tag is set to YES, an alphabetical index of all</span>
|
|
<span style="color:#898887"># compounds will be generated. Enable this if the project contains a lot of</span>
|
|
<span style="color:#898887"># classes, structs, unions or interfaces.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">ALPHABETICAL_INDEX</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">COLS_IN_ALPHA_INDEX</span><span style="color:#898887"> tag can be used to specify the number of columns in</span>
|
|
<span style="color:#898887"># which the alphabetical index list will be split.</span>
|
|
<span style="color:#898887"># Minimum value: 1, maximum value: 20, default value: 5.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">ALPHABETICAL_INDEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">COLS_IN_ALPHA_INDEX</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 5</span>
|
|
|
|
<span style="color:#898887"># In case all classes in a project start with a common prefix, all classes will</span>
|
|
<span style="color:#898887"># be put under the same header in the alphabetical index. The </span><span style="color:#0095ff">IGNORE_PREFIX</span><span style="color:#898887"> tag</span>
|
|
<span style="color:#898887"># can be used to specify a prefix (or a list of prefixes) that should be ignored</span>
|
|
<span style="color:#898887"># while generating the index headers.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">ALPHABETICAL_INDEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">IGNORE_PREFIX</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the HTML output</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> tag is set to YES, doxygen will generate HTML output</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_HTML</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_OUTPUT</span><span style="color:#898887"> tag is used to specify where the HTML docs will be put. If a</span>
|
|
<span style="color:#898887"># relative path is entered the value of </span><span style="color:#0095ff">OUTPUT_DIRECTORY</span><span style="color:#898887"> will be put in front of</span>
|
|
<span style="color:#898887"># it.</span>
|
|
<span style="color:#898887"># The default directory is: html.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_OUTPUT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> html</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_FILE_EXTENSION</span><span style="color:#898887"> tag can be used to specify the file extension for each</span>
|
|
<span style="color:#898887"># generated HTML page (for example: .htm, .php, .asp).</span>
|
|
<span style="color:#898887"># The default value is: .html.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_FILE_EXTENSION</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> .html</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_HEADER</span><span style="color:#898887"> tag can be used to specify a user-defined HTML header file for</span>
|
|
<span style="color:#898887"># each generated HTML page. If the tag is left blank doxygen will generate a</span>
|
|
<span style="color:#898887"># standard header.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># To get valid HTML the header file that includes any scripts and style sheets</span>
|
|
<span style="color:#898887"># that doxygen needs, which is dependent on the configuration options used (e.g.</span>
|
|
<span style="color:#898887"># the setting </span><span style="color:#0095ff">GENERATE_TREEVIEW</span><span style="color:#898887">). It is highly recommended to start with a</span>
|
|
<span style="color:#898887"># default header using</span>
|
|
<span style="color:#898887"># doxygen -w html new_header.html new_footer.html new_stylesheet.css</span>
|
|
<span style="color:#898887"># YourConfigFile</span>
|
|
<span style="color:#898887"># and then modify the file new_header.html. See also section "Doxygen usage"</span>
|
|
<span style="color:#898887"># for information on how to generate the default header that doxygen normally</span>
|
|
<span style="color:#898887"># uses.</span>
|
|
<span style="color:#898887"># Note: The header is subject to change so you typically have to regenerate the</span>
|
|
<span style="color:#898887"># default header when upgrading to a newer version of doxygen. For a description</span>
|
|
<span style="color:#898887"># of the possible markers and block names see the documentation.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_HEADER</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_FOOTER</span><span style="color:#898887"> tag can be used to specify a user-defined HTML footer for each</span>
|
|
<span style="color:#898887"># generated HTML page. If the tag is left blank doxygen will generate a standard</span>
|
|
<span style="color:#898887"># footer. See </span><span style="color:#0095ff">HTML_HEADER</span><span style="color:#898887"> for more information on how to generate a default</span>
|
|
<span style="color:#898887"># footer and what special commands can be used inside the footer. See also</span>
|
|
<span style="color:#898887"># section "Doxygen usage" for information on how to generate the default footer</span>
|
|
<span style="color:#898887"># that doxygen normally uses.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_FOOTER</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_STYLESHEET</span><span style="color:#898887"> tag can be used to specify a user-defined cascading style</span>
|
|
<span style="color:#898887"># sheet that is used by each HTML page. It can be used to fine-tune the look of</span>
|
|
<span style="color:#898887"># the HTML output. If left blank doxygen will generate a default style sheet.</span>
|
|
<span style="color:#898887"># See also section "Doxygen usage" for information on how to generate the style</span>
|
|
<span style="color:#898887"># sheet that doxygen normally uses.</span>
|
|
<span style="color:#898887"># Note: It is recommended to use </span><span style="color:#0095ff">HTML_EXTRA_STYLESHEET</span><span style="color:#898887"> instead of this tag, as</span>
|
|
<span style="color:#898887"># it is more robust and this tag (</span><span style="color:#0095ff">HTML_STYLESHEET</span><span style="color:#898887">) will in the future become</span>
|
|
<span style="color:#898887"># obsolete.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_STYLESHEET</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_EXTRA_STYLESHEET</span><span style="color:#898887"> tag can be used to specify additional user-defined</span>
|
|
<span style="color:#898887"># cascading style sheets that are included after the standard style sheets</span>
|
|
<span style="color:#898887"># created by doxygen. Using this option one can overrule certain style aspects.</span>
|
|
<span style="color:#898887"># This is preferred over using </span><span style="color:#0095ff">HTML_STYLESHEET</span><span style="color:#898887"> since it does not replace the</span>
|
|
<span style="color:#898887"># standard style sheet and is therefore more robust against future updates.</span>
|
|
<span style="color:#898887"># Doxygen will copy the style sheet files to the output directory.</span>
|
|
<span style="color:#898887"># Note: The order of the extra style sheet files is of importance (e.g. the last</span>
|
|
<span style="color:#898887"># style sheet in the list overrules the setting of the previous ones in the</span>
|
|
<span style="color:#898887"># list). For an example see the documentation.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_EXTRA_STYLESHEET</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_EXTRA_FILES</span><span style="color:#898887"> tag can be used to specify one or more extra images or</span>
|
|
<span style="color:#898887"># other source files which should be copied to the HTML output directory. Note</span>
|
|
<span style="color:#898887"># that these files will be copied to the base HTML output directory. Use the</span>
|
|
<span style="color:#898887"># $relpath^ marker in the </span><span style="color:#0095ff">HTML_HEADER</span><span style="color:#898887"> and/or </span><span style="color:#0095ff">HTML_FOOTER</span><span style="color:#898887"> files to load these</span>
|
|
<span style="color:#898887"># files. In the </span><span style="color:#0095ff">HTML_STYLESHEET</span><span style="color:#898887"> file, use the file name only. Also note that the</span>
|
|
<span style="color:#898887"># files will be copied as-is; there are no commands or markers available.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_EXTRA_FILES</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_COLORSTYLE_HUE</span><span style="color:#898887"> tag controls the color of the HTML output. Doxygen</span>
|
|
<span style="color:#898887"># will adjust the colors in the style sheet and background images according to</span>
|
|
<span style="color:#898887"># this color. Hue is specified as an angle on a colorwheel, see</span>
|
|
<span style="color:#898887"># http://en.wikipedia.org/wiki/Hue for more information. For instance the value</span>
|
|
<span style="color:#898887"># 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300</span>
|
|
<span style="color:#898887"># purple, and 360 is red again.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 359, default value: 220.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_COLORSTYLE_HUE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 220</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_COLORSTYLE_SAT</span><span style="color:#898887"> tag controls the purity (or saturation) of the colors</span>
|
|
<span style="color:#898887"># in the HTML output. For a value of 0 the output will use grayscales only. A</span>
|
|
<span style="color:#898887"># value of 255 will produce the most vivid colors.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 255, default value: 100.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_COLORSTYLE_SAT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 100</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HTML_COLORSTYLE_GAMMA</span><span style="color:#898887"> tag controls the gamma correction applied to the</span>
|
|
<span style="color:#898887"># luminance component of the colors in the HTML output. Values below 100</span>
|
|
<span style="color:#898887"># gradually make the output lighter, whereas values above 100 make the output</span>
|
|
<span style="color:#898887"># darker. The value divided by 100 is the actual gamma applied, so 80 represents</span>
|
|
<span style="color:#898887"># a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not</span>
|
|
<span style="color:#898887"># change the gamma.</span>
|
|
<span style="color:#898887"># Minimum value: 40, maximum value: 240, default value: 80.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_COLORSTYLE_GAMMA</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 80</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">HTML_TIMESTAMP</span><span style="color:#898887"> tag is set to YES then the footer of each generated HTML</span>
|
|
<span style="color:#898887"># page will contain the date and time when the page was generated. Setting this</span>
|
|
<span style="color:#898887"># to YES can help to show when doxygen was last run and thus if the</span>
|
|
<span style="color:#898887"># documentation is up to date.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_TIMESTAMP</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">HTML_DYNAMIC_SECTIONS</span><span style="color:#898887"> tag is set to YES then the generated HTML</span>
|
|
<span style="color:#898887"># documentation will contain sections that can be hidden and shown after the</span>
|
|
<span style="color:#898887"># page has loaded.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_DYNAMIC_SECTIONS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># With </span><span style="color:#0095ff">HTML_INDEX_NUM_ENTRIES</span><span style="color:#898887"> one can control the preferred number of entries</span>
|
|
<span style="color:#898887"># shown in the various tree structured indices initially; the user can expand</span>
|
|
<span style="color:#898887"># and collapse entries dynamically later on. Doxygen will expand the tree to</span>
|
|
<span style="color:#898887"># such a level that at most the specified number of entries are visible (unless</span>
|
|
<span style="color:#898887"># a fully collapsed tree already exceeds this amount). So setting the number of</span>
|
|
<span style="color:#898887"># entries 1 will produce a full collapsed tree by default. 0 is a special value</span>
|
|
<span style="color:#898887"># representing an infinite number of entries and will result in a full expanded</span>
|
|
<span style="color:#898887"># tree by default.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 9999, default value: 100.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HTML_INDEX_NUM_ENTRIES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 100</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_DOCSET</span><span style="color:#898887"> tag is set to YES, additional index files will be</span>
|
|
<span style="color:#898887"># generated that can be used as </span><span style="color:#0095ff">input</span><span style="color:#898887"> for Apple's Xcode 3 integrated development</span>
|
|
<span style="color:#898887"># environment (see: http://developer.apple.com/tools/xcode/), introduced with</span>
|
|
<span style="color:#898887"># OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a</span>
|
|
<span style="color:#898887"># Makefile in the HTML output directory. Running make will produce the docset in</span>
|
|
<span style="color:#898887"># that directory and running make install will install the docset in</span>
|
|
<span style="color:#898887"># ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at</span>
|
|
<span style="color:#898887"># startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html</span>
|
|
<span style="color:#898887"># for more information.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_DOCSET</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># This tag determines the name of the docset feed. A documentation feed provides</span>
|
|
<span style="color:#898887"># an umbrella under which multiple documentation sets from a single provider</span>
|
|
<span style="color:#898887"># (such as a company or product suite) can be grouped.</span>
|
|
<span style="color:#898887"># The default value is: Doxygen generated docs.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_DOCSET</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOCSET_FEEDNAME</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> "Doxygen generated docs"</span>
|
|
|
|
<span style="color:#898887"># This tag specifies a string that should uniquely identify the documentation</span>
|
|
<span style="color:#898887"># set bundle. This should be a reverse domain-name style string, e.g.</span>
|
|
<span style="color:#898887"># com.mycompany.MyDocSet. Doxygen will append .docset to the name.</span>
|
|
<span style="color:#898887"># The default value is: org.doxygen.Project.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_DOCSET</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOCSET_BUNDLE_ID</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> org.doxygen.Project</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DOCSET_PUBLISHER_ID</span><span style="color:#898887"> tag specifies a string that should uniquely identify</span>
|
|
<span style="color:#898887"># the documentation publisher. This should be a reverse domain-name style</span>
|
|
<span style="color:#898887"># string, e.g. com.mycompany.MyDocSet.documentation.</span>
|
|
<span style="color:#898887"># The default value is: org.doxygen.Publisher.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_DOCSET</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOCSET_PUBLISHER_ID</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> org.doxygen.Publisher</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DOCSET_PUBLISHER_NAME</span><span style="color:#898887"> tag identifies the documentation publisher.</span>
|
|
<span style="color:#898887"># The default value is: Publisher.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_DOCSET</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOCSET_PUBLISHER_NAME</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> Publisher</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_HTMLHELP</span><span style="color:#898887"> tag is set to YES then doxygen generates three</span>
|
|
<span style="color:#898887"># additional HTML index files: index.hhp, index.hhc, and index.hhk. The</span>
|
|
<span style="color:#898887"># index.hhp is a project file that can be read by Microsoft's HTML Help Workshop</span>
|
|
<span style="color:#898887"># (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on</span>
|
|
<span style="color:#898887"># Windows.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># The HTML Help Workshop contains a compiler that can convert all HTML output</span>
|
|
<span style="color:#898887"># generated by doxygen into a single compiled HTML file (.chm). Compiled HTML</span>
|
|
<span style="color:#898887"># files are now used as the Windows 98 help format, and will replace the old</span>
|
|
<span style="color:#898887"># Windows help format (.hlp) on all Windows platforms in the future. Compressed</span>
|
|
<span style="color:#898887"># HTML files also contain an index, a table of contents, and you can search for</span>
|
|
<span style="color:#898887"># words in the documentation. The HTML workshop also contains a viewer for</span>
|
|
<span style="color:#898887"># compressed HTML files.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_HTMLHELP</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">CHM_FILE</span><span style="color:#898887"> tag can be used to specify the file name of the resulting .chm</span>
|
|
<span style="color:#898887"># file. You can add a path in front of the file if the result should not be</span>
|
|
<span style="color:#898887"># written to the html output directory.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTMLHELP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">CHM_FILE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">HHC_LOCATION</span><span style="color:#898887"> tag can be used to specify the location (absolute path</span>
|
|
<span style="color:#898887"># including file name) of the HTML help compiler (hhc.exe). If non-empty,</span>
|
|
<span style="color:#898887"># doxygen will try to run the HTML help compiler on the generated index.hhp.</span>
|
|
<span style="color:#898887"># The file has to be specified with full path.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTMLHELP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">HHC_LOCATION</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">GENERATE_CHI</span><span style="color:#898887"> flag controls if a separate .chi index file is generated</span>
|
|
<span style="color:#898887"># (YES) or that it should be included in the master .chm file (NO).</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTMLHELP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_CHI</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">CHM_INDEX_ENCODING</span><span style="color:#898887"> is used to encode HtmlHelp index (hhk), content (hhc)</span>
|
|
<span style="color:#898887"># and project file content.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTMLHELP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">CHM_INDEX_ENCODING</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">BINARY_TOC</span><span style="color:#898887"> flag controls whether a binary table of contents is generated</span>
|
|
<span style="color:#898887"># (YES) or a normal table of contents (NO) in the .chm file. Furthermore it</span>
|
|
<span style="color:#898887"># enables the Previous and Next buttons.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTMLHELP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">BINARY_TOC</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">TOC_EXPAND</span><span style="color:#898887"> flag can be set to YES to add extra items for group members to</span>
|
|
<span style="color:#898887"># the table of contents of the HTML help documentation and to the tree view.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTMLHELP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">TOC_EXPAND</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_QHP</span><span style="color:#898887"> tag is set to YES and both </span><span style="color:#0095ff">QHP_NAMESPACE</span><span style="color:#898887"> and</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">QHP_VIRTUAL_FOLDER</span><span style="color:#898887"> are set, an additional index file will be generated that</span>
|
|
<span style="color:#898887"># can be used as </span><span style="color:#0095ff">input</span><span style="color:#898887"> for Qt's qhelpgenerator to generate a Qt Compressed Help</span>
|
|
<span style="color:#898887"># (.qch) of the generated HTML documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_QHP</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">QHG_LOCATION</span><span style="color:#898887"> tag is specified, the </span><span style="color:#0095ff">QCH_FILE</span><span style="color:#898887"> tag can be used to specify</span>
|
|
<span style="color:#898887"># the file name of the resulting .qch file. The path specified is relative to</span>
|
|
<span style="color:#898887"># the HTML output folder.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_QHP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">QCH_FILE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">QHP_NAMESPACE</span><span style="color:#898887"> tag specifies the namespace to use when generating Qt Help</span>
|
|
<span style="color:#898887"># Project output. For more information please see Qt Help Project / Namespace</span>
|
|
<span style="color:#898887"># (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).</span>
|
|
<span style="color:#898887"># The default value is: org.doxygen.Project.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_QHP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">QHP_NAMESPACE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> org.doxygen.Project</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">QHP_VIRTUAL_FOLDER</span><span style="color:#898887"> tag specifies the namespace to use when generating Qt</span>
|
|
<span style="color:#898887"># Help Project output. For more information please see Qt Help Project / Virtual</span>
|
|
<span style="color:#898887"># Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-</span>
|
|
<span style="color:#898887"># folders).</span>
|
|
<span style="color:#898887"># The default value is: doc.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_QHP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">QHP_VIRTUAL_FOLDER</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> doc</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">QHP_CUST_FILTER_NAME</span><span style="color:#898887"> tag is set, it specifies the name of a custom</span>
|
|
<span style="color:#898887"># filter to add. For more information please see Qt Help Project / Custom</span>
|
|
<span style="color:#898887"># Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-</span>
|
|
<span style="color:#898887"># filters).</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_QHP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">QHP_CUST_FILTER_NAME</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">QHP_CUST_FILTER_ATTRS</span><span style="color:#898887"> tag specifies the list of the attributes of the</span>
|
|
<span style="color:#898887"># custom filter to add. For more information please see Qt Help Project / Custom</span>
|
|
<span style="color:#898887"># Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-</span>
|
|
<span style="color:#898887"># filters).</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_QHP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">QHP_CUST_FILTER_ATTRS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">QHP_SECT_FILTER_ATTRS</span><span style="color:#898887"> tag specifies the list of the attributes this</span>
|
|
<span style="color:#898887"># project's filter section matches. Qt Help Project / Filter Attributes (see:</span>
|
|
<span style="color:#898887"># http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_QHP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">QHP_SECT_FILTER_ATTRS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">QHG_LOCATION</span><span style="color:#898887"> tag can be used to specify the location of Qt's</span>
|
|
<span style="color:#898887"># qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the</span>
|
|
<span style="color:#898887"># generated .qhp file.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_QHP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">QHG_LOCATION</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_ECLIPSEHELP</span><span style="color:#898887"> tag is set to YES, additional index files will be</span>
|
|
<span style="color:#898887"># generated, together with the HTML files, they form an Eclipse help plugin. To</span>
|
|
<span style="color:#898887"># install this plugin and make it available under the help contents menu in</span>
|
|
<span style="color:#898887"># Eclipse, the contents of the directory containing the HTML and XML files needs</span>
|
|
<span style="color:#898887"># to be copied into the plugins directory of eclipse. The name of the directory</span>
|
|
<span style="color:#898887"># within the plugins directory should be the same as the </span><span style="color:#0095ff">ECLIPSE_DOC_ID</span><span style="color:#898887"> value.</span>
|
|
<span style="color:#898887"># After copying Eclipse needs to be restarted before the help appears.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_ECLIPSEHELP</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># A unique identifier for the Eclipse help plugin. When installing the plugin</span>
|
|
<span style="color:#898887"># the directory name containing the HTML and XML files should also have this</span>
|
|
<span style="color:#898887"># name. Each documentation set should have its own identifier.</span>
|
|
<span style="color:#898887"># The default value is: org.doxygen.Project.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_ECLIPSEHELP</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">ECLIPSE_DOC_ID</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> org.doxygen.Project</span>
|
|
|
|
<span style="color:#898887"># If you want full control over the layout of the generated HTML pages it might</span>
|
|
<span style="color:#898887"># be necessary to disable the index and replace it with your own. The</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">DISABLE_INDEX</span><span style="color:#898887"> tag can be used to turn on/off the condensed index (tabs) at top</span>
|
|
<span style="color:#898887"># of each HTML page. A value of NO enables the index and the value YES disables</span>
|
|
<span style="color:#898887"># it. Since the tabs in the index contain the same information as the navigation</span>
|
|
<span style="color:#898887"># tree, you can set this option to YES if you also set </span><span style="color:#0095ff">GENERATE_TREEVIEW</span><span style="color:#898887"> to YES.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DISABLE_INDEX</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">GENERATE_TREEVIEW</span><span style="color:#898887"> tag is used to specify whether a tree-like index</span>
|
|
<span style="color:#898887"># structure should be generated to display hierarchical information. If the tag</span>
|
|
<span style="color:#898887"># value is set to YES, a side panel will be generated containing a tree-like</span>
|
|
<span style="color:#898887"># index structure (just like the one that is generated for HTML Help). For this</span>
|
|
<span style="color:#898887"># to work a browser that supports JavaScript, DHTML, CSS and frames is required</span>
|
|
<span style="color:#898887"># (i.e. any modern browser). Windows users are probably better off using the</span>
|
|
<span style="color:#898887"># HTML help feature. Via custom style sheets (see </span><span style="color:#0095ff">HTML_EXTRA_STYLESHEET</span><span style="color:#898887">) one can</span>
|
|
<span style="color:#898887"># further fine-tune the look of the index. As an example, the default style</span>
|
|
<span style="color:#898887"># sheet generated by doxygen has an example that shows how to put an image at</span>
|
|
<span style="color:#898887"># the root of the tree instead of the </span><span style="color:#0095ff">PROJECT_NAME</span><span style="color:#898887">. Since the tree basically has</span>
|
|
<span style="color:#898887"># the same information as the tab index, you could consider setting</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">DISABLE_INDEX</span><span style="color:#898887"> to YES when enabling this option.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_TREEVIEW</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">ENUM_VALUES_PER_LINE</span><span style="color:#898887"> tag can be used to set the number of enum values that</span>
|
|
<span style="color:#898887"># doxygen will group on one line in the generated HTML documentation.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that a value of 0 will completely suppress the enum values from appearing</span>
|
|
<span style="color:#898887"># in the overview section.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 20, default value: 4.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">ENUM_VALUES_PER_LINE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 4</span>
|
|
|
|
<span style="color:#898887"># If the treeview is enabled (see </span><span style="color:#0095ff">GENERATE_TREEVIEW</span><span style="color:#898887">) then this tag can be used</span>
|
|
<span style="color:#898887"># to set the initial width (in pixels) of the frame in which the tree is shown.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 1500, default value: 250.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">TREEVIEW_WIDTH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 250</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXT_LINKS_IN_WINDOW</span><span style="color:#898887"> option is set to YES, doxygen will open links to</span>
|
|
<span style="color:#898887"># external symbols imported via tag files in a separate window.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">EXT_LINKS_IN_WINDOW</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Use this tag to change the font size of LaTeX formulas included as images in</span>
|
|
<span style="color:#898887"># the HTML documentation. When you change the font size after a successful</span>
|
|
<span style="color:#898887"># doxygen run you need to manually remove any form_*.png images from the HTML</span>
|
|
<span style="color:#898887"># output directory to force them to be regenerated.</span>
|
|
<span style="color:#898887"># Minimum value: 8, maximum value: 50, default value: 10.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">FORMULA_FONTSIZE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 10</span>
|
|
|
|
<span style="color:#898887"># Use the FORMULA_TRANPARENT tag to determine whether or not the images</span>
|
|
<span style="color:#898887"># generated for formulas are transparent PNGs. Transparent PNGs are not</span>
|
|
<span style="color:#898887"># supported properly for IE 6.0, but are supported on all modern browsers.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that when changing this option you need to delete any form_*.png files in</span>
|
|
<span style="color:#898887"># the HTML output directory before the changes have effect.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">FORMULA_TRANSPARENT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># Enable the </span><span style="color:#0095ff">USE_MATHJAX</span><span style="color:#898887"> option to render LaTeX formulas using MathJax (see</span>
|
|
<span style="color:#898887"># http://www.mathjax.org) which uses client side Javascript for the rendering</span>
|
|
<span style="color:#898887"># instead of using pre-rendered bitmaps. Use this if you do not have LaTeX</span>
|
|
<span style="color:#898887"># installed or if you want to formulas look prettier in the HTML output. When</span>
|
|
<span style="color:#898887"># enabled you may also need to install MathJax separately and configure the path</span>
|
|
<span style="color:#898887"># to it using the </span><span style="color:#0095ff">MATHJAX_RELPATH</span><span style="color:#898887"> option.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">USE_MATHJAX</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># When MathJax is enabled you can set the default output format to be used for</span>
|
|
<span style="color:#898887"># the MathJax output. See the MathJax site (see:</span>
|
|
<span style="color:#898887"># http://docs.mathjax.org/en/latest/output.html) for more details.</span>
|
|
<span style="color:#898887"># Possible values are: HTML-CSS (which is slower, but has the best</span>
|
|
<span style="color:#898887"># compatibility), NativeMML (i.e. MathML) and SVG.</span>
|
|
<span style="color:#898887"># The default value is: HTML-CSS.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">USE_MATHJAX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MATHJAX_FORMAT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> HTML-CSS</span>
|
|
|
|
<span style="color:#898887"># When MathJax is enabled you need to specify the location relative to the HTML</span>
|
|
<span style="color:#898887"># output directory using the </span><span style="color:#0095ff">MATHJAX_RELPATH</span><span style="color:#898887"> option. The destination directory</span>
|
|
<span style="color:#898887"># should contain the MathJax.js script. For instance, if the mathjax directory</span>
|
|
<span style="color:#898887"># is located at the same level as the HTML output directory, then</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">MATHJAX_RELPATH</span><span style="color:#898887"> should be ../mathjax. The default value points to the MathJax</span>
|
|
<span style="color:#898887"># Content Delivery Network so you can quickly see the result without installing</span>
|
|
<span style="color:#898887"># MathJax. However, it is strongly recommended to install a local copy of</span>
|
|
<span style="color:#898887"># MathJax from http://www.mathjax.org before deployment.</span>
|
|
<span style="color:#898887"># The default value is: http://cdn.mathjax.org/mathjax/latest.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">USE_MATHJAX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MATHJAX_RELPATH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> http://cdn.mathjax.org/mathjax/latest</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MATHJAX_EXTENSIONS</span><span style="color:#898887"> tag can be used to specify one or more MathJax</span>
|
|
<span style="color:#898887"># extension names that should be enabled during MathJax rendering. For example</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">MATHJAX_EXTENSIONS</span><span style="color:#898887"> = TeX/AMSmath TeX/AMSsymbols</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">USE_MATHJAX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MATHJAX_EXTENSIONS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MATHJAX_CODEFILE</span><span style="color:#898887"> tag can be used to specify a file with javascript pieces</span>
|
|
<span style="color:#898887"># of code that will be used on startup of the MathJax code. See the MathJax site</span>
|
|
<span style="color:#898887"># (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an</span>
|
|
<span style="color:#898887"># example see the documentation.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">USE_MATHJAX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MATHJAX_CODEFILE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># When the </span><span style="color:#0095ff">SEARCHENGINE</span><span style="color:#898887"> tag is enabled doxygen will generate a search box for</span>
|
|
<span style="color:#898887"># the HTML output. The underlying search engine uses javascript and DHTML and</span>
|
|
<span style="color:#898887"># should work on any modern browser. Note that when using HTML help</span>
|
|
<span style="color:#898887"># (</span><span style="color:#0095ff">GENERATE_HTMLHELP</span><span style="color:#898887">), Qt help (</span><span style="color:#0095ff">GENERATE_QHP</span><span style="color:#898887">), or docsets (</span><span style="color:#0095ff">GENERATE_DOCSET</span><span style="color:#898887">)</span>
|
|
<span style="color:#898887"># there is already a search function so this one should typically be disabled.</span>
|
|
<span style="color:#898887"># For large projects the javascript based search engine can be slow, then</span>
|
|
<span style="color:#898887"># enabling </span><span style="color:#0095ff">SERVER_BASED_SEARCH</span><span style="color:#898887"> may provide a better solution. It is possible to</span>
|
|
<span style="color:#898887"># search using the keyboard; to jump to the search box use <access key> + S</span>
|
|
<span style="color:#898887"># (what the <access key> is depends on the OS and browser, but it is typically</span>
|
|
<span style="color:#898887"># <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down</span>
|
|
<span style="color:#898887"># key> to jump into the search results window, the results can be navigated</span>
|
|
<span style="color:#898887"># using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel</span>
|
|
<span style="color:#898887"># the search. The filter options can be selected when the cursor is inside the</span>
|
|
<span style="color:#898887"># search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys></span>
|
|
<span style="color:#898887"># to select a filter and <Enter> or <escape> to activate or cancel the filter</span>
|
|
<span style="color:#898887"># option.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_HTML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">SEARCHENGINE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># When the </span><span style="color:#0095ff">SERVER_BASED_SEARCH</span><span style="color:#898887"> tag is enabled the search engine will be</span>
|
|
<span style="color:#898887"># implemented using a web server instead of a web client using Javascript. There</span>
|
|
<span style="color:#898887"># are two flavors of web server based searching depending on the </span><span style="color:#0095ff">EXTERNAL_SEARCH</span>
|
|
<span style="color:#898887"># setting. When disabled, doxygen will generate a PHP script for searching and</span>
|
|
<span style="color:#898887"># an index file used by the script. When </span><span style="color:#0095ff">EXTERNAL_SEARCH</span><span style="color:#898887"> is enabled the indexing</span>
|
|
<span style="color:#898887"># and searching needs to be provided by external tools. See the section</span>
|
|
<span style="color:#898887"># "External Indexing and Searching" for details.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">SEARCHENGINE</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">SERVER_BASED_SEARCH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># When </span><span style="color:#0095ff">EXTERNAL_SEARCH</span><span style="color:#898887"> tag is enabled doxygen will no longer generate the PHP</span>
|
|
<span style="color:#898887"># script for searching. Instead the search results are written to an XML file</span>
|
|
<span style="color:#898887"># which needs to be processed by an external indexer. Doxygen will invoke an</span>
|
|
<span style="color:#898887"># external search engine pointed to by the </span><span style="color:#0095ff">SEARCHENGINE_URL</span><span style="color:#898887"> option to obtain the</span>
|
|
<span style="color:#898887"># search results.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Doxygen ships with an example indexer (doxyindexer) and search engine</span>
|
|
<span style="color:#898887"># (doxysearch.cgi) which are based on the open source search engine library</span>
|
|
<span style="color:#898887"># Xapian (see: http://xapian.org/).</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># See the section "External Indexing and Searching" for details.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">SEARCHENGINE</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">EXTERNAL_SEARCH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">SEARCHENGINE_URL</span><span style="color:#898887"> should point to a search engine hosted by a web server</span>
|
|
<span style="color:#898887"># which will return the search results when </span><span style="color:#0095ff">EXTERNAL_SEARCH</span><span style="color:#898887"> is enabled.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Doxygen ships with an example indexer (doxyindexer) and search engine</span>
|
|
<span style="color:#898887"># (doxysearch.cgi) which are based on the open source search engine library</span>
|
|
<span style="color:#898887"># Xapian (see: http://xapian.org/). See the section "External Indexing and</span>
|
|
<span style="color:#898887"># Searching" for details.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">SEARCHENGINE</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">SEARCHENGINE_URL</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># When </span><span style="color:#0095ff">SERVER_BASED_SEARCH</span><span style="color:#898887"> and </span><span style="color:#0095ff">EXTERNAL_SEARCH</span><span style="color:#898887"> are both enabled the unindexed</span>
|
|
<span style="color:#898887"># search data is written to a file for indexing by an external tool. With the</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">SEARCHDATA_FILE</span><span style="color:#898887"> tag the name of this file can be specified.</span>
|
|
<span style="color:#898887"># The default file is: searchdata.xml.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">SEARCHENGINE</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">SEARCHDATA_FILE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> searchdata.xml</span>
|
|
|
|
<span style="color:#898887"># When </span><span style="color:#0095ff">SERVER_BASED_SEARCH</span><span style="color:#898887"> and </span><span style="color:#0095ff">EXTERNAL_SEARCH</span><span style="color:#898887"> are both enabled the</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">EXTERNAL_SEARCH_ID</span><span style="color:#898887"> tag can be used as an identifier for the project. This is</span>
|
|
<span style="color:#898887"># useful in combination with </span><span style="color:#0095ff">EXTRA_SEARCH_MAPPINGS</span><span style="color:#898887"> to search through multiple</span>
|
|
<span style="color:#898887"># projects and redirect the results back to the right project.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">SEARCHENGINE</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">EXTERNAL_SEARCH_ID</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">EXTRA_SEARCH_MAPPINGS</span><span style="color:#898887"> tag can be used to enable searching through doxygen</span>
|
|
<span style="color:#898887"># projects other than the one defined by this configuration file, but that are</span>
|
|
<span style="color:#898887"># all added to the same external search index. Each project needs to have a</span>
|
|
<span style="color:#898887"># unique id set via </span><span style="color:#0095ff">EXTERNAL_SEARCH_ID</span><span style="color:#898887">. The search mapping then maps the id of</span>
|
|
<span style="color:#898887"># to a relative location where the documentation can be found. The format is:</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">EXTRA_SEARCH_MAPPINGS</span><span style="color:#898887"> = tagname1=loc1 tagname2=loc2 ...</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">SEARCHENGINE</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">EXTRA_SEARCH_MAPPINGS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the LaTeX output</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> tag is set to YES, doxygen will generate LaTeX output.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_LATEX</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">LATEX_OUTPUT</span><span style="color:#898887"> tag is used to specify where the LaTeX docs will be put. If a</span>
|
|
<span style="color:#898887"># relative path is entered the value of </span><span style="color:#0095ff">OUTPUT_DIRECTORY</span><span style="color:#898887"> will be put in front of</span>
|
|
<span style="color:#898887"># it.</span>
|
|
<span style="color:#898887"># The default directory is: latex.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_OUTPUT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> latex</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">LATEX_CMD_NAME</span><span style="color:#898887"> tag can be used to specify the LaTeX command name to be</span>
|
|
<span style="color:#898887"># invoked.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that when enabling </span><span style="color:#0095ff">USE_PDFLATEX</span><span style="color:#898887"> this option is only used for generating</span>
|
|
<span style="color:#898887"># bitmaps for formulas in the HTML output, but not in the Makefile that is</span>
|
|
<span style="color:#898887"># written to the output directory.</span>
|
|
<span style="color:#898887"># The default file is: latex.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_CMD_NAME</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> latex</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MAKEINDEX_CMD_NAME</span><span style="color:#898887"> tag can be used to specify the command name to generate</span>
|
|
<span style="color:#898887"># index for LaTeX.</span>
|
|
<span style="color:#898887"># The default file is: makeindex.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MAKEINDEX_CMD_NAME</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> makeindex</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">COMPACT_LATEX</span><span style="color:#898887"> tag is set to YES, doxygen generates more compact LaTeX</span>
|
|
<span style="color:#898887"># documents. This may be useful for small projects and may help to save some</span>
|
|
<span style="color:#898887"># trees in general.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">COMPACT_LATEX</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">PAPER_TYPE</span><span style="color:#898887"> tag can be used to set the paper type that is used by the</span>
|
|
<span style="color:#898887"># printer.</span>
|
|
<span style="color:#898887"># Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x</span>
|
|
<span style="color:#898887"># 14 inches) and executive (7.25 x 10.5 inches).</span>
|
|
<span style="color:#898887"># The default value is: a4.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">PAPER_TYPE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> a4</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">EXTRA_PACKAGES</span><span style="color:#898887"> tag can be used to specify one or more LaTeX package names</span>
|
|
<span style="color:#898887"># that should be included in the LaTeX output. The package can be specified just</span>
|
|
<span style="color:#898887"># by its name or with the correct syntax as to be used with the LaTeX</span>
|
|
<span style="color:#898887"># \usepackage command. To get the times font for instance you can specify :</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">EXTRA_PACKAGES</span><span style="color:#898887">=times or </span><span style="color:#0095ff">EXTRA_PACKAGES</span><span style="color:#898887">={times}</span>
|
|
<span style="color:#898887"># To use the option intlimits with the amsmath package you can specify:</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">EXTRA_PACKAGES</span><span style="color:#898887">=[intlimits]{amsmath}</span>
|
|
<span style="color:#898887"># If left blank no extra packages will be included.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">EXTRA_PACKAGES</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">LATEX_HEADER</span><span style="color:#898887"> tag can be used to specify a personal LaTeX header for the</span>
|
|
<span style="color:#898887"># generated LaTeX document. The header should contain everything until the first</span>
|
|
<span style="color:#898887"># chapter. If it is left blank doxygen will generate a standard header. See</span>
|
|
<span style="color:#898887"># section "Doxygen usage" for information on how to let doxygen write the</span>
|
|
<span style="color:#898887"># default header to a separate file.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note: Only use a user-defined header if you know what you are doing! The</span>
|
|
<span style="color:#898887"># following commands have a special meaning inside the header: $title,</span>
|
|
<span style="color:#898887"># $datetime, $date, $doxygenversion, $projectname, $projectnumber,</span>
|
|
<span style="color:#898887"># $projectbrief, $projectlogo. Doxygen will replace $title with the empty</span>
|
|
<span style="color:#898887"># string, for the replacement values of the other commands the user is referred</span>
|
|
<span style="color:#898887"># to </span><span style="color:#0095ff">HTML_HEADER</span><span style="color:#898887">.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_HEADER</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">LATEX_FOOTER</span><span style="color:#898887"> tag can be used to specify a personal LaTeX footer for the</span>
|
|
<span style="color:#898887"># generated LaTeX document. The footer should contain everything after the last</span>
|
|
<span style="color:#898887"># chapter. If it is left blank doxygen will generate a standard footer. See</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">LATEX_HEADER</span><span style="color:#898887"> for more information on how to generate a default footer and what</span>
|
|
<span style="color:#898887"># special commands can be used inside the footer.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note: Only use a user-defined footer if you know what you are doing!</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_FOOTER</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">LATEX_EXTRA_STYLESHEET</span><span style="color:#898887"> tag can be used to specify additional user-defined</span>
|
|
<span style="color:#898887"># LaTeX style sheets that are included after the standard style sheets created</span>
|
|
<span style="color:#898887"># by doxygen. Using this option one can overrule certain style aspects. Doxygen</span>
|
|
<span style="color:#898887"># will copy the style sheet files to the output directory.</span>
|
|
<span style="color:#898887"># Note: The order of the extra style sheet files is of importance (e.g. the last</span>
|
|
<span style="color:#898887"># style sheet in the list overrules the setting of the previous ones in the</span>
|
|
<span style="color:#898887"># list).</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_EXTRA_STYLESHEET</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">LATEX_EXTRA_FILES</span><span style="color:#898887"> tag can be used to specify one or more extra images or</span>
|
|
<span style="color:#898887"># other source files which should be copied to the </span><span style="color:#0095ff">LATEX_OUTPUT</span><span style="color:#898887"> output</span>
|
|
<span style="color:#898887"># directory. Note that the files will be copied as-is; there are no commands or</span>
|
|
<span style="color:#898887"># markers available.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_EXTRA_FILES</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">PDF_HYPERLINKS</span><span style="color:#898887"> tag is set to YES, the LaTeX that is generated is</span>
|
|
<span style="color:#898887"># prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will</span>
|
|
<span style="color:#898887"># contain links (just like the HTML output) instead of page references. This</span>
|
|
<span style="color:#898887"># makes the output suitable for online browsing using a PDF viewer.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">PDF_HYPERLINKS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">USE_PDFLATEX</span><span style="color:#898887"> tag is set to YES, doxygen will use pdflatex to generate</span>
|
|
<span style="color:#898887"># the PDF file directly from the LaTeX files. Set this option to YES, to get a</span>
|
|
<span style="color:#898887"># higher quality PDF documentation.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">USE_PDFLATEX</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">LATEX_BATCHMODE</span><span style="color:#898887"> tag is set to YES, doxygen will add the \batchmode</span>
|
|
<span style="color:#898887"># command to the generated LaTeX files. This will instruct LaTeX to keep running</span>
|
|
<span style="color:#898887"># if errors occur, instead of asking the user for help. This option is also used</span>
|
|
<span style="color:#898887"># when generating formulas in HTML.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_BATCHMODE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">LATEX_HIDE_INDICES</span><span style="color:#898887"> tag is set to YES then doxygen will not include the</span>
|
|
<span style="color:#898887"># index chapters (such as File Index, Compound Index, etc.) in the output.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_HIDE_INDICES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">LATEX_SOURCE_CODE</span><span style="color:#898887"> tag is set to YES then doxygen will include source</span>
|
|
<span style="color:#898887"># code with syntax highlighting in the LaTeX output.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that which sources are shown also depends on other settings such as</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">SOURCE_BROWSER</span><span style="color:#898887">.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_SOURCE_CODE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">LATEX_BIB_STYLE</span><span style="color:#898887"> tag can be used to specify the style to use for the</span>
|
|
<span style="color:#898887"># bibliography, e.g. plainnat, or ieeetr. See</span>
|
|
<span style="color:#898887"># http://en.wikipedia.org/wiki/BibTeX and \cite for more info.</span>
|
|
<span style="color:#898887"># The default value is: plain.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_BIB_STYLE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> plain</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">LATEX_TIMESTAMP</span><span style="color:#898887"> tag is set to YES then the footer of each generated</span>
|
|
<span style="color:#898887"># page will contain the date and time when the page was generated. Setting this</span>
|
|
<span style="color:#898887"># to NO can help when comparing the output of multiple runs.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_LATEX</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">LATEX_TIMESTAMP</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the RTF output</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_RTF</span><span style="color:#898887"> tag is set to YES, doxygen will generate RTF output. The</span>
|
|
<span style="color:#898887"># RTF output is optimized for Word 97 and may not look too pretty with other RTF</span>
|
|
<span style="color:#898887"># readers/editors.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_RTF</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">RTF_OUTPUT</span><span style="color:#898887"> tag is used to specify where the RTF docs will be put. If a</span>
|
|
<span style="color:#898887"># relative path is entered the value of </span><span style="color:#0095ff">OUTPUT_DIRECTORY</span><span style="color:#898887"> will be put in front of</span>
|
|
<span style="color:#898887"># it.</span>
|
|
<span style="color:#898887"># The default directory is: rtf.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_RTF</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">RTF_OUTPUT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> rtf</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">COMPACT_RTF</span><span style="color:#898887"> tag is set to YES, doxygen generates more compact RTF</span>
|
|
<span style="color:#898887"># documents. This may be useful for small projects and may help to save some</span>
|
|
<span style="color:#898887"># trees in general.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_RTF</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">COMPACT_RTF</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">RTF_HYPERLINKS</span><span style="color:#898887"> tag is set to YES, the RTF that is generated will</span>
|
|
<span style="color:#898887"># contain hyperlink fields. The RTF file will contain links (just like the HTML</span>
|
|
<span style="color:#898887"># output) instead of page references. This makes the output suitable for online</span>
|
|
<span style="color:#898887"># browsing using Word or some other Word compatible readers that support those</span>
|
|
<span style="color:#898887"># fields.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note: WordPad (write) and others do not support links.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_RTF</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">RTF_HYPERLINKS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Load stylesheet definitions from file. Syntax is similar to doxygen's config</span>
|
|
<span style="color:#898887"># file, i.e. a series of assignments. You only have to provide replacements,</span>
|
|
<span style="color:#898887"># missing definitions are set to their default value.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># See also section "Doxygen usage" for information on how to generate the</span>
|
|
<span style="color:#898887"># default style sheet that doxygen normally uses.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_RTF</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">RTF_STYLESHEET_FILE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># Set optional variables used in the generation of an RTF document. Syntax is</span>
|
|
<span style="color:#898887"># similar to doxygen's config file. A template extensions file can be generated</span>
|
|
<span style="color:#898887"># using doxygen -e rtf extensionFile.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_RTF</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">RTF_EXTENSIONS_FILE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">RTF_SOURCE_CODE</span><span style="color:#898887"> tag is set to YES then doxygen will include source code</span>
|
|
<span style="color:#898887"># with syntax highlighting in the RTF output.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that which sources are shown also depends on other settings such as</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">SOURCE_BROWSER</span><span style="color:#898887">.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_RTF</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">RTF_SOURCE_CODE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the man page output</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_MAN</span><span style="color:#898887"> tag is set to YES, doxygen will generate man pages for</span>
|
|
<span style="color:#898887"># classes and files.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_MAN</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MAN_OUTPUT</span><span style="color:#898887"> tag is used to specify where the man pages will be put. If a</span>
|
|
<span style="color:#898887"># relative path is entered the value of </span><span style="color:#0095ff">OUTPUT_DIRECTORY</span><span style="color:#898887"> will be put in front of</span>
|
|
<span style="color:#898887"># it. A directory man3 will be created inside the directory specified by</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">MAN_OUTPUT</span><span style="color:#898887">.</span>
|
|
<span style="color:#898887"># The default directory is: man.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_MAN</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MAN_OUTPUT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> man</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MAN_EXTENSION</span><span style="color:#898887"> tag determines the extension that is added to the generated</span>
|
|
<span style="color:#898887"># man pages. In case the manual section does not start with a number, the number</span>
|
|
<span style="color:#898887"># 3 is prepended. The dot (.) at the beginning of the </span><span style="color:#0095ff">MAN_EXTENSION</span><span style="color:#898887"> tag is</span>
|
|
<span style="color:#898887"># optional.</span>
|
|
<span style="color:#898887"># The default value is: .3.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_MAN</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MAN_EXTENSION</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> .3</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MAN_SUBDIR</span><span style="color:#898887"> tag determines the name of the directory created within</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">MAN_OUTPUT</span><span style="color:#898887"> in which the man pages are placed. If defaults to man followed by</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">MAN_EXTENSION</span><span style="color:#898887"> with the initial . removed.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_MAN</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MAN_SUBDIR</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">MAN_LINKS</span><span style="color:#898887"> tag is set to YES and doxygen generates man output, then it</span>
|
|
<span style="color:#898887"># will generate one additional man file for each entity documented in the real</span>
|
|
<span style="color:#898887"># man page(s). These additional files only source the real man page, but without</span>
|
|
<span style="color:#898887"># them the man command would be unable to find the correct page.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_MAN</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MAN_LINKS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the XML output</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_XML</span><span style="color:#898887"> tag is set to YES, doxygen will generate an XML file that</span>
|
|
<span style="color:#898887"># captures the structure of the code including all documentation.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_XML</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">XML_OUTPUT</span><span style="color:#898887"> tag is used to specify where the XML pages will be put. If a</span>
|
|
<span style="color:#898887"># relative path is entered the value of </span><span style="color:#0095ff">OUTPUT_DIRECTORY</span><span style="color:#898887"> will be put in front of</span>
|
|
<span style="color:#898887"># it.</span>
|
|
<span style="color:#898887"># The default directory is: xml.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_XML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">XML_OUTPUT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> xml</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">XML_PROGRAMLISTING</span><span style="color:#898887"> tag is set to YES, doxygen will dump the program</span>
|
|
<span style="color:#898887"># listings (including syntax highlighting and cross-referencing information) to</span>
|
|
<span style="color:#898887"># the XML output. Note that enabling this will significantly increase the size</span>
|
|
<span style="color:#898887"># of the XML output.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_XML</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">XML_PROGRAMLISTING</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the DOCBOOK output</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_DOCBOOK</span><span style="color:#898887"> tag is set to YES, doxygen will generate Docbook files</span>
|
|
<span style="color:#898887"># that can be used to generate PDF.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_DOCBOOK</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DOCBOOK_OUTPUT</span><span style="color:#898887"> tag is used to specify where the Docbook pages will be put.</span>
|
|
<span style="color:#898887"># If a relative path is entered the value of </span><span style="color:#0095ff">OUTPUT_DIRECTORY</span><span style="color:#898887"> will be put in</span>
|
|
<span style="color:#898887"># front of it.</span>
|
|
<span style="color:#898887"># The default directory is: docbook.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_DOCBOOK</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOCBOOK_OUTPUT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> docbook</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">DOCBOOK_PROGRAMLISTING</span><span style="color:#898887"> tag is set to YES, doxygen will include the</span>
|
|
<span style="color:#898887"># program listings (including syntax highlighting and cross-referencing</span>
|
|
<span style="color:#898887"># information) to the DOCBOOK output. Note that enabling this will significantly</span>
|
|
<span style="color:#898887"># increase the size of the DOCBOOK output.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_DOCBOOK</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOCBOOK_PROGRAMLISTING</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options for the AutoGen Definitions output</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_AUTOGEN_DEF</span><span style="color:#898887"> tag is set to YES, doxygen will generate an</span>
|
|
<span style="color:#898887"># AutoGen Definitions (see http://autogen.sf.net) file that captures the</span>
|
|
<span style="color:#898887"># structure of the code including all documentation. Note that this feature is</span>
|
|
<span style="color:#898887"># still experimental and incomplete at the moment.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_AUTOGEN_DEF</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the Perl module output</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_PERLMOD</span><span style="color:#898887"> tag is set to YES, doxygen will generate a Perl module</span>
|
|
<span style="color:#898887"># file that captures the structure of the code including all documentation.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that this feature is still experimental and incomplete at the moment.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_PERLMOD</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">PERLMOD_LATEX</span><span style="color:#898887"> tag is set to YES, doxygen will generate the necessary</span>
|
|
<span style="color:#898887"># Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI</span>
|
|
<span style="color:#898887"># output from the Perl module output.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_PERLMOD</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">PERLMOD_LATEX</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">PERLMOD_PRETTY</span><span style="color:#898887"> tag is set to YES, the Perl module output will be nicely</span>
|
|
<span style="color:#898887"># formatted so it can be parsed by a human reader. This is useful if you want to</span>
|
|
<span style="color:#898887"># understand what is going on. On the other hand, if this tag is set to NO, the</span>
|
|
<span style="color:#898887"># size of the Perl module output will be much smaller and Perl will parse it</span>
|
|
<span style="color:#898887"># just the same.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_PERLMOD</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">PERLMOD_PRETTY</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The names of the make variables in the generated doxyrules.make file are</span>
|
|
<span style="color:#898887"># prefixed with the string contained in </span><span style="color:#0095ff">PERLMOD_MAKEVAR_PREFIX</span><span style="color:#898887">. This is useful</span>
|
|
<span style="color:#898887"># so different doxyrules.make files included by the same Makefile don't</span>
|
|
<span style="color:#898887"># overwrite each other's variables.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">GENERATE_PERLMOD</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">PERLMOD_MAKEVAR_PREFIX</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the preprocessor</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> tag is set to YES, doxygen will evaluate all</span>
|
|
<span style="color:#898887"># C-preprocessor directives found in the sources and include files.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">ENABLE_PREPROCESSING</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">MACRO_EXPANSION</span><span style="color:#898887"> tag is set to YES, doxygen will expand all macro names</span>
|
|
<span style="color:#898887"># in the source code. If set to NO, only conditional compilation will be</span>
|
|
<span style="color:#898887"># performed. Macro expansion can be done in a controlled way by setting</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">EXPAND_ONLY_PREDEF</span><span style="color:#898887"> to YES.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MACRO_EXPANSION</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXPAND_ONLY_PREDEF</span><span style="color:#898887"> and </span><span style="color:#0095ff">MACRO_EXPANSION</span><span style="color:#898887"> tags are both set to YES then</span>
|
|
<span style="color:#898887"># the macro expansion is limited to the macros specified with the </span><span style="color:#0095ff">PREDEFINED</span><span style="color:#898887"> and</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">EXPAND_AS_DEFINED</span><span style="color:#898887"> tags.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">EXPAND_ONLY_PREDEF</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SEARCH_INCLUDES</span><span style="color:#898887"> tag is set to YES, the include files in the</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">INCLUDE_PATH</span><span style="color:#898887"> will be searched if a #include is found.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">SEARCH_INCLUDES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">INCLUDE_PATH</span><span style="color:#898887"> tag can be used to specify one or more directories that</span>
|
|
<span style="color:#898887"># contain include files that are not </span><span style="color:#0095ff">input</span><span style="color:#898887"> files but should be processed by the</span>
|
|
<span style="color:#898887"># preprocessor.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">SEARCH_INCLUDES</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">INCLUDE_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># You can use the </span><span style="color:#0095ff">INCLUDE_FILE_PATTERNS</span><span style="color:#898887"> tag to specify one or more wildcard</span>
|
|
<span style="color:#898887"># patterns (like *.h and *.hpp) to filter out the header-files in the</span>
|
|
<span style="color:#898887"># directories. If left blank, the patterns specified with </span><span style="color:#0095ff">FILE_PATTERNS</span><span style="color:#898887"> will be</span>
|
|
<span style="color:#898887"># used.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">INCLUDE_FILE_PATTERNS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">PREDEFINED</span><span style="color:#898887"> tag can be used to specify one or more macro names that are</span>
|
|
<span style="color:#898887"># defined before the preprocessor is started (similar to the -D option of e.g.</span>
|
|
<span style="color:#898887"># gcc). The argument of the tag is a list of macros of the form: name or</span>
|
|
<span style="color:#898887"># name=definition (no spaces). If the definition and the "=" are omitted, "=1"</span>
|
|
<span style="color:#898887"># is assumed. To prevent a macro definition from being undefined via #undef or</span>
|
|
<span style="color:#898887"># recursively expanded use the := operator instead of the = operator.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">PREDEFINED</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">MACRO_EXPANSION</span><span style="color:#898887"> and </span><span style="color:#0095ff">EXPAND_ONLY_PREDEF</span><span style="color:#898887"> tags are set to YES then this</span>
|
|
<span style="color:#898887"># tag can be used to specify a list of macro names that should be expanded. The</span>
|
|
<span style="color:#898887"># macro definition that is found in the sources will be used. Use the </span><span style="color:#0095ff">PREDEFINED</span>
|
|
<span style="color:#898887"># tag if you want to use a different macro definition that overrules the</span>
|
|
<span style="color:#898887"># definition found in the source code.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">EXPAND_AS_DEFINED</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">SKIP_FUNCTION_MACROS</span><span style="color:#898887"> tag is set to YES then doxygen's preprocessor will</span>
|
|
<span style="color:#898887"># remove all references to function-like macros that are alone on a line, have</span>
|
|
<span style="color:#898887"># an all uppercase name, and do not end with a semicolon. Such function macros</span>
|
|
<span style="color:#898887"># are typically used for boiler-plate code, and will confuse the parser if not</span>
|
|
<span style="color:#898887"># removed.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">SKIP_FUNCTION_MACROS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to external references</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">TAGFILES</span><span style="color:#898887"> tag can be used to specify one or more tag files. For each tag</span>
|
|
<span style="color:#898887"># file the location of the external documentation should be added. The format of</span>
|
|
<span style="color:#898887"># a tag file without this location is as follows:</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">TAGFILES</span><span style="color:#898887"> = file1 file2 ...</span>
|
|
<span style="color:#898887"># Adding location for the tag files is done as follows:</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">TAGFILES</span><span style="color:#898887"> = file1=loc1 "file2 = loc2" ...</span>
|
|
<span style="color:#898887"># where loc1 and loc2 can be relative or absolute paths or URLs. See the</span>
|
|
<span style="color:#898887"># section "Linking to external documentation" for more information about the use</span>
|
|
<span style="color:#898887"># of tag files.</span>
|
|
<span style="color:#898887"># Note: Each tag file must have a unique name (where the name does NOT include</span>
|
|
<span style="color:#898887"># the path). If a tag file is not located in the directory in which doxygen is</span>
|
|
<span style="color:#898887"># run, you must also specify the path to the tagfile here.</span>
|
|
|
|
<span style="font-weight:bold">TAGFILES</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># When a file name is specified after </span><span style="color:#0095ff">GENERATE_TAGFILE</span><span style="color:#898887">, doxygen will create a</span>
|
|
<span style="color:#898887"># tag file that is based on the </span><span style="color:#0095ff">input</span><span style="color:#898887"> files it reads. See section "Linking to</span>
|
|
<span style="color:#898887"># external documentation" for more information about the usage of tag files.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_TAGFILE</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">ALLEXTERNALS</span><span style="color:#898887"> tag is set to YES, all external class will be listed in</span>
|
|
<span style="color:#898887"># the class index. If set to NO, only the inherited external classes will be</span>
|
|
<span style="color:#898887"># listed.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">ALLEXTERNALS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXTERNAL_GROUPS</span><span style="color:#898887"> tag is set to YES, all external groups will be listed</span>
|
|
<span style="color:#898887"># in the modules index. If set to NO, only the current project's groups will be</span>
|
|
<span style="color:#898887"># listed.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">EXTERNAL_GROUPS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">EXTERNAL_PAGES</span><span style="color:#898887"> tag is set to YES, all external pages will be listed in</span>
|
|
<span style="color:#898887"># the related pages index. If set to NO, only the current project's pages will</span>
|
|
<span style="color:#898887"># be listed.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">EXTERNAL_PAGES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">PERL_PATH</span><span style="color:#898887"> should be the absolute path and name of the perl script</span>
|
|
<span style="color:#898887"># interpreter (i.e. the result of 'which perl').</span>
|
|
<span style="color:#898887"># The default file (with absolute path) is: /usr/bin/perl.</span>
|
|
|
|
<span style="font-weight:bold">PERL_PATH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> /usr/bin/perl</span>
|
|
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
<span style="color:#898887"># Configuration options related to the dot tool</span>
|
|
<span style="color:#898887">#---------------------------------------------------------------------------</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">CLASS_DIAGRAMS</span><span style="color:#898887"> tag is set to YES, doxygen will generate a class diagram</span>
|
|
<span style="color:#898887"># (in HTML and LaTeX) for classes with base or super classes. Setting the tag to</span>
|
|
<span style="color:#898887"># NO turns the diagrams off. Note that this option also works with </span><span style="color:#0095ff">HAVE_DOT</span>
|
|
<span style="color:#898887"># disabled, but it is recommended to install and use dot, since it yields more</span>
|
|
<span style="color:#898887"># powerful graphs.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">CLASS_DIAGRAMS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># You can define message sequence charts within doxygen comments using the \msc</span>
|
|
<span style="color:#898887"># command. Doxygen will then run the mscgen tool (see:</span>
|
|
<span style="color:#898887"># http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the</span>
|
|
<span style="color:#898887"># documentation. The </span><span style="color:#0095ff">MSCGEN_PATH</span><span style="color:#898887"> tag allows you to specify the directory where</span>
|
|
<span style="color:#898887"># the mscgen tool resides. If left empty the tool is assumed to be found in the</span>
|
|
<span style="color:#898887"># default search path.</span>
|
|
|
|
<span style="font-weight:bold">MSCGEN_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># You can include diagrams made with dia in doxygen documentation. Doxygen will</span>
|
|
<span style="color:#898887"># then run dia to produce the diagram and insert it in the documentation. The</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">DIA_PATH</span><span style="color:#898887"> tag allows you to specify the directory where the dia binary resides.</span>
|
|
<span style="color:#898887"># If left empty dia is assumed to be found in the default search path.</span>
|
|
|
|
<span style="font-weight:bold">DIA_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If set to YES the inheritance and collaboration graphs will hide inheritance</span>
|
|
<span style="color:#898887"># and usage relations if the target is undocumented or is not a class.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
|
|
<span style="font-weight:bold">HIDE_UNDOC_RELATIONS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If you set the </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> tag to YES then doxygen will assume the dot tool is</span>
|
|
<span style="color:#898887"># available from the path. This tool is part of Graphviz (see:</span>
|
|
<span style="color:#898887"># http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent</span>
|
|
<span style="color:#898887"># Bell Labs. The other options in this section have no effect if this option is</span>
|
|
<span style="color:#898887"># set to NO</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
|
|
<span style="font-weight:bold">HAVE_DOT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DOT_NUM_THREADS</span><span style="color:#898887"> specifies the number of dot invocations doxygen is allowed</span>
|
|
<span style="color:#898887"># to run in parallel. When set to 0 doxygen will base this on the number of</span>
|
|
<span style="color:#898887"># processors available in the system. You can set it explicitly to a value</span>
|
|
<span style="color:#898887"># larger than 0 to get control over the balance between CPU load and processing</span>
|
|
<span style="color:#898887"># speed.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 32, default value: 0.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_NUM_THREADS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 0</span>
|
|
|
|
<span style="color:#898887"># When you want a differently looking font in the dot files that doxygen</span>
|
|
<span style="color:#898887"># generates you can specify the font name using </span><span style="color:#0095ff">DOT_FONTNAME</span><span style="color:#898887">. You need to make</span>
|
|
<span style="color:#898887"># sure dot is able to find the font, which can be done by putting it in a</span>
|
|
<span style="color:#898887"># standard location or by setting the DOTFONTPATH environment variable or by</span>
|
|
<span style="color:#898887"># setting </span><span style="color:#0095ff">DOT_FONTPATH</span><span style="color:#898887"> to the directory containing the font.</span>
|
|
<span style="color:#898887"># The default value is: Helvetica.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_FONTNAME</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> Helvetica</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DOT_FONTSIZE</span><span style="color:#898887"> tag can be used to set the size (in points) of the font of</span>
|
|
<span style="color:#898887"># dot graphs.</span>
|
|
<span style="color:#898887"># Minimum value: 4, maximum value: 24, default value: 10.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_FONTSIZE</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 10</span>
|
|
|
|
<span style="color:#898887"># By default doxygen will tell dot to use the default font as specified with</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">DOT_FONTNAME</span><span style="color:#898887">. If you specify a different font using </span><span style="color:#0095ff">DOT_FONTNAME</span><span style="color:#898887"> you can set</span>
|
|
<span style="color:#898887"># the path where dot can find it using this tag.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_FONTPATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">CLASS_GRAPH</span><span style="color:#898887"> tag is set to YES then doxygen will generate a graph for</span>
|
|
<span style="color:#898887"># each documented class showing the direct and indirect inheritance relations.</span>
|
|
<span style="color:#898887"># Setting this tag to YES will force the </span><span style="color:#0095ff">CLASS_DIAGRAMS</span><span style="color:#898887"> tag to NO.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">CLASS_GRAPH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">COLLABORATION_GRAPH</span><span style="color:#898887"> tag is set to YES then doxygen will generate a</span>
|
|
<span style="color:#898887"># graph for each documented class showing the direct and indirect implementation</span>
|
|
<span style="color:#898887"># dependencies (inheritance, containment, and class references variables) of the</span>
|
|
<span style="color:#898887"># class with other documented classes.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">COLLABORATION_GRAPH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GROUP_GRAPHS</span><span style="color:#898887"> tag is set to YES then doxygen will generate a graph for</span>
|
|
<span style="color:#898887"># groups, showing the direct groups dependencies.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">GROUP_GRAPHS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">UML_LOOK</span><span style="color:#898887"> tag is set to YES, doxygen will generate inheritance and</span>
|
|
<span style="color:#898887"># collaboration diagrams in a style similar to the OMG's Unified Modeling</span>
|
|
<span style="color:#898887"># Language.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">UML_LOOK</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">UML_LOOK</span><span style="color:#898887"> tag is enabled, the fields and methods are shown inside the</span>
|
|
<span style="color:#898887"># class node. If there are many fields or methods and many nodes the graph may</span>
|
|
<span style="color:#898887"># become too big to be useful. The </span><span style="color:#0095ff">UML_LIMIT_NUM_FIELDS</span><span style="color:#898887"> threshold limits the</span>
|
|
<span style="color:#898887"># number of items for each type to make the size more manageable. Set this to 0</span>
|
|
<span style="color:#898887"># for no limit. Note that the threshold may be exceeded by 50% before the limit</span>
|
|
<span style="color:#898887"># is enforced. So when you set the threshold to 10, up to 15 fields may appear,</span>
|
|
<span style="color:#898887"># but if the number exceeds 15, the total amount of fields shown is limited to</span>
|
|
<span style="color:#898887"># 10.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 100, default value: 10.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">UML_LIMIT_NUM_FIELDS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 10</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">TEMPLATE_RELATIONS</span><span style="color:#898887"> tag is set to YES then the inheritance and</span>
|
|
<span style="color:#898887"># collaboration graphs will show the relations between templates and their</span>
|
|
<span style="color:#898887"># instances.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">TEMPLATE_RELATIONS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">INCLUDE_GRAPH</span><span style="color:#898887">, </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> and </span><span style="color:#0095ff">SEARCH_INCLUDES</span><span style="color:#898887"> tags are set to</span>
|
|
<span style="color:#898887"># YES then doxygen will generate a graph for each documented file showing the</span>
|
|
<span style="color:#898887"># direct and indirect include dependencies of the file with other documented</span>
|
|
<span style="color:#898887"># files.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">INCLUDE_GRAPH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">INCLUDED_BY_GRAPH</span><span style="color:#898887">, </span><span style="color:#0095ff">ENABLE_PREPROCESSING</span><span style="color:#898887"> and </span><span style="color:#0095ff">SEARCH_INCLUDES</span><span style="color:#898887"> tags are</span>
|
|
<span style="color:#898887"># set to YES then doxygen will generate a graph for each documented file showing</span>
|
|
<span style="color:#898887"># the direct and indirect include dependencies of the file with other documented</span>
|
|
<span style="color:#898887"># files.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">INCLUDED_BY_GRAPH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">CALL_GRAPH</span><span style="color:#898887"> tag is set to YES then doxygen will generate a call</span>
|
|
<span style="color:#898887"># dependency graph for every global function or class method.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that enabling this option will significantly increase the time of a run.</span>
|
|
<span style="color:#898887"># So in most cases it will be better to enable call graphs for selected</span>
|
|
<span style="color:#898887"># functions only using the \callgraph command. Disabling a call graph can be</span>
|
|
<span style="color:#898887"># accomplished by means of the command \hidecallgraph.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">CALL_GRAPH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">CALLER_GRAPH</span><span style="color:#898887"> tag is set to YES then doxygen will generate a caller</span>
|
|
<span style="color:#898887"># dependency graph for every global function or class method.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that enabling this option will significantly increase the time of a run.</span>
|
|
<span style="color:#898887"># So in most cases it will be better to enable caller graphs for selected</span>
|
|
<span style="color:#898887"># functions only using the \callergraph command. Disabling a caller graph can be</span>
|
|
<span style="color:#898887"># accomplished by means of the command \hidecallergraph.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">CALLER_GRAPH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GRAPHICAL_HIERARCHY</span><span style="color:#898887"> tag is set to YES then doxygen will graphical</span>
|
|
<span style="color:#898887"># hierarchy of all classes instead of a textual one.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">GRAPHICAL_HIERARCHY</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">DIRECTORY_GRAPH</span><span style="color:#898887"> tag is set to YES then doxygen will show the</span>
|
|
<span style="color:#898887"># dependencies a directory has on other directories in a graphical way. The</span>
|
|
<span style="color:#898887"># dependency relations are determined by the #include relations between the</span>
|
|
<span style="color:#898887"># files in the directories.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DIRECTORY_GRAPH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DOT_IMAGE_FORMAT</span><span style="color:#898887"> tag can be used to set the image format of the images</span>
|
|
<span style="color:#898887"># generated by dot. For an explanation of the image formats see the section</span>
|
|
<span style="color:#898887"># output formats in the documentation of the dot tool (Graphviz (see:</span>
|
|
<span style="color:#898887"># http://www.graphviz.org/)).</span>
|
|
<span style="color:#898887"># Note: If you choose svg you need to set </span><span style="color:#0095ff">HTML_FILE_EXTENSION</span><span style="color:#898887"> to xhtml in order</span>
|
|
<span style="color:#898887"># to make the SVG files visible in IE 9+ (other browsers do not have this</span>
|
|
<span style="color:#898887"># requirement).</span>
|
|
<span style="color:#898887"># Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,</span>
|
|
<span style="color:#898887"># png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and</span>
|
|
<span style="color:#898887"># png:gdiplus:gdiplus.</span>
|
|
<span style="color:#898887"># The default value is: png.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_IMAGE_FORMAT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> png</span>
|
|
|
|
<span style="color:#898887"># If </span><span style="color:#0095ff">DOT_IMAGE_FORMAT</span><span style="color:#898887"> is set to svg, then this option can be set to YES to</span>
|
|
<span style="color:#898887"># enable generation of interactive SVG images that allow zooming and panning.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Note that this requires a modern browser other than Internet Explorer. Tested</span>
|
|
<span style="color:#898887"># and working are Firefox, Chrome, Safari, and Opera.</span>
|
|
<span style="color:#898887"># Note: For IE 9+ you need to set </span><span style="color:#0095ff">HTML_FILE_EXTENSION</span><span style="color:#898887"> to xhtml in order to make</span>
|
|
<span style="color:#898887"># the SVG files visible. Older versions of IE do not have SVG support.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">INTERACTIVE_SVG</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DOT_PATH</span><span style="color:#898887"> tag can be used to specify the path where the dot tool can be</span>
|
|
<span style="color:#898887"># found. If left blank, it is assumed the dot tool can be found in the path.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DOTFILE_DIRS</span><span style="color:#898887"> tag can be used to specify one or more directories that</span>
|
|
<span style="color:#898887"># contain dot files that are included in the documentation (see the \dotfile</span>
|
|
<span style="color:#898887"># command).</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOTFILE_DIRS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MSCFILE_DIRS</span><span style="color:#898887"> tag can be used to specify one or more directories that</span>
|
|
<span style="color:#898887"># contain msc files that are included in the documentation (see the \mscfile</span>
|
|
<span style="color:#898887"># command).</span>
|
|
|
|
<span style="font-weight:bold">MSCFILE_DIRS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DIAFILE_DIRS</span><span style="color:#898887"> tag can be used to specify one or more directories that</span>
|
|
<span style="color:#898887"># contain dia files that are included in the documentation (see the \diafile</span>
|
|
<span style="color:#898887"># command).</span>
|
|
|
|
<span style="font-weight:bold">DIAFILE_DIRS</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># When using plantuml, the </span><span style="color:#0095ff">PLANTUML_JAR_PATH</span><span style="color:#898887"> tag should be used to specify the</span>
|
|
<span style="color:#898887"># path where java can find the plantuml.jar file. If left blank, it is assumed</span>
|
|
<span style="color:#898887"># PlantUML is not used or called during a preprocessing step. Doxygen will</span>
|
|
<span style="color:#898887"># generate a warning when it encounters a \startuml command in this case and</span>
|
|
<span style="color:#898887"># will not generate output for the diagram.</span>
|
|
|
|
<span style="font-weight:bold">PLANTUML_JAR_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># When using plantuml, the specified paths are searched for files specified by</span>
|
|
<span style="color:#898887"># the !include statement in a plantuml block.</span>
|
|
|
|
<span style="font-weight:bold">PLANTUML_INCLUDE_PATH</span> <span style="color:#ca60ca">=</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">DOT_GRAPH_MAX_NODES</span><span style="color:#898887"> tag can be used to set the maximum number of nodes</span>
|
|
<span style="color:#898887"># that will be shown in the graph. If the number of nodes in a graph becomes</span>
|
|
<span style="color:#898887"># larger than this value, doxygen will truncate the graph, which is visualized</span>
|
|
<span style="color:#898887"># by representing a node as a red box. Note that doxygen if the number of direct</span>
|
|
<span style="color:#898887"># children of the root node in a graph is already larger than</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">DOT_GRAPH_MAX_NODES</span><span style="color:#898887"> then the graph will not be shown at all. Also note that</span>
|
|
<span style="color:#898887"># the size of a graph can be further restricted by </span><span style="color:#0095ff">MAX_DOT_GRAPH_DEPTH</span><span style="color:#898887">.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 10000, default value: 50.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_GRAPH_MAX_NODES</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 50</span>
|
|
|
|
<span style="color:#898887"># The </span><span style="color:#0095ff">MAX_DOT_GRAPH_DEPTH</span><span style="color:#898887"> tag can be used to set the maximum depth of the graphs</span>
|
|
<span style="color:#898887"># generated by dot. A depth value of 3 means that only nodes reachable from the</span>
|
|
<span style="color:#898887"># root by following a path via at most 3 edges will be shown. Nodes that lay</span>
|
|
<span style="color:#898887"># further from the root node will be omitted. Note that setting this option to 1</span>
|
|
<span style="color:#898887"># or 2 may greatly reduce the computation time needed for large code bases. Also</span>
|
|
<span style="color:#898887"># note that the size of a graph can be further restricted by</span>
|
|
<span style="color:#898887"># </span><span style="color:#0095ff">DOT_GRAPH_MAX_NODES</span><span style="color:#898887">. Using a depth of 0 means no depth restriction.</span>
|
|
<span style="color:#898887"># Minimum value: 0, maximum value: 1000, default value: 0.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">MAX_DOT_GRAPH_DEPTH</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> 0</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">DOT_TRANSPARENT</span><span style="color:#898887"> tag to YES to generate images with a transparent</span>
|
|
<span style="color:#898887"># background. This is disabled by default, because dot on Windows does not seem</span>
|
|
<span style="color:#898887"># to support this out of the box.</span>
|
|
<span style="color:#898887">#</span>
|
|
<span style="color:#898887"># Warning: Depending on the platform used, enabling this option may lead to</span>
|
|
<span style="color:#898887"># badly anti-aliased labels on the edges of a graph (i.e. they become hard to</span>
|
|
<span style="color:#898887"># read).</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_TRANSPARENT</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># Set the </span><span style="color:#0095ff">DOT_MULTI_TARGETS</span><span style="color:#898887"> tag to YES to allow dot to generate multiple output</span>
|
|
<span style="color:#898887"># files in one run (i.e. multiple -o and -T options on the command line). This</span>
|
|
<span style="color:#898887"># makes dot run faster, but since only newer versions of dot (>1.8.10) support</span>
|
|
<span style="color:#898887"># this, this feature is disabled by default.</span>
|
|
<span style="color:#898887"># The default value is: NO.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_MULTI_TARGETS</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#bf0303">NO</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">GENERATE_LEGEND</span><span style="color:#898887"> tag is set to YES doxygen will generate a legend page</span>
|
|
<span style="color:#898887"># explaining the meaning of the various boxes and arrows in the dot generated</span>
|
|
<span style="color:#898887"># graphs.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">GENERATE_LEGEND</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
|
|
<span style="color:#898887"># If the </span><span style="color:#0095ff">DOT_CLEANUP</span><span style="color:#898887"> tag is set to YES, doxygen will remove the intermediate dot</span>
|
|
<span style="color:#898887"># files that are used to generate the various graphs.</span>
|
|
<span style="color:#898887"># The default value is: YES.</span>
|
|
<span style="color:#898887"># This tag requires that the tag </span><span style="color:#0095ff">HAVE_DOT</span><span style="color:#898887"> is set to YES.</span>
|
|
|
|
<span style="font-weight:bold">DOT_CLEANUP</span> <span style="color:#ca60ca">=</span><span style="color:#0057ae"> </span><span style="color:#006e28">YES</span>
|
|
</pre></body></html>
|