| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.10"/> |
| <title>0.9.8: man.doxy Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="logo.png"/></td> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">0.9.8 |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.10 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="modules.html"><span>Modules</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_275089585c7fc1b5fd5d7d42c69cb1da.html">D:</a></li><li class="navelem"><a class="el" href="dir_7b98f88bffbed4b390b5f8f520d9c08e.html">Source</a></li><li class="navelem"><a class="el" href="dir_1f76e953200861345293ade84ac7fb6c.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e29b03b892e0e25920d021a614d4db9b.html">glm</a></li><li class="navelem"><a class="el" href="dir_577c788b67d63fb3b3b5752bd495d0f2.html">doc</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">man.doxy</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor"># Doxyfile 1.8.10</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"># This file describes the settings to be used by the documentation system</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor"># doxygen (www.doxygen.org) for a project.</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor"># All text after a double hash (##) is considered a comment and is placed in</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"># front of the TAG it is preceding.</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"># All text after a single hash (#) is considered a comment and will be ignored.</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"># The format is:</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"># TAG = value [value, ...]</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"># For lists, items can also be appended using:</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"># TAG += value [value, ...]</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"># Values that contain spaces should be placed between quotes (\" \").</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"># Project related configuration options</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"># This tag specifies the encoding used for all characters in the config file</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"># that follow. The default is UTF-8 which is also the encoding used for all text</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"># before the first occurrence of this tag. Doxygen uses libiconv (or the iconv</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"># built into libc) for the transcoding. See http://www.gnu.org/software/libiconv</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"># for the list of possible encodings.</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"># The default value is: UTF-8.</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> DOXYFILE_ENCODING = UTF-8</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"># The PROJECT_NAME tag is a single word (or a sequence of words surrounded by</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"># double-quotes, unless you are using Doxywizard) that should identify the</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"># project for which the documentation is generated. This name is used in the</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"># title of most generated pages and in a few other places.</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"># The default value is: My Project.</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> PROJECT_NAME = 0.9.7</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"># The PROJECT_NUMBER tag can be used to enter a project or revision number. This</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"># could be handy for archiving the generated documentation or if some version</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"># control system is used.</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> PROJECT_NUMBER = </div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"># Using the PROJECT_BRIEF tag one can provide an optional one line description</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"># for a project that appears at the top of each page and should give viewer a</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"># quick idea about the purpose of the project. Keep the description short.</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> PROJECT_BRIEF = </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"># With the PROJECT_LOGO tag one can specify a logo or an icon that is included</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"># in the documentation. The maximum height of the logo should not exceed 55</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"># pixels and the maximum width should not exceed 200 pixels. Doxygen will copy</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"># the logo to the output directory.</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> PROJECT_LOGO = D:/Source/G-Truc/<a class="code" href="a00141.html">glm</a>/doc/logo.png</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"># The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"># into which the generated documentation will be written. If a relative path is</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"># entered, it will be relative to the location where doxygen was started. If</span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"># left blank the current directory will be used.</span></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> OUTPUT_DIRECTORY = .</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"># directories (in 2 levels) under the output directory of each output format and</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"># will distribute the generated files over these directories. Enabling this</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"># option can be useful when feeding doxygen a huge amount of source files, where</span></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"># putting all generated files in the same directory would otherwise causes</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"># performance problems for the file system.</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> CREATE_SUBDIRS = NO</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"># If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII</span></div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"># characters to appear in the names of generated files. If set to NO, non-ASCII</span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"># characters will be escaped, for example _xE3_x81_x84 will be used for Unicode</span></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"># U+3044.</span></div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> ALLOW_UNICODE_NAMES = NO</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"># The OUTPUT_LANGUAGE tag is used to specify the language in which all</span></div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"># documentation generated by doxygen is written. Doxygen will use this</span></div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"># information to generate all constant output in the proper language.</span></div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor"># Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,</span></div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"># Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),</span></div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor"># Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,</span></div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"># Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),</span></div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"># Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,</span></div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"># Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,</span></div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"># Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,</span></div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor"># Ukrainian and Vietnamese.</span></div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"># The default value is: English.</span></div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> OUTPUT_LANGUAGE = English</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor"># If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member</span></div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"># descriptions after the members that are listed in the file and class</span></div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor"># documentation (similar to Javadoc). Set to NO to disable this.</span></div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> BRIEF_MEMBER_DESC = NO</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor"># If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief</span></div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor"># description of a member or function before the detailed description</span></div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor"># Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the</span></div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"># brief descriptions will be completely suppressed.</span></div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> REPEAT_BRIEF = YES</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor"># This tag implements a quasi-intelligent brief description abbreviator that is</span></div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor"># used to form the text in various listings. Each string in this list, if found</span></div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"># as the leading text of the brief description, will be stripped from the text</span></div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor"># and the result, after processing the whole list, is used as the annotated</span></div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"># text. Otherwise, the brief description is used as-is. If left blank, the</span></div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor"># following values are used ($name is automatically replaced with the name of</span></div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor"># the entity):The $name class, The $name widget, The $name file, is, provides,</span></div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor"># specifies, contains, represents, a, an and the.</span></div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> ABBREVIATE_BRIEF = <span class="stringliteral">"The $name class "</span> \</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="stringliteral">"The $name widget "</span> \</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="stringliteral">"The $name file "</span> \</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  is \</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  provides \</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  specifies \</div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  contains \</div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  represents \</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  a \</div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  an \</div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  the</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor"># If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then</span></div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor"># doxygen will generate a detailed section even if there is only a brief</span></div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor"># description.</span></div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> ALWAYS_DETAILED_SEC = NO</div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="preprocessor"># If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all</span></div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor"># inherited members of a class in the documentation of that class as if those</span></div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor"># members were ordinary class members. Constructors, destructors and assignment</span></div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor"># operators of the base classes will not be shown.</span></div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> INLINE_INHERITED_MEMB = NO</div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor"># If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path</span></div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor"># before files name in the file list and in the header files. If set to NO the</span></div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="preprocessor"># shortest path that makes the file name unique will be used</span></div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> FULL_PATH_NAMES = NO</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor"># The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.</span></div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor"># Stripping is only done if one of the specified strings matches the left-hand</span></div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor"># part of the path. The tag can be used to show relative paths in the file list.</span></div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor"># If left blank the directory from which doxygen is run is used as the path to</span></div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor"># strip.</span></div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor"># Note that you can specify absolute paths here, but also relative paths, which</span></div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor"># will be relative from the directory where doxygen is started.</span></div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="preprocessor"># This tag requires that the tag FULL_PATH_NAMES is set to YES.</span></div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> STRIP_FROM_PATH = <span class="stringliteral">"C:/Documents and Settings/Groove/ "</span></div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor"># The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the</span></div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor"># path mentioned in the documentation of a class, which tells the reader which</span></div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor"># header file to include in order to use a class. If left blank only the name of</span></div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor"># the header file containing the class definition is used. Otherwise one should</span></div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="preprocessor"># specify the list of include paths that are normally passed to the compiler</span></div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor"># using the -I flag.</span></div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div> |
| <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> STRIP_FROM_INC_PATH = </div> |
| <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div> |
| <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="preprocessor"># If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but</span></div> |
| <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="preprocessor"># less readable) file names. This can be useful is your file systems doesn't</span></div> |
| <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="preprocessor"># support long names like on DOS, Mac, or CD-ROM.</span></div> |
| <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div> |
| <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> SHORT_NAMES = YES</div> |
| <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div> |
| <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor"># If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the</span></div> |
| <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor"># first line (until the first dot) of a Javadoc-style comment as the brief</span></div> |
| <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor"># description. If set to NO, the Javadoc-style will behave just like regular Qt-</span></div> |
| <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="preprocessor"># style comments (thus requiring an explicit @brief command for a brief</span></div> |
| <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor"># description.)</span></div> |
| <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div> |
| <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> JAVADOC_AUTOBRIEF = YES</div> |
| <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div> |
| <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor"># If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first</span></div> |
| <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="preprocessor"># line (until the first dot) of a Qt-style comment as the brief description. If</span></div> |
| <div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="preprocessor"># set to NO, the Qt-style will behave just like regular Qt-style comments (thus</span></div> |
| <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="preprocessor"># requiring an explicit \brief command for a brief description.)</span></div> |
| <div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div> |
| <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> QT_AUTOBRIEF = NO</div> |
| <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div> |
| <div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="preprocessor"># The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a</span></div> |
| <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="preprocessor"># multi-line C++ special comment block (i.e. a block of </span></div> |
| <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="preprocessor"># a brief description. This used to be the default behavior. The new default is</span></div> |
| <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="preprocessor"># to treat a multi-line C++ comment block as a detailed description. Set this</span></div> |
| <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="preprocessor"># tag to YES if you prefer the old behavior instead.</span></div> |
| <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="preprocessor"># Note that setting this tag to YES also means that rational rose comments are</span></div> |
| <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="preprocessor"># not recognized any more.</span></div> |
| <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div> |
| <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> MULTILINE_CPP_IS_BRIEF = NO</div> |
| <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div> |
| <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="preprocessor"># If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the</span></div> |
| <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="preprocessor"># documentation from any documented member that it re-implements.</span></div> |
| <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div> |
| <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> INHERIT_DOCS = YES</div> |
| <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div> |
| <div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="preprocessor"># If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new</span></div> |
| <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="preprocessor"># page for each member. If set to NO, the documentation of a member will be part</span></div> |
| <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="preprocessor"># of the file/class/namespace that contains it.</span></div> |
| <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div> |
| <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> SEPARATE_MEMBER_PAGES = NO</div> |
| <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div> |
| <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="preprocessor"># The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen</span></div> |
| <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="preprocessor"># uses this value to replace tabs by spaces in code fragments.</span></div> |
| <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="preprocessor"># Minimum value: 1, maximum value: 16, default value: 4.</span></div> |
| <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div> |
| <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> TAB_SIZE = 8</div> |
| <div class="line"><a name="l00230"></a><span class="lineno"> 230</span> </div> |
| <div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="preprocessor"># This tag can be used to specify a number of aliases that act as commands in</span></div> |
| <div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="preprocessor"># the documentation. An alias has the form:</span></div> |
| <div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="preprocessor"># name=value</span></div> |
| <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor"># For example adding</span></div> |
| <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor"># "sideeffect=@par Side Effects:\n"</span></div> |
| <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="preprocessor"># will allow you to put the command \sideeffect (or @sideeffect) in the</span></div> |
| <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="preprocessor"># documentation, which will result in a user-defined paragraph with heading</span></div> |
| <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="preprocessor"># "Side Effects:". You can put \n's in the value part of an alias to insert</span></div> |
| <div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="preprocessor"># newlines.</span></div> |
| <div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div> |
| <div class="line"><a name="l00241"></a><span class="lineno"> 241</span> ALIASES = </div> |
| <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div> |
| <div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="preprocessor"># This tag can be used to specify a number of word-keyword mappings (TCL only).</span></div> |
| <div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="preprocessor"># A mapping has the form "name=value". For example adding "class=itcl::class"</span></div> |
| <div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="preprocessor"># will allow you to use the command class in the itcl::class meaning.</span></div> |
| <div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div> |
| <div class="line"><a name="l00247"></a><span class="lineno"> 247</span> TCL_SUBST = </div> |
| <div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div> |
| <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="preprocessor"># Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources</span></div> |
| <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="preprocessor"># only. Doxygen will then generate output that is more tailored for C. For</span></div> |
| <div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="preprocessor"># instance, some of the names that are used will be different. The list of all</span></div> |
| <div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="preprocessor"># members will be omitted, etc.</span></div> |
| <div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00254"></a><span class="lineno"> 254</span> </div> |
| <div class="line"><a name="l00255"></a><span class="lineno"> 255</span> OPTIMIZE_OUTPUT_FOR_C = NO</div> |
| <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div> |
| <div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="preprocessor"># Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or</span></div> |
| <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="preprocessor"># Python sources only. Doxygen will then generate output that is more tailored</span></div> |
| <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="preprocessor"># for that language. For instance, namespaces will be presented as packages,</span></div> |
| <div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="preprocessor"># qualified scopes will look different, etc.</span></div> |
| <div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div> |
| <div class="line"><a name="l00263"></a><span class="lineno"> 263</span> OPTIMIZE_OUTPUT_JAVA = NO</div> |
| <div class="line"><a name="l00264"></a><span class="lineno"> 264</span> </div> |
| <div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="preprocessor"># Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran</span></div> |
| <div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="preprocessor"># sources. Doxygen will then generate output that is tailored for Fortran.</span></div> |
| <div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00268"></a><span class="lineno"> 268</span> </div> |
| <div class="line"><a name="l00269"></a><span class="lineno"> 269</span> OPTIMIZE_FOR_FORTRAN = NO</div> |
| <div class="line"><a name="l00270"></a><span class="lineno"> 270</span> </div> |
| <div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="preprocessor"># Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL</span></div> |
| <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="preprocessor"># sources. Doxygen will then generate output that is tailored for VHDL.</span></div> |
| <div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00274"></a><span class="lineno"> 274</span> </div> |
| <div class="line"><a name="l00275"></a><span class="lineno"> 275</span> OPTIMIZE_OUTPUT_VHDL = NO</div> |
| <div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div> |
| <div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="preprocessor"># Doxygen selects the parser to use depending on the extension of the files it</span></div> |
| <div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="preprocessor"># parses. With this tag you can assign which parser to use for a given</span></div> |
| <div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="preprocessor"># extension. Doxygen has a built-in mapping, but you can override or extend it</span></div> |
| <div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="preprocessor"># using this tag. The format is ext=language, where ext is a file extension, and</span></div> |
| <div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="preprocessor"># language is one of the parsers supported by doxygen: IDL, Java, Javascript,</span></div> |
| <div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="preprocessor"># C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:</span></div> |
| <div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="preprocessor"># FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:</span></div> |
| <div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="preprocessor"># Fortran. In the later case the parser tries to guess whether the code is fixed</span></div> |
| <div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="preprocessor"># or free formatted code, this is the default for Fortran type files), VHDL. For</span></div> |
| <div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="preprocessor"># instance to make doxygen treat .inc files as Fortran files (default is PHP),</span></div> |
| <div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="preprocessor"># and .f files as C (default is Fortran), use: inc=Fortran f=C.</span></div> |
| <div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="preprocessor"># Note: For files without extension you can use no_extension as a placeholder.</span></div> |
| <div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="preprocessor"># Note that for custom extensions you also need to set FILE_PATTERNS otherwise</span></div> |
| <div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="preprocessor"># the files are not read by doxygen.</span></div> |
| <div class="line"><a name="l00293"></a><span class="lineno"> 293</span> </div> |
| <div class="line"><a name="l00294"></a><span class="lineno"> 294</span> EXTENSION_MAPPING = </div> |
| <div class="line"><a name="l00295"></a><span class="lineno"> 295</span> </div> |
| <div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="preprocessor"># If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments</span></div> |
| <div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="preprocessor"># according to the Markdown format, which allows for more readable</span></div> |
| <div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="preprocessor"># documentation. See http://daringfireball.net/projects/markdown/ for details.</span></div> |
| <div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="preprocessor"># The output of markdown processing is further processed by doxygen, so you can</span></div> |
| <div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="preprocessor"># mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in</span></div> |
| <div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="preprocessor"># case of backward compatibilities issues.</span></div> |
| <div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00303"></a><span class="lineno"> 303</span> </div> |
| <div class="line"><a name="l00304"></a><span class="lineno"> 304</span> MARKDOWN_SUPPORT = YES</div> |
| <div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div> |
| <div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="preprocessor"># When enabled doxygen tries to link words that correspond to documented</span></div> |
| <div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="preprocessor"># classes, or namespaces to their corresponding documentation. Such a link can</span></div> |
| <div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="preprocessor"># be prevented in individual cases by putting a % sign in front of the word or</span></div> |
| <div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="preprocessor"># globally by setting AUTOLINK_SUPPORT to NO.</span></div> |
| <div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div> |
| <div class="line"><a name="l00312"></a><span class="lineno"> 312</span> AUTOLINK_SUPPORT = YES</div> |
| <div class="line"><a name="l00313"></a><span class="lineno"> 313</span> </div> |
| <div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="preprocessor"># If you use STL classes (i.e. std::string, std::vector, etc.) but do not want</span></div> |
| <div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="preprocessor"># to include (a tag file for) the STL sources as input, then you should set this</span></div> |
| <div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="preprocessor"># tag to YES in order to let doxygen match functions declarations and</span></div> |
| <div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="preprocessor"># definitions whose arguments contain STL classes (e.g. func(std::string);</span></div> |
| <div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="preprocessor"># versus func(std::string) {}). This also make the inheritance and collaboration</span></div> |
| <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="preprocessor"># diagrams that involve STL classes more complete and accurate.</span></div> |
| <div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> </div> |
| <div class="line"><a name="l00322"></a><span class="lineno"> 322</span> BUILTIN_STL_SUPPORT = NO</div> |
| <div class="line"><a name="l00323"></a><span class="lineno"> 323</span> </div> |
| <div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="preprocessor"># If you use Microsoft's C++/CLI language, you should set this option to YES to</span></div> |
| <div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="preprocessor"># enable parsing support.</span></div> |
| <div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00327"></a><span class="lineno"> 327</span> </div> |
| <div class="line"><a name="l00328"></a><span class="lineno"> 328</span> CPP_CLI_SUPPORT = NO</div> |
| <div class="line"><a name="l00329"></a><span class="lineno"> 329</span> </div> |
| <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="preprocessor"># Set the SIP_SUPPORT tag to YES if your project consists of sip (see:</span></div> |
| <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="preprocessor"># http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen</span></div> |
| <div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="preprocessor"># will parse them like normal C++ but will assume all classes use public instead</span></div> |
| <div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="preprocessor"># of private inheritance when no explicit protection keyword is present.</span></div> |
| <div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00335"></a><span class="lineno"> 335</span> </div> |
| <div class="line"><a name="l00336"></a><span class="lineno"> 336</span> SIP_SUPPORT = NO</div> |
| <div class="line"><a name="l00337"></a><span class="lineno"> 337</span> </div> |
| <div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="preprocessor"># For Microsoft's IDL there are propget and propput attributes to indicate</span></div> |
| <div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="preprocessor"># getter and setter methods for a property. Setting this option to YES will make</span></div> |
| <div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="preprocessor"># doxygen to replace the get and set methods by a property in the documentation.</span></div> |
| <div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="preprocessor"># This will only work if the methods are indeed getting or setting a simple</span></div> |
| <div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="preprocessor"># type. If this is not the case, or you want to show the methods anyway, you</span></div> |
| <div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="preprocessor"># should set this option to NO.</span></div> |
| <div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00345"></a><span class="lineno"> 345</span> </div> |
| <div class="line"><a name="l00346"></a><span class="lineno"> 346</span> IDL_PROPERTY_SUPPORT = YES</div> |
| <div class="line"><a name="l00347"></a><span class="lineno"> 347</span> </div> |
| <div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="preprocessor"># If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC</span></div> |
| <div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="preprocessor"># tag is set to YES then doxygen will reuse the documentation of the first</span></div> |
| <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="preprocessor"># member in the group (if any) for the other members of the group. By default</span></div> |
| <div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="preprocessor"># all members of a group must be documented explicitly.</span></div> |
| <div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00353"></a><span class="lineno"> 353</span> </div> |
| <div class="line"><a name="l00354"></a><span class="lineno"> 354</span> DISTRIBUTE_GROUP_DOC = NO</div> |
| <div class="line"><a name="l00355"></a><span class="lineno"> 355</span> </div> |
| <div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="preprocessor"># If one adds a struct or class to a group and this option is enabled, then also</span></div> |
| <div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="preprocessor"># any nested class or struct is added to the same group. By default this option</span></div> |
| <div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="preprocessor"># is disabled and one has to add nested compounds explicitly via \ingroup.</span></div> |
| <div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00360"></a><span class="lineno"> 360</span> </div> |
| <div class="line"><a name="l00361"></a><span class="lineno"> 361</span> GROUP_NESTED_COMPOUNDS = NO</div> |
| <div class="line"><a name="l00362"></a><span class="lineno"> 362</span> </div> |
| <div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="preprocessor"># Set the SUBGROUPING tag to YES to allow class member groups of the same type</span></div> |
| <div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="preprocessor"># (for instance a group of public functions) to be put as a subgroup of that</span></div> |
| <div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="preprocessor"># type (e.g. under the Public Functions section). Set it to NO to prevent</span></div> |
| <div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="preprocessor"># subgrouping. Alternatively, this can be done per class using the</span></div> |
| <div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="preprocessor"># \nosubgrouping command.</span></div> |
| <div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00369"></a><span class="lineno"> 369</span> </div> |
| <div class="line"><a name="l00370"></a><span class="lineno"> 370</span> SUBGROUPING = NO</div> |
| <div class="line"><a name="l00371"></a><span class="lineno"> 371</span> </div> |
| <div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="preprocessor"># When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions</span></div> |
| <div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="preprocessor"># are shown inside the group in which they are included (e.g. using \ingroup)</span></div> |
| <div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="preprocessor"># instead of on a separate page (for HTML and Man pages) or section (for LaTeX</span></div> |
| <div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="preprocessor"># and RTF).</span></div> |
| <div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="preprocessor"># Note that this feature does not work in combination with</span></div> |
| <div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="preprocessor"># SEPARATE_MEMBER_PAGES.</span></div> |
| <div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00380"></a><span class="lineno"> 380</span> </div> |
| <div class="line"><a name="l00381"></a><span class="lineno"> 381</span> INLINE_GROUPED_CLASSES = NO</div> |
| <div class="line"><a name="l00382"></a><span class="lineno"> 382</span> </div> |
| <div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="preprocessor"># When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions</span></div> |
| <div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="preprocessor"># with only public data fields or simple typedef fields will be shown inline in</span></div> |
| <div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="preprocessor"># the documentation of the scope in which they are defined (i.e. file,</span></div> |
| <div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="preprocessor"># namespace, or group documentation), provided this scope is documented. If set</span></div> |
| <div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="preprocessor"># to NO, structs, classes, and unions are shown on a separate page (for HTML and</span></div> |
| <div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="preprocessor"># Man pages) or section (for LaTeX and RTF).</span></div> |
| <div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00390"></a><span class="lineno"> 390</span> </div> |
| <div class="line"><a name="l00391"></a><span class="lineno"> 391</span> INLINE_SIMPLE_STRUCTS = NO</div> |
| <div class="line"><a name="l00392"></a><span class="lineno"> 392</span> </div> |
| <div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="preprocessor"># When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or</span></div> |
| <div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="preprocessor"># enum is documented as struct, union, or enum with the name of the typedef. So</span></div> |
| <div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="preprocessor"># typedef struct TypeS {} TypeT, will appear in the documentation as a struct</span></div> |
| <div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="preprocessor"># with name TypeT. When disabled the typedef will appear as a member of a file,</span></div> |
| <div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="preprocessor"># namespace, or class. And the struct will be named TypeS. This can typically be</span></div> |
| <div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="preprocessor"># useful for C code in case the coding convention dictates that all compound</span></div> |
| <div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="preprocessor"># types are typedef'ed and only the typedef is referenced, never the tag name.</span></div> |
| <div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00401"></a><span class="lineno"> 401</span> </div> |
| <div class="line"><a name="l00402"></a><span class="lineno"> 402</span> TYPEDEF_HIDES_STRUCT = NO</div> |
| <div class="line"><a name="l00403"></a><span class="lineno"> 403</span> </div> |
| <div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="preprocessor"># The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This</span></div> |
| <div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="preprocessor"># cache is used to resolve symbols given their name and scope. Since this can be</span></div> |
| <div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="preprocessor"># an expensive process and often the same symbol appears multiple times in the</span></div> |
| <div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="preprocessor"># code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small</span></div> |
| <div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="preprocessor"># doxygen will become slower. If the cache is too large, memory is wasted. The</span></div> |
| <div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="preprocessor"># cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range</span></div> |
| <div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="preprocessor"># is 0..9, the default is 0, corresponding to a cache size of 2^16=65536</span></div> |
| <div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="preprocessor"># symbols. At the end of a run doxygen will report the cache usage and suggest</span></div> |
| <div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="preprocessor"># the optimal cache size from a speed point of view.</span></div> |
| <div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="preprocessor"># Minimum value: 0, maximum value: 9, default value: 0.</span></div> |
| <div class="line"><a name="l00414"></a><span class="lineno"> 414</span> </div> |
| <div class="line"><a name="l00415"></a><span class="lineno"> 415</span> LOOKUP_CACHE_SIZE = 0</div> |
| <div class="line"><a name="l00416"></a><span class="lineno"> 416</span> </div> |
| <div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="preprocessor">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="preprocessor"># Build related configuration options</span></div> |
| <div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="preprocessor">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00420"></a><span class="lineno"> 420</span> </div> |
| <div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="preprocessor"># If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in</span></div> |
| <div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="preprocessor"># documentation are documented, even if no documentation was available. Private</span></div> |
| <div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="preprocessor"># class members and static file members will be hidden unless the</span></div> |
| <div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="preprocessor"># EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.</span></div> |
| <div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="preprocessor"># Note: This will also disable the warnings about undocumented members that are</span></div> |
| <div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="preprocessor"># normally produced when WARNINGS is set to YES.</span></div> |
| <div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00428"></a><span class="lineno"> 428</span> </div> |
| <div class="line"><a name="l00429"></a><span class="lineno"> 429</span> EXTRACT_ALL = NO</div> |
| <div class="line"><a name="l00430"></a><span class="lineno"> 430</span> </div> |
| <div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="preprocessor"># If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will</span></div> |
| <div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="preprocessor"># be included in the documentation.</span></div> |
| <div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00434"></a><span class="lineno"> 434</span> </div> |
| <div class="line"><a name="l00435"></a><span class="lineno"> 435</span> EXTRACT_PRIVATE = NO</div> |
| <div class="line"><a name="l00436"></a><span class="lineno"> 436</span> </div> |
| <div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="preprocessor"># If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal</span></div> |
| <div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="preprocessor"># scope will be included in the documentation.</span></div> |
| <div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00440"></a><span class="lineno"> 440</span> </div> |
| <div class="line"><a name="l00441"></a><span class="lineno"> 441</span> EXTRACT_PACKAGE = NO</div> |
| <div class="line"><a name="l00442"></a><span class="lineno"> 442</span> </div> |
| <div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="preprocessor"># If the EXTRACT_STATIC tag is set to YES, all static members of a file will be</span></div> |
| <div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="preprocessor"># included in the documentation.</span></div> |
| <div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00446"></a><span class="lineno"> 446</span> </div> |
| <div class="line"><a name="l00447"></a><span class="lineno"> 447</span> EXTRACT_STATIC = YES</div> |
| <div class="line"><a name="l00448"></a><span class="lineno"> 448</span> </div> |
| <div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="preprocessor"># If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined</span></div> |
| <div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="preprocessor"># locally in source files will be included in the documentation. If set to NO,</span></div> |
| <div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="preprocessor"># only classes defined in header files are included. Does not have any effect</span></div> |
| <div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="preprocessor"># for Java sources.</span></div> |
| <div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00454"></a><span class="lineno"> 454</span> </div> |
| <div class="line"><a name="l00455"></a><span class="lineno"> 455</span> EXTRACT_LOCAL_CLASSES = NO</div> |
| <div class="line"><a name="l00456"></a><span class="lineno"> 456</span> </div> |
| <div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="preprocessor"># This flag is only useful for Objective-C code. If set to YES, local methods,</span></div> |
| <div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="preprocessor"># which are defined in the implementation section but not in the interface are</span></div> |
| <div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="preprocessor"># included in the documentation. If set to NO, only methods in the interface are</span></div> |
| <div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="preprocessor"># included.</span></div> |
| <div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00462"></a><span class="lineno"> 462</span> </div> |
| <div class="line"><a name="l00463"></a><span class="lineno"> 463</span> EXTRACT_LOCAL_METHODS = NO</div> |
| <div class="line"><a name="l00464"></a><span class="lineno"> 464</span> </div> |
| <div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="preprocessor"># If this flag is set to YES, the members of anonymous namespaces will be</span></div> |
| <div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="preprocessor"># extracted and appear in the documentation as a namespace called</span></div> |
| <div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="preprocessor"># 'anonymous_namespace{file}', where file will be replaced with the base name of</span></div> |
| <div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="preprocessor"># the file that contains the anonymous namespace. By default anonymous namespace</span></div> |
| <div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="preprocessor"># are hidden.</span></div> |
| <div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00471"></a><span class="lineno"> 471</span> </div> |
| <div class="line"><a name="l00472"></a><span class="lineno"> 472</span> EXTRACT_ANON_NSPACES = NO</div> |
| <div class="line"><a name="l00473"></a><span class="lineno"> 473</span> </div> |
| <div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="preprocessor"># If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all</span></div> |
| <div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="preprocessor"># undocumented members inside documented classes or files. If set to NO these</span></div> |
| <div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="preprocessor"># members will be included in the various overviews, but no documentation</span></div> |
| <div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="preprocessor"># section is generated. This option has no effect if EXTRACT_ALL is enabled.</span></div> |
| <div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00479"></a><span class="lineno"> 479</span> </div> |
| <div class="line"><a name="l00480"></a><span class="lineno"> 480</span> HIDE_UNDOC_MEMBERS = YES</div> |
| <div class="line"><a name="l00481"></a><span class="lineno"> 481</span> </div> |
| <div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="preprocessor"># If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all</span></div> |
| <div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="preprocessor"># undocumented classes that are normally visible in the class hierarchy. If set</span></div> |
| <div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="preprocessor"># to NO, these classes will be included in the various overviews. This option</span></div> |
| <div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="preprocessor"># has no effect if EXTRACT_ALL is enabled.</span></div> |
| <div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00487"></a><span class="lineno"> 487</span> </div> |
| <div class="line"><a name="l00488"></a><span class="lineno"> 488</span> HIDE_UNDOC_CLASSES = YES</div> |
| <div class="line"><a name="l00489"></a><span class="lineno"> 489</span> </div> |
| <div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="preprocessor"># If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend</span></div> |
| <div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="preprocessor"># (class|struct|union) declarations. If set to NO, these declarations will be</span></div> |
| <div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="preprocessor"># included in the documentation.</span></div> |
| <div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00494"></a><span class="lineno"> 494</span> </div> |
| <div class="line"><a name="l00495"></a><span class="lineno"> 495</span> HIDE_FRIEND_COMPOUNDS = YES</div> |
| <div class="line"><a name="l00496"></a><span class="lineno"> 496</span> </div> |
| <div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="preprocessor"># If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any</span></div> |
| <div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="preprocessor"># documentation blocks found inside the body of a function. If set to NO, these</span></div> |
| <div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="preprocessor"># blocks will be appended to the function's detailed documentation block.</span></div> |
| <div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00501"></a><span class="lineno"> 501</span> </div> |
| <div class="line"><a name="l00502"></a><span class="lineno"> 502</span> HIDE_IN_BODY_DOCS = YES</div> |
| <div class="line"><a name="l00503"></a><span class="lineno"> 503</span> </div> |
| <div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="preprocessor"># The INTERNAL_DOCS tag determines if documentation that is typed after a</span></div> |
| <div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="preprocessor"># \internal command is included. If the tag is set to NO then the documentation</span></div> |
| <div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="preprocessor"># will be excluded. Set it to YES to include the internal documentation.</span></div> |
| <div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00508"></a><span class="lineno"> 508</span> </div> |
| <div class="line"><a name="l00509"></a><span class="lineno"> 509</span> INTERNAL_DOCS = NO</div> |
| <div class="line"><a name="l00510"></a><span class="lineno"> 510</span> </div> |
| <div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="preprocessor"># If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file</span></div> |
| <div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="preprocessor"># names in lower-case letters. If set to YES, upper-case letters are also</span></div> |
| <div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="preprocessor"># allowed. This is useful if you have classes or files whose names only differ</span></div> |
| <div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="preprocessor"># in case and if your file system supports case sensitive file names. Windows</span></div> |
| <div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="preprocessor"># and Mac users are advised to set this option to NO.</span></div> |
| <div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="preprocessor"># The default value is: system dependent.</span></div> |
| <div class="line"><a name="l00517"></a><span class="lineno"> 517</span> </div> |
| <div class="line"><a name="l00518"></a><span class="lineno"> 518</span> CASE_SENSE_NAMES = YES</div> |
| <div class="line"><a name="l00519"></a><span class="lineno"> 519</span> </div> |
| <div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="preprocessor"># If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with</span></div> |
| <div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="preprocessor"># their full class and namespace scopes in the documentation. If set to YES, the</span></div> |
| <div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="preprocessor"># scope will be hidden.</span></div> |
| <div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00524"></a><span class="lineno"> 524</span> </div> |
| <div class="line"><a name="l00525"></a><span class="lineno"> 525</span> HIDE_SCOPE_NAMES = YES</div> |
| <div class="line"><a name="l00526"></a><span class="lineno"> 526</span> </div> |
| <div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="preprocessor"># If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will</span></div> |
| <div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="preprocessor"># append additional text to a page's title, such as Class Reference. If set to</span></div> |
| <div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="preprocessor"># YES the compound reference will be hidden.</span></div> |
| <div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00531"></a><span class="lineno"> 531</span> </div> |
| <div class="line"><a name="l00532"></a><span class="lineno"> 532</span> HIDE_COMPOUND_REFERENCE= NO</div> |
| <div class="line"><a name="l00533"></a><span class="lineno"> 533</span> </div> |
| <div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="preprocessor"># If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of</span></div> |
| <div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="preprocessor"># the files that are included by a file in the documentation of that file.</span></div> |
| <div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00537"></a><span class="lineno"> 537</span> </div> |
| <div class="line"><a name="l00538"></a><span class="lineno"> 538</span> SHOW_INCLUDE_FILES = NO</div> |
| <div class="line"><a name="l00539"></a><span class="lineno"> 539</span> </div> |
| <div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="preprocessor"># If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each</span></div> |
| <div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="preprocessor"># grouped member an include statement to the documentation, telling the reader</span></div> |
| <div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="preprocessor"># which file to include in order to use the member.</span></div> |
| <div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00544"></a><span class="lineno"> 544</span> </div> |
| <div class="line"><a name="l00545"></a><span class="lineno"> 545</span> SHOW_GROUPED_MEMB_INC = NO</div> |
| <div class="line"><a name="l00546"></a><span class="lineno"> 546</span> </div> |
| <div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="preprocessor"># If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include</span></div> |
| <div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="preprocessor"># files with double quotes in the documentation rather than with sharp brackets.</span></div> |
| <div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00550"></a><span class="lineno"> 550</span> </div> |
| <div class="line"><a name="l00551"></a><span class="lineno"> 551</span> FORCE_LOCAL_INCLUDES = NO</div> |
| <div class="line"><a name="l00552"></a><span class="lineno"> 552</span> </div> |
| <div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="preprocessor"># If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the</span></div> |
| <div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="preprocessor"># documentation for inline members.</span></div> |
| <div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00556"></a><span class="lineno"> 556</span> </div> |
| <div class="line"><a name="l00557"></a><span class="lineno"> 557</span> INLINE_INFO = NO</div> |
| <div class="line"><a name="l00558"></a><span class="lineno"> 558</span> </div> |
| <div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="preprocessor"># If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the</span></div> |
| <div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="preprocessor"># (detailed) documentation of file and class members alphabetically by member</span></div> |
| <div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="preprocessor"># name. If set to NO, the members will appear in declaration order.</span></div> |
| <div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00563"></a><span class="lineno"> 563</span> </div> |
| <div class="line"><a name="l00564"></a><span class="lineno"> 564</span> SORT_MEMBER_DOCS = YES</div> |
| <div class="line"><a name="l00565"></a><span class="lineno"> 565</span> </div> |
| <div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="preprocessor"># If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief</span></div> |
| <div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="preprocessor"># descriptions of file, namespace and class members alphabetically by member</span></div> |
| <div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="preprocessor"># name. If set to NO, the members will appear in declaration order. Note that</span></div> |
| <div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="preprocessor"># this will also influence the order of the classes in the class list.</span></div> |
| <div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00571"></a><span class="lineno"> 571</span> </div> |
| <div class="line"><a name="l00572"></a><span class="lineno"> 572</span> SORT_BRIEF_DOCS = YES</div> |
| <div class="line"><a name="l00573"></a><span class="lineno"> 573</span> </div> |
| <div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="preprocessor"># If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the</span></div> |
| <div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="preprocessor"># (brief and detailed) documentation of class members so that constructors and</span></div> |
| <div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="preprocessor"># destructors are listed first. If set to NO the constructors will appear in the</span></div> |
| <div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="preprocessor"># respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.</span></div> |
| <div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="preprocessor"># Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief</span></div> |
| <div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="preprocessor"># member documentation.</span></div> |
| <div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="preprocessor"># Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting</span></div> |
| <div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="preprocessor"># detailed member documentation.</span></div> |
| <div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00583"></a><span class="lineno"> 583</span> </div> |
| <div class="line"><a name="l00584"></a><span class="lineno"> 584</span> SORT_MEMBERS_CTORS_1ST = NO</div> |
| <div class="line"><a name="l00585"></a><span class="lineno"> 585</span> </div> |
| <div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="preprocessor"># If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy</span></div> |
| <div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="preprocessor"># of group names into alphabetical order. If set to NO the group names will</span></div> |
| <div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="preprocessor"># appear in their defined order.</span></div> |
| <div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00590"></a><span class="lineno"> 590</span> </div> |
| <div class="line"><a name="l00591"></a><span class="lineno"> 591</span> SORT_GROUP_NAMES = NO</div> |
| <div class="line"><a name="l00592"></a><span class="lineno"> 592</span> </div> |
| <div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="preprocessor"># If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by</span></div> |
| <div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="preprocessor"># fully-qualified names, including namespaces. If set to NO, the class list will</span></div> |
| <div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="preprocessor"># be sorted only by class name, not including the namespace part.</span></div> |
| <div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="preprocessor"># Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.</span></div> |
| <div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="preprocessor"># Note: This option applies only to the class list, not to the alphabetical</span></div> |
| <div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="preprocessor"># list.</span></div> |
| <div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00600"></a><span class="lineno"> 600</span> </div> |
| <div class="line"><a name="l00601"></a><span class="lineno"> 601</span> SORT_BY_SCOPE_NAME = YES</div> |
| <div class="line"><a name="l00602"></a><span class="lineno"> 602</span> </div> |
| <div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="preprocessor"># If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper</span></div> |
| <div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="preprocessor"># type resolution of all parameters of a function it will reject a match between</span></div> |
| <div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="preprocessor"># the prototype and the implementation of a member function even if there is</span></div> |
| <div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="preprocessor"># only one candidate or it is obvious which candidate to choose by doing a</span></div> |
| <div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="preprocessor"># simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still</span></div> |
| <div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="preprocessor"># accept a match between prototype and implementation in such cases.</span></div> |
| <div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00610"></a><span class="lineno"> 610</span> </div> |
| <div class="line"><a name="l00611"></a><span class="lineno"> 611</span> STRICT_PROTO_MATCHING = NO</div> |
| <div class="line"><a name="l00612"></a><span class="lineno"> 612</span> </div> |
| <div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="preprocessor"># The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo</span></div> |
| <div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="preprocessor"># list. This list is created by putting \todo commands in the documentation.</span></div> |
| <div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00616"></a><span class="lineno"> 616</span> </div> |
| <div class="line"><a name="l00617"></a><span class="lineno"> 617</span> GENERATE_TODOLIST = YES</div> |
| <div class="line"><a name="l00618"></a><span class="lineno"> 618</span> </div> |
| <div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="preprocessor"># The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test</span></div> |
| <div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="preprocessor"># list. This list is created by putting \test commands in the documentation.</span></div> |
| <div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00622"></a><span class="lineno"> 622</span> </div> |
| <div class="line"><a name="l00623"></a><span class="lineno"> 623</span> GENERATE_TESTLIST = YES</div> |
| <div class="line"><a name="l00624"></a><span class="lineno"> 624</span> </div> |
| <div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="preprocessor"># The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug</span></div> |
| <div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="preprocessor"># list. This list is created by putting \bug commands in the documentation.</span></div> |
| <div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00628"></a><span class="lineno"> 628</span> </div> |
| <div class="line"><a name="l00629"></a><span class="lineno"> 629</span> GENERATE_BUGLIST = YES</div> |
| <div class="line"><a name="l00630"></a><span class="lineno"> 630</span> </div> |
| <div class="line"><a name="l00631"></a><span class="lineno"> 631</span> <span class="preprocessor"># The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)</span></div> |
| <div class="line"><a name="l00632"></a><span class="lineno"> 632</span> <span class="preprocessor"># the deprecated list. This list is created by putting \deprecated commands in</span></div> |
| <div class="line"><a name="l00633"></a><span class="lineno"> 633</span> <span class="preprocessor"># the documentation.</span></div> |
| <div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00635"></a><span class="lineno"> 635</span> </div> |
| <div class="line"><a name="l00636"></a><span class="lineno"> 636</span> GENERATE_DEPRECATEDLIST= YES</div> |
| <div class="line"><a name="l00637"></a><span class="lineno"> 637</span> </div> |
| <div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="preprocessor"># The ENABLED_SECTIONS tag can be used to enable conditional documentation</span></div> |
| <div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="preprocessor"># sections, marked by \if <section_label> ... \endif and \cond <section_label></span></div> |
| <div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="preprocessor"># ... \endcond blocks.</span></div> |
| <div class="line"><a name="l00641"></a><span class="lineno"> 641</span> </div> |
| <div class="line"><a name="l00642"></a><span class="lineno"> 642</span> ENABLED_SECTIONS = </div> |
| <div class="line"><a name="l00643"></a><span class="lineno"> 643</span> </div> |
| <div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="preprocessor"># The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the</span></div> |
| <div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="preprocessor"># initial value of a variable or macro / define can have for it to appear in the</span></div> |
| <div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="preprocessor"># documentation. If the initializer consists of more lines than specified here</span></div> |
| <div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="preprocessor"># it will be hidden. Use a value of 0 to hide initializers completely. The</span></div> |
| <div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="preprocessor"># appearance of the value of individual variables and macros / defines can be</span></div> |
| <div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="preprocessor"># controlled using \showinitializer or \hideinitializer command in the</span></div> |
| <div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="preprocessor"># documentation regardless of this setting.</span></div> |
| <div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="preprocessor"># Minimum value: 0, maximum value: 10000, default value: 30.</span></div> |
| <div class="line"><a name="l00652"></a><span class="lineno"> 652</span> </div> |
| <div class="line"><a name="l00653"></a><span class="lineno"> 653</span> MAX_INITIALIZER_LINES = 30</div> |
| <div class="line"><a name="l00654"></a><span class="lineno"> 654</span> </div> |
| <div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="preprocessor"># Set the SHOW_USED_FILES tag to NO to disable the list of files generated at</span></div> |
| <div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="preprocessor"># the bottom of the documentation of classes and structs. If set to YES, the</span></div> |
| <div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="preprocessor"># list will mention the files that were used to generate the documentation.</span></div> |
| <div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00659"></a><span class="lineno"> 659</span> </div> |
| <div class="line"><a name="l00660"></a><span class="lineno"> 660</span> SHOW_USED_FILES = NO</div> |
| <div class="line"><a name="l00661"></a><span class="lineno"> 661</span> </div> |
| <div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="preprocessor"># Set the SHOW_FILES tag to NO to disable the generation of the Files page. This</span></div> |
| <div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="preprocessor"># will remove the Files entry from the Quick Index and from the Folder Tree View</span></div> |
| <div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="preprocessor"># (if specified).</span></div> |
| <div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00666"></a><span class="lineno"> 666</span> </div> |
| <div class="line"><a name="l00667"></a><span class="lineno"> 667</span> SHOW_FILES = YES</div> |
| <div class="line"><a name="l00668"></a><span class="lineno"> 668</span> </div> |
| <div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="preprocessor"># Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces</span></div> |
| <div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="preprocessor"># page. This will remove the Namespaces entry from the Quick Index and from the</span></div> |
| <div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="preprocessor"># Folder Tree View (if specified).</span></div> |
| <div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00673"></a><span class="lineno"> 673</span> </div> |
| <div class="line"><a name="l00674"></a><span class="lineno"> 674</span> SHOW_NAMESPACES = YES</div> |
| <div class="line"><a name="l00675"></a><span class="lineno"> 675</span> </div> |
| <div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="preprocessor"># The FILE_VERSION_FILTER tag can be used to specify a program or script that</span></div> |
| <div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="preprocessor"># doxygen should invoke to get the current version for each file (typically from</span></div> |
| <div class="line"><a name="l00678"></a><span class="lineno"> 678</span> <span class="preprocessor"># the version control system). Doxygen will invoke the program by executing (via</span></div> |
| <div class="line"><a name="l00679"></a><span class="lineno"> 679</span> <span class="preprocessor"># popen()) the command command input-file, where command is the value of the</span></div> |
| <div class="line"><a name="l00680"></a><span class="lineno"> 680</span> <span class="preprocessor"># FILE_VERSION_FILTER tag, and input-file is the name of an input file provided</span></div> |
| <div class="line"><a name="l00681"></a><span class="lineno"> 681</span> <span class="preprocessor"># by doxygen. Whatever the program writes to standard output is used as the file</span></div> |
| <div class="line"><a name="l00682"></a><span class="lineno"> 682</span> <span class="preprocessor"># version. For an example see the documentation.</span></div> |
| <div class="line"><a name="l00683"></a><span class="lineno"> 683</span> </div> |
| <div class="line"><a name="l00684"></a><span class="lineno"> 684</span> FILE_VERSION_FILTER = </div> |
| <div class="line"><a name="l00685"></a><span class="lineno"> 685</span> </div> |
| <div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="preprocessor"># The LAYOUT_FILE tag can be used to specify a layout file which will be parsed</span></div> |
| <div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="preprocessor"># by doxygen. The layout file controls the global structure of the generated</span></div> |
| <div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="preprocessor"># output files in an output format independent way. To create the layout file</span></div> |
| <div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="preprocessor"># that represents doxygen's defaults, run doxygen with the -l option. You can</span></div> |
| <div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="preprocessor"># optionally specify a file name after the option, if omitted DoxygenLayout.xml</span></div> |
| <div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="preprocessor"># will be used as the name of the layout file.</span></div> |
| <div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="preprocessor"># Note that if you run doxygen from a directory containing a file called</span></div> |
| <div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="preprocessor"># DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE</span></div> |
| <div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="preprocessor"># tag is left empty.</span></div> |
| <div class="line"><a name="l00696"></a><span class="lineno"> 696</span> </div> |
| <div class="line"><a name="l00697"></a><span class="lineno"> 697</span> LAYOUT_FILE = </div> |
| <div class="line"><a name="l00698"></a><span class="lineno"> 698</span> </div> |
| <div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="preprocessor"># The CITE_BIB_FILES tag can be used to specify one or more bib files containing</span></div> |
| <div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="preprocessor"># the reference definitions. This must be a list of .bib files. The .bib</span></div> |
| <div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="preprocessor"># extension is automatically appended if omitted. This requires the bibtex tool</span></div> |
| <div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="preprocessor"># to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.</span></div> |
| <div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="preprocessor"># For LaTeX the style of the bibliography can be controlled using</span></div> |
| <div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="preprocessor"># LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the</span></div> |
| <div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="preprocessor"># search path. See also \cite for info how to create references.</span></div> |
| <div class="line"><a name="l00706"></a><span class="lineno"> 706</span> </div> |
| <div class="line"><a name="l00707"></a><span class="lineno"> 707</span> CITE_BIB_FILES = </div> |
| <div class="line"><a name="l00708"></a><span class="lineno"> 708</span> </div> |
| <div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="preprocessor">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="preprocessor"># Configuration options related to warning and progress messages</span></div> |
| <div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="preprocessor">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00712"></a><span class="lineno"> 712</span> </div> |
| <div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="preprocessor"># The QUIET tag can be used to turn on/off the messages that are generated to</span></div> |
| <div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="preprocessor"># standard output by doxygen. If QUIET is set to YES this implies that the</span></div> |
| <div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <span class="preprocessor"># messages are off.</span></div> |
| <div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00717"></a><span class="lineno"> 717</span> </div> |
| <div class="line"><a name="l00718"></a><span class="lineno"> 718</span> QUIET = NO</div> |
| <div class="line"><a name="l00719"></a><span class="lineno"> 719</span> </div> |
| <div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="preprocessor"># The WARNINGS tag can be used to turn on/off the warning messages that are</span></div> |
| <div class="line"><a name="l00721"></a><span class="lineno"> 721</span> <span class="preprocessor"># generated to standard error (stderr) by doxygen. If WARNINGS is set to YES</span></div> |
| <div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="preprocessor"># this implies that the warnings are on.</span></div> |
| <div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="preprocessor"># Tip: Turn warnings on while writing the documentation.</span></div> |
| <div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00726"></a><span class="lineno"> 726</span> </div> |
| <div class="line"><a name="l00727"></a><span class="lineno"> 727</span> WARNINGS = YES</div> |
| <div class="line"><a name="l00728"></a><span class="lineno"> 728</span> </div> |
| <div class="line"><a name="l00729"></a><span class="lineno"> 729</span> <span class="preprocessor"># If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate</span></div> |
| <div class="line"><a name="l00730"></a><span class="lineno"> 730</span> <span class="preprocessor"># warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag</span></div> |
| <div class="line"><a name="l00731"></a><span class="lineno"> 731</span> <span class="preprocessor"># will automatically be disabled.</span></div> |
| <div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00733"></a><span class="lineno"> 733</span> </div> |
| <div class="line"><a name="l00734"></a><span class="lineno"> 734</span> WARN_IF_UNDOCUMENTED = YES</div> |
| <div class="line"><a name="l00735"></a><span class="lineno"> 735</span> </div> |
| <div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="preprocessor"># If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for</span></div> |
| <div class="line"><a name="l00737"></a><span class="lineno"> 737</span> <span class="preprocessor"># potential errors in the documentation, such as not documenting some parameters</span></div> |
| <div class="line"><a name="l00738"></a><span class="lineno"> 738</span> <span class="preprocessor"># in a documented function, or documenting parameters that don't exist or using</span></div> |
| <div class="line"><a name="l00739"></a><span class="lineno"> 739</span> <span class="preprocessor"># markup commands wrongly.</span></div> |
| <div class="line"><a name="l00740"></a><span class="lineno"> 740</span> <span class="preprocessor"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00741"></a><span class="lineno"> 741</span> </div> |
| <div class="line"><a name="l00742"></a><span class="lineno"> 742</span> WARN_IF_DOC_ERROR = YES</div> |
| <div class="line"><a name="l00743"></a><span class="lineno"> 743</span> </div> |
| <div class="line"><a name="l00744"></a><span class="lineno"> 744</span> <span class="preprocessor"># This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that</span></div> |
| <div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="preprocessor"># are documented, but have no documentation for their parameters or return</span></div> |
| <div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="preprocessor"># value. If set to NO, doxygen will only warn about wrong or incomplete</span></div> |
| <div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="preprocessor"># parameter documentation, but not about the absence of documentation.</span></div> |
| <div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00749"></a><span class="lineno"> 749</span> </div> |
| <div class="line"><a name="l00750"></a><span class="lineno"> 750</span> WARN_NO_PARAMDOC = NO</div> |
| <div class="line"><a name="l00751"></a><span class="lineno"> 751</span> </div> |
| <div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="preprocessor"># The WARN_FORMAT tag determines the format of the warning messages that doxygen</span></div> |
| <div class="line"><a name="l00753"></a><span class="lineno"> 753</span> <span class="preprocessor"># can produce. The string should contain the $file, $line, and $text tags, which</span></div> |
| <div class="line"><a name="l00754"></a><span class="lineno"> 754</span> <span class="preprocessor"># will be replaced by the file and line number from which the warning originated</span></div> |
| <div class="line"><a name="l00755"></a><span class="lineno"> 755</span> <span class="preprocessor"># and the warning text. Optionally the format may contain $version, which will</span></div> |
| <div class="line"><a name="l00756"></a><span class="lineno"> 756</span> <span class="preprocessor"># be replaced by the version of the file (if it could be obtained via</span></div> |
| <div class="line"><a name="l00757"></a><span class="lineno"> 757</span> <span class="preprocessor"># FILE_VERSION_FILTER)</span></div> |
| <div class="line"><a name="l00758"></a><span class="lineno"> 758</span> <span class="preprocessor"># The default value is: $file:$line: $text.</span></div> |
| <div class="line"><a name="l00759"></a><span class="lineno"> 759</span> </div> |
| <div class="line"><a name="l00760"></a><span class="lineno"> 760</span> WARN_FORMAT = <span class="stringliteral">"$file:$line: $text"</span></div> |
| <div class="line"><a name="l00761"></a><span class="lineno"> 761</span> </div> |
| <div class="line"><a name="l00762"></a><span class="lineno"> 762</span> <span class="preprocessor"># The WARN_LOGFILE tag can be used to specify a file to which warning and error</span></div> |
| <div class="line"><a name="l00763"></a><span class="lineno"> 763</span> <span class="preprocessor"># messages should be written. If left blank the output is written to standard</span></div> |
| <div class="line"><a name="l00764"></a><span class="lineno"> 764</span> <span class="preprocessor"># error (stderr).</span></div> |
| <div class="line"><a name="l00765"></a><span class="lineno"> 765</span> </div> |
| <div class="line"><a name="l00766"></a><span class="lineno"> 766</span> WARN_LOGFILE = </div> |
| <div class="line"><a name="l00767"></a><span class="lineno"> 767</span> </div> |
| <div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="preprocessor">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="preprocessor"># Configuration options related to the input files</span></div> |
| <div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="preprocessor">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00771"></a><span class="lineno"> 771</span> </div> |
| <div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="preprocessor"># The INPUT tag is used to specify the files and/or directories that contain</span></div> |
| <div class="line"><a name="l00773"></a><span class="lineno"> 773</span> <span class="preprocessor"># documented source files. You may enter file names like myfile.cpp or</span></div> |
| <div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="preprocessor"># directories like /usr/src/myproject. Separate the files or directories with</span></div> |
| <div class="line"><a name="l00775"></a><span class="lineno"> 775</span> <span class="preprocessor"># spaces. See also FILE_PATTERNS and EXTENSION_MAPPING</span></div> |
| <div class="line"><a name="l00776"></a><span class="lineno"> 776</span> <span class="preprocessor"># Note: If this tag is empty the current directory is searched.</span></div> |
| <div class="line"><a name="l00777"></a><span class="lineno"> 777</span> </div> |
| <div class="line"><a name="l00778"></a><span class="lineno"> 778</span> INPUT = ../<a class="code" href="a00141.html">glm</a> \</div> |
| <div class="line"><a name="l00779"></a><span class="lineno"> 779</span>  .</div> |
| <div class="line"><a name="l00780"></a><span class="lineno"> 780</span> </div> |
| <div class="line"><a name="l00781"></a><span class="lineno"> 781</span> # This tag can be used to specify the character encoding of the source files</div> |
| <div class="line"><a name="l00782"></a><span class="lineno"> 782</span> <span class="preprocessor"># that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses</span></div> |
| <div class="line"><a name="l00783"></a><span class="lineno"> 783</span> <span class="preprocessor"># libiconv (or the iconv built into libc) for the transcoding. See the libiconv</span></div> |
| <div class="line"><a name="l00784"></a><span class="lineno"> 784</span> <span class="preprocessor"># documentation (see: http://www.gnu.org/software/libiconv) for the list of</span></div> |
| <div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="preprocessor"># possible encodings.</span></div> |
| <div class="line"><a name="l00786"></a><span class="lineno"> 786</span> <span class="preprocessor"># The default value is: UTF-8.</span></div> |
| <div class="line"><a name="l00787"></a><span class="lineno"> 787</span> </div> |
| <div class="line"><a name="l00788"></a><span class="lineno"> 788</span> INPUT_ENCODING = UTF-8</div> |
| <div class="line"><a name="l00789"></a><span class="lineno"> 789</span> </div> |
| <div class="line"><a name="l00790"></a><span class="lineno"> 790</span> <span class="preprocessor"># If the value of the INPUT tag contains directories, you can use the</span></div> |
| <div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <span class="preprocessor"># FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and</span></div> |
| <div class="line"><a name="l00792"></a><span class="lineno"> 792</span> <span class="preprocessor"># *.h) to filter out the source-files in the directories.</span></div> |
| <div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00794"></a><span class="lineno"> 794</span> <span class="preprocessor"># Note that for custom extensions or not directly supported extensions you also</span></div> |
| <div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="preprocessor"># need to set EXTENSION_MAPPING for the extension otherwise the files are not</span></div> |
| <div class="line"><a name="l00796"></a><span class="lineno"> 796</span> <span class="preprocessor"># read by doxygen.</span></div> |
| <div class="line"><a name="l00797"></a><span class="lineno"> 797</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00798"></a><span class="lineno"> 798</span> <span class="preprocessor"># If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,</span></div> |
| <div class="line"><a name="l00799"></a><span class="lineno"> 799</span> <span class="preprocessor"># *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,</span></div> |
| <div class="line"><a name="l00800"></a><span class="lineno"> 800</span> <span class="preprocessor"># *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,</span></div> |
| <div class="line"><a name="l00801"></a><span class="lineno"> 801</span> <span class="preprocessor"># *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd,</span></div> |
| <div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="preprocessor"># *.vhdl, *.ucf, *.qsf, *.as and *.js.</span></div> |
| <div class="line"><a name="l00803"></a><span class="lineno"> 803</span> </div> |
| <div class="line"><a name="l00804"></a><span class="lineno"> 804</span> FILE_PATTERNS = *.hpp \</div> |
| <div class="line"><a name="l00805"></a><span class="lineno"> 805</span>  *.doxy</div> |
| <div class="line"><a name="l00806"></a><span class="lineno"> 806</span> </div> |
| <div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="preprocessor"># The RECURSIVE tag can be used to specify whether or not subdirectories should</span></div> |
| <div class="line"><a name="l00808"></a><span class="lineno"> 808</span> <span class="preprocessor"># be searched for input files as well.</span></div> |
| <div class="line"><a name="l00809"></a><span class="lineno"> 809</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00810"></a><span class="lineno"> 810</span> </div> |
| <div class="line"><a name="l00811"></a><span class="lineno"> 811</span> RECURSIVE = YES</div> |
| <div class="line"><a name="l00812"></a><span class="lineno"> 812</span> </div> |
| <div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="preprocessor"># The EXCLUDE tag can be used to specify files and/or directories that should be</span></div> |
| <div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="preprocessor"># excluded from the INPUT source files. This way you can easily exclude a</span></div> |
| <div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="preprocessor"># subdirectory from a directory tree whose root is specified with the INPUT tag.</span></div> |
| <div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="preprocessor"># Note that relative paths are relative to the directory from which doxygen is</span></div> |
| <div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="preprocessor"># run.</span></div> |
| <div class="line"><a name="l00819"></a><span class="lineno"> 819</span> </div> |
| <div class="line"><a name="l00820"></a><span class="lineno"> 820</span> EXCLUDE = </div> |
| <div class="line"><a name="l00821"></a><span class="lineno"> 821</span> </div> |
| <div class="line"><a name="l00822"></a><span class="lineno"> 822</span> <span class="preprocessor"># The EXCLUDE_SYMLINKS tag can be used to select whether or not files or</span></div> |
| <div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="preprocessor"># directories that are symbolic links (a Unix file system feature) are excluded</span></div> |
| <div class="line"><a name="l00824"></a><span class="lineno"> 824</span> <span class="preprocessor"># from the input.</span></div> |
| <div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="preprocessor"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00826"></a><span class="lineno"> 826</span> </div> |
| <div class="line"><a name="l00827"></a><span class="lineno"> 827</span> EXCLUDE_SYMLINKS = NO</div> |
| <div class="line"><a name="l00828"></a><span class="lineno"> 828</span> </div> |
| <div class="line"><a name="l00829"></a><span class="lineno"> 829</span> <span class="preprocessor"># If the value of the INPUT tag contains directories, you can use the</span></div> |
| <div class="line"><a name="l00830"></a><span class="lineno"> 830</span> <span class="preprocessor"># EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude</span></div> |
| <div class="line"><a name="l00831"></a><span class="lineno"> 831</span> <span class="preprocessor"># certain files from those directories.</span></div> |
| <div class="line"><a name="l00832"></a><span class="lineno"> 832</span> <span class="preprocessor">#</span></div> |
| <div class="line"><a name="l00833"></a><span class="lineno"> 833</span> <span class="preprocessor"># Note that the wildcards are matched against the file with absolute path, so to</span></div> |
| <div class="line"><a name="l00834"></a><span class="lineno"> 834</span> <span class="preprocessor"># exclude all test directories for example use the pattern */test</span><span class="comment">/*</span></div> |
| <div class="line"><a name="l00835"></a><span class="lineno"> 835</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00836"></a><span class="lineno"> 836</span> <span class="comment">EXCLUDE_PATTERNS = </span></div> |
| <div class="line"><a name="l00837"></a><span class="lineno"> 837</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00838"></a><span class="lineno"> 838</span> <span class="comment"># The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names</span></div> |
| <div class="line"><a name="l00839"></a><span class="lineno"> 839</span> <span class="comment"># (namespaces, classes, functions, etc.) that should be excluded from the</span></div> |
| <div class="line"><a name="l00840"></a><span class="lineno"> 840</span> <span class="comment"># output. The symbol name can be a fully qualified name, a word, or if the</span></div> |
| <div class="line"><a name="l00841"></a><span class="lineno"> 841</span> <span class="comment"># wildcard * is used, a substring. Examples: ANamespace, AClass,</span></div> |
| <div class="line"><a name="l00842"></a><span class="lineno"> 842</span> <span class="comment"># AClass::ANamespace, ANamespace::*Test</span></div> |
| <div class="line"><a name="l00843"></a><span class="lineno"> 843</span> <span class="comment">#</span></div> |
| <div class="line"><a name="l00844"></a><span class="lineno"> 844</span> <span class="comment"># Note that the wildcards are matched against the file with absolute path, so to</span></div> |
| <div class="line"><a name="l00845"></a><span class="lineno"> 845</span> <span class="comment"># exclude all test directories use the pattern */</span><span class="preprocessor">test</span><span class="comment">/*</span></div> |
| <div class="line"><a name="l00846"></a><span class="lineno"> 846</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00847"></a><span class="lineno"> 847</span> <span class="comment">EXCLUDE_SYMBOLS = </span></div> |
| <div class="line"><a name="l00848"></a><span class="lineno"> 848</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00849"></a><span class="lineno"> 849</span> <span class="comment"># The EXAMPLE_PATH tag can be used to specify one or more files or directories</span></div> |
| <div class="line"><a name="l00850"></a><span class="lineno"> 850</span> <span class="comment"># that contain example code fragments that are included (see the \include</span></div> |
| <div class="line"><a name="l00851"></a><span class="lineno"> 851</span> <span class="comment"># command).</span></div> |
| <div class="line"><a name="l00852"></a><span class="lineno"> 852</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00853"></a><span class="lineno"> 853</span> <span class="comment">EXAMPLE_PATH = </span></div> |
| <div class="line"><a name="l00854"></a><span class="lineno"> 854</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="comment"># If the value of the EXAMPLE_PATH tag contains directories, you can use the</span></div> |
| <div class="line"><a name="l00856"></a><span class="lineno"> 856</span> <span class="comment"># EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and</span></div> |
| <div class="line"><a name="l00857"></a><span class="lineno"> 857</span> <span class="comment"># *.h) to filter out the source-files in the directories. If left blank all</span></div> |
| <div class="line"><a name="l00858"></a><span class="lineno"> 858</span> <span class="comment"># files are included.</span></div> |
| <div class="line"><a name="l00859"></a><span class="lineno"> 859</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00860"></a><span class="lineno"> 860</span> <span class="comment">EXAMPLE_PATTERNS = *</span></div> |
| <div class="line"><a name="l00861"></a><span class="lineno"> 861</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00862"></a><span class="lineno"> 862</span> <span class="comment"># If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be</span></div> |
| <div class="line"><a name="l00863"></a><span class="lineno"> 863</span> <span class="comment"># searched for input files to be used with the \include or \dontinclude commands</span></div> |
| <div class="line"><a name="l00864"></a><span class="lineno"> 864</span> <span class="comment"># irrespective of the value of the RECURSIVE tag.</span></div> |
| <div class="line"><a name="l00865"></a><span class="lineno"> 865</span> <span class="comment"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00866"></a><span class="lineno"> 866</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00867"></a><span class="lineno"> 867</span> <span class="comment">EXAMPLE_RECURSIVE = NO</span></div> |
| <div class="line"><a name="l00868"></a><span class="lineno"> 868</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00869"></a><span class="lineno"> 869</span> <span class="comment"># The IMAGE_PATH tag can be used to specify one or more files or directories</span></div> |
| <div class="line"><a name="l00870"></a><span class="lineno"> 870</span> <span class="comment"># that contain images that are to be included in the documentation (see the</span></div> |
| <div class="line"><a name="l00871"></a><span class="lineno"> 871</span> <span class="comment"># \image command).</span></div> |
| <div class="line"><a name="l00872"></a><span class="lineno"> 872</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00873"></a><span class="lineno"> 873</span> <span class="comment">IMAGE_PATH = </span></div> |
| <div class="line"><a name="l00874"></a><span class="lineno"> 874</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00875"></a><span class="lineno"> 875</span> <span class="comment"># The INPUT_FILTER tag can be used to specify a program that doxygen should</span></div> |
| <div class="line"><a name="l00876"></a><span class="lineno"> 876</span> <span class="comment"># invoke to filter for each input file. Doxygen will invoke the filter program</span></div> |
| <div class="line"><a name="l00877"></a><span class="lineno"> 877</span> <span class="comment"># by executing (via popen()) the command:</span></div> |
| <div class="line"><a name="l00878"></a><span class="lineno"> 878</span> <span class="comment">#</span></div> |
| <div class="line"><a name="l00879"></a><span class="lineno"> 879</span> <span class="comment"># <filter> <input-file></span></div> |
| <div class="line"><a name="l00880"></a><span class="lineno"> 880</span> <span class="comment">#</span></div> |
| <div class="line"><a name="l00881"></a><span class="lineno"> 881</span> <span class="comment"># where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the</span></div> |
| <div class="line"><a name="l00882"></a><span class="lineno"> 882</span> <span class="comment"># name of an input file. Doxygen will then use the output that the filter</span></div> |
| <div class="line"><a name="l00883"></a><span class="lineno"> 883</span> <span class="comment"># program writes to standard output. If FILTER_PATTERNS is specified, this tag</span></div> |
| <div class="line"><a name="l00884"></a><span class="lineno"> 884</span> <span class="comment"># will be ignored.</span></div> |
| <div class="line"><a name="l00885"></a><span class="lineno"> 885</span> <span class="comment">#</span></div> |
| <div class="line"><a name="l00886"></a><span class="lineno"> 886</span> <span class="comment"># Note that the filter must not add or remove lines; it is applied before the</span></div> |
| <div class="line"><a name="l00887"></a><span class="lineno"> 887</span> <span class="comment"># code is scanned, but not when the output code is generated. If lines are added</span></div> |
| <div class="line"><a name="l00888"></a><span class="lineno"> 888</span> <span class="comment"># or removed, the anchors will not be placed correctly.</span></div> |
| <div class="line"><a name="l00889"></a><span class="lineno"> 889</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00890"></a><span class="lineno"> 890</span> <span class="comment">INPUT_FILTER = </span></div> |
| <div class="line"><a name="l00891"></a><span class="lineno"> 891</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00892"></a><span class="lineno"> 892</span> <span class="comment"># The FILTER_PATTERNS tag can be used to specify filters on a per file pattern</span></div> |
| <div class="line"><a name="l00893"></a><span class="lineno"> 893</span> <span class="comment"># basis. Doxygen will compare the file name with each pattern and apply the</span></div> |
| <div class="line"><a name="l00894"></a><span class="lineno"> 894</span> <span class="comment"># filter if there is a match. The filters are a list of the form: pattern=filter</span></div> |
| <div class="line"><a name="l00895"></a><span class="lineno"> 895</span> <span class="comment"># (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how</span></div> |
| <div class="line"><a name="l00896"></a><span class="lineno"> 896</span> <span class="comment"># filters are used. If the FILTER_PATTERNS tag is empty or if none of the</span></div> |
| <div class="line"><a name="l00897"></a><span class="lineno"> 897</span> <span class="comment"># patterns match the file name, INPUT_FILTER is applied.</span></div> |
| <div class="line"><a name="l00898"></a><span class="lineno"> 898</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00899"></a><span class="lineno"> 899</span> <span class="comment">FILTER_PATTERNS = </span></div> |
| <div class="line"><a name="l00900"></a><span class="lineno"> 900</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00901"></a><span class="lineno"> 901</span> <span class="comment"># If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using</span></div> |
| <div class="line"><a name="l00902"></a><span class="lineno"> 902</span> <span class="comment"># INPUT_FILTER) will also be used to filter the input files that are used for</span></div> |
| <div class="line"><a name="l00903"></a><span class="lineno"> 903</span> <span class="comment"># producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).</span></div> |
| <div class="line"><a name="l00904"></a><span class="lineno"> 904</span> <span class="comment"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00905"></a><span class="lineno"> 905</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00906"></a><span class="lineno"> 906</span> <span class="comment">FILTER_SOURCE_FILES = NO</span></div> |
| <div class="line"><a name="l00907"></a><span class="lineno"> 907</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00908"></a><span class="lineno"> 908</span> <span class="comment"># The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file</span></div> |
| <div class="line"><a name="l00909"></a><span class="lineno"> 909</span> <span class="comment"># pattern. A pattern will override the setting for FILTER_PATTERN (if any) and</span></div> |
| <div class="line"><a name="l00910"></a><span class="lineno"> 910</span> <span class="comment"># it is also possible to disable source filtering for a specific pattern using</span></div> |
| <div class="line"><a name="l00911"></a><span class="lineno"> 911</span> <span class="comment"># *.ext= (so without naming a filter).</span></div> |
| <div class="line"><a name="l00912"></a><span class="lineno"> 912</span> <span class="comment"># This tag requires that the tag FILTER_SOURCE_FILES is set to YES.</span></div> |
| <div class="line"><a name="l00913"></a><span class="lineno"> 913</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00914"></a><span class="lineno"> 914</span> <span class="comment">FILTER_SOURCE_PATTERNS = </span></div> |
| <div class="line"><a name="l00915"></a><span class="lineno"> 915</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00916"></a><span class="lineno"> 916</span> <span class="comment"># If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that</span></div> |
| <div class="line"><a name="l00917"></a><span class="lineno"> 917</span> <span class="comment"># is part of the input, its contents will be placed on the main page</span></div> |
| <div class="line"><a name="l00918"></a><span class="lineno"> 918</span> <span class="comment"># (index.html). This can be useful if you have a project on for instance GitHub</span></div> |
| <div class="line"><a name="l00919"></a><span class="lineno"> 919</span> <span class="comment"># and want to reuse the introduction page also for the doxygen output.</span></div> |
| <div class="line"><a name="l00920"></a><span class="lineno"> 920</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00921"></a><span class="lineno"> 921</span> <span class="comment">USE_MDFILE_AS_MAINPAGE = </span></div> |
| <div class="line"><a name="l00922"></a><span class="lineno"> 922</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00923"></a><span class="lineno"> 923</span> <span class="comment">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00924"></a><span class="lineno"> 924</span> <span class="comment"># Configuration options related to source browsing</span></div> |
| <div class="line"><a name="l00925"></a><span class="lineno"> 925</span> <span class="comment">#---------------------------------------------------------------------------</span></div> |
| <div class="line"><a name="l00926"></a><span class="lineno"> 926</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00927"></a><span class="lineno"> 927</span> <span class="comment"># If the SOURCE_BROWSER tag is set to YES then a list of source files will be</span></div> |
| <div class="line"><a name="l00928"></a><span class="lineno"> 928</span> <span class="comment"># generated. Documented entities will be cross-referenced with these sources.</span></div> |
| <div class="line"><a name="l00929"></a><span class="lineno"> 929</span> <span class="comment">#</span></div> |
| <div class="line"><a name="l00930"></a><span class="lineno"> 930</span> <span class="comment"># Note: To get rid of all source code in the generated output, make sure that</span></div> |
| <div class="line"><a name="l00931"></a><span class="lineno"> 931</span> <span class="comment"># also VERBATIM_HEADERS is set to NO.</span></div> |
| <div class="line"><a name="l00932"></a><span class="lineno"> 932</span> <span class="comment"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00933"></a><span class="lineno"> 933</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00934"></a><span class="lineno"> 934</span> <span class="comment">SOURCE_BROWSER = YES</span></div> |
| <div class="line"><a name="l00935"></a><span class="lineno"> 935</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00936"></a><span class="lineno"> 936</span> <span class="comment"># Setting the INLINE_SOURCES tag to YES will include the body of functions,</span></div> |
| <div class="line"><a name="l00937"></a><span class="lineno"> 937</span> <span class="comment"># classes and enums directly into the documentation.</span></div> |
| <div class="line"><a name="l00938"></a><span class="lineno"> 938</span> <span class="comment"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00939"></a><span class="lineno"> 939</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00940"></a><span class="lineno"> 940</span> <span class="comment">INLINE_SOURCES = NO</span></div> |
| <div class="line"><a name="l00941"></a><span class="lineno"> 941</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00942"></a><span class="lineno"> 942</span> <span class="comment"># Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any</span></div> |
| <div class="line"><a name="l00943"></a><span class="lineno"> 943</span> <span class="comment"># special comment blocks from generated source code fragments. Normal C, C++ and</span></div> |
| <div class="line"><a name="l00944"></a><span class="lineno"> 944</span> <span class="comment"># Fortran comments will always remain visible.</span></div> |
| <div class="line"><a name="l00945"></a><span class="lineno"> 945</span> <span class="comment"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00946"></a><span class="lineno"> 946</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00947"></a><span class="lineno"> 947</span> <span class="comment">STRIP_CODE_COMMENTS = YES</span></div> |
| <div class="line"><a name="l00948"></a><span class="lineno"> 948</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00949"></a><span class="lineno"> 949</span> <span class="comment"># If the REFERENCED_BY_RELATION tag is set to YES then for each documented</span></div> |
| <div class="line"><a name="l00950"></a><span class="lineno"> 950</span> <span class="comment"># function all documented functions referencing it will be listed.</span></div> |
| <div class="line"><a name="l00951"></a><span class="lineno"> 951</span> <span class="comment"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00952"></a><span class="lineno"> 952</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00953"></a><span class="lineno"> 953</span> <span class="comment">REFERENCED_BY_RELATION = YES</span></div> |
| <div class="line"><a name="l00954"></a><span class="lineno"> 954</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00955"></a><span class="lineno"> 955</span> <span class="comment"># If the REFERENCES_RELATION tag is set to YES then for each documented function</span></div> |
| <div class="line"><a name="l00956"></a><span class="lineno"> 956</span> <span class="comment"># all documented entities called/used by that function will be listed.</span></div> |
| <div class="line"><a name="l00957"></a><span class="lineno"> 957</span> <span class="comment"># The default value is: NO.</span></div> |
| <div class="line"><a name="l00958"></a><span class="lineno"> 958</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00959"></a><span class="lineno"> 959</span> <span class="comment">REFERENCES_RELATION = YES</span></div> |
| <div class="line"><a name="l00960"></a><span class="lineno"> 960</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00961"></a><span class="lineno"> 961</span> <span class="comment"># If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set</span></div> |
| <div class="line"><a name="l00962"></a><span class="lineno"> 962</span> <span class="comment"># to YES then the hyperlinks from functions in REFERENCES_RELATION and</span></div> |
| <div class="line"><a name="l00963"></a><span class="lineno"> 963</span> <span class="comment"># REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will</span></div> |
| <div class="line"><a name="l00964"></a><span class="lineno"> 964</span> <span class="comment"># link to the documentation.</span></div> |
| <div class="line"><a name="l00965"></a><span class="lineno"> 965</span> <span class="comment"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00966"></a><span class="lineno"> 966</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00967"></a><span class="lineno"> 967</span> <span class="comment">REFERENCES_LINK_SOURCE = YES</span></div> |
| <div class="line"><a name="l00968"></a><span class="lineno"> 968</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00969"></a><span class="lineno"> 969</span> <span class="comment"># If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the</span></div> |
| <div class="line"><a name="l00970"></a><span class="lineno"> 970</span> <span class="comment"># source code will show a tooltip with additional information such as prototype,</span></div> |
| <div class="line"><a name="l00971"></a><span class="lineno"> 971</span> <span class="comment"># brief description and links to the definition and documentation. Since this</span></div> |
| <div class="line"><a name="l00972"></a><span class="lineno"> 972</span> <span class="comment"># will make the HTML file larger and loading of large files a bit slower, you</span></div> |
| <div class="line"><a name="l00973"></a><span class="lineno"> 973</span> <span class="comment"># can opt to disable this feature.</span></div> |
| <div class="line"><a name="l00974"></a><span class="lineno"> 974</span> <span class="comment"># The default value is: YES.</span></div> |
| <div class="line"><a name="l00975"></a><span class="lineno"> 975</span> <span class="comment"># This tag requires that the tag SOURCE_BROWSER is set to YES.</span></div> |
| <div class="line"><a name="l00976"></a><span class="lineno"> 976</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00977"></a><span class="lineno"> 977</span> <span class="comment">SOURCE_TOOLTIPS = YES</span></div> |
| <div class="line"><a name="l00978"></a><span class="lineno"> 978</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00979"></a><span class="lineno"> 979</span> <span class="comment"># If the USE_HTAGS tag is set to YES then the references to source code will</span></div> |
| <div class="line"><a name="l00980"></a><span class="lineno"> 980</span> <span class="comment"># point to the HTML generated by the htags(1) tool instead of doxygen built-in</span></div> |
| <div class="line"><a name="l00981"></a><span class="lineno"> 981</span> <span |
