<divclass="line"><aname="l00003"></a><spanclass="lineno"> 3</span> <spanclass="preprocessor"># This file describes the settings to be used by the documentation system</span></div>
<divclass="line"><aname="l00004"></a><spanclass="lineno"> 4</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># doxygen (www.doxygen.org) for a project</span></div>
<divclass="line"><aname="l00006"></a><spanclass="lineno"> 6</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># All text after a hash (#) is considered a comment and will be ignored</span></div>
<divclass="line"><aname="l00007"></a><spanclass="lineno"> 7</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># The format is:</span></div>
<divclass="line"><aname="l00008"></a><spanclass="lineno"> 8</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># TAG = value [value, ...]</span></div>
<divclass="line"><aname="l00009"></a><spanclass="lineno"> 9</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># For lists items can also be appended using:</span></div>
<divclass="line"><aname="l00010"></a><spanclass="lineno"> 10</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># TAG += value [value, ...]</span></div>
<divclass="line"><aname="l00011"></a><spanclass="lineno"> 11</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Values that contain spaces should be placed between quotes ("")</span></div>
<divclass="line"><aname="l00017"></a><spanclass="lineno"> 17</span> <spanclass="preprocessor"># This tag specifies the encoding used for all characters in the config file </span></div>
<divclass="line"><aname="l00018"></a><spanclass="lineno"> 18</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># that follow. The default is UTF-8 which is also the encoding used for all </span></div>
<divclass="line"><aname="l00019"></a><spanclass="lineno"> 19</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># text before the first occurrence of this tag. Doxygen uses libiconv (or the </span></div>
<divclass="line"><aname="l00020"></a><spanclass="lineno"> 20</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># iconv built into libc) for the transcoding. See </span></div>
<divclass="line"><aname="l00021"></a><spanclass="lineno"> 21</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># http://www.gnu.org/software/libiconv for the list of possible encodings.</span></div>
<divclass="line"><aname="l00025"></a><spanclass="lineno"> 25</span> <spanclass="preprocessor"># The PROJECT_NAME tag is a single word (or sequence of words) that should </span></div>
<divclass="line"><aname="l00026"></a><spanclass="lineno"> 26</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># identify the project. Note that if you do not use Doxywizard you need </span></div>
<divclass="line"><aname="l00027"></a><spanclass="lineno"> 27</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># to put quotes around the project name if it contains spaces.</span></div>
<divclass="line"><aname="l00031"></a><spanclass="lineno"> 31</span> <spanclass="preprocessor"># The PROJECT_NUMBER tag can be used to enter a project or revision number. </span></div>
<divclass="line"><aname="l00032"></a><spanclass="lineno"> 32</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># This could be handy for archiving the generated documentation or </span></div>
<divclass="line"><aname="l00033"></a><spanclass="lineno"> 33</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># if some version control system is used.</span></div>
<divclass="line"><aname="l00037"></a><spanclass="lineno"> 37</span> <spanclass="preprocessor"># Using the PROJECT_BRIEF tag one can provide an optional one line description </span></div>
<divclass="line"><aname="l00038"></a><spanclass="lineno"> 38</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># for a project that appears at the top of each page and should give viewer </span></div>
<divclass="line"><aname="l00039"></a><spanclass="lineno"> 39</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># a quick idea about the purpose of the project. Keep the description short.</span></div>
<divclass="line"><aname="l00043"></a><spanclass="lineno"> 43</span> <spanclass="preprocessor"># With the PROJECT_LOGO tag one can specify an logo or icon that is </span></div>
<divclass="line"><aname="l00044"></a><spanclass="lineno"> 44</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># included in the documentation. The maximum height of the logo should not </span></div>
<divclass="line"><aname="l00045"></a><spanclass="lineno"> 45</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># exceed 55 pixels and the maximum width should not exceed 200 pixels. </span></div>
<divclass="line"><aname="l00046"></a><spanclass="lineno"> 46</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Doxygen will copy the logo to the output directory.</span></div>
<divclass="line"><aname="l00050"></a><spanclass="lineno"> 50</span> <spanclass="preprocessor"># The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) </span></div>
<divclass="line"><aname="l00051"></a><spanclass="lineno"> 51</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># base path where the generated documentation will be put. </span></div>
<divclass="line"><aname="l00052"></a><spanclass="lineno"> 52</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If a relative path is entered, it will be relative to the location </span></div>
<divclass="line"><aname="l00053"></a><spanclass="lineno"> 53</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># where doxygen was started. If left blank the current directory will be used.</span></div>
<divclass="line"><aname="l00057"></a><spanclass="lineno"> 57</span> # If the CREATE_SUBDIRS tag is <spanclass="keyword">set</span> to YES, then doxygen will create </div>
<divclass="line"><aname="l00058"></a><spanclass="lineno"> 58</span> <spanclass="preprocessor"># 4096 sub-directories (in 2 levels) under the output directory of each output </span></div>
<divclass="line"><aname="l00059"></a><spanclass="lineno"> 59</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># format and will distribute the generated files over these directories. </span></div>
<divclass="line"><aname="l00060"></a><spanclass="lineno"> 60</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Enabling this option can be useful when feeding doxygen a huge amount of </span></div>
<divclass="line"><aname="l00061"></a><spanclass="lineno"> 61</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># source files, where putting all generated files in the same directory would </span></div>
<divclass="line"><aname="l00062"></a><spanclass="lineno"> 62</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># otherwise cause performance problems for the file system.</span></div>
<divclass="line"><aname="l00066"></a><spanclass="lineno"> 66</span> <spanclass="preprocessor"># The OUTPUT_LANGUAGE tag is used to specify the language in which all </span></div>
<divclass="line"><aname="l00067"></a><spanclass="lineno"> 67</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation generated by doxygen is written. Doxygen will use this </span></div>
<divclass="line"><aname="l00068"></a><spanclass="lineno"> 68</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># information to generate all constant output in the proper language. </span></div>
<divclass="line"><aname="l00069"></a><spanclass="lineno"> 69</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># The default language is English, other supported languages are: </span></div>
<divclass="line"><aname="l00079"></a><spanclass="lineno"> 79</span> <spanclass="preprocessor"># If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will </span></div>
<divclass="line"><aname="l00080"></a><spanclass="lineno"> 80</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># include brief member descriptions after the members that are listed in </span></div>
<divclass="line"><aname="l00081"></a><spanclass="lineno"> 81</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the file and class documentation (similar to JavaDoc). </span></div>
<divclass="line"><aname="l00082"></a><spanclass="lineno"> 82</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Set to NO to disable this.</span></div>
<divclass="line"><aname="l00086"></a><spanclass="lineno"> 86</span> <spanclass="preprocessor"># If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend </span></div>
<divclass="line"><aname="l00087"></a><spanclass="lineno"> 87</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the brief description of a member or function before the detailed description. </span></div>
<divclass="line"><aname="l00088"></a><spanclass="lineno"> 88</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the </span></div>
<divclass="line"><aname="l00089"></a><spanclass="lineno"> 89</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># brief descriptions will be completely suppressed.</span></div>
<divclass="line"><aname="l00093"></a><spanclass="lineno"> 93</span> <spanclass="preprocessor"># This tag implements a quasi-intelligent brief description abbreviator </span></div>
<divclass="line"><aname="l00094"></a><spanclass="lineno"> 94</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># that is used to form the text in various listings. Each string </span></div>
<divclass="line"><aname="l00095"></a><spanclass="lineno"> 95</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># in this list, if found as the leading text of the brief description, will be </span></div>
<divclass="line"><aname="l00096"></a><spanclass="lineno"> 96</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># stripped from the text and the result after processing the whole list, is </span></div>
<divclass="line"><aname="l00097"></a><spanclass="lineno"> 97</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># used as the annotated text. Otherwise, the brief description is used as-is. </span></div>
<divclass="line"><aname="l00098"></a><spanclass="lineno"> 98</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If left blank, the following values are used ("$name" is automatically </span></div>
<divclass="line"><aname="l00099"></a><spanclass="lineno"> 99</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># replaced with the name of the entity): "The $name class""The $name widget"</span></div>
<divclass="line"><aname="l00115"></a><spanclass="lineno"> 115</span> <spanclass="preprocessor"># If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then </span></div>
<divclass="line"><aname="l00116"></a><spanclass="lineno"> 116</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Doxygen will generate a detailed section even if there is only a brief </span></div>
<divclass="line"><aname="l00121"></a><spanclass="lineno"> 121</span> <spanclass="preprocessor"># If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all </span></div>
<divclass="line"><aname="l00122"></a><spanclass="lineno"> 122</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># inherited members of a class in the documentation of that class as if those </span></div>
<divclass="line"><aname="l00123"></a><spanclass="lineno"> 123</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># members were ordinary class members. Constructors, destructors and assignment </span></div>
<divclass="line"><aname="l00124"></a><spanclass="lineno"> 124</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># operators of the base classes will not be shown.</span></div>
<divclass="line"><aname="l00128"></a><spanclass="lineno"> 128</span> <spanclass="preprocessor"># If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full </span></div>
<divclass="line"><aname="l00129"></a><spanclass="lineno"> 129</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># path before files name in the file list and in the header files. If set </span></div>
<divclass="line"><aname="l00130"></a><spanclass="lineno"> 130</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># to NO the shortest path that makes the file name unique will be used.</span></div>
<divclass="line"><aname="l00134"></a><spanclass="lineno"> 134</span> <spanclass="preprocessor"># If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag </span></div>
<divclass="line"><aname="l00135"></a><spanclass="lineno"> 135</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># can be used to strip a user-defined part of the path. Stripping is </span></div>
<divclass="line"><aname="l00136"></a><spanclass="lineno"> 136</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># only done if one of the specified strings matches the left-hand part of </span></div>
<divclass="line"><aname="l00137"></a><spanclass="lineno"> 137</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the path. The tag can be used to show relative paths in the file list. </span></div>
<divclass="line"><aname="l00138"></a><spanclass="lineno"> 138</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If left blank the directory from which doxygen is run is used as the </span></div>
<divclass="line"><aname="l00139"></a><spanclass="lineno"> 139</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># path to strip. Note that you specify absolute paths here, but also </span></div>
<divclass="line"><aname="l00140"></a><spanclass="lineno"> 140</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># relative paths, which will be relative from the directory where doxygen is </span></div>
<divclass="line"><aname="l00145"></a><spanclass="lineno"> 145</span> <spanclass="preprocessor"># The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of </span></div>
<divclass="line"><aname="l00146"></a><spanclass="lineno"> 146</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the path mentioned in the documentation of a class, which tells </span></div>
<divclass="line"><aname="l00147"></a><spanclass="lineno"> 147</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the reader which header file to include in order to use a class. </span></div>
<divclass="line"><aname="l00148"></a><spanclass="lineno"> 148</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If left blank only the name of the header file containing the class </span></div>
<divclass="line"><aname="l00149"></a><spanclass="lineno"> 149</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># definition is used. Otherwise one should specify the include paths that </span></div>
<divclass="line"><aname="l00150"></a><spanclass="lineno"> 150</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># are normally passed to the compiler using the -I flag.</span></div>
<divclass="line"><aname="l00154"></a><spanclass="lineno"> 154</span> <spanclass="preprocessor"># If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter </span></div>
<divclass="line"><aname="l00155"></a><spanclass="lineno"> 155</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># (but less readable) file names. This can be useful if your file system </span></div>
<divclass="line"><aname="l00156"></a><spanclass="lineno"> 156</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># doesn't support long names like on DOS, Mac, or CD-ROM.</span></div>
<divclass="line"><aname="l00160"></a><spanclass="lineno"> 160</span> <spanclass="preprocessor"># If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen </span></div>
<divclass="line"><aname="l00161"></a><spanclass="lineno"> 161</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will interpret the first line (until the first dot) of a JavaDoc-style </span></div>
<divclass="line"><aname="l00162"></a><spanclass="lineno"> 162</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># comment as the brief description. If set to NO, the JavaDoc </span></div>
<divclass="line"><aname="l00163"></a><spanclass="lineno"> 163</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># comments will behave just like regular Qt-style comments </span></div>
<divclass="line"><aname="l00164"></a><spanclass="lineno"> 164</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># (thus requiring an explicit @brief command for a brief description.)</span></div>
<divclass="line"><aname="l00168"></a><spanclass="lineno"> 168</span> <spanclass="preprocessor"># If the QT_AUTOBRIEF tag is set to YES then Doxygen will </span></div>
<divclass="line"><aname="l00169"></a><spanclass="lineno"> 169</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># interpret the first line (until the first dot) of a Qt-style </span></div>
<divclass="line"><aname="l00170"></a><spanclass="lineno"> 170</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># comment as the brief description. If set to NO, the comments </span></div>
<divclass="line"><aname="l00171"></a><spanclass="lineno"> 171</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will behave just like regular Qt-style comments (thus requiring </span></div>
<divclass="line"><aname="l00172"></a><spanclass="lineno"> 172</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># an explicit \brief command for a brief description.)</span></div>
<divclass="line"><aname="l00176"></a><spanclass="lineno"> 176</span> <spanclass="preprocessor"># The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen </span></div>
<divclass="line"><aname="l00177"></a><spanclass="lineno"> 177</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># treat a multi-line C++ special comment block (i.e. a block of </span></div>
<divclass="line"><aname="l00178"></a><spanclass="lineno"> 178</span> <spanclass="preprocessor"># comments) as a brief description. This used to be the default behaviour. </span></div>
<divclass="line"><aname="l00179"></a><spanclass="lineno"> 179</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># The new default is to treat a multi-line C++ comment block as a detailed </span></div>
<divclass="line"><aname="l00180"></a><spanclass="lineno"> 180</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># description. Set this tag to YES if you prefer the old behaviour instead.</span></div>
<divclass="line"><aname="l00184"></a><spanclass="lineno"> 184</span> <spanclass="preprocessor"># If the INHERIT_DOCS tag is set to YES (the default) then an undocumented </span></div>
<divclass="line"><aname="l00185"></a><spanclass="lineno"> 185</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># member inherits the documentation from any documented member that it </span></div>
<divclass="line"><aname="l00190"></a><spanclass="lineno"> 190</span> <spanclass="preprocessor"># If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce </span></div>
<divclass="line"><aname="l00191"></a><spanclass="lineno"> 191</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># a new page for each member. If set to NO, the documentation of a member will </span></div>
<divclass="line"><aname="l00192"></a><spanclass="lineno"> 192</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># be part of the file/class/namespace that contains it.</span></div>
<divclass="line"><aname="l00196"></a><spanclass="lineno"> 196</span> <spanclass="preprocessor"># The TAB_SIZE tag can be used to set the number of spaces in a tab. </span></div>
<divclass="line"><aname="l00197"></a><spanclass="lineno"> 197</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Doxygen uses this value to replace tabs by spaces in code fragments.</span></div>
<divclass="line"><aname="l00201"></a><spanclass="lineno"> 201</span> <spanclass="preprocessor"># This tag can be used to specify a number of aliases that acts </span></div>
<divclass="line"><aname="l00202"></a><spanclass="lineno"> 202</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># as commands in the documentation. An alias has the form "name=value". </span></div>
<divclass="line"><aname="l00203"></a><spanclass="lineno"> 203</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># For example adding "sideeffect=\par Side Effects:\n" will allow you to </span></div>
<divclass="line"><aname="l00204"></a><spanclass="lineno"> 204</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># put the command \sideeffect (or @sideeffect) in the documentation, which </span></div>
<divclass="line"><aname="l00205"></a><spanclass="lineno"> 205</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will result in a user-defined paragraph with heading "Side Effects:". </span></div>
<divclass="line"><aname="l00206"></a><spanclass="lineno"> 206</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># You can put \n's in the value part of an alias to insert newlines.</span></div>
<divclass="line"><aname="l00210"></a><spanclass="lineno"> 210</span> <spanclass="preprocessor"># This tag can be used to specify a number of word-keyword mappings (TCL only). </span></div>
<divclass="line"><aname="l00211"></a><spanclass="lineno"> 211</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># A mapping has the form "name=value". For example adding </span></div>
<divclass="line"><aname="l00212"></a><spanclass="lineno"> 212</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># "class=itcl::class" will allow you to use the command class in the </span></div>
<divclass="line"><aname="l00217"></a><spanclass="lineno"> 217</span> <spanclass="preprocessor"># Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C </span></div>
<divclass="line"><aname="l00218"></a><spanclass="lineno"> 218</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># sources only. Doxygen will then generate output that is more tailored for C. </span></div>
<divclass="line"><aname="l00219"></a><spanclass="lineno"> 219</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># For instance, some of the names that are used will be different. The list </span></div>
<divclass="line"><aname="l00220"></a><spanclass="lineno"> 220</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># of all members will be omitted, etc.</span></div>
<divclass="line"><aname="l00224"></a><spanclass="lineno"> 224</span> <spanclass="preprocessor"># Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java </span></div>
<divclass="line"><aname="l00225"></a><spanclass="lineno"> 225</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># sources only. Doxygen will then generate output that is more tailored for </span></div>
<divclass="line"><aname="l00226"></a><spanclass="lineno"> 226</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Java. For instance, namespaces will be presented as packages, qualified </span></div>
<divclass="line"><aname="l00227"></a><spanclass="lineno"> 227</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># scopes will look different, etc.</span></div>
<divclass="line"><aname="l00231"></a><spanclass="lineno"> 231</span> <spanclass="preprocessor"># Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran </span></div>
<divclass="line"><aname="l00232"></a><spanclass="lineno"> 232</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># sources only. Doxygen will then generate output that is more tailored for </span></div>
<divclass="line"><aname="l00237"></a><spanclass="lineno"> 237</span> <spanclass="preprocessor"># Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL </span></div>
<divclass="line"><aname="l00238"></a><spanclass="lineno"> 238</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># sources. Doxygen will then generate output that is tailored for </span></div>
<divclass="line"><aname="l00243"></a><spanclass="lineno"> 243</span> <spanclass="preprocessor"># Doxygen selects the parser to use depending on the extension of the files it </span></div>
<divclass="line"><aname="l00244"></a><spanclass="lineno"> 244</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># parses. With this tag you can assign which parser to use for a given </span></div>
<divclass="line"><aname="l00245"></a><spanclass="lineno"> 245</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># extension. Doxygen has a built-in mapping, but you can override or extend it </span></div>
<divclass="line"><aname="l00246"></a><spanclass="lineno"> 246</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># using this tag. The format is ext=language, where ext is a file extension, </span></div>
<divclass="line"><aname="l00247"></a><spanclass="lineno"> 247</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># and language is one of the parsers supported by doxygen: IDL, Java, </span></div>
<divclass="line"><aname="l00249"></a><spanclass="lineno"> 249</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># C++. For instance to make doxygen treat .inc files as Fortran files (default </span></div>
<divclass="line"><aname="l00250"></a><spanclass="lineno"> 250</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note </span></div>
<divclass="line"><aname="l00251"></a><spanclass="lineno"> 251</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># that for custom extensions you also need to set FILE_PATTERNS otherwise the </span></div>
<divclass="line"><aname="l00252"></a><spanclass="lineno"> 252</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># files are not read by doxygen.</span></div>
<divclass="line"><aname="l00256"></a><spanclass="lineno"> 256</span> <spanclass="preprocessor"># If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all </span></div>
<divclass="line"><aname="l00257"></a><spanclass="lineno"> 257</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># comments according to the Markdown format, which allows for more readable </span></div>
<divclass="line"><aname="l00258"></a><spanclass="lineno"> 258</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation. See http://daringfireball.net/projects/markdown/ for details. </span></div>
<divclass="line"><aname="l00259"></a><spanclass="lineno"> 259</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># The output of markdown processing is further processed by doxygen, so you </span></div>
<divclass="line"><aname="l00260"></a><spanclass="lineno"> 260</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># can mix doxygen, HTML, and XML commands with Markdown formatting. </span></div>
<divclass="line"><aname="l00261"></a><spanclass="lineno"> 261</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Disable only in case of backward compatibilities issues.</span></div>
<divclass="line"><aname="l00265"></a><spanclass="lineno"> 265</span> <spanclass="preprocessor"># When enabled doxygen tries to link words that correspond to documented classes, </span></div>
<divclass="line"><aname="l00266"></a><spanclass="lineno"> 266</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># or namespaces to their corresponding documentation. Such a link can be </span></div>
<divclass="line"><aname="l00267"></a><spanclass="lineno"> 267</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># prevented in individual cases by by putting a % sign in front of the word or </span></div>
<divclass="line"><aname="l00268"></a><spanclass="lineno"> 268</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># globally by setting AUTOLINK_SUPPORT to NO.</span></div>
<divclass="line"><aname="l00272"></a><spanclass="lineno"> 272</span> <spanclass="preprocessor"># If you use STL classes (i.e. std::string, std::vector, etc.) but do not want </span></div>
<divclass="line"><aname="l00273"></a><spanclass="lineno"> 273</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># to include (a tag file for) the STL sources as input, then you should </span></div>
<divclass="line"><aname="l00274"></a><spanclass="lineno"> 274</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># set this tag to YES in order to let doxygen match functions declarations and </span></div>
<divclass="line"><aname="l00276"></a><spanclass="lineno"> 276</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># func(std::string) {}). This also makes the inheritance and collaboration </span></div>
<divclass="line"><aname="l00277"></a><spanclass="lineno"> 277</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># diagrams that involve STL classes more complete and accurate.</span></div>
<divclass="line"><aname="l00281"></a><spanclass="lineno"> 281</span> <spanclass="preprocessor"># If you use Microsoft's C++/CLI language, you should set this option to YES to </span></div>
<divclass="line"><aname="l00286"></a><spanclass="lineno"> 286</span> <spanclass="preprocessor"># Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. </span></div>
<divclass="line"><aname="l00287"></a><spanclass="lineno"> 287</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Doxygen will parse them like normal C++ but will assume all classes use public </span></div>
<divclass="line"><aname="l00288"></a><spanclass="lineno"> 288</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># instead of private inheritance when no explicit protection keyword is present.</span></div>
<divclass="line"><aname="l00292"></a><spanclass="lineno"> 292</span> <spanclass="preprocessor"># For Microsoft's IDL there are propget and propput attributes to indicate</span></div>
<divclass="line"><aname="l00293"></a><spanclass="lineno"> 293</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># getter and setter methods for a property. Setting this option to YES (the</span></div>
<divclass="line"><aname="l00294"></a><spanclass="lineno"> 294</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># default) will make doxygen replace the get and set methods by a property in</span></div>
<divclass="line"><aname="l00295"></a><spanclass="lineno"> 295</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the documentation. This will only work if the methods are indeed getting or</span></div>
<divclass="line"><aname="l00296"></a><spanclass="lineno"> 296</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># setting a simple type. If this is not the case, or you want to show the</span></div>
<divclass="line"><aname="l00297"></a><spanclass="lineno"> 297</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># methods anyway, you should set this option to NO.</span></div>
<divclass="line"><aname="l00301"></a><spanclass="lineno"> 301</span> <spanclass="preprocessor"># If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC </span></div>
<divclass="line"><aname="l00302"></a><spanclass="lineno"> 302</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># tag is set to YES, then doxygen will reuse the documentation of the first </span></div>
<divclass="line"><aname="l00303"></a><spanclass="lineno"> 303</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># member in the group (if any) for the other members of the group. By default </span></div>
<divclass="line"><aname="l00304"></a><spanclass="lineno"> 304</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># all members of a group must be documented explicitly.</span></div>
<divclass="line"><aname="l00308"></a><spanclass="lineno"> 308</span> <spanclass="preprocessor"># Set the SUBGROUPING tag to YES (the default) to allow class member groups of </span></div>
<divclass="line"><aname="l00309"></a><spanclass="lineno"> 309</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the same type (for instance a group of public functions) to be put as a </span></div>
<divclass="line"><aname="l00310"></a><spanclass="lineno"> 310</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># subgroup of that type (e.g. under the Public Functions section). Set it to </span></div>
<divclass="line"><aname="l00311"></a><spanclass="lineno"> 311</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># NO to prevent subgrouping. Alternatively, this can be done per class using </span></div>
<divclass="line"><aname="l00312"></a><spanclass="lineno"> 312</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the \nosubgrouping command.</span></div>
<divclass="line"><aname="l00316"></a><spanclass="lineno"> 316</span> <spanclass="preprocessor"># When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and </span></div>
<divclass="line"><aname="l00317"></a><spanclass="lineno"> 317</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># unions are shown inside the group in which they are included (e.g. using </span></div>
<divclass="line"><aname="l00318"></a><spanclass="lineno"> 318</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># @ingroup) instead of on a separate page (for HTML and Man pages) or </span></div>
<divclass="line"><aname="l00319"></a><spanclass="lineno"> 319</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># section (for LaTeX and RTF).</span></div>
<divclass="line"><aname="l00323"></a><spanclass="lineno"> 323</span> <spanclass="preprocessor"># When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and </span></div>
<divclass="line"><aname="l00324"></a><spanclass="lineno"> 324</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># unions with only public data fields will be shown inline in the documentation </span></div>
<divclass="line"><aname="l00325"></a><spanclass="lineno"> 325</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># of the scope in which they are defined (i.e. file, namespace, or group </span></div>
<divclass="line"><aname="l00326"></a><spanclass="lineno"> 326</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation), provided this scope is documented. If set to NO (the default), </span></div>
<divclass="line"><aname="l00327"></a><spanclass="lineno"> 327</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># structs, classes, and unions are shown on a separate page (for HTML and Man </span></div>
<divclass="line"><aname="l00328"></a><spanclass="lineno"> 328</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># pages) or section (for LaTeX and RTF).</span></div>
<divclass="line"><aname="l00332"></a><spanclass="lineno"> 332</span> <spanclass="preprocessor"># When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum </span></div>
<divclass="line"><aname="l00333"></a><spanclass="lineno"> 333</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># is documented as struct, union, or enum with the name of the typedef. So </span></div>
<divclass="line"><aname="l00334"></a><spanclass="lineno"> 334</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># typedef struct TypeS {} TypeT, will appear in the documentation as a struct </span></div>
<divclass="line"><aname="l00335"></a><spanclass="lineno"> 335</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># with name TypeT. When disabled the typedef will appear as a member of a file, </span></div>
<divclass="line"><aname="l00336"></a><spanclass="lineno"> 336</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># namespace, or class. And the struct will be named TypeS. This can typically </span></div>
<divclass="line"><aname="l00337"></a><spanclass="lineno"> 337</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># be useful for C code in case the coding convention dictates that all compound </span></div>
<divclass="line"><aname="l00338"></a><spanclass="lineno"> 338</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># types are typedef'ed and only the typedef is referenced, never the tag name.</span></div>
<divclass="line"><aname="l00342"></a><spanclass="lineno"> 342</span> <spanclass="preprocessor"># The SYMBOL_CACHE_SIZE determines the size of the internal cache use to </span></div>
<divclass="line"><aname="l00343"></a><spanclass="lineno"> 343</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># determine which symbols to keep in memory and which to flush to disk. </span></div>
<divclass="line"><aname="l00344"></a><spanclass="lineno"> 344</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># When the cache is full, less often used symbols will be written to disk. </span></div>
<divclass="line"><aname="l00345"></a><spanclass="lineno"> 345</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># For small to medium size projects (<1000 input files) the default value is </span></div>
<divclass="line"><aname="l00346"></a><spanclass="lineno"> 346</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># probably good enough. For larger projects a too small cache size can cause </span></div>
<divclass="line"><aname="l00347"></a><spanclass="lineno"> 347</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># doxygen to be busy swapping symbols to and from disk most of the time </span></div>
<divclass="line"><aname="l00348"></a><spanclass="lineno"> 348</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># causing a significant performance penalty. </span></div>
<divclass="line"><aname="l00349"></a><spanclass="lineno"> 349</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If the system has enough physical memory increasing the cache will improve the </span></div>
<divclass="line"><aname="l00350"></a><spanclass="lineno"> 350</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># performance by keeping more symbols in memory. Note that the value works on </span></div>
<divclass="line"><aname="l00351"></a><spanclass="lineno"> 351</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># a logarithmic scale so increasing the size by one will roughly double the </span></div>
<divclass="line"><aname="l00352"></a><spanclass="lineno"> 352</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># memory usage. The cache size is given by this formula: </span></div>
<divclass="line"><aname="l00353"></a><spanclass="lineno"> 353</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, </span></div>
<divclass="line"><aname="l00354"></a><spanclass="lineno"> 354</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># corresponding to a cache size of 2^16 = 65536 symbols.</span></div>
<divclass="line"><aname="l00358"></a><spanclass="lineno"> 358</span> <spanclass="preprocessor"># Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be </span></div>
<divclass="line"><aname="l00359"></a><spanclass="lineno"> 359</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given </span></div>
<divclass="line"><aname="l00360"></a><spanclass="lineno"> 360</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># their name and scope. Since this can be an expensive process and often the </span></div>
<divclass="line"><aname="l00361"></a><spanclass="lineno"> 361</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># same symbol appear multiple times in the code, doxygen keeps a cache of </span></div>
<divclass="line"><aname="l00362"></a><spanclass="lineno"> 362</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># pre-resolved symbols. If the cache is too small doxygen will become slower. </span></div>
<divclass="line"><aname="l00363"></a><spanclass="lineno"> 363</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If the cache is too large, memory is wasted. The cache size is given by this </span></div>
<divclass="line"><aname="l00364"></a><spanclass="lineno"> 364</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, </span></div>
<divclass="line"><aname="l00365"></a><spanclass="lineno"> 365</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># corresponding to a cache size of 2^16 = 65536 symbols.</span></div>
<divclass="line"><aname="l00373"></a><spanclass="lineno"> 373</span> <spanclass="preprocessor"># If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in </span></div>
<divclass="line"><aname="l00374"></a><spanclass="lineno"> 374</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation are documented, even if no documentation was available. </span></div>
<divclass="line"><aname="l00375"></a><spanclass="lineno"> 375</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Private class members and static file members will be hidden unless </span></div>
<divclass="line"><aname="l00376"></a><spanclass="lineno"> 376</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES</span></div>
<divclass="line"><aname="l00380"></a><spanclass="lineno"> 380</span> <spanclass="preprocessor"># If the EXTRACT_PRIVATE tag is set to YES all private members of a class </span></div>
<divclass="line"><aname="l00381"></a><spanclass="lineno"> 381</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will be included in the documentation.</span></div>
<divclass="line"><aname="l00385"></a><spanclass="lineno"> 385</span> <spanclass="preprocessor"># If the EXTRACT_PACKAGE tag is set to YES all members with package or internal </span></div>
<divclass="line"><aname="l00386"></a><spanclass="lineno"> 386</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># scope will be included in the documentation.</span></div>
<divclass="line"><aname="l00390"></a><spanclass="lineno"> 390</span> <spanclass="preprocessor"># If the EXTRACT_STATIC tag is set to YES all static members of a file </span></div>
<divclass="line"><aname="l00391"></a><spanclass="lineno"> 391</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will be included in the documentation.</span></div>
<divclass="line"><aname="l00395"></a><spanclass="lineno"> 395</span> <spanclass="preprocessor"># If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) </span></div>
<divclass="line"><aname="l00396"></a><spanclass="lineno"> 396</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># defined locally in source files will be included in the documentation. </span></div>
<divclass="line"><aname="l00397"></a><spanclass="lineno"> 397</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO only classes defined in header files are included.</span></div>
<divclass="line"><aname="l00401"></a><spanclass="lineno"> 401</span> <spanclass="preprocessor"># This flag is only useful for Objective-C code. When set to YES local </span></div>
<divclass="line"><aname="l00402"></a><spanclass="lineno"> 402</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># methods, which are defined in the implementation section but not in </span></div>
<divclass="line"><aname="l00403"></a><spanclass="lineno"> 403</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the interface are included in the documentation. </span></div>
<divclass="line"><aname="l00404"></a><spanclass="lineno"> 404</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) only methods in the interface are included.</span></div>
<divclass="line"><aname="l00408"></a><spanclass="lineno"> 408</span> <spanclass="preprocessor"># If this flag is set to YES, the members of anonymous namespaces will be </span></div>
<divclass="line"><aname="l00409"></a><spanclass="lineno"> 409</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># extracted and appear in the documentation as a namespace called </span></div>
<divclass="line"><aname="l00410"></a><spanclass="lineno"> 410</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># 'anonymous_namespace{file}', where file will be replaced with the base </span></div>
<divclass="line"><aname="l00411"></a><spanclass="lineno"> 411</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># name of the file that contains the anonymous namespace. By default </span></div>
<divclass="line"><aname="l00412"></a><spanclass="lineno"> 412</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># anonymous namespaces are hidden.</span></div>
<divclass="line"><aname="l00416"></a><spanclass="lineno"> 416</span> <spanclass="preprocessor"># If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all </span></div>
<divclass="line"><aname="l00417"></a><spanclass="lineno"> 417</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># undocumented members of documented classes, files or namespaces. </span></div>
<divclass="line"><aname="l00418"></a><spanclass="lineno"> 418</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) these members will be included in the </span></div>
<divclass="line"><aname="l00419"></a><spanclass="lineno"> 419</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># various overviews, but no documentation section is generated. </span></div>
<divclass="line"><aname="l00420"></a><spanclass="lineno"> 420</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># This option has no effect if EXTRACT_ALL is enabled.</span></div>
<divclass="line"><aname="l00424"></a><spanclass="lineno"> 424</span> <spanclass="preprocessor"># If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all </span></div>
<divclass="line"><aname="l00425"></a><spanclass="lineno"> 425</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># undocumented classes that are normally visible in the class hierarchy. </span></div>
<divclass="line"><aname="l00426"></a><spanclass="lineno"> 426</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) these classes will be included in the various </span></div>
<divclass="line"><aname="l00427"></a><spanclass="lineno"> 427</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># overviews. This option has no effect if EXTRACT_ALL is enabled.</span></div>
<divclass="line"><aname="l00431"></a><spanclass="lineno"> 431</span> <spanclass="preprocessor"># If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all </span></div>
<divclass="line"><aname="l00433"></a><spanclass="lineno"> 433</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) these declarations will be included in the </span></div>
<divclass="line"><aname="l00438"></a><spanclass="lineno"> 438</span> <spanclass="preprocessor"># If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any </span></div>
<divclass="line"><aname="l00439"></a><spanclass="lineno"> 439</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation blocks found inside the body of a function. </span></div>
<divclass="line"><aname="l00440"></a><spanclass="lineno"> 440</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) these blocks will be appended to the </span></div>
<divclass="line"><aname="l00445"></a><spanclass="lineno"> 445</span> <spanclass="preprocessor"># The INTERNAL_DOCS tag determines if documentation </span></div>
<divclass="line"><aname="l00446"></a><spanclass="lineno"> 446</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># that is typed after a \internal command is included. If the tag is set </span></div>
<divclass="line"><aname="l00447"></a><spanclass="lineno"> 447</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># to NO (the default) then the documentation will be excluded. </span></div>
<divclass="line"><aname="l00448"></a><spanclass="lineno"> 448</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Set it to YES to include the internal documentation.</span></div>
<divclass="line"><aname="l00452"></a><spanclass="lineno"> 452</span> <spanclass="preprocessor"># If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate </span></div>
<divclass="line"><aname="l00453"></a><spanclass="lineno"> 453</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># file names in lower-case letters. If set to YES upper-case letters are also </span></div>
<divclass="line"><aname="l00454"></a><spanclass="lineno"> 454</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># allowed. This is useful if you have classes or files whose names only differ </span></div>
<divclass="line"><aname="l00455"></a><spanclass="lineno"> 455</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># in case and if your file system supports case sensitive file names. Windows </span></div>
<divclass="line"><aname="l00456"></a><spanclass="lineno"> 456</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># and Mac users are advised to set this option to NO.</span></div>
<divclass="line"><aname="l00460"></a><spanclass="lineno"> 460</span> <spanclass="preprocessor"># If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen </span></div>
<divclass="line"><aname="l00461"></a><spanclass="lineno"> 461</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will show members with their full class and namespace scopes in the </span></div>
<divclass="line"><aname="l00462"></a><spanclass="lineno"> 462</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation. If set to YES the scope will be hidden.</span></div>
<divclass="line"><aname="l00466"></a><spanclass="lineno"> 466</span> <spanclass="preprocessor"># If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen </span></div>
<divclass="line"><aname="l00467"></a><spanclass="lineno"> 467</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will put a list of the files that are included by a file in the documentation </span></div>
<divclass="line"><aname="l00468"></a><spanclass="lineno"> 468</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># of that file.</span></div>
<divclass="line"><aname="l00472"></a><spanclass="lineno"> 472</span> <spanclass="preprocessor"># If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen </span></div>
<divclass="line"><aname="l00473"></a><spanclass="lineno"> 473</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will list include files with double quotes in the documentation </span></div>
<divclass="line"><aname="l00474"></a><spanclass="lineno"> 474</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># rather than with sharp brackets.</span></div>
<divclass="line"><aname="l00478"></a><spanclass="lineno"> 478</span> <spanclass="preprocessor"># If the INLINE_INFO tag is set to YES (the default) then a tag [inline] </span></div>
<divclass="line"><aname="l00479"></a><spanclass="lineno"> 479</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># is inserted in the documentation for inline members.</span></div>
<divclass="line"><aname="l00483"></a><spanclass="lineno"> 483</span> <spanclass="preprocessor"># If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen </span></div>
<divclass="line"><aname="l00484"></a><spanclass="lineno"> 484</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will sort the (detailed) documentation of file and class members </span></div>
<divclass="line"><aname="l00485"></a><spanclass="lineno"> 485</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># alphabetically by member name. If set to NO the members will appear in </span></div>
<divclass="line"><aname="l00490"></a><spanclass="lineno"> 490</span> <spanclass="preprocessor"># If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the </span></div>
<divclass="line"><aname="l00491"></a><spanclass="lineno"> 491</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># brief documentation of file, namespace and class members alphabetically </span></div>
<divclass="line"><aname="l00492"></a><spanclass="lineno"> 492</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># by member name. If set to NO (the default) the members will appear in </span></div>
<divclass="line"><aname="l00497"></a><spanclass="lineno"> 497</span> <spanclass="preprocessor"># If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen </span></div>
<divclass="line"><aname="l00498"></a><spanclass="lineno"> 498</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will sort the (brief and detailed) documentation of class members so that </span></div>
<divclass="line"><aname="l00499"></a><spanclass="lineno"> 499</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># constructors and destructors are listed first. If set to NO (the default) </span></div>
<divclass="line"><aname="l00500"></a><spanclass="lineno"> 500</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the constructors will appear in the respective orders defined by </span></div>
<divclass="line"><aname="l00501"></a><spanclass="lineno"> 501</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. </span></div>
<divclass="line"><aname="l00502"></a><spanclass="lineno"> 502</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO </span></div>
<divclass="line"><aname="l00503"></a><spanclass="lineno"> 503</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.</span></div>
<divclass="line"><aname="l00507"></a><spanclass="lineno"> 507</span> <spanclass="preprocessor"># If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the </span></div>
<divclass="line"><aname="l00508"></a><spanclass="lineno"> 508</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># hierarchy of group names into alphabetical order. If set to NO (the default) </span></div>
<divclass="line"><aname="l00509"></a><spanclass="lineno"> 509</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the group names will appear in their defined order.</span></div>
<divclass="line"><aname="l00513"></a><spanclass="lineno"> 513</span> <spanclass="preprocessor"># If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be </span></div>
<divclass="line"><aname="l00514"></a><spanclass="lineno"> 514</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># sorted by fully-qualified names, including namespaces. If set to </span></div>
<divclass="line"><aname="l00515"></a><spanclass="lineno"> 515</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># NO (the default), the class list will be sorted only by class name, </span></div>
<divclass="line"><aname="l00516"></a><spanclass="lineno"> 516</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># not including the namespace part. </span></div>
<divclass="line"><aname="l00517"></a><spanclass="lineno"> 517</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. </span></div>
<divclass="line"><aname="l00518"></a><spanclass="lineno"> 518</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Note: This option applies only to the class list, not to the </span></div>
<divclass="line"><aname="l00523"></a><spanclass="lineno"> 523</span> <spanclass="preprocessor"># If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to </span></div>
<divclass="line"><aname="l00524"></a><spanclass="lineno"> 524</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># do proper type resolution of all parameters of a function it will reject a </span></div>
<divclass="line"><aname="l00525"></a><spanclass="lineno"> 525</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># match between the prototype and the implementation of a member function even </span></div>
<divclass="line"><aname="l00526"></a><spanclass="lineno"> 526</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># if there is only one candidate or it is obvious which candidate to choose </span></div>
<divclass="line"><aname="l00527"></a><spanclass="lineno"> 527</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen </span></div>
<divclass="line"><aname="l00528"></a><spanclass="lineno"> 528</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># will still accept a match between prototype and implementation in such cases.</span></div>
<divclass="line"><aname="l00532"></a><spanclass="lineno"> 532</span> <spanclass="preprocessor"># The GENERATE_TODOLIST tag can be used to enable (YES) or </span></div>
<divclass="line"><aname="l00533"></a><spanclass="lineno"> 533</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># disable (NO) the todo list. This list is created by putting \todo </span></div>
<divclass="line"><aname="l00534"></a><spanclass="lineno"> 534</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># commands in the documentation.</span></div>
<divclass="line"><aname="l00538"></a><spanclass="lineno"> 538</span> <spanclass="preprocessor"># The GENERATE_TESTLIST tag can be used to enable (YES) or </span></div>
<divclass="line"><aname="l00539"></a><spanclass="lineno"> 539</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># disable (NO) the test list. This list is created by putting \test </span></div>
<divclass="line"><aname="l00540"></a><spanclass="lineno"> 540</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># commands in the documentation.</span></div>
<divclass="line"><aname="l00544"></a><spanclass="lineno"> 544</span> <spanclass="preprocessor"># The GENERATE_BUGLIST tag can be used to enable (YES) or </span></div>
<divclass="line"><aname="l00545"></a><spanclass="lineno"> 545</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># disable (NO) the bug list. This list is created by putting \bug </span></div>
<divclass="line"><aname="l00546"></a><spanclass="lineno"> 546</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># commands in the documentation.</span></div>
<divclass="line"><aname="l00550"></a><spanclass="lineno"> 550</span> <spanclass="preprocessor"># The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or </span></div>
<divclass="line"><aname="l00551"></a><spanclass="lineno"> 551</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># disable (NO) the deprecated list. This list is created by putting </span></div>
<divclass="line"><aname="l00552"></a><spanclass="lineno"> 552</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># \deprecated commands in the documentation.</span></div>
<divclass="line"><aname="l00556"></a><spanclass="lineno"> 556</span> <spanclass="preprocessor"># The ENABLED_SECTIONS tag can be used to enable conditional </span></div>
<divclass="line"><aname="l00557"></a><spanclass="lineno"> 557</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation sections, marked by \if sectionname ... \endif.</span></div>
<divclass="line"><aname="l00561"></a><spanclass="lineno"> 561</span> <spanclass="preprocessor"># The MAX_INITIALIZER_LINES tag determines the maximum number of lines </span></div>
<divclass="line"><aname="l00562"></a><spanclass="lineno"> 562</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the initial value of a variable or macro consists of for it to appear in </span></div>
<divclass="line"><aname="l00563"></a><spanclass="lineno"> 563</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the documentation. If the initializer consists of more lines than specified </span></div>
<divclass="line"><aname="l00564"></a><spanclass="lineno"> 564</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># here it will be hidden. Use a value of 0 to hide initializers completely. </span></div>
<divclass="line"><aname="l00565"></a><spanclass="lineno"> 565</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># The appearance of the initializer of individual variables and macros in the </span></div>
<divclass="line"><aname="l00566"></a><spanclass="lineno"> 566</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation can be controlled using \showinitializer or \hideinitializer </span></div>
<divclass="line"><aname="l00567"></a><spanclass="lineno"> 567</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># command in the documentation regardless of this setting.</span></div>
<divclass="line"><aname="l00571"></a><spanclass="lineno"> 571</span> <spanclass="preprocessor"># Set the SHOW_USED_FILES tag to NO to disable the list of files generated </span></div>
<divclass="line"><aname="l00572"></a><spanclass="lineno"> 572</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># at the bottom of the documentation of classes and structs. If set to YES the </span></div>
<divclass="line"><aname="l00573"></a><spanclass="lineno"> 573</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># list will mention the files that were used to generate the documentation.</span></div>
<divclass="line"><aname="l00577"></a><spanclass="lineno"> 577</span> <spanclass="preprocessor"># Set the SHOW_FILES tag to NO to disable the generation of the Files page. </span></div>
<divclass="line"><aname="l00578"></a><spanclass="lineno"> 578</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># This will remove the Files entry from the Quick Index and from the </span></div>
<divclass="line"><aname="l00579"></a><spanclass="lineno"> 579</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Folder Tree View (if specified). The default is YES.</span></div>
<divclass="line"><aname="l00583"></a><spanclass="lineno"> 583</span> <spanclass="preprocessor"># Set the SHOW_NAMESPACES tag to NO to disable the generation of the </span></div>
<divclass="line"><aname="l00584"></a><spanclass="lineno"> 584</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Namespaces page. This will remove the Namespaces entry from the Quick Index </span></div>
<divclass="line"><aname="l00585"></a><spanclass="lineno"> 585</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># and from the Folder Tree View (if specified). The default is YES.</span></div>
<divclass="line"><aname="l00589"></a><spanclass="lineno"> 589</span> <spanclass="preprocessor"># The FILE_VERSION_FILTER tag can be used to specify a program or script that </span></div>
<divclass="line"><aname="l00590"></a><spanclass="lineno"> 590</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># doxygen should invoke to get the current version for each file (typically from </span></div>
<divclass="line"><aname="l00591"></a><spanclass="lineno"> 591</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the version control system). Doxygen will invoke the program by executing (via </span></div>
<divclass="line"><aname="l00592"></a><spanclass="lineno"> 592</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># popen()) the command <command><input-file>, where <command> is the value of </span></div>
<divclass="line"><aname="l00593"></a><spanclass="lineno"> 593</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file </span></div>
<divclass="line"><aname="l00594"></a><spanclass="lineno"> 594</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># provided by doxygen. Whatever the program writes to standard output </span></div>
<divclass="line"><aname="l00595"></a><spanclass="lineno"> 595</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># is used as the file version. See the manual for examples.</span></div>
<divclass="line"><aname="l00599"></a><spanclass="lineno"> 599</span> <spanclass="preprocessor"># The LAYOUT_FILE tag can be used to specify a layout file which will be parsed </span></div>
<divclass="line"><aname="l00600"></a><spanclass="lineno"> 600</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># by doxygen. The layout file controls the global structure of the generated </span></div>
<divclass="line"><aname="l00601"></a><spanclass="lineno"> 601</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># output files in an output format independent way. To create the layout file </span></div>
<divclass="line"><aname="l00602"></a><spanclass="lineno"> 602</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># that represents doxygen's defaults, run doxygen with the -l option. </span></div>
<divclass="line"><aname="l00603"></a><spanclass="lineno"> 603</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># You can optionally specify a file name after the option, if omitted </span></div>
<divclass="line"><aname="l00604"></a><spanclass="lineno"> 604</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># DoxygenLayout.xml will be used as the name of the layout file.</span></div>
<divclass="line"><aname="l00608"></a><spanclass="lineno"> 608</span> <spanclass="preprocessor"># The CITE_BIB_FILES tag can be used to specify one or more bib files </span></div>
<divclass="line"><aname="l00609"></a><spanclass="lineno"> 609</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># containing the references data. This must be a list of .bib files. The </span></div>
<divclass="line"><aname="l00610"></a><spanclass="lineno"> 610</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># .bib extension is automatically appended if omitted. Using this command </span></div>
<divclass="line"><aname="l00611"></a><spanclass="lineno"> 611</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># requires the bibtex tool to be installed. See also </span></div>
<divclass="line"><aname="l00612"></a><spanclass="lineno"> 612</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style </span></div>
<divclass="line"><aname="l00613"></a><spanclass="lineno"> 613</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># of the bibliography can be controlled using LATEX_BIB_STYLE. To use this </span></div>
<divclass="line"><aname="l00614"></a><spanclass="lineno"> 614</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># feature you need bibtex and perl available in the search path.</span></div>
<divclass="line"><aname="l00619"></a><spanclass="lineno"> 619</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># configuration options related to warning and progress messages</span></div>
<divclass="line"><aname="l00622"></a><spanclass="lineno"> 622</span> <spanclass="preprocessor"># The QUIET tag can be used to turn on/off the messages that are generated </span></div>
<divclass="line"><aname="l00623"></a><spanclass="lineno"> 623</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># by doxygen. Possible values are YES and NO. If left blank NO is used.</span></div>
<divclass="line"><aname="l00627"></a><spanclass="lineno"> 627</span> <spanclass="preprocessor"># The WARNINGS tag can be used to turn on/off the warning messages that are </span></div>
<divclass="line"><aname="l00628"></a><spanclass="lineno"> 628</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># generated by doxygen. Possible values are YES and NO. If left blank </span></div>
<divclass="line"><aname="l00629"></a><spanclass="lineno"> 629</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># NO is used.</span></div>
<divclass="line"><aname="l00633"></a><spanclass="lineno"> 633</span> <spanclass="preprocessor"># If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings </span></div>
<divclass="line"><aname="l00634"></a><spanclass="lineno"> 634</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># for undocumented members. If EXTRACT_ALL is set to YES then this flag will </span></div>
<divclass="line"><aname="l00635"></a><spanclass="lineno"> 635</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># automatically be disabled.</span></div>
<divclass="line"><aname="l00639"></a><spanclass="lineno"> 639</span> <spanclass="preprocessor"># If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for </span></div>
<divclass="line"><aname="l00640"></a><spanclass="lineno"> 640</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># potential errors in the documentation, such as not documenting some </span></div>
<divclass="line"><aname="l00641"></a><spanclass="lineno"> 641</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># parameters in a documented function, or documenting parameters that </span></div>
<divclass="line"><aname="l00642"></a><spanclass="lineno"> 642</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># don't exist or using markup commands wrongly.</span></div>
<divclass="line"><aname="l00646"></a><spanclass="lineno"> 646</span> <spanclass="preprocessor"># The WARN_NO_PARAMDOC option can be enabled to get warnings for </span></div>
<divclass="line"><aname="l00647"></a><spanclass="lineno"> 647</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># functions that are documented, but have no documentation for their parameters </span></div>
<divclass="line"><aname="l00648"></a><spanclass="lineno"> 648</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># or return value. If set to NO (the default) doxygen will only warn about </span></div>
<divclass="line"><aname="l00649"></a><spanclass="lineno"> 649</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># wrong or incomplete parameter documentation, but not about the absence of </span></div>
<divclass="line"><aname="l00654"></a><spanclass="lineno"> 654</span> <spanclass="preprocessor"># The WARN_FORMAT tag determines the format of the warning messages that </span></div>
<divclass="line"><aname="l00655"></a><spanclass="lineno"> 655</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># doxygen can produce. The string should contain the $file, $line, and $text </span></div>
<divclass="line"><aname="l00656"></a><spanclass="lineno"> 656</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># tags, which will be replaced by the file and line number from which the </span></div>
<divclass="line"><aname="l00657"></a><spanclass="lineno"> 657</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># warning originated and the warning text. Optionally the format may contain </span></div>
<divclass="line"><aname="l00658"></a><spanclass="lineno"> 658</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># $version, which will be replaced by the version of the file (if it could </span></div>
<divclass="line"><aname="l00659"></a><spanclass="lineno"> 659</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># be obtained via FILE_VERSION_FILTER)</span></div>
<divclass="line"><aname="l00663"></a><spanclass="lineno"> 663</span> <spanclass="preprocessor"># The WARN_LOGFILE tag can be used to specify a file to which warning </span></div>
<divclass="line"><aname="l00664"></a><spanclass="lineno"> 664</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># and error messages should be written. If left blank the output is written </span></div>
<divclass="line"><aname="l00665"></a><spanclass="lineno"> 665</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># to stderr.</span></div>
<divclass="line"><aname="l00670"></a><spanclass="lineno"> 670</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># configuration options related to the input files</span></div>
<divclass="line"><aname="l00673"></a><spanclass="lineno"> 673</span> <spanclass="preprocessor"># The INPUT tag can be used to specify the files and/or directories that contain </span></div>
<divclass="line"><aname="l00674"></a><spanclass="lineno"> 674</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># documented source files. You may enter file names like "myfile.cpp" or </span></div>
<divclass="line"><aname="l00675"></a><spanclass="lineno"> 675</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># directories like "/usr/src/myproject". Separate the files or directories </span></div>
<divclass="line"><aname="l00676"></a><spanclass="lineno"> 676</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># with spaces.</span></div>
<divclass="line"><aname="l00681"></a><spanclass="lineno"> 681</span> # This tag can be used to specify the character encoding of the source files </div>
<divclass="line"><aname="l00682"></a><spanclass="lineno"> 682</span> <spanclass="preprocessor"># that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is </span></div>
<divclass="line"><aname="l00683"></a><spanclass="lineno"> 683</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># also the default input encoding. Doxygen uses libiconv (or the iconv built </span></div>
<divclass="line"><aname="l00684"></a><spanclass="lineno"> 684</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># into libc) for the transcoding. See http://www.gnu.org/software/libiconv for </span></div>
<divclass="line"><aname="l00685"></a><spanclass="lineno"> 685</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># the list of possible encodings.</span></div>
<divclass="line"><aname="l00689"></a><spanclass="lineno"> 689</span> <spanclass="preprocessor"># If the value of the INPUT tag contains directories, you can use the </span></div>
<divclass="line"><aname="l00690"></a><spanclass="lineno"> 690</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp </span></div>
<divclass="line"><aname="l00691"></a><spanclass="lineno"> 691</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># and *.h) to filter out the source-files in the directories. If left </span></div>
<divclass="line"><aname="l00692"></a><spanclass="lineno"> 692</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># blank the following patterns are tested: </span></div>
<divclass="line"><aname="l00700"></a><spanclass="lineno"> 700</span> <spanclass="preprocessor"># The RECURSIVE tag can be used to turn specify whether or not subdirectories </span></div>
<divclass="line"><aname="l00701"></a><spanclass="lineno"> 701</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># should be searched for input files as well. Possible values are YES and NO. </span></div>
<divclass="line"><aname="l00702"></a><spanclass="lineno"> 702</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># If left blank NO is used.</span></div>
<divclass="line"><aname="l00706"></a><spanclass="lineno"> 706</span> <spanclass="preprocessor"># The EXCLUDE tag can be used to specify files and/or directories that should be </span></div>
<divclass="line"><aname="l00707"></a><spanclass="lineno"> 707</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># excluded from the INPUT source files. This way you can easily exclude a </span></div>
<divclass="line"><aname="l00708"></a><spanclass="lineno"> 708</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># subdirectory from a directory tree whose root is specified with the INPUT tag. </span></div>
<divclass="line"><aname="l00709"></a><spanclass="lineno"> 709</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># Note that relative paths are relative to the directory from which doxygen is </span></div>
<divclass="line"><aname="l00714"></a><spanclass="lineno"> 714</span> <spanclass="preprocessor"># The EXCLUDE_SYMLINKS tag can be used to select whether or not files or </span></div>
<divclass="line"><aname="l00715"></a><spanclass="lineno"> 715</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># directories that are symbolic links (a Unix file system feature) are excluded </span></div>
<divclass="line"><aname="l00716"></a><spanclass="lineno"> 716</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># from the input.</span></div>
<divclass="line"><aname="l00720"></a><spanclass="lineno"> 720</span> <spanclass="preprocessor"># If the value of the INPUT tag contains directories, you can use the </span></div>
<divclass="line"><aname="l00721"></a><spanclass="lineno"> 721</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude </span></div>
<divclass="line"><aname="l00722"></a><spanclass="lineno"> 722</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># certain files from those directories. Note that the wildcards are matched </span></div>
<divclass="line"><aname="l00723"></a><spanclass="lineno"> 723</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># against the file with absolute path, so to exclude all test directories </span></div>
<divclass="line"><aname="l00724"></a><spanclass="lineno"> 724</span> <spanclass="preprocessor"></span><spanclass="preprocessor"># for example use the pattern */test</span><spanclass="comment">/*</span></div>
<divclass="line"><aname="l00728"></a><spanclass="lineno"> 728</span> <spanclass="comment"># The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names </span></div>
<divclass="line"><aname="l00729"></a><spanclass="lineno"> 729</span> <spanclass="comment"># (namespaces, classes, functions, etc.) that should be excluded from the </span></div>
<divclass="line"><aname="l00730"></a><spanclass="lineno"> 730</span> <spanclass="comment"># output. The symbol name can be a fully qualified name, a word, or if the </span></div>
<divclass="line"><aname="l00731"></a><spanclass="lineno"> 731</span> <spanclass="comment"># wildcard * is used, a substring. Examples: ANamespace, AClass, </span></div>
<divclass="line"><aname="l00736"></a><spanclass="lineno"> 736</span> <spanclass="comment"># The EXAMPLE_PATH tag can be used to specify one or more files or </span></div>
<divclass="line"><aname="l00737"></a><spanclass="lineno"> 737</span> <spanclass="comment"># directories that contain example code fragments that are included (see </span></div>
<divclass="line"><aname="l00738"></a><spanclass="lineno"> 738</span> <spanclass="comment"># the \include command).</span></div>
<divclass="line"><aname="l00742"></a><spanclass="lineno"> 742</span> <spanclass="comment"># If the value of the EXAMPLE_PATH tag contains directories, you can use the </span></div>
<divclass="line"><aname="l00743"></a><spanclass="lineno"> 743</span> <spanclass="comment"># EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp </span></div>
<divclass="line"><aname="l00744"></a><spanclass="lineno"> 744</span> <spanclass="comment"># and *.h) to filter out the source-files in the directories. If left </span></div>
<divclass="line"><aname="l00745"></a><spanclass="lineno"> 745</span> <spanclass="comment"># blank all files are included.</span></div>
<divclass="line"><aname="l00749"></a><spanclass="lineno"> 749</span> <spanclass="comment"># If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be </span></div>
<divclass="line"><aname="l00750"></a><spanclass="lineno"> 750</span> <spanclass="comment"># searched for input files to be used with the \include or \dontinclude </span></div>
<divclass="line"><aname="l00751"></a><spanclass="lineno"> 751</span> <spanclass="comment"># commands irrespective of the value of the RECURSIVE tag. </span></div>
<divclass="line"><aname="l00752"></a><spanclass="lineno"> 752</span> <spanclass="comment"># Possible values are YES and NO. If left blank NO is used.</span></div>
<divclass="line"><aname="l00756"></a><spanclass="lineno"> 756</span> <spanclass="comment"># The IMAGE_PATH tag can be used to specify one or more files or </span></div>
<divclass="line"><aname="l00757"></a><spanclass="lineno"> 757</span> <spanclass="comment"># directories that contain image that are included in the documentation (see </span></div>
<divclass="line"><aname="l00758"></a><spanclass="lineno"> 758</span> <spanclass="comment"># the \image command).</span></div>
<divclass="line"><aname="l00762"></a><spanclass="lineno"> 762</span> <spanclass="comment"># The INPUT_FILTER tag can be used to specify a program that doxygen should </span></div>
<divclass="line"><aname="l00763"></a><spanclass="lineno"> 763</span> <spanclass="comment"># invoke to filter for each input file. Doxygen will invoke the filter program </span></div>
<divclass="line"><aname="l00764"></a><spanclass="lineno"> 764</span> <spanclass="comment"># by executing (via popen()) the command <filter><input-file>, where <filter></span></div>
<divclass="line"><aname="l00765"></a><spanclass="lineno"> 765</span> <spanclass="comment"># is the value of the INPUT_FILTER tag, and <input-file> is the name of an </span></div>
<divclass="line"><aname="l00766"></a><spanclass="lineno"> 766</span> <spanclass="comment"># input file. Doxygen will then use the output that the filter program writes </span></div>
<divclass="line"><aname="l00767"></a><spanclass="lineno"> 767</span> <spanclass="comment"># to standard output. If FILTER_PATTERNS is specified, this tag will be </span></div>
<divclass="line"><aname="l00772"></a><spanclass="lineno"> 772</span> <spanclass="comment"># The FILTER_PATTERNS tag can be used to specify filters on a per file pattern </span></div>
<divclass="line"><aname="l00773"></a><spanclass="lineno"> 773</span> <spanclass="comment"># basis. Doxygen will compare the file name with each pattern and apply the </span></div>
<divclass="line"><aname="l00774"></a><spanclass="lineno"> 774</span> <spanclass="comment"># filter if there is a match. The filters are a list of the form: </span></div>
<divclass="line"><aname="l00775"></a><spanclass="lineno"> 775</span> <spanclass="comment"># pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further </span></div>
<divclass="line"><aname="l00776"></a><spanclass="lineno"> 776</span> <spanclass="comment"># info on how filters are used. If FILTER_PATTERNS is empty or if </span></div>
<divclass="line"><aname="l00777"></a><spanclass="lineno"> 777</span> <spanclass="comment"># non of the patterns match the file name, INPUT_FILTER is applied.</span></div>
<divclass="line"><aname="l00781"></a><spanclass="lineno"> 781</span> <spanclass="comment"># If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using </span></div>
<divclass="line"><aname="l00782"></a><spanclass="lineno"> 782</span> <spanclass="comment"># INPUT_FILTER) will be used to filter the input files when producing source </span></div>
<divclass="line"><aname="l00783"></a><spanclass="lineno"> 783</span> <spanclass="comment"># files to browse (i.e. when SOURCE_BROWSER is set to YES).</span></div>
<divclass="line"><aname="l00787"></a><spanclass="lineno"> 787</span> <spanclass="comment"># The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file </span></div>
<divclass="line"><aname="l00788"></a><spanclass="lineno"> 788</span> <spanclass="comment"># pattern. A pattern will override the setting for FILTER_PATTERN (if any) </span></div>
<divclass="line"><aname="l00789"></a><spanclass="lineno"> 789</span> <spanclass="comment"># and it is also possible to disable source filtering for a specific pattern </span></div>
<divclass="line"><aname="l00790"></a><spanclass="lineno"> 790</span> <spanclass="comment"># using *.ext= (so without naming a filter). This option only has effect when </span></div>
<divclass="line"><aname="l00791"></a><spanclass="lineno"> 791</span> <spanclass="comment"># FILTER_SOURCE_FILES is enabled.</span></div>
<divclass="line"><aname="l00796"></a><spanclass="lineno"> 796</span> <spanclass="comment"># configuration options related to source browsing</span></div>
<divclass="line"><aname="l00799"></a><spanclass="lineno"> 799</span> <spanclass="comment"># If the SOURCE_BROWSER tag is set to YES then a list of source files will </span></div>
<divclass="line"><aname="l00800"></a><spanclass="lineno"> 800</span> <spanclass="comment"># be generated. Documented entities will be cross-referenced with these sources. </span></div>
<divclass="line"><aname="l00801"></a><spanclass="lineno"> 801</span> <spanclass="comment"># Note: To get rid of all source code in the generated output, make sure also </span></div>
<divclass="line"><aname="l00802"></a><spanclass="lineno"> 802</span> <spanclass="comment"># VERBATIM_HEADERS is set to NO.</span></div>
<divclass="line"><aname="l00806"></a><spanclass="lineno"> 806</span> <spanclass="comment"># Setting the INLINE_SOURCES tag to YES will include the body </span></div>
<divclass="line"><aname="l00807"></a><spanclass="lineno"> 807</span> <spanclass="comment"># of functions and classes directly in the documentation.</span></div>
<divclass="line"><aname="l00811"></a><spanclass="lineno"> 811</span> <spanclass="comment"># Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct </span></div>
<divclass="line"><aname="l00812"></a><spanclass="lineno"> 812</span> <spanclass="comment"># doxygen to hide any special comment blocks from generated source code </span></div>
<divclass="line"><aname="l00813"></a><spanclass="lineno"> 813</span> <spanclass="comment"># fragments. Normal C, C++ and Fortran comments will always remain visible.</span></div>
<divclass="line"><aname="l00817"></a><spanclass="lineno"> 817</span> <spanclass="comment"># If the REFERENCED_BY_RELATION tag is set to YES </span></div>
<divclass="line"><aname="l00818"></a><spanclass="lineno"> 818</span> <spanclass="comment"># then for each documented function all documented </span></div>
<divclass="line"><aname="l00819"></a><spanclass="lineno"> 819</span> <spanclass="comment"># functions referencing it will be listed.</span></div>
<divclass="line"><aname="l00823"></a><spanclass="lineno"> 823</span> <spanclass="comment"># If the REFERENCES_RELATION tag is set to YES </span></div>
<divclass="line"><aname="l00824"></a><spanclass="lineno"> 824</span> <spanclass="comment"># then for each documented function all documented entities </span></div>
<divclass="line"><aname="l00825"></a><spanclass="lineno"> 825</span> <spanclass="comment"># called/used by that function will be listed.</span></div>
<divclass="line"><aname="l00829"></a><spanclass="lineno"> 829</span> <spanclass="comment"># If the REFERENCES_LINK_SOURCE tag is set to YES (the default) </span></div>
<divclass="line"><aname="l00830"></a><spanclass="lineno"> 830</span> <spanclass="comment"># and SOURCE_BROWSER tag is set to YES, then the hyperlinks from </span></div>
<divclass="line"><aname="l00831"></a><spanclass="lineno"> 831</span> <spanclass="comment"># functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will </span></div>
<divclass="line"><aname="l00832"></a><spanclass="lineno"> 832</span> <spanclass="comment"># link to the source code. Otherwise they will link to the documentation.</span></div>
<divclass="line"><aname="l00836"></a><spanclass="lineno"> 836</span> <spanclass="comment"># If the USE_HTAGS tag is set to YES then the references to source code </span></div>
<divclass="line"><aname="l00837"></a><spanclass="lineno"> 837</span> <spanclass="comment"># will point to the HTML generated by the htags(1) tool instead of doxygen </span></div>
<divclass="line"><aname="l00838"></a><spanclass="lineno"> 838</span> <spanclass="comment"># built-in source browser. The htags tool is part of GNU's global source </span></div>
<divclass="line"><aname="l00839"></a><spanclass="lineno"> 839</span> <spanclass="comment"># tagging system (see http://www.gnu.org/software/global/global.html). You </span></div>
<divclass="line"><aname="l00840"></a><spanclass="lineno"> 840</span> <spanclass="comment"># will need version 4.8.6 or higher.</span></div>
<divclass="line"><aname="l00844"></a><spanclass="lineno"> 844</span> <spanclass="comment"># If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen </span></div>
<divclass="line"><aname="l00845"></a><spanclass="lineno"> 845</span> <spanclass="comment"># will generate a verbatim copy of the header file for each class for </span></div>
<divclass="line"><aname="l00846"></a><spanclass="lineno"> 846</span> <spanclass="comment"># which an include is specified. Set to NO to disable this.</span></div>
<divclass="line"><aname="l00851"></a><spanclass="lineno"> 851</span> <spanclass="comment"># configuration options related to the alphabetical class index</span></div>
<divclass="line"><aname="l00854"></a><spanclass="lineno"> 854</span> <spanclass="comment"># If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index </span></div>
<divclass="line"><aname="l00855"></a><spanclass="lineno"> 855</span> <spanclass="comment"># of all compounds will be generated. Enable this if the project </span></div>
<divclass="line"><aname="l00856"></a><spanclass="lineno"> 856</span> <spanclass="comment"># contains a lot of classes, structs, unions or interfaces.</span></div>
<divclass="line"><aname="l00860"></a><spanclass="lineno"> 860</span> <spanclass="comment"># If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then </span></div>
<divclass="line"><aname="l00861"></a><spanclass="lineno"> 861</span> <spanclass="comment"># the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns </span></div>
<divclass="line"><aname="l00862"></a><spanclass="lineno"> 862</span> <spanclass="comment"># in which this list will be split (can be a number in the range [1..20])</span></div>
<divclass="line"><aname="l00866"></a><spanclass="lineno"> 866</span> <spanclass="comment"># In case all classes in a project start with a common prefix, all </span></div>
<divclass="line"><aname="l00867"></a><spanclass="lineno"> 867</span> <spanclass="comment"># classes will be put under the same header in the alphabetical index. </span></div>
<divclass="line"><aname="l00868"></a><spanclass="lineno"> 868</span> <spanclass="comment"># The IGNORE_PREFIX tag can be used to specify one or more prefixes that </span></div>
<divclass="line"><aname="l00869"></a><spanclass="lineno"> 869</span> <spanclass="comment"># should be ignored while generating the index headers.</span></div>
<divclass="line"><aname="l00874"></a><spanclass="lineno"> 874</span> <spanclass="comment"># configuration options related to the HTML output</span></div>
<divclass="line"><aname="l00877"></a><spanclass="lineno"> 877</span> <spanclass="comment"># If the GENERATE_HTML tag is set to YES (the default) Doxygen will </span></div>
<divclass="line"><aname="l00878"></a><spanclass="lineno"> 878</span> <spanclass="comment"># generate HTML output.</span></div>
<divclass="line"><aname="l00882"></a><spanclass="lineno"> 882</span> <spanclass="comment"># The HTML_OUTPUT tag is used to specify where the HTML docs will be put. </span></div>
<divclass="line"><aname="l00883"></a><spanclass="lineno"> 883</span> <spanclass="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span></div>
<divclass="line"><aname="l00884"></a><spanclass="lineno"> 884</span> <spanclass="comment"># put in front of it. If left blank `html' will be used as the default path.</span></div>
<divclass="line"><aname="l00888"></a><spanclass="lineno"> 888</span> <spanclass="comment"># The HTML_FILE_EXTENSION tag can be used to specify the file extension for </span></div>
<divclass="line"><aname="l00889"></a><spanclass="lineno"> 889</span> <spanclass="comment"># each generated HTML page (for example: .htm,.php,.asp). If it is left blank </span></div>
<divclass="line"><aname="l00890"></a><spanclass="lineno"> 890</span> <spanclass="comment"># doxygen will generate files with .html extension.</span></div>
<divclass="line"><aname="l00894"></a><spanclass="lineno"> 894</span> <spanclass="comment"># The HTML_HEADER tag can be used to specify a personal HTML header for </span></div>
<divclass="line"><aname="l00895"></a><spanclass="lineno"> 895</span> <spanclass="comment"># each generated HTML page. If it is left blank doxygen will generate a </span></div>
<divclass="line"><aname="l00896"></a><spanclass="lineno"> 896</span> <spanclass="comment"># standard header. Note that when using a custom header you are responsible </span></div>
<divclass="line"><aname="l00897"></a><spanclass="lineno"> 897</span> <spanclass="comment"># for the proper inclusion of any scripts and style sheets that doxygen </span></div>
<divclass="line"><aname="l00898"></a><spanclass="lineno"> 898</span> <spanclass="comment"># needs, which is dependent on the configuration options used. </span></div>
<divclass="line"><aname="l00899"></a><spanclass="lineno"> 899</span> <spanclass="comment"># It is advised to generate a default header using "doxygen -w html </span></div>
<divclass="line"><aname="l00900"></a><spanclass="lineno"> 900</span> <spanclass="comment"># header.html footer.html stylesheet.css YourConfigFile" and then modify </span></div>
<divclass="line"><aname="l00901"></a><spanclass="lineno"> 901</span> <spanclass="comment"># that header. Note that the header is subject to change so you typically </span></div>
<divclass="line"><aname="l00902"></a><spanclass="lineno"> 902</span> <spanclass="comment"># have to redo this when upgrading to a newer version of doxygen or when </span></div>
<divclass="line"><aname="l00903"></a><spanclass="lineno"> 903</span> <spanclass="comment"># changing the value of configuration settings such as GENERATE_TREEVIEW!</span></div>
<divclass="line"><aname="l00907"></a><spanclass="lineno"> 907</span> <spanclass="comment"># The HTML_FOOTER tag can be used to specify a personal HTML footer for </span></div>
<divclass="line"><aname="l00908"></a><spanclass="lineno"> 908</span> <spanclass="comment"># each generated HTML page. If it is left blank doxygen will generate a </span></div>
<divclass="line"><aname="l00909"></a><spanclass="lineno"> 909</span> <spanclass="comment"># standard footer.</span></div>
<divclass="line"><aname="l00913"></a><spanclass="lineno"> 913</span> <spanclass="comment"># The HTML_STYLESHEET tag can be used to specify a user-defined cascading </span></div>
<divclass="line"><aname="l00914"></a><spanclass="lineno"> 914</span> <spanclass="comment"># style sheet that is used by each HTML page. It can be used to </span></div>
<divclass="line"><aname="l00915"></a><spanclass="lineno"> 915</span> <spanclass="comment"># fine-tune the look of the HTML output. If left blank doxygen will </span></div>
<divclass="line"><aname="l00916"></a><spanclass="lineno"> 916</span> <spanclass="comment"># generate a default style sheet. Note that it is recommended to use </span></div>
<divclass="line"><aname="l00917"></a><spanclass="lineno"> 917</span> <spanclass="comment"># HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this </span></div>
<divclass="line"><aname="l00918"></a><spanclass="lineno"> 918</span> <spanclass="comment"># tag will in the future become obsolete.</span></div>
<divclass="line"><aname="l00922"></a><spanclass="lineno"> 922</span> <spanclass="comment"># The HTML_EXTRA_STYLESHEET tag can be used to specify an additional </span></div>
<divclass="line"><aname="l00923"></a><spanclass="lineno"> 923</span> <spanclass="comment"># user-defined cascading style sheet that is included after the standard </span></div>
<divclass="line"><aname="l00924"></a><spanclass="lineno"> 924</span> <spanclass="comment"># style sheets created by doxygen. Using this option one can overrule </span></div>
<divclass="line"><aname="l00925"></a><spanclass="lineno"> 925</span> <spanclass="comment"># certain style aspects. This is preferred over using HTML_STYLESHEET </span></div>
<divclass="line"><aname="l00926"></a><spanclass="lineno"> 926</span> <spanclass="comment"># since it does not replace the standard style sheet and is therefor more </span></div>
<divclass="line"><aname="l00927"></a><spanclass="lineno"> 927</span> <spanclass="comment"># robust against future updates. Doxygen will copy the style sheet file to </span></div>
<divclass="line"><aname="l00928"></a><spanclass="lineno"> 928</span> <spanclass="comment"># the output directory.</span></div>
<divclass="line"><aname="l00932"></a><spanclass="lineno"> 932</span> <spanclass="comment"># The HTML_EXTRA_FILES tag can be used to specify one or more extra images or </span></div>
<divclass="line"><aname="l00933"></a><spanclass="lineno"> 933</span> <spanclass="comment"># other source files which should be copied to the HTML output directory. Note </span></div>
<divclass="line"><aname="l00934"></a><spanclass="lineno"> 934</span> <spanclass="comment"># that these files will be copied to the base HTML output directory. Use the </span></div>
<divclass="line"><aname="l00935"></a><spanclass="lineno"> 935</span> <spanclass="comment"># $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these </span></div>
<divclass="line"><aname="l00936"></a><spanclass="lineno"> 936</span> <spanclass="comment"># files. In the HTML_STYLESHEET file, use the file name only. Also note that </span></div>
<divclass="line"><aname="l00937"></a><spanclass="lineno"> 937</span> <spanclass="comment"># the files will be copied as-is; there are no commands or markers available.</span></div>
<divclass="line"><aname="l00941"></a><spanclass="lineno"> 941</span> <spanclass="comment"># The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. </span></div>
<divclass="line"><aname="l00942"></a><spanclass="lineno"> 942</span> <spanclass="comment"># Doxygen will adjust the colors in the style sheet and background images </span></div>
<divclass="line"><aname="l00943"></a><spanclass="lineno"> 943</span> <spanclass="comment"># according to this color. Hue is specified as an angle on a colorwheel, </span></div>
<divclass="line"><aname="l00944"></a><spanclass="lineno"> 944</span> <spanclass="comment"># see http://en.wikipedia.org/wiki/Hue for more information. </span></div>
<divclass="line"><aname="l00945"></a><spanclass="lineno"> 945</span> <spanclass="comment"># For instance the value 0 represents red, 60 is yellow, 120 is green, </span></div>
<divclass="line"><aname="l00946"></a><spanclass="lineno"> 946</span> <spanclass="comment"># 180 is cyan, 240 is blue, 300 purple, and 360 is red again. </span></div>
<divclass="line"><aname="l00947"></a><spanclass="lineno"> 947</span> <spanclass="comment"># The allowed range is 0 to 359.</span></div>
<divclass="line"><aname="l00951"></a><spanclass="lineno"> 951</span> <spanclass="comment"># The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of </span></div>
<divclass="line"><aname="l00952"></a><spanclass="lineno"> 952</span> <spanclass="comment"># the colors in the HTML output. For a value of 0 the output will use </span></div>
<divclass="line"><aname="l00953"></a><spanclass="lineno"> 953</span> <spanclass="comment"># grayscales only. A value of 255 will produce the most vivid colors.</span></div>
<divclass="line"><aname="l00957"></a><spanclass="lineno"> 957</span> <spanclass="comment"># The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to </span></div>
<divclass="line"><aname="l00958"></a><spanclass="lineno"> 958</span> <spanclass="comment"># the luminance component of the colors in the HTML output. Values below </span></div>
<divclass="line"><aname="l00959"></a><spanclass="lineno"> 959</span> <spanclass="comment"># 100 gradually make the output lighter, whereas values above 100 make </span></div>
<divclass="line"><aname="l00960"></a><spanclass="lineno"> 960</span> <spanclass="comment"># the output darker. The value divided by 100 is the actual gamma applied, </span></div>
<divclass="line"><aname="l00961"></a><spanclass="lineno"> 961</span> <spanclass="comment"># so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, </span></div>
<divclass="line"><aname="l00962"></a><spanclass="lineno"> 962</span> <spanclass="comment"># and 100 does not change the gamma.</span></div>
<divclass="line"><aname="l00966"></a><spanclass="lineno"> 966</span> <spanclass="comment"># If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML </span></div>
<divclass="line"><aname="l00967"></a><spanclass="lineno"> 967</span> <spanclass="comment"># page will contain the date and time when the page was generated. Setting </span></div>
<divclass="line"><aname="l00968"></a><spanclass="lineno"> 968</span> <spanclass="comment"># this to NO can help when comparing the output of multiple runs.</span></div>
<divclass="line"><aname="l00972"></a><spanclass="lineno"> 972</span> <spanclass="comment"># If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML </span></div>
<divclass="line"><aname="l00973"></a><spanclass="lineno"> 973</span> <spanclass="comment"># documentation will contain sections that can be hidden and shown after the </span></div>
<divclass="line"><aname="l00974"></a><spanclass="lineno"> 974</span> <spanclass="comment"># page has loaded.</span></div>
<divclass="line"><aname="l00978"></a><spanclass="lineno"> 978</span> <spanclass="comment"># With HTML_INDEX_NUM_ENTRIES one can control the preferred number of </span></div>
<divclass="line"><aname="l00979"></a><spanclass="lineno"> 979</span> <spanclass="comment"># entries shown in the various tree structured indices initially; the user </span></div>
<divclass="line"><aname="l00980"></a><spanclass="lineno"> 980</span> <spanclass="comment"># can expand and collapse entries dynamically later on. Doxygen will expand </span></div>
<divclass="line"><aname="l00981"></a><spanclass="lineno"> 981</span> <spanclass="comment"># the tree to such a level that at most the specified number of entries are </span></div>
<divclass="line"><aname="l00982"></a><spanclass="lineno"> 982</span> <spanclass="comment"># visible (unless a fully collapsed tree already exceeds this amount). </span></div>
<divclass="line"><aname="l00983"></a><spanclass="lineno"> 983</span> <spanclass="comment"># So setting the number of entries 1 will produce a full collapsed tree by </span></div>
<divclass="line"><aname="l00984"></a><spanclass="lineno"> 984</span> <spanclass="comment"># default. 0 is a special value representing an infinite number of entries </span></div>
<divclass="line"><aname="l00985"></a><spanclass="lineno"> 985</span> <spanclass="comment"># and will result in a full expanded tree by default.</span></div>
<divclass="line"><aname="l00989"></a><spanclass="lineno"> 989</span> <spanclass="comment"># If the GENERATE_DOCSET tag is set to YES, additional index files </span></div>
<divclass="line"><aname="l00990"></a><spanclass="lineno"> 990</span> <spanclass="comment"># will be generated that can be used as input for Apple's Xcode 3 </span></div>
<divclass="line"><aname="l00991"></a><spanclass="lineno"> 991</span> <spanclass="comment"># integrated development environment, introduced with OSX 10.5 (Leopard). </span></div>
<divclass="line"><aname="l00992"></a><spanclass="lineno"> 992</span> <spanclass="comment"># To create a documentation set, doxygen will generate a Makefile in the </span></div>
<divclass="line"><aname="l00993"></a><spanclass="lineno"> 993</span> <spanclass="comment"># HTML output directory. Running make will produce the docset in that </span></div>
<divclass="line"><aname="l00994"></a><spanclass="lineno"> 994</span> <spanclass="comment"># directory and running "make install" will install the docset in </span></div>
<divclass="line"><aname="l00995"></a><spanclass="lineno"> 995</span> <spanclass="comment"># ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find </span></div>
<divclass="line"><aname="l00996"></a><spanclass="lineno"> 996</span> <spanclass="comment"># it at startup. </span></div>
<divclass="line"><aname="l00997"></a><spanclass="lineno"> 997</span> <spanclass="comment"># See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html </span></div>
<divclass="line"><aname="l00998"></a><spanclass="lineno"> 998</span> <spanclass="comment"># for more information.</span></div>
<divclass="line"><aname="l01002"></a><spanclass="lineno"> 1002</span> <spanclass="comment"># When GENERATE_DOCSET tag is set to YES, this tag determines the name of the </span></div>
<divclass="line"><aname="l01003"></a><spanclass="lineno"> 1003</span> <spanclass="comment"># feed. A documentation feed provides an umbrella under which multiple </span></div>
<divclass="line"><aname="l01004"></a><spanclass="lineno"> 1004</span> <spanclass="comment"># documentation sets from a single provider (such as a company or product suite) </span></div>
<divclass="line"><aname="l01005"></a><spanclass="lineno"> 1005</span> <spanclass="comment"># can be grouped.</span></div>
<divclass="line"><aname="l01009"></a><spanclass="lineno"> 1009</span> <spanclass="comment"># When GENERATE_DOCSET tag is set to YES, this tag specifies a string that </span></div>
<divclass="line"><aname="l01010"></a><spanclass="lineno"> 1010</span> <spanclass="comment"># should uniquely identify the documentation set bundle. This should be a </span></div>
<divclass="line"><aname="l01011"></a><spanclass="lineno"> 1011</span> <spanclass="comment"># reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen </span></div>
<divclass="line"><aname="l01012"></a><spanclass="lineno"> 1012</span> <spanclass="comment"># will append .docset to the name.</span></div>
<divclass="line"><aname="l01016"></a><spanclass="lineno"> 1016</span> <spanclass="comment"># When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely </span></div>
<divclass="line"><aname="l01017"></a><spanclass="lineno"> 1017</span> <spanclass="comment"># identify the documentation publisher. This should be a reverse domain-name </span></div>
<divclass="line"><aname="l01018"></a><spanclass="lineno"> 1018</span> <spanclass="comment"># style string, e.g. com.mycompany.MyDocSet.documentation.</span></div>
<divclass="line"><aname="l01022"></a><spanclass="lineno"> 1022</span> <spanclass="comment"># The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.</span></div>
<divclass="line"><aname="l01026"></a><spanclass="lineno"> 1026</span> <spanclass="comment"># If the GENERATE_HTMLHELP tag is set to YES, additional index files </span></div>
<divclass="line"><aname="l01027"></a><spanclass="lineno"> 1027</span> <spanclass="comment"># will be generated that can be used as input for tools like the </span></div>
<divclass="line"><aname="l01028"></a><spanclass="lineno"> 1028</span> <spanclass="comment"># Microsoft HTML help workshop to generate a compiled HTML help file (.chm) </span></div>
<divclass="line"><aname="l01029"></a><spanclass="lineno"> 1029</span> <spanclass="comment"># of the generated HTML documentation.</span></div>
<divclass="line"><aname="l01033"></a><spanclass="lineno"> 1033</span> <spanclass="comment"># If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can </span></div>
<divclass="line"><aname="l01034"></a><spanclass="lineno"> 1034</span> <spanclass="comment"># be used to specify the file name of the resulting .chm file. You </span></div>
<divclass="line"><aname="l01035"></a><spanclass="lineno"> 1035</span> <spanclass="comment"># can add a path in front of the file if the result should not be </span></div>
<divclass="line"><aname="l01036"></a><spanclass="lineno"> 1036</span> <spanclass="comment"># written to the html output directory.</span></div>
<divclass="line"><aname="l01040"></a><spanclass="lineno"> 1040</span> <spanclass="comment"># If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can </span></div>
<divclass="line"><aname="l01041"></a><spanclass="lineno"> 1041</span> <spanclass="comment"># be used to specify the location (absolute path including file name) of </span></div>
<divclass="line"><aname="l01042"></a><spanclass="lineno"> 1042</span> <spanclass="comment"># the HTML help compiler (hhc.exe). If non-empty doxygen will try to run </span></div>
<divclass="line"><aname="l01043"></a><spanclass="lineno"> 1043</span> <spanclass="comment"># the HTML help compiler on the generated index.hhp.</span></div>
<divclass="line"><aname="l01047"></a><spanclass="lineno"> 1047</span> <spanclass="comment"># If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag </span></div>
<divclass="line"><aname="l01048"></a><spanclass="lineno"> 1048</span> <spanclass="comment"># controls if a separate .chi index file is generated (YES) or that </span></div>
<divclass="line"><aname="l01049"></a><spanclass="lineno"> 1049</span> <spanclass="comment"># it should be included in the master .chm file (NO).</span></div>
<divclass="line"><aname="l01053"></a><spanclass="lineno"> 1053</span> <spanclass="comment"># If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING </span></div>
<divclass="line"><aname="l01054"></a><spanclass="lineno"> 1054</span> <spanclass="comment"># is used to encode HtmlHelp index (hhk), content (hhc) and project file </span></div>
<divclass="line"><aname="l01059"></a><spanclass="lineno"> 1059</span> <spanclass="comment"># If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag </span></div>
<divclass="line"><aname="l01060"></a><spanclass="lineno"> 1060</span> <spanclass="comment"># controls whether a binary table of contents is generated (YES) or a </span></div>
<divclass="line"><aname="l01061"></a><spanclass="lineno"> 1061</span> <spanclass="comment"># normal table of contents (NO) in the .chm file.</span></div>
<divclass="line"><aname="l01065"></a><spanclass="lineno"> 1065</span> <spanclass="comment"># The TOC_EXPAND flag can be set to YES to add extra items for group members </span></div>
<divclass="line"><aname="l01066"></a><spanclass="lineno"> 1066</span> <spanclass="comment"># to the contents of the HTML help documentation and to the tree view.</span></div>
<divclass="line"><aname="l01070"></a><spanclass="lineno"> 1070</span> <spanclass="comment"># If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and </span></div>
<divclass="line"><aname="l01071"></a><spanclass="lineno"> 1071</span> <spanclass="comment"># QHP_VIRTUAL_FOLDER are set, an additional index file will be generated </span></div>
<divclass="line"><aname="l01072"></a><spanclass="lineno"> 1072</span> <spanclass="comment"># that can be used as input for Qt's qhelpgenerator to generate a </span></div>
<divclass="line"><aname="l01073"></a><spanclass="lineno"> 1073</span> <spanclass="comment"># Qt Compressed Help (.qch) of the generated HTML documentation.</span></div>
<divclass="line"><aname="l01077"></a><spanclass="lineno"> 1077</span> <spanclass="comment"># If the QHG_LOCATION tag is specified, the QCH_FILE tag can </span></div>
<divclass="line"><aname="l01078"></a><spanclass="lineno"> 1078</span> <spanclass="comment"># be used to specify the file name of the resulting .qch file. </span></div>
<divclass="line"><aname="l01079"></a><spanclass="lineno"> 1079</span> <spanclass="comment"># The path specified is relative to the HTML output folder.</span></div>
<divclass="line"><aname="l01083"></a><spanclass="lineno"> 1083</span> <spanclass="comment"># The QHP_NAMESPACE tag specifies the namespace to use when generating </span></div>
<divclass="line"><aname="l01084"></a><spanclass="lineno"> 1084</span> <spanclass="comment"># Qt Help Project output. For more information please see </span></div>
<divclass="line"><aname="l01089"></a><spanclass="lineno"> 1089</span> <spanclass="comment"># The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating </span></div>
<divclass="line"><aname="l01090"></a><spanclass="lineno"> 1090</span> <spanclass="comment"># Qt Help Project output. For more information please see </span></div>
<divclass="line"><aname="l01095"></a><spanclass="lineno"> 1095</span> <spanclass="comment"># If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to </span></div>
<divclass="line"><aname="l01096"></a><spanclass="lineno"> 1096</span> <spanclass="comment"># add. For more information please see </span></div>
<divclass="line"><aname="l01101"></a><spanclass="lineno"> 1101</span> <spanclass="comment"># The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the </span></div>
<divclass="line"><aname="l01102"></a><spanclass="lineno"> 1102</span> <spanclass="comment"># custom filter to add. For more information please see </span></div>
<divclass="line"><aname="l01108"></a><spanclass="lineno"> 1108</span> <spanclass="comment"># The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this </span></div>
<divclass="line"><aname="l01116"></a><spanclass="lineno"> 1116</span> <spanclass="comment"># If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can </span></div>
<divclass="line"><aname="l01117"></a><spanclass="lineno"> 1117</span> <spanclass="comment"># be used to specify the location of Qt's qhelpgenerator. </span></div>
<divclass="line"><aname="l01118"></a><spanclass="lineno"> 1118</span> <spanclass="comment"># If non-empty doxygen will try to run qhelpgenerator on the generated </span></div>
<divclass="line"><aname="l01123"></a><spanclass="lineno"> 1123</span> <spanclass="comment"># If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files </span></div>
<divclass="line"><aname="l01124"></a><spanclass="lineno"> 1124</span> <spanclass="comment"># will be generated, which together with the HTML files, form an Eclipse help </span></div>
<divclass="line"><aname="l01125"></a><spanclass="lineno"> 1125</span> <spanclass="comment"># plugin. To install this plugin and make it available under the help contents </span></div>
<divclass="line"><aname="l01126"></a><spanclass="lineno"> 1126</span> <spanclass="comment"># menu in Eclipse, the contents of the directory containing the HTML and XML </span></div>
<divclass="line"><aname="l01127"></a><spanclass="lineno"> 1127</span> <spanclass="comment"># files needs to be copied into the plugins directory of eclipse. The name of </span></div>
<divclass="line"><aname="l01128"></a><spanclass="lineno"> 1128</span> <spanclass="comment"># the directory within the plugins directory should be the same as </span></div>
<divclass="line"><aname="l01129"></a><spanclass="lineno"> 1129</span> <spanclass="comment"># the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before </span></div>
<divclass="line"><aname="l01130"></a><spanclass="lineno"> 1130</span> <spanclass="comment"># the help appears.</span></div>
<divclass="line"><aname="l01134"></a><spanclass="lineno"> 1134</span> <spanclass="comment"># A unique identifier for the eclipse help plugin. When installing the plugin </span></div>
<divclass="line"><aname="l01135"></a><spanclass="lineno"> 1135</span> <spanclass="comment"># the directory name containing the HTML and XML files should also have </span></div>
<divclass="line"><aname="l01136"></a><spanclass="lineno"> 1136</span> <spanclass="comment"># this name.</span></div>
<divclass="line"><aname="l01140"></a><spanclass="lineno"> 1140</span> <spanclass="comment"># The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) </span></div>
<divclass="line"><aname="l01141"></a><spanclass="lineno"> 1141</span> <spanclass="comment"># at top of each HTML page. The value NO (the default) enables the index and </span></div>
<divclass="line"><aname="l01142"></a><spanclass="lineno"> 1142</span> <spanclass="comment"># the value YES disables it. Since the tabs have the same information as the </span></div>
<divclass="line"><aname="l01143"></a><spanclass="lineno"> 1143</span> <spanclass="comment"># navigation tree you can set this option to NO if you already set </span></div>
<divclass="line"><aname="l01144"></a><spanclass="lineno"> 1144</span> <spanclass="comment"># GENERATE_TREEVIEW to YES.</span></div>
<divclass="line"><aname="l01148"></a><spanclass="lineno"> 1148</span> <spanclass="comment"># The GENERATE_TREEVIEW tag is used to specify whether a tree-like index </span></div>
<divclass="line"><aname="l01149"></a><spanclass="lineno"> 1149</span> <spanclass="comment"># structure should be generated to display hierarchical information. </span></div>
<divclass="line"><aname="l01150"></a><spanclass="lineno"> 1150</span> <spanclass="comment"># If the tag value is set to YES, a side panel will be generated </span></div>
<divclass="line"><aname="l01151"></a><spanclass="lineno"> 1151</span> <spanclass="comment"># containing a tree-like index structure (just like the one that </span></div>
<divclass="line"><aname="l01152"></a><spanclass="lineno"> 1152</span> <spanclass="comment"># is generated for HTML Help). For this to work a browser that supports </span></div>
<divclass="line"><aname="l01153"></a><spanclass="lineno"> 1153</span> <spanclass="comment"># JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). </span></div>
<divclass="line"><aname="l01154"></a><spanclass="lineno"> 1154</span> <spanclass="comment"># Windows users are probably better off using the HTML help feature. </span></div>
<divclass="line"><aname="l01155"></a><spanclass="lineno"> 1155</span> <spanclass="comment"># Since the tree basically has the same information as the tab index you </span></div>
<divclass="line"><aname="l01156"></a><spanclass="lineno"> 1156</span> <spanclass="comment"># could consider to set DISABLE_INDEX to NO when enabling this option.</span></div>
<divclass="line"><aname="l01160"></a><spanclass="lineno"> 1160</span> <spanclass="comment"># The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values </span></div>
<divclass="line"><aname="l01161"></a><spanclass="lineno"> 1161</span> <spanclass="comment"># (range [0,1..20]) that doxygen will group on one line in the generated HTML </span></div>
<divclass="line"><aname="l01162"></a><spanclass="lineno"> 1162</span> <spanclass="comment"># documentation. Note that a value of 0 will completely suppress the enum </span></div>
<divclass="line"><aname="l01163"></a><spanclass="lineno"> 1163</span> <spanclass="comment"># values from appearing in the overview section.</span></div>
<divclass="line"><aname="l01167"></a><spanclass="lineno"> 1167</span> <spanclass="comment"># If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be </span></div>
<divclass="line"><aname="l01168"></a><spanclass="lineno"> 1168</span> <spanclass="comment"># used to set the initial width (in pixels) of the frame in which the tree </span></div>
<divclass="line"><aname="l01169"></a><spanclass="lineno"> 1169</span> <spanclass="comment"># is shown.</span></div>
<divclass="line"><aname="l01173"></a><spanclass="lineno"> 1173</span> <spanclass="comment"># When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open </span></div>
<divclass="line"><aname="l01174"></a><spanclass="lineno"> 1174</span> <spanclass="comment"># links to external symbols imported via tag files in a separate window.</span></div>
<divclass="line"><aname="l01178"></a><spanclass="lineno"> 1178</span> <spanclass="comment"># Use this tag to change the font size of Latex formulas included </span></div>
<divclass="line"><aname="l01179"></a><spanclass="lineno"> 1179</span> <spanclass="comment"># as images in the HTML documentation. The default is 10. Note that </span></div>
<divclass="line"><aname="l01180"></a><spanclass="lineno"> 1180</span> <spanclass="comment"># when you change the font size after a successful doxygen run you need </span></div>
<divclass="line"><aname="l01181"></a><spanclass="lineno"> 1181</span> <spanclass="comment"># to manually remove any form_*.png images from the HTML output directory </span></div>
<divclass="line"><aname="l01182"></a><spanclass="lineno"> 1182</span> <spanclass="comment"># to force them to be regenerated.</span></div>
<divclass="line"><aname="l01186"></a><spanclass="lineno"> 1186</span> <spanclass="comment"># Use the FORMULA_TRANPARENT tag to determine whether or not the images </span></div>
<divclass="line"><aname="l01187"></a><spanclass="lineno"> 1187</span> <spanclass="comment"># generated for formulas are transparent PNGs. Transparent PNGs are </span></div>
<divclass="line"><aname="l01188"></a><spanclass="lineno"> 1188</span> <spanclass="comment"># not supported properly for IE 6.0, but are supported on all modern browsers. </span></div>
<divclass="line"><aname="l01189"></a><spanclass="lineno"> 1189</span> <spanclass="comment"># Note that when changing this option you need to delete any form_*.png files </span></div>
<divclass="line"><aname="l01190"></a><spanclass="lineno"> 1190</span> <spanclass="comment"># in the HTML output before the changes have effect.</span></div>
<divclass="line"><aname="l01194"></a><spanclass="lineno"> 1194</span> <spanclass="comment"># Enable the USE_MATHJAX option to render LaTeX formulas using MathJax </span></div>
<divclass="line"><aname="l01195"></a><spanclass="lineno"> 1195</span> <spanclass="comment"># (see http://www.mathjax.org) which uses client side Javascript for the </span></div>
<divclass="line"><aname="l01196"></a><spanclass="lineno"> 1196</span> <spanclass="comment"># rendering instead of using prerendered bitmaps. Use this if you do not </span></div>
<divclass="line"><aname="l01197"></a><spanclass="lineno"> 1197</span> <spanclass="comment"># have LaTeX installed or if you want to formulas look prettier in the HTML </span></div>
<divclass="line"><aname="l01198"></a><spanclass="lineno"> 1198</span> <spanclass="comment"># output. When enabled you may also need to install MathJax separately and </span></div>
<divclass="line"><aname="l01199"></a><spanclass="lineno"> 1199</span> <spanclass="comment"># configure the path to it using the MATHJAX_RELPATH option.</span></div>
<divclass="line"><aname="l01203"></a><spanclass="lineno"> 1203</span> <spanclass="comment"># When MathJax is enabled you need to specify the location relative to the </span></div>
<divclass="line"><aname="l01204"></a><spanclass="lineno"> 1204</span> <spanclass="comment"># HTML output directory using the MATHJAX_RELPATH option. The destination </span></div>
<divclass="line"><aname="l01205"></a><spanclass="lineno"> 1205</span> <spanclass="comment"># directory should contain the MathJax.js script. For instance, if the mathjax </span></div>
<divclass="line"><aname="l01206"></a><spanclass="lineno"> 1206</span> <spanclass="comment"># directory is located at the same level as the HTML output directory, then </span></div>
<divclass="line"><aname="l01207"></a><spanclass="lineno"> 1207</span> <spanclass="comment"># MATHJAX_RELPATH should be ../mathjax. The default value points to </span></div>
<divclass="line"><aname="l01208"></a><spanclass="lineno"> 1208</span> <spanclass="comment"># the MathJax Content Delivery Network so you can quickly see the result without </span></div>
<divclass="line"><aname="l01209"></a><spanclass="lineno"> 1209</span> <spanclass="comment"># installing MathJax. However, it is strongly recommended to install a local </span></div>
<divclass="line"><aname="l01210"></a><spanclass="lineno"> 1210</span> <spanclass="comment"># copy of MathJax from http://www.mathjax.org before deployment.</span></div>
<divclass="line"><aname="l01214"></a><spanclass="lineno"> 1214</span> <spanclass="comment"># The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension </span></div>
<divclass="line"><aname="l01215"></a><spanclass="lineno"> 1215</span> <spanclass="comment"># names that should be enabled during MathJax rendering.</span></div>
<divclass="line"><aname="l01219"></a><spanclass="lineno"> 1219</span> <spanclass="comment"># When the SEARCHENGINE tag is enabled doxygen will generate a search box </span></div>
<divclass="line"><aname="l01220"></a><spanclass="lineno"> 1220</span> <spanclass="comment"># for the HTML output. The underlying search engine uses javascript </span></div>
<divclass="line"><aname="l01221"></a><spanclass="lineno"> 1221</span> <spanclass="comment"># and DHTML and should work on any modern browser. Note that when using </span></div>
<divclass="line"><aname="l01222"></a><spanclass="lineno"> 1222</span> <spanclass="comment"># HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets </span></div>
<divclass="line"><aname="l01223"></a><spanclass="lineno"> 1223</span> <spanclass="comment"># (GENERATE_DOCSET) there is already a search function so this one should </span></div>
<divclass="line"><aname="l01224"></a><spanclass="lineno"> 1224</span> <spanclass="comment"># typically be disabled. For large projects the javascript based search engine </span></div>
<divclass="line"><aname="l01225"></a><spanclass="lineno"> 1225</span> <spanclass="comment"># can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.</span></div>
<divclass="line"><aname="l01229"></a><spanclass="lineno"> 1229</span> <spanclass="comment"># When the SERVER_BASED_SEARCH tag is enabled the search engine will be </span></div>
<divclass="line"><aname="l01230"></a><spanclass="lineno"> 1230</span> <spanclass="comment"># implemented using a PHP enabled web server instead of at the web client </span></div>
<divclass="line"><aname="l01231"></a><spanclass="lineno"> 1231</span> <spanclass="comment"># using Javascript. Doxygen will generate the search PHP script and index </span></div>
<divclass="line"><aname="l01232"></a><spanclass="lineno"> 1232</span> <spanclass="comment"># file to put on the web server. The advantage of the server </span></div>
<divclass="line"><aname="l01233"></a><spanclass="lineno"> 1233</span> <spanclass="comment"># based approach is that it scales better to large projects and allows </span></div>
<divclass="line"><aname="l01234"></a><spanclass="lineno"> 1234</span> <spanclass="comment"># full text search. The disadvantages are that it is more difficult to setup </span></div>
<divclass="line"><aname="l01235"></a><spanclass="lineno"> 1235</span> <spanclass="comment"># and does not have live searching capabilities.</span></div>
<divclass="line"><aname="l01240"></a><spanclass="lineno"> 1240</span> <spanclass="comment"># configuration options related to the LaTeX output</span></div>
<divclass="line"><aname="l01243"></a><spanclass="lineno"> 1243</span> <spanclass="comment"># If the GENERATE_LATEX tag is set to YES (the default) Doxygen will </span></div>
<divclass="line"><aname="l01248"></a><spanclass="lineno"> 1248</span> <spanclass="comment"># The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. </span></div>
<divclass="line"><aname="l01249"></a><spanclass="lineno"> 1249</span> <spanclass="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span></div>
<divclass="line"><aname="l01250"></a><spanclass="lineno"> 1250</span> <spanclass="comment"># put in front of it. If left blank `latex' will be used as the default path.</span></div>
<divclass="line"><aname="l01254"></a><spanclass="lineno"> 1254</span> <spanclass="comment"># The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be </span></div>
<divclass="line"><aname="l01255"></a><spanclass="lineno"> 1255</span> <spanclass="comment"># invoked. If left blank `latex' will be used as the default command name. </span></div>
<divclass="line"><aname="l01256"></a><spanclass="lineno"> 1256</span> <spanclass="comment"># Note that when enabling USE_PDFLATEX this option is only used for </span></div>
<divclass="line"><aname="l01257"></a><spanclass="lineno"> 1257</span> <spanclass="comment"># generating bitmaps for formulas in the HTML output, but not in the </span></div>
<divclass="line"><aname="l01258"></a><spanclass="lineno"> 1258</span> <spanclass="comment"># Makefile that is written to the output directory.</span></div>
<divclass="line"><aname="l01262"></a><spanclass="lineno"> 1262</span> <spanclass="comment"># The MAKEINDEX_CMD_NAME tag can be used to specify the command name to </span></div>
<divclass="line"><aname="l01263"></a><spanclass="lineno"> 1263</span> <spanclass="comment"># generate index for LaTeX. If left blank `makeindex' will be used as the </span></div>
<divclass="line"><aname="l01268"></a><spanclass="lineno"> 1268</span> <spanclass="comment"># If the COMPACT_LATEX tag is set to YES Doxygen generates more compact </span></div>
<divclass="line"><aname="l01269"></a><spanclass="lineno"> 1269</span> <spanclass="comment"># LaTeX documents. This may be useful for small projects and may help to </span></div>
<divclass="line"><aname="l01270"></a><spanclass="lineno"> 1270</span> <spanclass="comment"># save some trees in general.</span></div>
<divclass="line"><aname="l01274"></a><spanclass="lineno"> 1274</span> <spanclass="comment"># The PAPER_TYPE tag can be used to set the paper type that is used </span></div>
<divclass="line"><aname="l01275"></a><spanclass="lineno"> 1275</span> <spanclass="comment"># by the printer. Possible values are: a4, letter, legal and </span></div>
<divclass="line"><aname="l01276"></a><spanclass="lineno"> 1276</span> <spanclass="comment"># executive. If left blank a4wide will be used.</span></div>
<divclass="line"><aname="l01280"></a><spanclass="lineno"> 1280</span> <spanclass="comment"># The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX </span></div>
<divclass="line"><aname="l01281"></a><spanclass="lineno"> 1281</span> <spanclass="comment"># packages that should be included in the LaTeX output.</span></div>
<divclass="line"><aname="l01285"></a><spanclass="lineno"> 1285</span> <spanclass="comment"># The LATEX_HEADER tag can be used to specify a personal LaTeX header for </span></div>
<divclass="line"><aname="l01286"></a><spanclass="lineno"> 1286</span> <spanclass="comment"># the generated latex document. The header should contain everything until </span></div>
<divclass="line"><aname="l01287"></a><spanclass="lineno"> 1287</span> <spanclass="comment"># the first chapter. If it is left blank doxygen will generate a </span></div>
<divclass="line"><aname="l01288"></a><spanclass="lineno"> 1288</span> <spanclass="comment"># standard header. Notice: only use this tag if you know what you are doing!</span></div>
<divclass="line"><aname="l01292"></a><spanclass="lineno"> 1292</span> <spanclass="comment"># The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for </span></div>
<divclass="line"><aname="l01293"></a><spanclass="lineno"> 1293</span> <spanclass="comment"># the generated latex document. The footer should contain everything after </span></div>
<divclass="line"><aname="l01294"></a><spanclass="lineno"> 1294</span> <spanclass="comment"># the last chapter. If it is left blank doxygen will generate a </span></div>
<divclass="line"><aname="l01295"></a><spanclass="lineno"> 1295</span> <spanclass="comment"># standard footer. Notice: only use this tag if you know what you are doing!</span></div>
<divclass="line"><aname="l01299"></a><spanclass="lineno"> 1299</span> <spanclass="comment"># If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated </span></div>
<divclass="line"><aname="l01300"></a><spanclass="lineno"> 1300</span> <spanclass="comment"># is prepared for conversion to pdf (using ps2pdf). The pdf file will </span></div>
<divclass="line"><aname="l01301"></a><spanclass="lineno"> 1301</span> <spanclass="comment"># contain links (just like the HTML output) instead of page references </span></div>
<divclass="line"><aname="l01302"></a><spanclass="lineno"> 1302</span> <spanclass="comment"># This makes the output suitable for online browsing using a pdf viewer.</span></div>
<divclass="line"><aname="l01306"></a><spanclass="lineno"> 1306</span> <spanclass="comment"># If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of </span></div>
<divclass="line"><aname="l01307"></a><spanclass="lineno"> 1307</span> <spanclass="comment"># plain latex in the generated Makefile. Set this option to YES to get a </span></div>
<divclass="line"><aname="l01308"></a><spanclass="lineno"> 1308</span> <spanclass="comment"># higher quality PDF documentation.</span></div>
<divclass="line"><aname="l01312"></a><spanclass="lineno"> 1312</span> <spanclass="comment"># If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. </span></div>
<divclass="line"><aname="l01313"></a><spanclass="lineno"> 1313</span> <spanclass="comment"># command to the generated LaTeX files. This will instruct LaTeX to keep </span></div>
<divclass="line"><aname="l01314"></a><spanclass="lineno"> 1314</span> <spanclass="comment"># running if errors occur, instead of asking the user for help. </span></div>
<divclass="line"><aname="l01315"></a><spanclass="lineno"> 1315</span> <spanclass="comment"># This option is also used when generating formulas in HTML.</span></div>
<divclass="line"><aname="l01319"></a><spanclass="lineno"> 1319</span> <spanclass="comment"># If LATEX_HIDE_INDICES is set to YES then doxygen will not </span></div>
<divclass="line"><aname="l01320"></a><spanclass="lineno"> 1320</span> <spanclass="comment"># include the index chapters (such as File Index, Compound Index, etc.) </span></div>
<divclass="line"><aname="l01321"></a><spanclass="lineno"> 1321</span> <spanclass="comment"># in the output.</span></div>
<divclass="line"><aname="l01325"></a><spanclass="lineno"> 1325</span> <spanclass="comment"># If LATEX_SOURCE_CODE is set to YES then doxygen will include </span></div>
<divclass="line"><aname="l01326"></a><spanclass="lineno"> 1326</span> <spanclass="comment"># source code with syntax highlighting in the LaTeX output. </span></div>
<divclass="line"><aname="l01327"></a><spanclass="lineno"> 1327</span> <spanclass="comment"># Note that which sources are shown also depends on other settings </span></div>
<divclass="line"><aname="l01328"></a><spanclass="lineno"> 1328</span> <spanclass="comment"># such as SOURCE_BROWSER.</span></div>
<divclass="line"><aname="l01332"></a><spanclass="lineno"> 1332</span> <spanclass="comment"># The LATEX_BIB_STYLE tag can be used to specify the style to use for the </span></div>
<divclass="line"><aname="l01333"></a><spanclass="lineno"> 1333</span> <spanclass="comment"># bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See </span></div>
<divclass="line"><aname="l01334"></a><spanclass="lineno"> 1334</span> <spanclass="comment"># http://en.wikipedia.org/wiki/BibTeX for more info.</span></div>
<divclass="line"><aname="l01339"></a><spanclass="lineno"> 1339</span> <spanclass="comment"># configuration options related to the RTF output</span></div>
<divclass="line"><aname="l01342"></a><spanclass="lineno"> 1342</span> <spanclass="comment"># If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output </span></div>
<divclass="line"><aname="l01343"></a><spanclass="lineno"> 1343</span> <spanclass="comment"># The RTF output is optimized for Word 97 and may not look very pretty with </span></div>
<divclass="line"><aname="l01344"></a><spanclass="lineno"> 1344</span> <spanclass="comment"># other RTF readers or editors.</span></div>
<divclass="line"><aname="l01348"></a><spanclass="lineno"> 1348</span> <spanclass="comment"># The RTF_OUTPUT tag is used to specify where the RTF docs will be put. </span></div>
<divclass="line"><aname="l01349"></a><spanclass="lineno"> 1349</span> <spanclass="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span></div>
<divclass="line"><aname="l01350"></a><spanclass="lineno"> 1350</span> <spanclass="comment"># put in front of it. If left blank `rtf' will be used as the default path.</span></div>
<divclass="line"><aname="l01354"></a><spanclass="lineno"> 1354</span> <spanclass="comment"># If the COMPACT_RTF tag is set to YES Doxygen generates more compact </span></div>
<divclass="line"><aname="l01355"></a><spanclass="lineno"> 1355</span> <spanclass="comment"># RTF documents. This may be useful for small projects and may help to </span></div>
<divclass="line"><aname="l01356"></a><spanclass="lineno"> 1356</span> <spanclass="comment"># save some trees in general.</span></div>
<divclass="line"><aname="l01360"></a><spanclass="lineno"> 1360</span> <spanclass="comment"># If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated </span></div>
<divclass="line"><aname="l01361"></a><spanclass="lineno"> 1361</span> <spanclass="comment"># will contain hyperlink fields. The RTF file will </span></div>
<divclass="line"><aname="l01362"></a><spanclass="lineno"> 1362</span> <spanclass="comment"># contain links (just like the HTML output) instead of page references. </span></div>
<divclass="line"><aname="l01363"></a><spanclass="lineno"> 1363</span> <spanclass="comment"># This makes the output suitable for online browsing using WORD or other </span></div>
<divclass="line"><aname="l01364"></a><spanclass="lineno"> 1364</span> <spanclass="comment"># programs which support those fields. </span></div>
<divclass="line"><aname="l01365"></a><spanclass="lineno"> 1365</span> <spanclass="comment"># Note: wordpad (write) and others do not support links.</span></div>
<divclass="line"><aname="l01369"></a><spanclass="lineno"> 1369</span> <spanclass="comment"># Load style sheet definitions from file. Syntax is similar to doxygen's </span></div>
<divclass="line"><aname="l01370"></a><spanclass="lineno"> 1370</span> <spanclass="comment"># config file, i.e. a series of assignments. You only have to provide </span></div>
<divclass="line"><aname="l01371"></a><spanclass="lineno"> 1371</span> <spanclass="comment"># replacements, missing definitions are set to their default value.</span></div>
<divclass="line"><aname="l01375"></a><spanclass="lineno"> 1375</span> <spanclass="comment"># Set optional variables used in the generation of an rtf document. </span></div>
<divclass="line"><aname="l01376"></a><spanclass="lineno"> 1376</span> <spanclass="comment"># Syntax is similar to doxygen's config file.</span></div>
<divclass="line"><aname="l01381"></a><spanclass="lineno"> 1381</span> <spanclass="comment"># configuration options related to the man page output</span></div>
<divclass="line"><aname="l01384"></a><spanclass="lineno"> 1384</span> <spanclass="comment"># If the GENERATE_MAN tag is set to YES (the default) Doxygen will </span></div>
<divclass="line"><aname="l01385"></a><spanclass="lineno"> 1385</span> <spanclass="comment"># generate man pages</span></div>
<divclass="line"><aname="l01389"></a><spanclass="lineno"> 1389</span> <spanclass="comment"># The MAN_OUTPUT tag is used to specify where the man pages will be put. </span></div>
<divclass="line"><aname="l01390"></a><spanclass="lineno"> 1390</span> <spanclass="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span></div>
<divclass="line"><aname="l01391"></a><spanclass="lineno"> 1391</span> <spanclass="comment"># put in front of it. If left blank `man' will be used as the default path.</span></div>
<divclass="line"><aname="l01395"></a><spanclass="lineno"> 1395</span> <spanclass="comment"># The MAN_EXTENSION tag determines the extension that is added to </span></div>
<divclass="line"><aname="l01396"></a><spanclass="lineno"> 1396</span> <spanclass="comment"># the generated man pages (default is the subroutine's section .3)</span></div>
<divclass="line"><aname="l01400"></a><spanclass="lineno"> 1400</span> <spanclass="comment"># If the MAN_LINKS tag is set to YES and Doxygen generates man output, </span></div>
<divclass="line"><aname="l01401"></a><spanclass="lineno"> 1401</span> <spanclass="comment"># then it will generate one additional man file for each entity </span></div>
<divclass="line"><aname="l01402"></a><spanclass="lineno"> 1402</span> <spanclass="comment"># documented in the real man page(s). These additional files </span></div>
<divclass="line"><aname="l01403"></a><spanclass="lineno"> 1403</span> <spanclass="comment"># only source the real man page, but without them the man command </span></div>
<divclass="line"><aname="l01404"></a><spanclass="lineno"> 1404</span> <spanclass="comment"># would be unable to find the correct page. The default is NO.</span></div>
<divclass="line"><aname="l01409"></a><spanclass="lineno"> 1409</span> <spanclass="comment"># configuration options related to the XML output</span></div>
<divclass="line"><aname="l01412"></a><spanclass="lineno"> 1412</span> <spanclass="comment"># If the GENERATE_XML tag is set to YES Doxygen will </span></div>
<divclass="line"><aname="l01413"></a><spanclass="lineno"> 1413</span> <spanclass="comment"># generate an XML file that captures the structure of </span></div>
<divclass="line"><aname="l01414"></a><spanclass="lineno"> 1414</span> <spanclass="comment"># the code including all documentation.</span></div>
<divclass="line"><aname="l01418"></a><spanclass="lineno"> 1418</span> <spanclass="comment"># The XML_OUTPUT tag is used to specify where the XML pages will be put. </span></div>
<divclass="line"><aname="l01419"></a><spanclass="lineno"> 1419</span> <spanclass="comment"># If a relative path is entered the value of OUTPUT_DIRECTORY will be </span></div>
<divclass="line"><aname="l01420"></a><spanclass="lineno"> 1420</span> <spanclass="comment"># put in front of it. If left blank `xml' will be used as the default path.</span></div>
<divclass="line"><aname="l01424"></a><spanclass="lineno"> 1424</span> <spanclass="comment"># The XML_SCHEMA tag can be used to specify an XML schema, </span></div>
<divclass="line"><aname="l01425"></a><spanclass="lineno"> 1425</span> <spanclass="comment"># which can be used by a validating XML parser to check the </span></div>
<divclass="line"><aname="l01426"></a><spanclass="lineno"> 1426</span> <spanclass="comment"># syntax of the XML files.</span></div>
<divclass="line"><aname="l01430"></a><spanclass="lineno"> 1430</span> <spanclass="comment"># The XML_DTD tag can be used to specify an XML DTD, </span></div>
<divclass="line"><aname="l01431"></a><spanclass="lineno"> 1431</span> <spanclass="comment"># which can be used by a validating XML parser to check the </span></div>
<divclass="line"><aname="l01432"></a><spanclass="lineno"> 1432</span> <spanclass="comment"># syntax of the XML files.</span></div>
<divclass="line"><aname="l01436"></a><spanclass="lineno"> 1436</span> <spanclass="comment"># If the XML_PROGRAMLISTING tag is set to YES Doxygen will </span></div>
<divclass="line"><aname="l01437"></a><spanclass="lineno"> 1437</span> <spanclass="comment"># dump the program listings (including syntax highlighting </span></div>
<divclass="line"><aname="l01438"></a><spanclass="lineno"> 1438</span> <spanclass="comment"># and cross-referencing information) to the XML output. Note that </span></div>
<divclass="line"><aname="l01439"></a><spanclass="lineno"> 1439</span> <spanclass="comment"># enabling this will significantly increase the size of the XML output.</span></div>
<divclass="line"><aname="l01444"></a><spanclass="lineno"> 1444</span> <spanclass="comment"># configuration options for the AutoGen Definitions output</span></div>
<divclass="line"><aname="l01447"></a><spanclass="lineno"> 1447</span> <spanclass="comment"># If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will </span></div>
<divclass="line"><aname="l01448"></a><spanclass="lineno"> 1448</span> <spanclass="comment"># generate an AutoGen Definitions (see autogen.sf.net) file </span></div>
<divclass="line"><aname="l01449"></a><spanclass="lineno"> 1449</span> <spanclass="comment"># that captures the structure of the code including all </span></div>
<divclass="line"><aname="l01450"></a><spanclass="lineno"> 1450</span> <spanclass="comment"># documentation. Note that this feature is still experimental </span></div>
<divclass="line"><aname="l01451"></a><spanclass="lineno"> 1451</span> <spanclass="comment"># and incomplete at the moment.</span></div>
<divclass="line"><aname="l01456"></a><spanclass="lineno"> 1456</span> <spanclass="comment"># configuration options related to the Perl module output</span></div>
<divclass="line"><aname="l01459"></a><spanclass="lineno"> 1459</span> <spanclass="comment"># If the GENERATE_PERLMOD tag is set to YES Doxygen will </span></div>
<divclass="line"><aname="l01460"></a><spanclass="lineno"> 1460</span> <spanclass="comment"># generate a Perl module file that captures the structure of </span></div>
<divclass="line"><aname="l01461"></a><spanclass="lineno"> 1461</span> <spanclass="comment"># the code including all documentation. Note that this </span></div>
<divclass="line"><aname="l01462"></a><spanclass="lineno"> 1462</span> <spanclass="comment"># feature is still experimental and incomplete at the </span></div>
<divclass="line"><aname="l01467"></a><spanclass="lineno"> 1467</span> <spanclass="comment"># If the PERLMOD_LATEX tag is set to YES Doxygen will generate </span></div>
<divclass="line"><aname="l01468"></a><spanclass="lineno"> 1468</span> <spanclass="comment"># the necessary Makefile rules, Perl scripts and LaTeX code to be able </span></div>
<divclass="line"><aname="l01469"></a><spanclass="lineno"> 1469</span> <spanclass="comment"># to generate PDF and DVI output from the Perl module output.</span></div>
<divclass="line"><aname="l01473"></a><spanclass="lineno"> 1473</span> <spanclass="comment"># If the PERLMOD_PRETTY tag is set to YES the Perl module output will be </span></div>
<divclass="line"><aname="l01474"></a><spanclass="lineno"> 1474</span> <spanclass="comment"># nicely formatted so it can be parsed by a human reader. This is useful </span></div>
<divclass="line"><aname="l01475"></a><spanclass="lineno"> 1475</span> <spanclass="comment"># if you want to understand what is going on. On the other hand, if this </span></div>
<divclass="line"><aname="l01476"></a><spanclass="lineno"> 1476</span> <spanclass="comment"># tag is set to NO the size of the Perl module output will be much smaller </span></div>
<divclass="line"><aname="l01477"></a><spanclass="lineno"> 1477</span> <spanclass="comment"># and Perl will parse it just the same.</span></div>
<divclass="line"><aname="l01481"></a><spanclass="lineno"> 1481</span> <spanclass="comment"># The names of the make variables in the generated doxyrules.make file </span></div>
<divclass="line"><aname="l01482"></a><spanclass="lineno"> 1482</span> <spanclass="comment"># are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. </span></div>
<divclass="line"><aname="l01483"></a><spanclass="lineno"> 1483</span> <spanclass="comment"># This is useful so different doxyrules.make files included by the same </span></div>
<divclass="line"><aname="l01484"></a><spanclass="lineno"> 1484</span> <spanclass="comment"># Makefile don't overwrite each other's variables.</span></div>
<divclass="line"><aname="l01489"></a><spanclass="lineno"> 1489</span> <spanclass="comment"># Configuration options related to the preprocessor</span></div>
<divclass="line"><aname="l01492"></a><spanclass="lineno"> 1492</span> <spanclass="comment"># If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will </span></div>
<divclass="line"><aname="l01493"></a><spanclass="lineno"> 1493</span> <spanclass="comment"># evaluate all C-preprocessor directives found in the sources and include </span></div>
<divclass="line"><aname="l01498"></a><spanclass="lineno"> 1498</span> <spanclass="comment"># If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro </span></div>
<divclass="line"><aname="l01499"></a><spanclass="lineno"> 1499</span> <spanclass="comment"># names in the source code. If set to NO (the default) only conditional </span></div>
<divclass="line"><aname="l01500"></a><spanclass="lineno"> 1500</span> <spanclass="comment"># compilation will be performed. Macro expansion can be done in a controlled </span></div>
<divclass="line"><aname="l01501"></a><spanclass="lineno"> 1501</span> <spanclass="comment"># way by setting EXPAND_ONLY_PREDEF to YES.</span></div>
<divclass="line"><aname="l01505"></a><spanclass="lineno"> 1505</span> <spanclass="comment"># If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES </span></div>
<divclass="line"><aname="l01506"></a><spanclass="lineno"> 1506</span> <spanclass="comment"># then the macro expansion is limited to the macros specified with the </span></div>
<divclass="line"><aname="l01507"></a><spanclass="lineno"> 1507</span> <spanclass="comment"># PREDEFINED and EXPAND_AS_DEFINED tags.</span></div>
<divclass="line"><aname="l01511"></a><spanclass="lineno"> 1511</span> <spanclass="comment"># If the SEARCH_INCLUDES tag is set to YES (the default) the includes files </span></div>
<divclass="line"><aname="l01512"></a><spanclass="lineno"> 1512</span> <spanclass="comment"># pointed to by INCLUDE_PATH will be searched when a #include is found.</span></div>
<divclass="line"><aname="l01516"></a><spanclass="lineno"> 1516</span> <spanclass="comment"># The INCLUDE_PATH tag can be used to specify one or more directories that </span></div>
<divclass="line"><aname="l01517"></a><spanclass="lineno"> 1517</span> <spanclass="comment"># contain include files that are not input files but should be processed by </span></div>
<divclass="line"><aname="l01518"></a><spanclass="lineno"> 1518</span> <spanclass="comment"># the preprocessor.</span></div>
<divclass="line"><aname="l01522"></a><spanclass="lineno"> 1522</span> <spanclass="comment"># You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard </span></div>
<divclass="line"><aname="l01523"></a><spanclass="lineno"> 1523</span> <spanclass="comment"># patterns (like *.h and *.hpp) to filter out the header-files in the </span></div>
<divclass="line"><aname="l01524"></a><spanclass="lineno"> 1524</span> <spanclass="comment"># directories. If left blank, the patterns specified with FILE_PATTERNS will </span></div>
<divclass="line"><aname="l01525"></a><spanclass="lineno"> 1525</span> <spanclass="comment"># be used.</span></div>
<divclass="line"><aname="l01529"></a><spanclass="lineno"> 1529</span> <spanclass="comment"># The PREDEFINED tag can be used to specify one or more macro names that </span></div>
<divclass="line"><aname="l01530"></a><spanclass="lineno"> 1530</span> <spanclass="comment"># are defined before the preprocessor is started (similar to the -D option of </span></div>
<divclass="line"><aname="l01531"></a><spanclass="lineno"> 1531</span> <spanclass="comment"># gcc). The argument of the tag is a list of macros of the form: name </span></div>
<divclass="line"><aname="l01532"></a><spanclass="lineno"> 1532</span> <spanclass="comment"># or name=definition (no spaces). If the definition and the = are </span></div>
<divclass="line"><aname="l01533"></a><spanclass="lineno"> 1533</span> <spanclass="comment"># omitted =1 is assumed. To prevent a macro definition from being </span></div>
<divclass="line"><aname="l01534"></a><spanclass="lineno"> 1534</span> <spanclass="comment"># undefined via #undef or recursively expanded use the := operator </span></div>
<divclass="line"><aname="l01535"></a><spanclass="lineno"> 1535</span> <spanclass="comment"># instead of the = operator.</span></div>
<divclass="line"><aname="l01539"></a><spanclass="lineno"> 1539</span> <spanclass="comment"># If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then </span></div>
<divclass="line"><aname="l01540"></a><spanclass="lineno"> 1540</span> <spanclass="comment"># this tag can be used to specify a list of macro names that should be expanded. </span></div>
<divclass="line"><aname="l01541"></a><spanclass="lineno"> 1541</span> <spanclass="comment"># The macro definition that is found in the sources will be used. </span></div>
<divclass="line"><aname="l01542"></a><spanclass="lineno"> 1542</span> <spanclass="comment"># Use the PREDEFINED tag if you want to use a different macro definition that </span></div>
<divclass="line"><aname="l01543"></a><spanclass="lineno"> 1543</span> <spanclass="comment"># overrules the definition found in the source code.</span></div>
<divclass="line"><aname="l01547"></a><spanclass="lineno"> 1547</span> <spanclass="comment"># If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then </span></div>
<divclass="line"><aname="l01548"></a><spanclass="lineno"> 1548</span> <spanclass="comment"># doxygen's preprocessor will remove all references to function-like macros </span></div>
<divclass="line"><aname="l01549"></a><spanclass="lineno"> 1549</span> <spanclass="comment"># that are alone on a line, have an all uppercase name, and do not end with a </span></div>
<divclass="line"><aname="l01550"></a><spanclass="lineno"> 1550</span> <spanclass="comment"># semicolon, because these will confuse the parser if not removed.</span></div>
<divclass="line"><aname="l01555"></a><spanclass="lineno"> 1555</span> <spanclass="comment"># Configuration::additions related to external references</span></div>
<divclass="line"><aname="l01558"></a><spanclass="lineno"> 1558</span> <spanclass="comment"># The TAGFILES option can be used to specify one or more tagfiles. For each </span></div>
<divclass="line"><aname="l01559"></a><spanclass="lineno"> 1559</span> <spanclass="comment"># tag file the location of the external documentation should be added. The </span></div>
<divclass="line"><aname="l01560"></a><spanclass="lineno"> 1560</span> <spanclass="comment"># format of a tag file without this location is as follows: </span></div>
<divclass="line"><aname="l01562"></a><spanclass="lineno"> 1562</span> <spanclass="comment"># Adding location for the tag files is done as follows: </span></div>
<divclass="line"><aname="l01564"></a><spanclass="lineno"> 1564</span> <spanclass="comment"># where "loc1" and "loc2" can be relative or absolute paths </span></div>
<divclass="line"><aname="l01565"></a><spanclass="lineno"> 1565</span> <spanclass="comment"># or URLs. Note that each tag file must have a unique name (where the name does </span></div>
<divclass="line"><aname="l01566"></a><spanclass="lineno"> 1566</span> <spanclass="comment"># NOT include the path). If a tag file is not located in the directory in which </span></div>
<divclass="line"><aname="l01567"></a><spanclass="lineno"> 1567</span> <spanclass="comment"># doxygen is run, you must also specify the path to the tagfile here.</span></div>
<divclass="line"><aname="l01571"></a><spanclass="lineno"> 1571</span> <spanclass="comment"># When a file name is specified after GENERATE_TAGFILE, doxygen will create </span></div>
<divclass="line"><aname="l01572"></a><spanclass="lineno"> 1572</span> <spanclass="comment"># a tag file that is based on the input files it reads.</span></div>
<divclass="line"><aname="l01576"></a><spanclass="lineno"> 1576</span> <spanclass="comment"># If the ALLEXTERNALS tag is set to YES all external classes will be listed </span></div>
<divclass="line"><aname="l01577"></a><spanclass="lineno"> 1577</span> <spanclass="comment"># in the class index. If set to NO only the inherited external classes </span></div>
<divclass="line"><aname="l01578"></a><spanclass="lineno"> 1578</span> <spanclass="comment"># will be listed.</span></div>
<divclass="line"><aname="l01582"></a><spanclass="lineno"> 1582</span> <spanclass="comment"># If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed </span></div>
<divclass="line"><aname="l01583"></a><spanclass="lineno"> 1583</span> <spanclass="comment"># in the modules index. If set to NO, only the current project's groups will </span></div>
<divclass="line"><aname="l01584"></a><spanclass="lineno"> 1584</span> <spanclass="comment"># be listed.</span></div>
<divclass="line"><aname="l01588"></a><spanclass="lineno"> 1588</span> <spanclass="comment"># The PERL_PATH should be the absolute path and name of the perl script </span></div>
<divclass="line"><aname="l01589"></a><spanclass="lineno"> 1589</span> <spanclass="comment"># interpreter (i.e. the result of `which perl').</span></div>
<divclass="line"><aname="l01594"></a><spanclass="lineno"> 1594</span> <spanclass="comment"># Configuration options related to the dot tool</span></div>
<divclass="line"><aname="l01597"></a><spanclass="lineno"> 1597</span> <spanclass="comment"># If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will </span></div>
<divclass="line"><aname="l01598"></a><spanclass="lineno"> 1598</span> <spanclass="comment"># generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base </span></div>
<divclass="line"><aname="l01599"></a><spanclass="lineno"> 1599</span> <spanclass="comment"># or super classes. Setting the tag to NO turns the diagrams off. Note that </span></div>
<divclass="line"><aname="l01600"></a><spanclass="lineno"> 1600</span> <spanclass="comment"># this option also works with HAVE_DOT disabled, but it is recommended to </span></div>
<divclass="line"><aname="l01601"></a><spanclass="lineno"> 1601</span> <spanclass="comment"># install and use dot, since it yields more powerful graphs.</span></div>
<divclass="line"><aname="l01605"></a><spanclass="lineno"> 1605</span> <spanclass="comment"># You can define message sequence charts within doxygen comments using the \msc </span></div>
<divclass="line"><aname="l01606"></a><spanclass="lineno"> 1606</span> <spanclass="comment"># command. Doxygen will then run the mscgen tool (see </span></div>
<divclass="line"><aname="l01607"></a><spanclass="lineno"> 1607</span> <spanclass="comment"># http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the </span></div>
<divclass="line"><aname="l01608"></a><spanclass="lineno"> 1608</span> <spanclass="comment"># documentation. The MSCGEN_PATH tag allows you to specify the directory where </span></div>
<divclass="line"><aname="l01609"></a><spanclass="lineno"> 1609</span> <spanclass="comment"># the mscgen tool resides. If left empty the tool is assumed to be found in the </span></div>
<divclass="line"><aname="l01614"></a><spanclass="lineno"> 1614</span> <spanclass="comment"># If set to YES, the inheritance and collaboration graphs will hide </span></div>
<divclass="line"><aname="l01615"></a><spanclass="lineno"> 1615</span> <spanclass="comment"># inheritance and usage relations if the target is undocumented </span></div>
<divclass="line"><aname="l01616"></a><spanclass="lineno"> 1616</span> <spanclass="comment"># or is not a class.</span></div>
<divclass="line"><aname="l01620"></a><spanclass="lineno"> 1620</span> <spanclass="comment"># If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is </span></div>
<divclass="line"><aname="l01621"></a><spanclass="lineno"> 1621</span> <spanclass="comment"># available from the path. This tool is part of Graphviz, a graph visualization </span></div>
<divclass="line"><aname="l01622"></a><spanclass="lineno"> 1622</span> <spanclass="comment"># toolkit from AT&T and Lucent Bell Labs. The other options in this section </span></div>
<divclass="line"><aname="l01623"></a><spanclass="lineno"> 1623</span> <spanclass="comment"># have no effect if this option is set to NO (the default)</span></div>
<divclass="line"><aname="l01627"></a><spanclass="lineno"> 1627</span> <spanclass="comment"># The DOT_NUM_THREADS specifies the number of dot invocations doxygen is </span></div>
<divclass="line"><aname="l01628"></a><spanclass="lineno"> 1628</span> <spanclass="comment"># allowed to run in parallel. When set to 0 (the default) doxygen will </span></div>
<divclass="line"><aname="l01629"></a><spanclass="lineno"> 1629</span> <spanclass="comment"># base this on the number of processors available in the system. You can set it </span></div>
<divclass="line"><aname="l01630"></a><spanclass="lineno"> 1630</span> <spanclass="comment"># explicitly to a value larger than 0 to get control over the balance </span></div>
<divclass="line"><aname="l01631"></a><spanclass="lineno"> 1631</span> <spanclass="comment"># between CPU load and processing speed.</span></div>
<divclass="line"><aname="l01635"></a><spanclass="lineno"> 1635</span> <spanclass="comment"># By default doxygen will use the Helvetica font for all dot files that </span></div>
<divclass="line"><aname="l01636"></a><spanclass="lineno"> 1636</span> <spanclass="comment"># doxygen generates. When you want a differently looking font you can specify </span></div>
<divclass="line"><aname="l01637"></a><spanclass="lineno"> 1637</span> <spanclass="comment"># the font name using DOT_FONTNAME. You need to make sure dot is able to find </span></div>
<divclass="line"><aname="l01638"></a><spanclass="lineno"> 1638</span> <spanclass="comment"># the font, which can be done by putting it in a standard location or by setting </span></div>
<divclass="line"><aname="l01639"></a><spanclass="lineno"> 1639</span> <spanclass="comment"># the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the </span></div>
<divclass="line"><aname="l01640"></a><spanclass="lineno"> 1640</span> <spanclass="comment"># directory containing the font.</span></div>
<divclass="line"><aname="l01644"></a><spanclass="lineno"> 1644</span> <spanclass="comment"># The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. </span></div>
<divclass="line"><aname="l01645"></a><spanclass="lineno"> 1645</span> <spanclass="comment"># The default size is 10pt.</span></div>
<divclass="line"><aname="l01649"></a><spanclass="lineno"> 1649</span> <spanclass="comment"># By default doxygen will tell dot to use the Helvetica font. </span></div>
<divclass="line"><aname="l01650"></a><spanclass="lineno"> 1650</span> <spanclass="comment"># If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to </span></div>
<divclass="line"><aname="l01651"></a><spanclass="lineno"> 1651</span> <spanclass="comment"># set the path where dot can find it.</span></div>
<divclass="line"><aname="l01655"></a><spanclass="lineno"> 1655</span> <spanclass="comment"># If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen </span></div>
<divclass="line"><aname="l01656"></a><spanclass="lineno"> 1656</span> <spanclass="comment"># will generate a graph for each documented class showing the direct and </span></div>
<divclass="line"><aname="l01657"></a><spanclass="lineno"> 1657</span> <spanclass="comment"># indirect inheritance relations. Setting this tag to YES will force the </span></div>
<divclass="line"><aname="l01658"></a><spanclass="lineno"> 1658</span> <spanclass="comment"># CLASS_DIAGRAMS tag to NO.</span></div>
<divclass="line"><aname="l01662"></a><spanclass="lineno"> 1662</span> <spanclass="comment"># If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen </span></div>
<divclass="line"><aname="l01663"></a><spanclass="lineno"> 1663</span> <spanclass="comment"># will generate a graph for each documented class showing the direct and </span></div>
<divclass="line"><aname="l01664"></a><spanclass="lineno"> 1664</span> <spanclass="comment"># indirect implementation dependencies (inheritance, containment, and </span></div>
<divclass="line"><aname="l01665"></a><spanclass="lineno"> 1665</span> <spanclass="comment"># class references variables) of the class with other documented classes.</span></div>
<divclass="line"><aname="l01669"></a><spanclass="lineno"> 1669</span> <spanclass="comment"># If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen </span></div>
<divclass="line"><aname="l01670"></a><spanclass="lineno"> 1670</span> <spanclass="comment"># will generate a graph for groups, showing the direct groups dependencies</span></div>
<divclass="line"><aname="l01674"></a><spanclass="lineno"> 1674</span> <spanclass="comment"># If the UML_LOOK tag is set to YES doxygen will generate inheritance and </span></div>
<divclass="line"><aname="l01675"></a><spanclass="lineno"> 1675</span> <spanclass="comment"># collaboration diagrams in a style similar to the OMG's Unified Modeling </span></div>
<divclass="line"><aname="l01680"></a><spanclass="lineno"> 1680</span> <spanclass="comment"># If the UML_LOOK tag is enabled, the fields and methods are shown inside </span></div>
<divclass="line"><aname="l01681"></a><spanclass="lineno"> 1681</span> <spanclass="comment"># the class node. If there are many fields or methods and many nodes the </span></div>
<divclass="line"><aname="l01682"></a><spanclass="lineno"> 1682</span> <spanclass="comment"># graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS </span></div>
<divclass="line"><aname="l01683"></a><spanclass="lineno"> 1683</span> <spanclass="comment"># threshold limits the number of items for each type to make the size more </span></div>
<divclass="line"><aname="l01684"></a><spanclass="lineno"> 1684</span> <spanclass="comment"># managable. Set this to 0 for no limit. Note that the threshold may be </span></div>
<divclass="line"><aname="l01685"></a><spanclass="lineno"> 1685</span> <spanclass="comment"># exceeded by 50% before the limit is enforced.</span></div>
<divclass="line"><aname="l01689"></a><spanclass="lineno"> 1689</span> <spanclass="comment"># If set to YES, the inheritance and collaboration graphs will show the </span></div>
<divclass="line"><aname="l01690"></a><spanclass="lineno"> 1690</span> <spanclass="comment"># relations between templates and their instances.</span></div>
<divclass="line"><aname="l01694"></a><spanclass="lineno"> 1694</span> <spanclass="comment"># If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT </span></div>
<divclass="line"><aname="l01695"></a><spanclass="lineno"> 1695</span> <spanclass="comment"># tags are set to YES then doxygen will generate a graph for each documented </span></div>
<divclass="line"><aname="l01696"></a><spanclass="lineno"> 1696</span> <spanclass="comment"># file showing the direct and indirect include dependencies of the file with </span></div>
<divclass="line"><aname="l01697"></a><spanclass="lineno"> 1697</span> <spanclass="comment"># other documented files.</span></div>
<divclass="line"><aname="l01701"></a><spanclass="lineno"> 1701</span> <spanclass="comment"># If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and </span></div>
<divclass="line"><aname="l01702"></a><spanclass="lineno"> 1702</span> <spanclass="comment"># HAVE_DOT tags are set to YES then doxygen will generate a graph for each </span></div>
<divclass="line"><aname="l01703"></a><spanclass="lineno"> 1703</span> <spanclass="comment"># documented header file showing the documented files that directly or </span></div>
<divclass="line"><aname="l01704"></a><spanclass="lineno"> 1704</span> <spanclass="comment"># indirectly include this file.</span></div>
<divclass="line"><aname="l01708"></a><spanclass="lineno"> 1708</span> <spanclass="comment"># If the CALL_GRAPH and HAVE_DOT options are set to YES then </span></div>
<divclass="line"><aname="l01709"></a><spanclass="lineno"> 1709</span> <spanclass="comment"># doxygen will generate a call dependency graph for every global function </span></div>
<divclass="line"><aname="l01710"></a><spanclass="lineno"> 1710</span> <spanclass="comment"># or class method. Note that enabling this option will significantly increase </span></div>
<divclass="line"><aname="l01711"></a><spanclass="lineno"> 1711</span> <spanclass="comment"># the time of a run. So in most cases it will be better to enable call graphs </span></div>
<divclass="line"><aname="l01712"></a><spanclass="lineno"> 1712</span> <spanclass="comment"># for selected functions only using the \callgraph command.</span></div>
<divclass="line"><aname="l01716"></a><spanclass="lineno"> 1716</span> <spanclass="comment"># If the CALLER_GRAPH and HAVE_DOT tags are set to YES then </span></div>
<divclass="line"><aname="l01717"></a><spanclass="lineno"> 1717</span> <spanclass="comment"># doxygen will generate a caller dependency graph for every global function </span></div>
<divclass="line"><aname="l01718"></a><spanclass="lineno"> 1718</span> <spanclass="comment"># or class method. Note that enabling this option will significantly increase </span></div>
<divclass="line"><aname="l01719"></a><spanclass="lineno"> 1719</span> <spanclass="comment"># the time of a run. So in most cases it will be better to enable caller </span></div>
<divclass="line"><aname="l01720"></a><spanclass="lineno"> 1720</span> <spanclass="comment"># graphs for selected functions only using the \callergraph command.</span></div>
<divclass="line"><aname="l01724"></a><spanclass="lineno"> 1724</span> <spanclass="comment"># If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen </span></div>
<divclass="line"><aname="l01725"></a><spanclass="lineno"> 1725</span> <spanclass="comment"># will generate a graphical hierarchy of all classes instead of a textual one.</span></div>
<divclass="line"><aname="l01729"></a><spanclass="lineno"> 1729</span> <spanclass="comment"># If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES </span></div>
<divclass="line"><aname="l01730"></a><spanclass="lineno"> 1730</span> <spanclass="comment"># then doxygen will show the dependencies a directory has on other directories </span></div>
<divclass="line"><aname="l01731"></a><spanclass="lineno"> 1731</span> <spanclass="comment"># in a graphical way. The dependency relations are determined by the #include </span></div>
<divclass="line"><aname="l01732"></a><spanclass="lineno"> 1732</span> <spanclass="comment"># relations between the files in the directories.</span></div>
<divclass="line"><aname="l01736"></a><spanclass="lineno"> 1736</span> <spanclass="comment"># The DOT_IMAGE_FORMAT tag can be used to set the image format of the images </span></div>
<divclass="line"><aname="l01737"></a><spanclass="lineno"> 1737</span> <spanclass="comment"># generated by dot. Possible values are svg, png, jpg, or gif. </span></div>
<divclass="line"><aname="l01738"></a><spanclass="lineno"> 1738</span> <spanclass="comment"># If left blank png will be used. If you choose svg you need to set </span></div>
<divclass="line"><aname="l01739"></a><spanclass="lineno"> 1739</span> <spanclass="comment"># HTML_FILE_EXTENSION to xhtml in order to make the SVG files </span></div>
<divclass="line"><aname="l01740"></a><spanclass="lineno"> 1740</span> <spanclass="comment"># visible in IE 9+ (other browsers do not have this requirement).</span></div>
<divclass="line"><aname="l01744"></a><spanclass="lineno"> 1744</span> <spanclass="comment"># If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to </span></div>
<divclass="line"><aname="l01745"></a><spanclass="lineno"> 1745</span> <spanclass="comment"># enable generation of interactive SVG images that allow zooming and panning. </span></div>
<divclass="line"><aname="l01746"></a><spanclass="lineno"> 1746</span> <spanclass="comment"># Note that this requires a modern browser other than Internet Explorer. </span></div>
<divclass="line"><aname="l01747"></a><spanclass="lineno"> 1747</span> <spanclass="comment"># Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you </span></div>
<divclass="line"><aname="l01748"></a><spanclass="lineno"> 1748</span> <spanclass="comment"># need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files </span></div>
<divclass="line"><aname="l01749"></a><spanclass="lineno"> 1749</span> <spanclass="comment"># visible. Older versions of IE do not have SVG support.</span></div>
<divclass="line"><aname="l01753"></a><spanclass="lineno"> 1753</span> <spanclass="comment"># The tag DOT_PATH can be used to specify the path where the dot tool can be </span></div>
<divclass="line"><aname="l01754"></a><spanclass="lineno"> 1754</span> <spanclass="comment"># found. If left blank, it is assumed the dot tool can be found in the path.</span></div>
<divclass="line"><aname="l01758"></a><spanclass="lineno"> 1758</span> <spanclass="comment"># The DOTFILE_DIRS tag can be used to specify one or more directories that </span></div>
<divclass="line"><aname="l01759"></a><spanclass="lineno"> 1759</span> <spanclass="comment"># contain dot files that are included in the documentation (see the </span></div>
<divclass="line"><aname="l01764"></a><spanclass="lineno"> 1764</span> <spanclass="comment"># The MSCFILE_DIRS tag can be used to specify one or more directories that </span></div>
<divclass="line"><aname="l01765"></a><spanclass="lineno"> 1765</span> <spanclass="comment"># contain msc files that are included in the documentation (see the </span></div>
<divclass="line"><aname="l01770"></a><spanclass="lineno"> 1770</span> <spanclass="comment"># The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of </span></div>
<divclass="line"><aname="l01771"></a><spanclass="lineno"> 1771</span> <spanclass="comment"># nodes that will be shown in the graph. If the number of nodes in a graph </span></div>
<divclass="line"><aname="l01772"></a><spanclass="lineno"> 1772</span> <spanclass="comment"># becomes larger than this value, doxygen will truncate the graph, which is </span></div>
<divclass="line"><aname="l01773"></a><spanclass="lineno"> 1773</span> <spanclass="comment"># visualized by representing a node as a red box. Note that doxygen if the </span></div>
<divclass="line"><aname="l01774"></a><spanclass="lineno"> 1774</span> <spanclass="comment"># number of direct children of the root node in a graph is already larger than </span></div>
<divclass="line"><aname="l01775"></a><spanclass="lineno"> 1775</span> <spanclass="comment"># DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note </span></div>
<divclass="line"><aname="l01776"></a><spanclass="lineno"> 1776</span> <spanclass="comment"># that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.</span></div>
<divclass="line"><aname="l01780"></a><spanclass="lineno"> 1780</span> <spanclass="comment"># The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the </span></div>
<divclass="line"><aname="l01781"></a><spanclass="lineno"> 1781</span> <spanclass="comment"># graphs generated by dot. A depth value of 3 means that only nodes reachable </span></div>
<divclass="line"><aname="l01782"></a><spanclass="lineno"> 1782</span> <spanclass="comment"># from the root by following a path via at most 3 edges will be shown. Nodes </span></div>
<divclass="line"><aname="l01783"></a><spanclass="lineno"> 1783</span> <spanclass="comment"># that lay further from the root node will be omitted. Note that setting this </span></div>
<divclass="line"><aname="l01784"></a><spanclass="lineno"> 1784</span> <spanclass="comment"># option to 1 or 2 may greatly reduce the computation time needed for large </span></div>
<divclass="line"><aname="l01785"></a><spanclass="lineno"> 1785</span> <spanclass="comment"># code bases. Also note that the size of a graph can be further restricted by </span></div>
<divclass="line"><aname="l01786"></a><spanclass="lineno"> 1786</span> <spanclass="comment"># DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.</span></div>
<divclass="line"><aname="l01790"></a><spanclass="lineno"> 1790</span> <spanclass="comment"># Set the DOT_TRANSPARENT tag to YES to generate images with a transparent </span></div>
<divclass="line"><aname="l01791"></a><spanclass="lineno"> 1791</span> <spanclass="comment"># background. This is disabled by default, because dot on Windows does not </span></div>
<divclass="line"><aname="l01792"></a><spanclass="lineno"> 1792</span> <spanclass="comment"># seem to support this out of the box. Warning: Depending on the platform used, </span></div>
<divclass="line"><aname="l01793"></a><spanclass="lineno"> 1793</span> <spanclass="comment"># enabling this option may lead to badly anti-aliased labels on the edges of </span></div>
<divclass="line"><aname="l01794"></a><spanclass="lineno"> 1794</span> <spanclass="comment"># a graph (i.e. they become hard to read).</span></div>
<divclass="line"><aname="l01798"></a><spanclass="lineno"> 1798</span> <spanclass="comment"># Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output </span></div>
<divclass="line"><aname="l01799"></a><spanclass="lineno"> 1799</span> <spanclass="comment"># files in one run (i.e. multiple -o and -T options on the command line). This </span></div>
<divclass="line"><aname="l01800"></a><spanclass="lineno"> 1800</span> <spanclass="comment"># makes dot run faster, but since only newer versions of dot (>1.8.10) </span></div>
<divclass="line"><aname="l01801"></a><spanclass="lineno"> 1801</span> <spanclass="comment"># support this, this feature is disabled by default.</span></div>
<divclass="line"><aname="l01805"></a><spanclass="lineno"> 1805</span> <spanclass="comment"># If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will </span></div>
<divclass="line"><aname="l01806"></a><spanclass="lineno"> 1806</span> <spanclass="comment"># generate a legend page explaining the meaning of the various boxes and </span></div>
<divclass="line"><aname="l01807"></a><spanclass="lineno"> 1807</span> <spanclass="comment"># arrows in the dot generated graphs.</span></div>
<divclass="line"><aname="l01811"></a><spanclass="lineno"> 1811</span> <spanclass="comment"># If the DOT_CLEANUP tag is set to YES (the default) Doxygen will </span></div>
<divclass="line"><aname="l01812"></a><spanclass="lineno"> 1812</span> <spanclass="comment"># remove the intermediate dot files that are used to generate </span></div>
<divclass="line"><aname="l01813"></a><spanclass="lineno"> 1813</span> <spanclass="comment"># the various graphs.</span></div>
