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