<aname="l00006"></a>00006 <spanclass="preprocessor"></span><spanclass="preprocessor"># All text after a hash (#) is considered a comment and will be ignored</span>
<aname="l00007"></a>00007 <spanclass="preprocessor"></span><spanclass="preprocessor"># The format is:</span>
<aname="l00008"></a>00008 <spanclass="preprocessor"></span><spanclass="preprocessor"># TAG = value [value, ...]</span>
<aname="l00009"></a>00009 <spanclass="preprocessor"></span><spanclass="preprocessor"># For lists items can also be appended using:</span>
<aname="l00010"></a>00010 <spanclass="preprocessor"></span><spanclass="preprocessor"># TAG += value [value, ...]</span>
<aname="l00011"></a>00011 <spanclass="preprocessor"></span><spanclass="preprocessor"># Values that contain spaces should be placed between quotes ("")</span>
<aname="l00017"></a>00017 <spanclass="preprocessor"># This tag specifies the encoding used for all characters in the config file </span>
<aname="l00018"></a>00018 <spanclass="preprocessor"></span><spanclass="preprocessor"># that follow. The default is UTF-8 which is also the encoding used for all </span>
<aname="l00019"></a>00019 <spanclass="preprocessor"></span><spanclass="preprocessor"># text before the first occurrence of this tag. Doxygen uses libiconv (or the </span>
<aname="l00020"></a>00020 <spanclass="preprocessor"></span><spanclass="preprocessor"># iconv built into libc) for the transcoding. See </span>
<aname="l00021"></a>00021 <spanclass="preprocessor"></span><spanclass="preprocessor"># http://www.gnu.org/software/libiconv for the list of possible encodings.</span>
<aname="l00025"></a>00025 <spanclass="preprocessor"># The PROJECT_NAME tag is a single word (or sequence of words) that should </span>
<aname="l00026"></a>00026 <spanclass="preprocessor"></span><spanclass="preprocessor"># identify the project. Note that if you do not use Doxywizard you need </span>
<aname="l00027"></a>00027 <spanclass="preprocessor"></span><spanclass="preprocessor"># to put quotes around the project name if it contains spaces.</span>
<aname="l00031"></a>00031 <spanclass="preprocessor"># The PROJECT_NUMBER tag can be used to enter a project or revision number. </span>
<aname="l00032"></a>00032 <spanclass="preprocessor"></span><spanclass="preprocessor"># This could be handy for archiving the generated documentation or </span>
<aname="l00033"></a>00033 <spanclass="preprocessor"></span><spanclass="preprocessor"># if some version control system is used.</span>
<aname="l00037"></a>00037 <spanclass="preprocessor"># Using the PROJECT_BRIEF tag one can provide an optional one line description </span>
<aname="l00038"></a>00038 <spanclass="preprocessor"></span><spanclass="preprocessor"># for a project that appears at the top of each page and should give viewer </span>
<aname="l00039"></a>00039 <spanclass="preprocessor"></span><spanclass="preprocessor"># a quick idea about the purpose of the project. Keep the description short.</span>
<aname="l00043"></a>00043 <spanclass="preprocessor"># With the PROJECT_LOGO tag one can specify an logo or icon that is </span>
<aname="l00044"></a>00044 <spanclass="preprocessor"></span><spanclass="preprocessor"># included in the documentation. The maximum height of the logo should not </span>
<aname="l00045"></a>00045 <spanclass="preprocessor"></span><spanclass="preprocessor"># exceed 55 pixels and the maximum width should not exceed 200 pixels. </span>
<aname="l00046"></a>00046 <spanclass="preprocessor"></span><spanclass="preprocessor"># Doxygen will copy the logo to the output directory.</span>
<aname="l00050"></a>00050 <spanclass="preprocessor"># The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) </span>
<aname="l00051"></a>00051 <spanclass="preprocessor"></span><spanclass="preprocessor"># base path where the generated documentation will be put. </span>
<aname="l00052"></a>00052 <spanclass="preprocessor"></span><spanclass="preprocessor"># If a relative path is entered, it will be relative to the location </span>
<aname="l00053"></a>00053 <spanclass="preprocessor"></span><spanclass="preprocessor"># where doxygen was started. If left blank the current directory will be used.</span>
<aname="l00057"></a>00057 # If the CREATE_SUBDIRS tag is <spanclass="keyword">set</span> to YES, then doxygen will create
<aname="l00058"></a>00058 <spanclass="preprocessor"># 4096 sub-directories (in 2 levels) under the output directory of each output </span>
<aname="l00059"></a>00059 <spanclass="preprocessor"></span><spanclass="preprocessor"># format and will distribute the generated files over these directories. </span>
<aname="l00060"></a>00060 <spanclass="preprocessor"></span><spanclass="preprocessor"># Enabling this option can be useful when feeding doxygen a huge amount of </span>
<aname="l00061"></a>00061 <spanclass="preprocessor"></span><spanclass="preprocessor"># source files, where putting all generated files in the same directory would </span>
<aname="l00062"></a>00062 <spanclass="preprocessor"></span><spanclass="preprocessor"># otherwise cause performance problems for the file system.</span>
<aname="l00066"></a>00066 <spanclass="preprocessor"># The OUTPUT_LANGUAGE tag is used to specify the language in which all </span>
<aname="l00067"></a>00067 <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation generated by doxygen is written. Doxygen will use this </span>
<aname="l00068"></a>00068 <spanclass="preprocessor"></span><spanclass="preprocessor"># information to generate all constant output in the proper language. </span>
<aname="l00069"></a>00069 <spanclass="preprocessor"></span><spanclass="preprocessor"># The default language is English, other supported languages are: </span>
<aname="l00077"></a>00077 OUTPUT_LANGUAGE = English
<aname="l00078"></a>00078
<aname="l00079"></a>00079 <spanclass="preprocessor"># If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will </span>
<aname="l00080"></a>00080 <spanclass="preprocessor"></span><spanclass="preprocessor"># include brief member descriptions after the members that are listed in </span>
<aname="l00081"></a>00081 <spanclass="preprocessor"></span><spanclass="preprocessor"># the file and class documentation (similar to JavaDoc). </span>
<aname="l00082"></a>00082 <spanclass="preprocessor"></span><spanclass="preprocessor"># Set to NO to disable this.</span>
<aname="l00086"></a>00086 <spanclass="preprocessor"># If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend </span>
<aname="l00087"></a>00087 <spanclass="preprocessor"></span><spanclass="preprocessor"># the brief description of a member or function before the detailed description. </span>
<aname="l00088"></a>00088 <spanclass="preprocessor"></span><spanclass="preprocessor"># Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the </span>
<aname="l00089"></a>00089 <spanclass="preprocessor"></span><spanclass="preprocessor"># brief descriptions will be completely suppressed.</span>
<aname="l00093"></a>00093 <spanclass="preprocessor"># This tag implements a quasi-intelligent brief description abbreviator </span>
<aname="l00094"></a>00094 <spanclass="preprocessor"></span><spanclass="preprocessor"># that is used to form the text in various listings. Each string </span>
<aname="l00095"></a>00095 <spanclass="preprocessor"></span><spanclass="preprocessor"># in this list, if found as the leading text of the brief description, will be </span>
<aname="l00096"></a>00096 <spanclass="preprocessor"></span><spanclass="preprocessor"># stripped from the text and the result after processing the whole list, is </span>
<aname="l00097"></a>00097 <spanclass="preprocessor"></span><spanclass="preprocessor"># used as the annotated text. Otherwise, the brief description is used as-is. </span>
<aname="l00098"></a>00098 <spanclass="preprocessor"></span><spanclass="preprocessor"># If left blank, the following values are used ("$name" is automatically </span>
<aname="l00099"></a>00099 <spanclass="preprocessor"></span><spanclass="preprocessor"># replaced with the name of the entity): "The $name class""The $name widget"</span>
<aname="l00115"></a>00115 <spanclass="preprocessor"># If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then </span>
<aname="l00116"></a>00116 <spanclass="preprocessor"></span><spanclass="preprocessor"># Doxygen will generate a detailed section even if there is only a brief </span>
<aname="l00119"></a>00119 ALWAYS_DETAILED_SEC = NO
<aname="l00120"></a>00120
<aname="l00121"></a>00121 <spanclass="preprocessor"># If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all </span>
<aname="l00122"></a>00122 <spanclass="preprocessor"></span><spanclass="preprocessor"># inherited members of a class in the documentation of that class as if those </span>
<aname="l00123"></a>00123 <spanclass="preprocessor"></span><spanclass="preprocessor"># members were ordinary class members. Constructors, destructors and assignment </span>
<aname="l00124"></a>00124 <spanclass="preprocessor"></span><spanclass="preprocessor"># operators of the base classes will not be shown.</span>
<aname="l00126"></a>00126 INLINE_INHERITED_MEMB = NO
<aname="l00127"></a>00127
<aname="l00128"></a>00128 <spanclass="preprocessor"># If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full </span>
<aname="l00129"></a>00129 <spanclass="preprocessor"></span><spanclass="preprocessor"># path before files name in the file list and in the header files. If set </span>
<aname="l00130"></a>00130 <spanclass="preprocessor"></span><spanclass="preprocessor"># to NO the shortest path that makes the file name unique will be used.</span>
<aname="l00134"></a>00134 <spanclass="preprocessor"># If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag </span>
<aname="l00135"></a>00135 <spanclass="preprocessor"></span><spanclass="preprocessor"># can be used to strip a user-defined part of the path. Stripping is </span>
<aname="l00136"></a>00136 <spanclass="preprocessor"></span><spanclass="preprocessor"># only done if one of the specified strings matches the left-hand part of </span>
<aname="l00137"></a>00137 <spanclass="preprocessor"></span><spanclass="preprocessor"># the path. The tag can be used to show relative paths in the file list. </span>
<aname="l00138"></a>00138 <spanclass="preprocessor"></span><spanclass="preprocessor"># If left blank the directory from which doxygen is run is used as the </span>
<aname="l00139"></a>00139 <spanclass="preprocessor"></span><spanclass="preprocessor"># path to strip.</span>
<aname="l00141"></a>00141 STRIP_FROM_PATH = <spanclass="stringliteral">"C:/Documents and Settings/Groove/ "</span>
<aname="l00142"></a>00142
<aname="l00143"></a>00143 <spanclass="preprocessor"># The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of </span>
<aname="l00144"></a>00144 <spanclass="preprocessor"></span><spanclass="preprocessor"># the path mentioned in the documentation of a class, which tells </span>
<aname="l00145"></a>00145 <spanclass="preprocessor"></span><spanclass="preprocessor"># the reader which header file to include in order to use a class. </span>
<aname="l00146"></a>00146 <spanclass="preprocessor"></span><spanclass="preprocessor"># If left blank only the name of the header file containing the class </span>
<aname="l00147"></a>00147 <spanclass="preprocessor"></span><spanclass="preprocessor"># definition is used. Otherwise one should specify the include paths that </span>
<aname="l00148"></a>00148 <spanclass="preprocessor"></span><spanclass="preprocessor"># are normally passed to the compiler using the -I flag.</span>
<aname="l00152"></a>00152 <spanclass="preprocessor"># If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter </span>
<aname="l00153"></a>00153 <spanclass="preprocessor"></span><spanclass="preprocessor"># (but less readable) file names. This can be useful if your file system </span>
<aname="l00154"></a>00154 <spanclass="preprocessor"></span><spanclass="preprocessor"># doesn't support long names like on DOS, Mac, or CD-ROM.</span>
<aname="l00158"></a>00158 <spanclass="preprocessor"># If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen </span>
<aname="l00159"></a>00159 <spanclass="preprocessor"></span><spanclass="preprocessor"># will interpret the first line (until the first dot) of a JavaDoc-style </span>
<aname="l00160"></a>00160 <spanclass="preprocessor"></span><spanclass="preprocessor"># comment as the brief description. If set to NO, the JavaDoc </span>
<aname="l00161"></a>00161 <spanclass="preprocessor"></span><spanclass="preprocessor"># comments will behave just like regular Qt-style comments </span>
<aname="l00162"></a>00162 <spanclass="preprocessor"></span><spanclass="preprocessor"># (thus requiring an explicit @brief command for a brief description.)</span>
<aname="l00166"></a>00166 <spanclass="preprocessor"># If the QT_AUTOBRIEF tag is set to YES then Doxygen will </span>
<aname="l00167"></a>00167 <spanclass="preprocessor"></span><spanclass="preprocessor"># interpret the first line (until the first dot) of a Qt-style </span>
<aname="l00168"></a>00168 <spanclass="preprocessor"></span><spanclass="preprocessor"># comment as the brief description. If set to NO, the comments </span>
<aname="l00169"></a>00169 <spanclass="preprocessor"></span><spanclass="preprocessor"># will behave just like regular Qt-style comments (thus requiring </span>
<aname="l00170"></a>00170 <spanclass="preprocessor"></span><spanclass="preprocessor"># an explicit \brief command for a brief description.)</span>
<aname="l00174"></a>00174 <spanclass="preprocessor"># The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen </span>
<aname="l00175"></a>00175 <spanclass="preprocessor"></span><spanclass="preprocessor"># treat a multi-line C++ special comment block (i.e. a block of //! or /// </span>
<aname="l00176"></a>00176 <spanclass="preprocessor"></span><spanclass="preprocessor"># comments) as a brief description. This used to be the default behaviour. </span>
<aname="l00177"></a>00177 <spanclass="preprocessor"></span><spanclass="preprocessor"># The new default is to treat a multi-line C++ comment block as a detailed </span>
<aname="l00178"></a>00178 <spanclass="preprocessor"></span><spanclass="preprocessor"># description. Set this tag to YES if you prefer the old behaviour instead.</span>
<aname="l00180"></a>00180 MULTILINE_CPP_IS_BRIEF = NO
<aname="l00181"></a>00181
<aname="l00182"></a>00182 <spanclass="preprocessor"># If the INHERIT_DOCS tag is set to YES (the default) then an undocumented </span>
<aname="l00183"></a>00183 <spanclass="preprocessor"></span><spanclass="preprocessor"># member inherits the documentation from any documented member that it </span>
<aname="l00188"></a>00188 <spanclass="preprocessor"># If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce </span>
<aname="l00189"></a>00189 <spanclass="preprocessor"></span><spanclass="preprocessor"># a new page for each member. If set to NO, the documentation of a member will </span>
<aname="l00190"></a>00190 <spanclass="preprocessor"></span><spanclass="preprocessor"># be part of the file/class/namespace that contains it.</span>
<aname="l00192"></a>00192 SEPARATE_MEMBER_PAGES = NO
<aname="l00193"></a>00193
<aname="l00194"></a>00194 <spanclass="preprocessor"># The TAB_SIZE tag can be used to set the number of spaces in a tab. </span>
<aname="l00195"></a>00195 <spanclass="preprocessor"></span><spanclass="preprocessor"># Doxygen uses this value to replace tabs by spaces in code fragments.</span>
<aname="l00199"></a>00199 <spanclass="preprocessor"># This tag can be used to specify a number of aliases that acts </span>
<aname="l00200"></a>00200 <spanclass="preprocessor"></span><spanclass="preprocessor"># as commands in the documentation. An alias has the form "name=value". </span>
<aname="l00201"></a>00201 <spanclass="preprocessor"></span><spanclass="preprocessor"># For example adding "sideeffect=\par Side Effects:\n" will allow you to </span>
<aname="l00202"></a>00202 <spanclass="preprocessor"></span><spanclass="preprocessor"># put the command \sideeffect (or @sideeffect) in the documentation, which </span>
<aname="l00203"></a>00203 <spanclass="preprocessor"></span><spanclass="preprocessor"># will result in a user-defined paragraph with heading "Side Effects:". </span>
<aname="l00204"></a>00204 <spanclass="preprocessor"></span><spanclass="preprocessor"># You can put \n's in the value part of an alias to insert newlines.</span>
<aname="l00208"></a>00208 <spanclass="preprocessor"># This tag can be used to specify a number of word-keyword mappings (TCL only). </span>
<aname="l00209"></a>00209 <spanclass="preprocessor"></span><spanclass="preprocessor"># A mapping has the form "name=value". For example adding </span>
<aname="l00210"></a>00210 <spanclass="preprocessor"></span><spanclass="preprocessor"># "class=itcl::class" will allow you to use the command class in the </span>
<aname="l00215"></a>00215 <spanclass="preprocessor"># Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C </span>
<aname="l00216"></a>00216 <spanclass="preprocessor"></span><spanclass="preprocessor"># sources only. Doxygen will then generate output that is more tailored for C. </span>
<aname="l00217"></a>00217 <spanclass="preprocessor"></span><spanclass="preprocessor"># For instance, some of the names that are used will be different. The list </span>
<aname="l00218"></a>00218 <spanclass="preprocessor"></span><spanclass="preprocessor"># of all members will be omitted, etc.</span>
<aname="l00220"></a>00220 OPTIMIZE_OUTPUT_FOR_C = NO
<aname="l00221"></a>00221
<aname="l00222"></a>00222 <spanclass="preprocessor"># Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java </span>
<aname="l00223"></a>00223 <spanclass="preprocessor"></span><spanclass="preprocessor"># sources only. Doxygen will then generate output that is more tailored for </span>
<aname="l00224"></a>00224 <spanclass="preprocessor"></span><spanclass="preprocessor"># Java. For instance, namespaces will be presented as packages, qualified </span>
<aname="l00225"></a>00225 <spanclass="preprocessor"></span><spanclass="preprocessor"># scopes will look different, etc.</span>
<aname="l00227"></a>00227 OPTIMIZE_OUTPUT_JAVA = NO
<aname="l00228"></a>00228
<aname="l00229"></a>00229 <spanclass="preprocessor"># Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran </span>
<aname="l00230"></a>00230 <spanclass="preprocessor"></span><spanclass="preprocessor"># sources only. Doxygen will then generate output that is more tailored for </span>
<aname="l00233"></a>00233 OPTIMIZE_FOR_FORTRAN = NO
<aname="l00234"></a>00234
<aname="l00235"></a>00235 <spanclass="preprocessor"># Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL </span>
<aname="l00236"></a>00236 <spanclass="preprocessor"></span><spanclass="preprocessor"># sources. Doxygen will then generate output that is tailored for </span>
<aname="l00239"></a>00239 OPTIMIZE_OUTPUT_VHDL = NO
<aname="l00240"></a>00240
<aname="l00241"></a>00241 <spanclass="preprocessor"># Doxygen selects the parser to use depending on the extension of the files it </span>
<aname="l00242"></a>00242 <spanclass="preprocessor"></span><spanclass="preprocessor"># parses. With this tag you can assign which parser to use for a given extension. </span>
<aname="l00243"></a>00243 <spanclass="preprocessor"></span><spanclass="preprocessor"># Doxygen has a built-in mapping, but you can override or extend it using this </span>
<aname="l00244"></a>00244 <spanclass="preprocessor"></span><spanclass="preprocessor"># tag. The format is ext=language, where ext is a file extension, and language </span>
<aname="l00245"></a>00245 <spanclass="preprocessor"></span><spanclass="preprocessor"># is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, </span>
<aname="l00246"></a>00246 <spanclass="preprocessor"></span><spanclass="preprocessor"># C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make </span>
<aname="l00247"></a>00247 <spanclass="preprocessor"></span><spanclass="preprocessor"># doxygen treat .inc files as Fortran files (default is PHP), and .f files as C </span>
<aname="l00248"></a>00248 <spanclass="preprocessor"></span><spanclass="preprocessor"># (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions </span>
<aname="l00249"></a>00249 <spanclass="preprocessor"></span><spanclass="preprocessor"># you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.</span>
<aname="l00253"></a>00253 <spanclass="preprocessor"># If you use STL classes (i.e. std::string, std::vector, etc.) but do not want </span>
<aname="l00254"></a>00254 <spanclass="preprocessor"></span><spanclass="preprocessor"># to include (a tag file for) the STL sources as input, then you should </span>
<aname="l00255"></a>00255 <spanclass="preprocessor"></span><spanclass="preprocessor"># set this tag to YES in order to let doxygen match functions declarations and </span>
<aname="l00257"></a>00257 <spanclass="preprocessor"></span><spanclass="preprocessor"># func(std::string) {}). This also makes the inheritance and collaboration </span>
<aname="l00258"></a>00258 <spanclass="preprocessor"></span><spanclass="preprocessor"># diagrams that involve STL classes more complete and accurate.</span>
<aname="l00267"></a>00267 <spanclass="preprocessor"># Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. </span>
<aname="l00268"></a>00268 <spanclass="preprocessor"></span><spanclass="preprocessor"># Doxygen will parse them like normal C++ but will assume all classes use public </span>
<aname="l00269"></a>00269 <spanclass="preprocessor"></span><spanclass="preprocessor"># instead of private inheritance when no explicit protection keyword is present.</span>
<aname="l00273"></a>00273 <spanclass="preprocessor"># For Microsoft's IDL there are propget and propput attributes to indicate getter </span>
<aname="l00274"></a>00274 <spanclass="preprocessor"></span><spanclass="preprocessor"># and setter methods for a property. Setting this option to YES (the default) </span>
<aname="l00275"></a>00275 <spanclass="preprocessor"></span><spanclass="preprocessor"># will make doxygen replace the get and set methods by a property in the </span>
<aname="l00276"></a>00276 <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation. This will only work if the methods are indeed getting or </span>
<aname="l00277"></a>00277 <spanclass="preprocessor"></span><spanclass="preprocessor"># setting a simple type. If this is not the case, or you want to show the </span>
<aname="l00278"></a>00278 <spanclass="preprocessor"></span><spanclass="preprocessor"># methods anyway, you should set this option to NO.</span>
<aname="l00282"></a>00282 <spanclass="preprocessor"># If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC </span>
<aname="l00283"></a>00283 <spanclass="preprocessor"></span><spanclass="preprocessor"># tag is set to YES, then doxygen will reuse the documentation of the first </span>
<aname="l00284"></a>00284 <spanclass="preprocessor"></span><spanclass="preprocessor"># member in the group (if any) for the other members of the group. By default </span>
<aname="l00285"></a>00285 <spanclass="preprocessor"></span><spanclass="preprocessor"># all members of a group must be documented explicitly.</span>
<aname="l00287"></a>00287 DISTRIBUTE_GROUP_DOC = NO
<aname="l00288"></a>00288
<aname="l00289"></a>00289 <spanclass="preprocessor"># Set the SUBGROUPING tag to YES (the default) to allow class member groups of </span>
<aname="l00290"></a>00290 <spanclass="preprocessor"></span><spanclass="preprocessor"># the same type (for instance a group of public functions) to be put as a </span>
<aname="l00291"></a>00291 <spanclass="preprocessor"></span><spanclass="preprocessor"># subgroup of that type (e.g. under the Public Functions section). Set it to </span>
<aname="l00292"></a>00292 <spanclass="preprocessor"></span><spanclass="preprocessor"># NO to prevent subgrouping. Alternatively, this can be done per class using </span>
<aname="l00293"></a>00293 <spanclass="preprocessor"></span><spanclass="preprocessor"># the \nosubgrouping command.</span>
<aname="l00297"></a>00297 <spanclass="preprocessor"># When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and </span>
<aname="l00298"></a>00298 <spanclass="preprocessor"></span><spanclass="preprocessor"># unions are shown inside the group in which they are included (e.g. using </span>
<aname="l00299"></a>00299 <spanclass="preprocessor"></span><spanclass="preprocessor"># @ingroup) instead of on a separate page (for HTML and Man pages) or </span>
<aname="l00300"></a>00300 <spanclass="preprocessor"></span><spanclass="preprocessor"># section (for LaTeX and RTF).</span>
<aname="l00302"></a>00302 INLINE_GROUPED_CLASSES = NO
<aname="l00303"></a>00303
<aname="l00304"></a>00304 <spanclass="preprocessor"># When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and </span>
<aname="l00305"></a>00305 <spanclass="preprocessor"></span><spanclass="preprocessor"># unions with only public data fields will be shown inline in the documentation </span>
<aname="l00306"></a>00306 <spanclass="preprocessor"></span><spanclass="preprocessor"># of the scope in which they are defined (i.e. file, namespace, or group </span>
<aname="l00307"></a>00307 <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation), provided this scope is documented. If set to NO (the default), </span>
<aname="l00308"></a>00308 <spanclass="preprocessor"></span><spanclass="preprocessor"># structs, classes, and unions are shown on a separate page (for HTML and Man </span>
<aname="l00309"></a>00309 <spanclass="preprocessor"></span><spanclass="preprocessor"># pages) or section (for LaTeX and RTF).</span>
<aname="l00311"></a>00311 INLINE_SIMPLE_STRUCTS = NO
<aname="l00312"></a>00312
<aname="l00313"></a>00313 <spanclass="preprocessor"># When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum </span>
<aname="l00314"></a>00314 <spanclass="preprocessor"></span><spanclass="preprocessor"># is documented as struct, union, or enum with the name of the typedef. So </span>
<aname="l00315"></a>00315 <spanclass="preprocessor"></span><spanclass="preprocessor"># typedef struct TypeS {} TypeT, will appear in the documentation as a struct </span>
<aname="l00316"></a>00316 <spanclass="preprocessor"></span><spanclass="preprocessor"># with name TypeT. When disabled the typedef will appear as a member of a file, </span>
<aname="l00317"></a>00317 <spanclass="preprocessor"></span><spanclass="preprocessor"># namespace, or class. And the struct will be named TypeS. This can typically </span>
<aname="l00318"></a>00318 <spanclass="preprocessor"></span><spanclass="preprocessor"># be useful for C code in case the coding convention dictates that all compound </span>
<aname="l00319"></a>00319 <spanclass="preprocessor"></span><spanclass="preprocessor"># types are typedef'ed and only the typedef is referenced, never the tag name.</span>
<aname="l00321"></a>00321 TYPEDEF_HIDES_STRUCT = NO
<aname="l00322"></a>00322
<aname="l00323"></a>00323 <spanclass="preprocessor"># The SYMBOL_CACHE_SIZE determines the size of the internal cache use to </span>
<aname="l00324"></a>00324 <spanclass="preprocessor"></span><spanclass="preprocessor"># determine which symbols to keep in memory and which to flush to disk. </span>
<aname="l00325"></a>00325 <spanclass="preprocessor"></span><spanclass="preprocessor"># When the cache is full, less often used symbols will be written to disk. </span>
<aname="l00326"></a>00326 <spanclass="preprocessor"></span><spanclass="preprocessor"># For small to medium size projects (<1000 input files) the default value is </span>
<aname="l00327"></a>00327 <spanclass="preprocessor"></span><spanclass="preprocessor"># probably good enough. For larger projects a too small cache size can cause </span>
<aname="l00328"></a>00328 <spanclass="preprocessor"></span><spanclass="preprocessor"># doxygen to be busy swapping symbols to and from disk most of the time </span>
<aname="l00329"></a>00329 <spanclass="preprocessor"></span><spanclass="preprocessor"># causing a significant performance penalty. </span>
<aname="l00330"></a>00330 <spanclass="preprocessor"></span><spanclass="preprocessor"># If the system has enough physical memory increasing the cache will improve the </span>
<aname="l00331"></a>00331 <spanclass="preprocessor"></span><spanclass="preprocessor"># performance by keeping more symbols in memory. Note that the value works on </span>
<aname="l00332"></a>00332 <spanclass="preprocessor"></span><spanclass="preprocessor"># a logarithmic scale so increasing the size by one will roughly double the </span>
<aname="l00333"></a>00333 <spanclass="preprocessor"></span><spanclass="preprocessor"># memory usage. The cache size is given by this formula: </span>
<aname="l00334"></a>00334 <spanclass="preprocessor"></span><spanclass="preprocessor"># 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, </span>
<aname="l00335"></a>00335 <spanclass="preprocessor"></span><spanclass="preprocessor"># corresponding to a cache size of 2^16 = 65536 symbols</span>
<aname="l00343"></a>00343 <spanclass="preprocessor"># If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in </span>
<aname="l00344"></a>00344 <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation are documented, even if no documentation was available. </span>
<aname="l00345"></a>00345 <spanclass="preprocessor"></span><spanclass="preprocessor"># Private class members and static file members will be hidden unless </span>
<aname="l00346"></a>00346 <spanclass="preprocessor"></span><spanclass="preprocessor"># the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES</span>
<aname="l00360"></a>00360 <spanclass="preprocessor"># If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) </span>
<aname="l00361"></a>00361 <spanclass="preprocessor"></span><spanclass="preprocessor"># defined locally in source files will be included in the documentation. </span>
<aname="l00362"></a>00362 <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO only classes defined in header files are included.</span>
<aname="l00364"></a>00364 EXTRACT_LOCAL_CLASSES = NO
<aname="l00365"></a>00365
<aname="l00366"></a>00366 <spanclass="preprocessor"># This flag is only useful for Objective-C code. When set to YES local </span>
<aname="l00367"></a>00367 <spanclass="preprocessor"></span><spanclass="preprocessor"># methods, which are defined in the implementation section but not in </span>
<aname="l00368"></a>00368 <spanclass="preprocessor"></span><spanclass="preprocessor"># the interface are included in the documentation. </span>
<aname="l00369"></a>00369 <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) only methods in the interface are included.</span>
<aname="l00371"></a>00371 EXTRACT_LOCAL_METHODS = NO
<aname="l00372"></a>00372
<aname="l00373"></a>00373 <spanclass="preprocessor"># If this flag is set to YES, the members of anonymous namespaces will be </span>
<aname="l00374"></a>00374 <spanclass="preprocessor"></span><spanclass="preprocessor"># extracted and appear in the documentation as a namespace called </span>
<aname="l00375"></a>00375 <spanclass="preprocessor"></span><spanclass="preprocessor"># 'anonymous_namespace{file}', where file will be replaced with the base </span>
<aname="l00376"></a>00376 <spanclass="preprocessor"></span><spanclass="preprocessor"># name of the file that contains the anonymous namespace. By default </span>
<aname="l00377"></a>00377 <spanclass="preprocessor"></span><spanclass="preprocessor"># anonymous namespaces are hidden.</span>
<aname="l00379"></a>00379 EXTRACT_ANON_NSPACES = NO
<aname="l00380"></a>00380
<aname="l00381"></a>00381 <spanclass="preprocessor"># If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all </span>
<aname="l00382"></a>00382 <spanclass="preprocessor"></span><spanclass="preprocessor"># undocumented members of documented classes, files or namespaces. </span>
<aname="l00383"></a>00383 <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) these members will be included in the </span>
<aname="l00384"></a>00384 <spanclass="preprocessor"></span><spanclass="preprocessor"># various overviews, but no documentation section is generated. </span>
<aname="l00385"></a>00385 <spanclass="preprocessor"></span><spanclass="preprocessor"># This option has no effect if EXTRACT_ALL is enabled.</span>
<aname="l00389"></a>00389 <spanclass="preprocessor"># If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all </span>
<aname="l00390"></a>00390 <spanclass="preprocessor"></span><spanclass="preprocessor"># undocumented classes that are normally visible in the class hierarchy. </span>
<aname="l00391"></a>00391 <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) these classes will be included in the various </span>
<aname="l00392"></a>00392 <spanclass="preprocessor"></span><spanclass="preprocessor"># overviews. This option has no effect if EXTRACT_ALL is enabled.</span>
<aname="l00398"></a>00398 <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) these declarations will be included in the </span>
<aname="l00403"></a>00403 <spanclass="preprocessor"># If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any </span>
<aname="l00404"></a>00404 <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation blocks found inside the body of a function. </span>
<aname="l00405"></a>00405 <spanclass="preprocessor"></span><spanclass="preprocessor"># If set to NO (the default) these blocks will be appended to the </span>
<aname="l00410"></a>00410 <spanclass="preprocessor"># The INTERNAL_DOCS tag determines if documentation </span>
<aname="l00411"></a>00411 <spanclass="preprocessor"></span><spanclass="preprocessor"># that is typed after a \internal command is included. If the tag is set </span>
<aname="l00412"></a>00412 <spanclass="preprocessor"></span><spanclass="preprocessor"># to NO (the default) then the documentation will be excluded. </span>
<aname="l00413"></a>00413 <spanclass="preprocessor"></span><spanclass="preprocessor"># Set it to YES to include the internal documentation.</span>
<aname="l00417"></a>00417 <spanclass="preprocessor"># If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate </span>
<aname="l00418"></a>00418 <spanclass="preprocessor"></span><spanclass="preprocessor"># file names in lower-case letters. If set to YES upper-case letters are also </span>
<aname="l00419"></a>00419 <spanclass="preprocessor"></span><spanclass="preprocessor"># allowed. This is useful if you have classes or files whose names only differ </span>
<aname="l00420"></a>00420 <spanclass="preprocessor"></span><spanclass="preprocessor"># in case and if your file system supports case sensitive file names. Windows </span>
<aname="l00421"></a>00421 <spanclass="preprocessor"></span><spanclass="preprocessor"># and Mac users are advised to set this option to NO.</span>
<aname="l00425"></a>00425 <spanclass="preprocessor"># If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen </span>
<aname="l00426"></a>00426 <spanclass="preprocessor"></span><spanclass="preprocessor"># will show members with their full class and namespace scopes in the </span>
<aname="l00427"></a>00427 <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation. If set to YES the scope will be hidden.</span>
<aname="l00431"></a>00431 <spanclass="preprocessor"># If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen </span>
<aname="l00432"></a>00432 <spanclass="preprocessor"></span><spanclass="preprocessor"># will put a list of the files that are included by a file in the documentation </span>
<aname="l00433"></a>00433 <spanclass="preprocessor"></span><spanclass="preprocessor"># of that file.</span>
<aname="l00437"></a>00437 <spanclass="preprocessor"># If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen </span>
<aname="l00438"></a>00438 <spanclass="preprocessor"></span><spanclass="preprocessor"># will list include files with double quotes in the documentation </span>
<aname="l00439"></a>00439 <spanclass="preprocessor"></span><spanclass="preprocessor"># rather than with sharp brackets.</span>
<aname="l00448"></a>00448 <spanclass="preprocessor"># If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen </span>
<aname="l00449"></a>00449 <spanclass="preprocessor"></span><spanclass="preprocessor"># will sort the (detailed) documentation of file and class members </span>
<aname="l00450"></a>00450 <spanclass="preprocessor"></span><spanclass="preprocessor"># alphabetically by member name. If set to NO the members will appear in </span>
<aname="l00455"></a>00455 <spanclass="preprocessor"># If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the </span>
<aname="l00456"></a>00456 <spanclass="preprocessor"></span><spanclass="preprocessor"># brief documentation of file, namespace and class members alphabetically </span>
<aname="l00457"></a>00457 <spanclass="preprocessor"></span><spanclass="preprocessor"># by member name. If set to NO (the default) the members will appear in </span>
<aname="l00462"></a>00462 <spanclass="preprocessor"># If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen </span>
<aname="l00463"></a>00463 <spanclass="preprocessor"></span><spanclass="preprocessor"># will sort the (brief and detailed) documentation of class members so that </span>
<aname="l00464"></a>00464 <spanclass="preprocessor"></span><spanclass="preprocessor"># constructors and destructors are listed first. If set to NO (the default) </span>
<aname="l00465"></a>00465 <spanclass="preprocessor"></span><spanclass="preprocessor"># the constructors will appear in the respective orders defined by </span>
<aname="l00466"></a>00466 <spanclass="preprocessor"></span><spanclass="preprocessor"># SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. </span>
<aname="l00467"></a>00467 <spanclass="preprocessor"></span><spanclass="preprocessor"># This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO </span>
<aname="l00468"></a>00468 <spanclass="preprocessor"></span><spanclass="preprocessor"># and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.</span>
<aname="l00470"></a>00470 SORT_MEMBERS_CTORS_1ST = NO
<aname="l00471"></a>00471
<aname="l00472"></a>00472 <spanclass="preprocessor"># If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the </span>
<aname="l00473"></a>00473 <spanclass="preprocessor"></span><spanclass="preprocessor"># hierarchy of group names into alphabetical order. If set to NO (the default) </span>
<aname="l00474"></a>00474 <spanclass="preprocessor"></span><spanclass="preprocessor"># the group names will appear in their defined order.</span>
<aname="l00478"></a>00478 <spanclass="preprocessor"># If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be </span>
<aname="l00479"></a>00479 <spanclass="preprocessor"></span><spanclass="preprocessor"># sorted by fully-qualified names, including namespaces. If set to </span>
<aname="l00480"></a>00480 <spanclass="preprocessor"></span><spanclass="preprocessor"># NO (the default), the class list will be sorted only by class name, </span>
<aname="l00481"></a>00481 <spanclass="preprocessor"></span><spanclass="preprocessor"># not including the namespace part. </span>
<aname="l00482"></a>00482 <spanclass="preprocessor"></span><spanclass="preprocessor"># Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. </span>
<aname="l00483"></a>00483 <spanclass="preprocessor"></span><spanclass="preprocessor"># Note: This option applies only to the class list, not to the </span>
<aname="l00488"></a>00488 <spanclass="preprocessor"># If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to </span>
<aname="l00489"></a>00489 <spanclass="preprocessor"></span><spanclass="preprocessor"># do proper type resolution of all parameters of a function it will reject a </span>
<aname="l00490"></a>00490 <spanclass="preprocessor"></span><spanclass="preprocessor"># match between the prototype and the implementation of a member function even </span>
<aname="l00491"></a>00491 <spanclass="preprocessor"></span><spanclass="preprocessor"># if there is only one candidate or it is obvious which candidate to choose </span>
<aname="l00492"></a>00492 <spanclass="preprocessor"></span><spanclass="preprocessor"># by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen </span>
<aname="l00493"></a>00493 <spanclass="preprocessor"></span><spanclass="preprocessor"># will still accept a match between prototype and implementation in such cases.</span>
<aname="l00495"></a>00495 STRICT_PROTO_MATCHING = NO
<aname="l00496"></a>00496
<aname="l00497"></a>00497 <spanclass="preprocessor"># The GENERATE_TODOLIST tag can be used to enable (YES) or </span>
<aname="l00498"></a>00498 <spanclass="preprocessor"></span><spanclass="preprocessor"># disable (NO) the todo list. This list is created by putting \todo </span>
<aname="l00499"></a>00499 <spanclass="preprocessor"></span><spanclass="preprocessor"># commands in the documentation.</span>
<aname="l00503"></a>00503 <spanclass="preprocessor"># The GENERATE_TESTLIST tag can be used to enable (YES) or </span>
<aname="l00504"></a>00504 <spanclass="preprocessor"></span><spanclass="preprocessor"># disable (NO) the test list. This list is created by putting \test </span>
<aname="l00505"></a>00505 <spanclass="preprocessor"></span><spanclass="preprocessor"># commands in the documentation.</span>
<aname="l00509"></a>00509 <spanclass="preprocessor"># The GENERATE_BUGLIST tag can be used to enable (YES) or </span>
<aname="l00510"></a>00510 <spanclass="preprocessor"></span><spanclass="preprocessor"># disable (NO) the bug list. This list is created by putting \bug </span>
<aname="l00511"></a>00511 <spanclass="preprocessor"></span><spanclass="preprocessor"># commands in the documentation.</span>
<aname="l00515"></a>00515 <spanclass="preprocessor"># The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or </span>
<aname="l00516"></a>00516 <spanclass="preprocessor"></span><spanclass="preprocessor"># disable (NO) the deprecated list. This list is created by putting </span>
<aname="l00517"></a>00517 <spanclass="preprocessor"></span><spanclass="preprocessor"># \deprecated commands in the documentation.</span>
<aname="l00526"></a>00526 <spanclass="preprocessor"># The MAX_INITIALIZER_LINES tag determines the maximum number of lines </span>
<aname="l00527"></a>00527 <spanclass="preprocessor"></span><spanclass="preprocessor"># the initial value of a variable or macro consists of for it to appear in </span>
<aname="l00528"></a>00528 <spanclass="preprocessor"></span><spanclass="preprocessor"># the documentation. If the initializer consists of more lines than specified </span>
<aname="l00529"></a>00529 <spanclass="preprocessor"></span><spanclass="preprocessor"># here it will be hidden. Use a value of 0 to hide initializers completely. </span>
<aname="l00530"></a>00530 <spanclass="preprocessor"></span><spanclass="preprocessor"># The appearance of the initializer of individual variables and macros in the </span>
<aname="l00531"></a>00531 <spanclass="preprocessor"></span><spanclass="preprocessor"># documentation can be controlled using \showinitializer or \hideinitializer </span>
<aname="l00532"></a>00532 <spanclass="preprocessor"></span><spanclass="preprocessor"># command in the documentation regardless of this setting.</span>
<aname="l00536"></a>00536 <spanclass="preprocessor"># Set the SHOW_USED_FILES tag to NO to disable the list of files generated </span>
<aname="l00537"></a>00537 <spanclass="preprocessor"></span><spanclass="preprocessor"># at the bottom of the documentation of classes and structs. If set to YES the </span>
<aname="l00538"></a>00538 <spanclass="preprocessor"></span><spanclass="preprocessor"># list will mention the files that were used to generate the documentation.</span>
<aname="l00542"></a>00542 <spanclass="preprocessor"># If the sources in your project are distributed over multiple directories </span>
<aname="l00543"></a>00543 <spanclass="preprocessor"></span><spanclass="preprocessor"># then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy </span>
<aname="l00544"></a>00544 <spanclass="preprocessor"></span><spanclass="preprocessor"># in the documentation. The default is NO.</span>
<aname="l00548"></a>00548 <spanclass="preprocessor"># Set the SHOW_FILES tag to NO to disable the generation of the Files page. </span>
<aname="l00549"></a>00549 <spanclass="preprocessor"></span><spanclass="preprocessor"># This will remove the Files entry from the Quick Index and from the </span>
<aname="l00550"></a>00550 <spanclass="preprocessor"></span><spanclass="preprocessor"># Folder Tree View (if specified). The default is YES.</span>
<aname="l00554"></a>00554 <spanclass="preprocessor"># Set the SHOW_NAMESPACES tag to NO to disable the generation of the </span>
<aname="l00555"></a>00555 <spanclass="preprocessor"></span><spanclass="preprocessor"># Namespaces page. This will remove the Namespaces entry from the Quick Index </span>
<aname="l00556"></a>00556 <spanclass="preprocessor"></span><spanclass="preprocessor"># and from the Folder Tree View (if specified). The default is YES.</span>
<aname="l00560"></a>00560 <spanclass="preprocessor"># The FILE_VERSION_FILTER tag can be used to specify a program or script that </span>
<aname="l00561"></a>00561 <spanclass="preprocessor"></span><spanclass="preprocessor"># doxygen should invoke to get the current version for each file (typically from </span>
<aname="l00562"></a>00562 <spanclass="preprocessor"></span><spanclass="preprocessor"># the version control system). Doxygen will invoke the program by executing (via </span>
<aname="l00563"></a>00563 <spanclass="preprocessor"></span><spanclass="preprocessor"># popen()) the command <command><input-file>, where <command> is the value of </span>
<aname="l00564"></a>00564 <spanclass="preprocessor"></span><spanclass="preprocessor"># the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file </span>
<aname="l00565"></a>00565 <spanclass="preprocessor"></span><spanclass="preprocessor"># provided by doxygen. Whatever the program writes to standard output </span>
<aname="l00566"></a>00566 <spanclass="preprocessor"></span><spanclass="preprocessor"># is used as the file version. See the manual for examples.</span>
<aname="l00570"></a>00570 <spanclass="preprocessor"># The LAYOUT_FILE tag can be used to specify a layout file which will be parsed </span>
<aname="l00571"></a>00571 <spanclass="preprocessor"></span><spanclass="preprocessor"># by doxygen. The layout file controls the global structure of the generated </span>
<aname="l00572"></a>00572 <spanclass="preprocessor"></span><spanclass="preprocessor"># output files in an output format independent way. The create the layout file </span>
<aname="l00573"></a>00573 <spanclass="preprocessor"></span><spanclass="preprocessor"># that represents doxygen's defaults, run doxygen with the -l option. </span>
<aname="l00574"></a>00574 <spanclass="preprocessor"></span><spanclass="preprocessor"># You can optionally specify a file name after the option, if omitted </span>
<aname="l00575"></a>00575 <spanclass="preprocessor"></span><spanclass="preprocessor"># DoxygenLayout.xml will be used as the name of the layout file.</span>
<aname="l00579"></a>00579 <spanclass="preprocessor"># The CITE_BIB_FILES tag can be used to specify one or more bib files </span>
<aname="l00580"></a>00580 <spanclass="preprocessor"></span><spanclass="preprocessor"># containing the references data. This must be a list of .bib files. The </span>
<aname="l00581"></a>00581 <spanclass="preprocessor"></span><spanclass="preprocessor"># .bib extension is automatically appended if omitted. Using this command </span>
<aname="l00582"></a>00582 <spanclass="preprocessor"></span><spanclass="preprocessor"># requires the bibtex tool to be installed. See also </span>
<aname="l00583"></a>00583 <spanclass="preprocessor"></span><spanclass="preprocessor"># http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style </span>
<aname="l00584"></a>00584 <spanclass="preprocessor"></span><spanclass="preprocessor"># of the bibliography can be controlled using LATEX_BIB_STYLE. To use this</span>
<aname="l00585"></a>00585 <spanclass="preprocessor"></span><spanclass="preprocessor"># feature you need bibtex and perl available in the search path.</span>
<aname="l00590"></a>00590 <spanclass="preprocessor"></span><spanclass="preprocessor"># configuration options related to warning and progress messages</span>
<aname="l00593"></a>00593 <spanclass="preprocessor"># The QUIET tag can be used to turn on/off the messages that are generated </span>
<aname="l00594"></a>00594 <spanclass="preprocessor"></span><spanclass="preprocessor"># by doxygen. Possible values are YES and NO. If left blank NO is used.</span>
<aname="l00598"></a>00598 <spanclass="preprocessor"># The WARNINGS tag can be used to turn on/off the warning messages that are </span>
<aname="l00599"></a>00599 <spanclass="preprocessor"></span><spanclass="preprocessor"># generated by doxygen. Possible values are YES and NO. If left blank </span>
<aname="l00600"></a>00600 <spanclass="preprocessor"></span><spanclass="preprocessor"># NO is used.</span>
<aname="l00604"></a>00604 <spanclass="preprocessor"># If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings </span>
<aname="l00605"></a>00605 <spanclass="preprocessor"></span><spanclass="preprocessor"># for undocumented members. If EXTRACT_ALL is set to YES then this flag will </span>
<aname="l00606"></a>00606 <spanclass="preprocessor"></span><spanclass="preprocessor"># automatically be disabled.</span>
<aname="l00610"></a>00610 <spanclass="preprocessor"># If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for </span>
<aname="l00611"></a>00611 <spanclass="preprocessor"></span><spanclass="preprocessor"># potential errors in the documentation, such as not documenting some </span>
<aname="l00612"></a>00612 <spanclass="preprocessor"></span><spanclass="preprocessor"># parameters in a documented function, or documenting parameters that </span>
<aname="l00613"></a>00613 <spanclass="preprocessor"></span><spanclass="preprocessor"># don't exist or using markup commands wrongly.</span>
<aname="l00617"></a>00617 <spanclass="preprocessor"># The WARN_NO_PARAMDOC option can be enabled to get warnings for </span>
<aname="l00618"></a>00618 <spanclass="preprocessor"></span><spanclass="preprocessor"># functions that are documented, but have no documentation for their parameters </span>
<aname="l00619"></a>00619 <spanclass="preprocessor"></span><spanclass="preprocessor"># or return value. If set to NO (the default) doxygen will only warn about </span>
<aname="l00620"></a>00620 <spanclass="preprocessor"></span><spanclass="preprocessor"># wrong or incomplete parameter documentation, but not about the absence of </span>
<aname="l00625"></a>00625 <spanclass="preprocessor"># The WARN_FORMAT tag determines the format of the warning messages that </span>
<aname="l00626"></a>00626 <spanclass="preprocessor"></span><spanclass="preprocessor"># doxygen can produce. The string should contain the $file, $line, and $text </span>
<aname="l00627"></a>00627 <spanclass="preprocessor"></span><spanclass="preprocessor"># tags, which will be replaced by the file and line number from which the </span>
<aname="l00628"></a>00628 <spanclass="preprocessor"></span><spanclass="preprocessor"># warning originated and the warning text. Optionally the format may contain </span>
<aname="l00629"></a>00629 <spanclass="preprocessor"></span><spanclass="preprocessor"># $version, which will be replaced by the version of the file (if it could </span>
<aname="l00630"></a>00630 <spanclass="preprocessor"></span><spanclass="preprocessor"># be obtained via FILE_VERSION_FILTER)</span>
<aname="l00634"></a>00634 <spanclass="preprocessor"># The WARN_LOGFILE tag can be used to specify a file to which warning </span>
<aname="l00635"></a>00635 <spanclass="preprocessor"></span><spanclass="preprocessor"># and error messages should be written. If left blank the output is written </span>
<aname="l00636"></a>00636 <spanclass="preprocessor"></span><spanclass="preprocessor"># to stderr.</span>
<aname="l00644"></a>00644 <spanclass="preprocessor"># The INPUT tag can be used to specify the files and/or directories that contain </span>
<aname="l00645"></a>00645 <spanclass="preprocessor"></span><spanclass="preprocessor"># documented source files. You may enter file names like "myfile.cpp" or </span>
<aname="l00646"></a>00646 <spanclass="preprocessor"></span><spanclass="preprocessor"># directories like "/usr/src/myproject". Separate the files or directories </span>
<aname="l00647"></a>00647 <spanclass="preprocessor"></span><spanclass="preprocessor"># with spaces.</span>
<aname="l00652"></a>00652 # This tag can be used to specify the character encoding of the source files
<aname="l00653"></a>00653 <spanclass="preprocessor"># that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is </span>
<aname="l00654"></a>00654 <spanclass="preprocessor"></span><spanclass="preprocessor"># also the default input encoding. Doxygen uses libiconv (or the iconv built </span>
<aname="l00655"></a>00655 <spanclass="preprocessor"></span><spanclass="preprocessor"># into libc) for the transcoding. See http://www.gnu.org/software/libiconv for </span>
<aname="l00656"></a>00656 <spanclass="preprocessor"></span><spanclass="preprocessor"># the list of possible encodings.</span>
<aname="l00660"></a>00660 <spanclass="preprocessor"># If the value of the INPUT tag contains directories, you can use the </span>
<aname="l00661"></a>00661 <spanclass="preprocessor"></span><spanclass="preprocessor"># FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp </span>
<aname="l00662"></a>00662 <spanclass="preprocessor"></span><spanclass="preprocessor"># and *.h) to filter out the source-files in the directories. If left </span>
<aname="l00663"></a>00663 <spanclass="preprocessor"></span><spanclass="preprocessor"># blank the following patterns are tested: </span>
<aname="l00671"></a>00671 <spanclass="preprocessor"># The RECURSIVE tag can be used to turn specify whether or not subdirectories </span>
<aname="l00672"></a>00672 <spanclass="preprocessor"></span><spanclass="preprocessor"># should be searched for input files as well. Possible values are YES and NO. </span>
<aname="l00673"></a>00673 <spanclass="preprocessor"></span><spanclass="preprocessor"># If left blank NO is used.</span>
<aname="l00677"></a>00677 <spanclass="preprocessor"># The EXCLUDE tag can be used to specify files and/or directories that should be </span>
<aname="l00678"></a>00678 <spanclass="preprocessor"></span><spanclass="preprocessor"># excluded from the INPUT source files. This way you can easily exclude a </span>
<aname="l00679"></a>00679 <spanclass="preprocessor"></span><spanclass="preprocessor"># subdirectory from a directory tree whose root is specified with the INPUT tag. </span>
<aname="l00680"></a>00680 <spanclass="preprocessor"></span><spanclass="preprocessor"># Note that relative paths are relative to the directory from which doxygen is </span>
<aname="l00685"></a>00685 <spanclass="preprocessor"># The EXCLUDE_SYMLINKS tag can be used to select whether or not files or </span>
<aname="l00686"></a>00686 <spanclass="preprocessor"></span><spanclass="preprocessor"># directories that are symbolic links (a Unix file system feature) are excluded </span>
<aname="l00687"></a>00687 <spanclass="preprocessor"></span><spanclass="preprocessor"># from the input.</span>
<aname="l00691"></a>00691 <spanclass="preprocessor"># If the value of the INPUT tag contains directories, you can use the </span>
<aname="l00692"></a>00692 <spanclass="preprocessor"></span><spanclass="preprocessor"># EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude </span>
<aname="l00693"></a>00693 <spanclass="preprocessor"></span><spanclass="preprocessor"># certain files from those directories. Note that the wildcards are matched </span>
<aname="l00694"></a>00694 <spanclass="preprocessor"></span><spanclass="preprocessor"># against the file with absolute path, so to exclude all test directories </span>
<aname="l00695"></a>00695 <spanclass="preprocessor"></span><spanclass="preprocessor"># for example use the pattern */test</span><spanclass="comment">/*</span>
