Changeset 703a0720ce in tspsg
- Timestamp:
- Aug 10, 2012, 7:13:33 PM (12 years ago)
- Branches:
- appveyor, imgbot, master, readme
- Children:
- 697a9dc08f
- Parents:
- 4a5e9a66d4
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
Doxyfile
r4a5e9a66d4 r703a0720ce 1 ###################################################################### 1 # Doxyfile 1.8.1.2 2 3 # This file describes the settings to be used by the documentation system 4 # doxygen (www.doxygen.org) for a project. 2 5 # 3 # TSPSG: TSP Solver and Generator 4 # Copyright (C) 2007-2012 Oleksii Serdiuk <contacts[at]oleksii[dot]name> 5 # 6 # $Id: $Format:%h %ai %an$ $ 7 # $URL: http://tspsg.info/ $ 8 # 9 # This file is part of TSPSG. 10 # 11 ###################################################################### 12 13 # Doxyfile 1.6.1 14 15 # This file describes the settings to be used by the documentation system 16 # doxygen (www.doxygen.org) for a project 17 # 18 # All text after a hash (#) is considered a comment and will be ignored 6 # All text after a hash (#) is considered a comment and will be ignored. 19 7 # The format is: 20 8 # TAG = value [value, ...] 21 9 # For lists items can also be appended using: 22 10 # TAG += value [value, ...] 23 # Values that contain spaces should be placed between quotes (" ") 11 # Values that contain spaces should be placed between quotes (" "). 24 12 25 13 #--------------------------------------------------------------------------- … … 27 15 #--------------------------------------------------------------------------- 28 16 29 # This tag specifies the encoding used for all characters in the config file 30 # that follow. The default is UTF-8 which is also the encoding used for all 31 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 32 # iconv built into libc) for the transcoding. See 17 # This tag specifies the encoding used for all characters in the config file 18 # that follow. The default is UTF-8 which is also the encoding used for all 19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 20 # iconv built into libc) for the transcoding. See 33 21 # http://www.gnu.org/software/libiconv for the list of possible encodings. 34 22 35 23 DOXYFILE_ENCODING = UTF-8 36 24 37 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 38 # by quotes) that should identify the project. 25 # The PROJECT_NAME tag is a single word (or sequence of words) that should 26 # identify the project. Note that if you do not use Doxywizard you need 27 # to put quotes around the project name if it contains spaces. 39 28 40 29 PROJECT_NAME = "TSP Solver and Generator" 41 30 42 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 43 # This could be handy for archiving the generated documentation or 31 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 32 # This could be handy for archiving the generated documentation or 44 33 # if some version control system is used. 45 34 46 PROJECT_NUMBER = 47 48 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 49 # base path where the generated documentation will be put. 50 # If a relative path is entered, it will be relative to the location 35 PROJECT_NUMBER = 36 37 # Using the PROJECT_BRIEF tag one can provide an optional one line description 38 # for a project that appears at the top of each page and should give viewer 39 # a quick idea about the purpose of the project. Keep the description short. 40 41 PROJECT_BRIEF = 42 43 # With the PROJECT_LOGO tag one can specify an logo or icon that is 44 # included in the documentation. The maximum height of the logo should not 45 # exceed 55 pixels and the maximum width should not exceed 200 pixels. 46 # Doxygen will copy the logo to the output directory. 47 48 PROJECT_LOGO = 49 50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 51 # base path where the generated documentation will be put. 52 # If a relative path is entered, it will be relative to the location 51 53 # where doxygen was started. If left blank the current directory will be used. 52 54 53 55 OUTPUT_DIRECTORY = doc 54 56 55 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 56 # 4096 sub-directories (in 2 levels) under the output directory of each output 57 # format and will distribute the generated files over these directories. 58 # Enabling this option can be useful when feeding doxygen a huge amount of 59 # source files, where putting all generated files in the same directory would 57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 58 # 4096 sub-directories (in 2 levels) under the output directory of each output 59 # format and will distribute the generated files over these directories. 60 # Enabling this option can be useful when feeding doxygen a huge amount of 61 # source files, where putting all generated files in the same directory would 60 62 # otherwise cause performance problems for the file system. 61 63 62 64 CREATE_SUBDIRS = NO 63 65 64 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 65 # documentation generated by doxygen is written. Doxygen will use this 66 # information to generate all constant output in the proper language. 67 # The default language is English, other supported languages are: 68 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 69 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 70 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 71 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 72 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyril ic, Slovak,66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 67 # documentation generated by doxygen is written. Doxygen will use this 68 # information to generate all constant output in the proper language. 69 # The default language is English, other supported languages are: 70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 73 75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. 74 76 75 77 OUTPUT_LANGUAGE = English 76 78 77 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 78 # include brief member descriptions after the members that are listed in 79 # the file and class documentation (similar to JavaDoc). 79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 80 # include brief member descriptions after the members that are listed in 81 # the file and class documentation (similar to JavaDoc). 80 82 # Set to NO to disable this. 81 83 82 84 BRIEF_MEMBER_DESC = YES 83 85 84 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 85 # the brief description of a member or function before the detailed description. 86 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 87 # the brief description of a member or function before the detailed description. 88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 87 89 # brief descriptions will be completely suppressed. 88 90 89 91 REPEAT_BRIEF = YES 90 92 91 # This tag implements a quasi-intelligent brief description abbreviator 92 # that is used to form the text in various listings. Each string 93 # in this list, if found as the leading text of the brief description, will be 94 # stripped from the text and the result after processing the whole list, is 95 # used as the annotated text. Otherwise, the brief description is used as-is. 96 # If left blank, the following values are used ("$name" is automatically 97 # replaced with the name of the entity): "The $name class" "The $name widget" 98 # "The $name file" "is" "provides" "specifies" "contains" 93 # This tag implements a quasi-intelligent brief description abbreviator 94 # that is used to form the text in various listings. Each string 95 # in this list, if found as the leading text of the brief description, will be 96 # stripped from the text and the result after processing the whole list, is 97 # used as the annotated text. Otherwise, the brief description is used as-is. 98 # If left blank, the following values are used ("$name" is automatically 99 # replaced with the name of the entity): "The $name class" "The $name widget" 100 # "The $name file" "is" "provides" "specifies" "contains" 99 101 # "represents" "a" "an" "the" 100 102 … … 111 113 the 112 114 113 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 114 # Doxygen will generate a detailed section even if there is only a brief 115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 116 # Doxygen will generate a detailed section even if there is only a brief 115 117 # description. 116 118 117 119 ALWAYS_DETAILED_SEC = NO 118 120 119 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 120 # inherited members of a class in the documentation of that class as if those 121 # members were ordinary class members. Constructors, destructors and assignment 121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 122 # inherited members of a class in the documentation of that class as if those 123 # members were ordinary class members. Constructors, destructors and assignment 122 124 # operators of the base classes will not be shown. 123 125 124 126 INLINE_INHERITED_MEMB = NO 125 127 126 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 127 # path before files name in the file list and in the header files. If set 128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 129 # path before files name in the file list and in the header files. If set 128 130 # to NO the shortest path that makes the file name unique will be used. 129 131 130 132 FULL_PATH_NAMES = YES 131 133 132 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 133 # can be used to strip a user-defined part of the path. Stripping is 134 # only done if one of the specified strings matches the left-hand part of 135 # the path. The tag can be used to show relative paths in the file list. 136 # If left blank the directory from which doxygen is run is used as the 134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 135 # can be used to strip a user-defined part of the path. Stripping is 136 # only done if one of the specified strings matches the left-hand part of 137 # the path. The tag can be used to show relative paths in the file list. 138 # If left blank the directory from which doxygen is run is used as the 137 139 # path to strip. 138 140 139 STRIP_FROM_PATH = 140 141 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 142 # the path mentioned in the documentation of a class, which tells 143 # the reader which header file to include in order to use a class. 144 # If left blank only the name of the header file containing the class 145 # definition is used. Otherwise one should specify the include paths that 141 STRIP_FROM_PATH = 142 143 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 144 # the path mentioned in the documentation of a class, which tells 145 # the reader which header file to include in order to use a class. 146 # If left blank only the name of the header file containing the class 147 # definition is used. Otherwise one should specify the include paths that 146 148 # are normally passed to the compiler using the -I flag. 147 149 148 STRIP_FROM_INC_PATH = 149 150 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 151 # (but less readable) file names. This can be useful i s your file systems150 STRIP_FROM_INC_PATH = 151 152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 153 # (but less readable) file names. This can be useful if your file system 152 154 # doesn't support long names like on DOS, Mac, or CD-ROM. 153 155 154 156 SHORT_NAMES = NO 155 157 156 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 157 # will interpret the first line (until the first dot) of a JavaDoc-style 158 # comment as the brief description. If set to NO, the JavaDoc 159 # comments will behave just like regular Qt-style comments 158 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 159 # will interpret the first line (until the first dot) of a JavaDoc-style 160 # comment as the brief description. If set to NO, the JavaDoc 161 # comments will behave just like regular Qt-style comments 160 162 # (thus requiring an explicit @brief command for a brief description.) 161 163 162 164 JAVADOC_AUTOBRIEF = NO 163 165 164 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 165 # interpret the first line (until the first dot) of a Qt-style 166 # comment as the brief description. If set to NO, the comments 167 # will behave just like regular Qt-style comments (thus requiring 166 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 167 # interpret the first line (until the first dot) of a Qt-style 168 # comment as the brief description. If set to NO, the comments 169 # will behave just like regular Qt-style comments (thus requiring 168 170 # an explicit \brief command for a brief description.) 169 171 170 172 QT_AUTOBRIEF = YES 171 173 172 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 173 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 174 # comments) as a brief description. This used to be the default behaviour. 175 # The new default is to treat a multi-line C++ comment block as a detailed 174 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 175 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 176 # comments) as a brief description. This used to be the default behaviour. 177 # The new default is to treat a multi-line C++ comment block as a detailed 176 178 # description. Set this tag to YES if you prefer the old behaviour instead. 177 179 178 180 MULTILINE_CPP_IS_BRIEF = NO 179 181 180 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 181 # member inherits the documentation from any documented member that it 182 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 183 # member inherits the documentation from any documented member that it 182 184 # re-implements. 183 185 184 186 INHERIT_DOCS = YES 185 187 186 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 187 # a new page for each member. If set to NO, the documentation of a member will 188 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 189 # a new page for each member. If set to NO, the documentation of a member will 188 190 # be part of the file/class/namespace that contains it. 189 191 190 192 SEPARATE_MEMBER_PAGES = NO 191 193 192 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 194 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 193 195 # Doxygen uses this value to replace tabs by spaces in code fragments. 194 196 195 197 TAB_SIZE = 4 196 198 197 # This tag can be used to specify a number of aliases that acts 198 # as commands in the documentation. An alias has the form "name=value". 199 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 200 # put the command \sideeffect (or @sideeffect) in the documentation, which 201 # will result in a user-defined paragraph with heading "Side Effects:". 199 # This tag can be used to specify a number of aliases that acts 200 # as commands in the documentation. An alias has the form "name=value". 201 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 202 # put the command \sideeffect (or @sideeffect) in the documentation, which 203 # will result in a user-defined paragraph with heading "Side Effects:". 202 204 # You can put \n's in the value part of an alias to insert newlines. 203 205 204 ALIASES = "hack=\xrefitem hacks \"Hack\" \"Hack List\"" 205 ALIASES += "ticket{2}=<a href=\"http://bugs.tspsg.info/ticket/\1\">\2</a>" 206 207 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 208 # sources only. Doxygen will then generate output that is more tailored for C. 209 # For instance, some of the names that are used will be different. The list 206 ALIASES = "hack=\xrefitem hacks \"Hack\" \"Hack List\"" \ 207 "ticket{2}=<a href=\"http://bugs.tspsg.info/ticket/\1\">\2</a>" 208 209 # This tag can be used to specify a number of word-keyword mappings (TCL only). 210 # A mapping has the form "name=value". For example adding 211 # "class=itcl::class" will allow you to use the command class in the 212 # itcl::class meaning. 213 214 TCL_SUBST = 215 216 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 217 # sources only. Doxygen will then generate output that is more tailored for C. 218 # For instance, some of the names that are used will be different. The list 210 219 # of all members will be omitted, etc. 211 220 212 221 OPTIMIZE_OUTPUT_FOR_C = NO 213 222 214 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 215 # sources only. Doxygen will then generate output that is more tailored for 216 # Java. For instance, namespaces will be presented as packages, qualified 223 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 224 # sources only. Doxygen will then generate output that is more tailored for 225 # Java. For instance, namespaces will be presented as packages, qualified 217 226 # scopes will look different, etc. 218 227 219 228 OPTIMIZE_OUTPUT_JAVA = NO 220 229 221 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 222 # sources only. Doxygen will then generate output that is more tailored for 230 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 231 # sources only. Doxygen will then generate output that is more tailored for 223 232 # Fortran. 224 233 225 234 OPTIMIZE_FOR_FORTRAN = NO 226 235 227 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 228 # sources. Doxygen will then generate output that is tailored for 236 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 237 # sources. Doxygen will then generate output that is tailored for 229 238 # VHDL. 230 239 231 240 OPTIMIZE_OUTPUT_VHDL = NO 232 241 233 # Doxygen selects the parser to use depending on the extension of the files it parses. 234 # With this tag you can assign which parser to use for a given extension. 235 # Doxygen has a built-in mapping, but you can override or extend it using this tag. 236 # The format is ext=language, where ext is a file extension, and language is one of 237 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 238 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 239 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 240 # use: inc=Fortran f=C. Note that for custom extensions you also need to set 241 # FILE_PATTERNS otherwise the files are not read by doxygen. 242 243 EXTENSION_MAPPING = 244 245 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 246 # to include (a tag file for) the STL sources as input, then you should 247 # set this tag to YES in order to let doxygen match functions declarations and 248 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 249 # func(std::string) {}). This also make the inheritance and collaboration 242 # Doxygen selects the parser to use depending on the extension of the files it 243 # parses. With this tag you can assign which parser to use for a given extension. 244 # Doxygen has a built-in mapping, but you can override or extend it using this 245 # tag. The format is ext=language, where ext is a file extension, and language 246 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 247 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 248 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 249 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 250 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. 251 252 EXTENSION_MAPPING = 253 254 # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all 255 # comments according to the Markdown format, which allows for more readable 256 # documentation. See http://daringfireball.net/projects/markdown/ for details. 257 # The output of markdown processing is further processed by doxygen, so you 258 # can mix doxygen, HTML, and XML commands with Markdown formatting. 259 # Disable only in case of backward compatibilities issues. 260 261 MARKDOWN_SUPPORT = YES 262 263 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 264 # to include (a tag file for) the STL sources as input, then you should 265 # set this tag to YES in order to let doxygen match functions declarations and 266 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 267 # func(std::string) {}). This also makes the inheritance and collaboration 250 268 # diagrams that involve STL classes more complete and accurate. 251 269 252 270 BUILTIN_STL_SUPPORT = NO 253 271 254 # If you use Microsoft's C++/CLI language, you should set this option to YES to 272 # If you use Microsoft's C++/CLI language, you should set this option to YES to 255 273 # enable parsing support. 256 274 257 275 CPP_CLI_SUPPORT = NO 258 276 259 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 260 # Doxygen will parse them like normal C++ but will assume all classes use public 277 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 278 # Doxygen will parse them like normal C++ but will assume all classes use public 261 279 # instead of private inheritance when no explicit protection keyword is present. 262 280 263 281 SIP_SUPPORT = NO 264 282 265 # For Microsoft's IDL there are propget and propput attributes to indicate getter 266 # and setter methods for a property. Setting this option to YES (the default) 267 # will make doxygen to replace the get and set methods by a property in the268 # documentation. This will only work if the methods are indeed getting or 269 # setting a simple type. If this is not the case, or you want to show the 283 # For Microsoft's IDL there are propget and propput attributes to indicate getter 284 # and setter methods for a property. Setting this option to YES (the default) 285 # will make doxygen replace the get and set methods by a property in the 286 # documentation. This will only work if the methods are indeed getting or 287 # setting a simple type. If this is not the case, or you want to show the 270 288 # methods anyway, you should set this option to NO. 271 289 272 290 IDL_PROPERTY_SUPPORT = YES 273 291 274 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 275 # tag is set to YES, then doxygen will reuse the documentation of the first 276 # member in the group (if any) for the other members of the group. By default 292 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 293 # tag is set to YES, then doxygen will reuse the documentation of the first 294 # member in the group (if any) for the other members of the group. By default 277 295 # all members of a group must be documented explicitly. 278 296 279 297 DISTRIBUTE_GROUP_DOC = NO 280 298 281 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 282 # the same type (for instance a group of public functions) to be put as a 283 # subgroup of that type (e.g. under the Public Functions section). Set it to 284 # NO to prevent subgrouping. Alternatively, this can be done per class using 299 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 300 # the same type (for instance a group of public functions) to be put as a 301 # subgroup of that type (e.g. under the Public Functions section). Set it to 302 # NO to prevent subgrouping. Alternatively, this can be done per class using 285 303 # the \nosubgrouping command. 286 304 287 305 SUBGROUPING = YES 288 306 289 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 290 # is documented as struct, union, or enum with the name of the typedef. So 291 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 292 # with name TypeT. When disabled the typedef will appear as a member of a file, 293 # namespace, or class. And the struct will be named TypeS. This can typically 294 # be useful for C code in case the coding convention dictates that all compound 307 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 308 # unions are shown inside the group in which they are included (e.g. using 309 # @ingroup) instead of on a separate page (for HTML and Man pages) or 310 # section (for LaTeX and RTF). 311 312 INLINE_GROUPED_CLASSES = NO 313 314 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 315 # unions with only public data fields will be shown inline in the documentation 316 # of the scope in which they are defined (i.e. file, namespace, or group 317 # documentation), provided this scope is documented. If set to NO (the default), 318 # structs, classes, and unions are shown on a separate page (for HTML and Man 319 # pages) or section (for LaTeX and RTF). 320 321 INLINE_SIMPLE_STRUCTS = NO 322 323 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 324 # is documented as struct, union, or enum with the name of the typedef. So 325 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 326 # with name TypeT. When disabled the typedef will appear as a member of a file, 327 # namespace, or class. And the struct will be named TypeS. This can typically 328 # be useful for C code in case the coding convention dictates that all compound 295 329 # types are typedef'ed and only the typedef is referenced, never the tag name. 296 330 297 331 TYPEDEF_HIDES_STRUCT = NO 298 332 299 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 300 # determine which symbols to keep in memory and which to flush to disk. 301 # When the cache is full, less often used symbols will be written to disk. 302 # For small to medium size projects (<1000 input files) the default value is 303 # probably good enough. For larger projects a too small cache size can cause 304 # doxygen to be busy swapping symbols to and from disk most of the time 305 # causing a significant performance penal ity.306 # If the system has enough physical memory increasing the cache will improve the 307 # performance by keeping more symbols in memory. Note that the value works on 308 # a logarithmic scale so increasing the size by one will roug ly double the309 # memory usage. The cache size is given by this formula: 310 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 311 # corresponding to a cache size of 2^16 = 65536 symbols 333 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 334 # determine which symbols to keep in memory and which to flush to disk. 335 # When the cache is full, less often used symbols will be written to disk. 336 # For small to medium size projects (<1000 input files) the default value is 337 # probably good enough. For larger projects a too small cache size can cause 338 # doxygen to be busy swapping symbols to and from disk most of the time 339 # causing a significant performance penalty. 340 # If the system has enough physical memory increasing the cache will improve the 341 # performance by keeping more symbols in memory. Note that the value works on 342 # a logarithmic scale so increasing the size by one will roughly double the 343 # memory usage. The cache size is given by this formula: 344 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 345 # corresponding to a cache size of 2^16 = 65536 symbols. 312 346 313 347 SYMBOL_CACHE_SIZE = 0 314 348 349 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 350 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 351 # their name and scope. Since this can be an expensive process and often the 352 # same symbol appear multiple times in the code, doxygen keeps a cache of 353 # pre-resolved symbols. If the cache is too small doxygen will become slower. 354 # If the cache is too large, memory is wasted. The cache size is given by this 355 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 356 # corresponding to a cache size of 2^16 = 65536 symbols. 357 358 LOOKUP_CACHE_SIZE = 0 359 315 360 #--------------------------------------------------------------------------- 316 361 # Build related configuration options 317 362 #--------------------------------------------------------------------------- 318 363 319 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 320 # documentation are documented, even if no documentation was available. 321 # Private class members and static file members will be hidden unless 364 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 365 # documentation are documented, even if no documentation was available. 366 # Private class members and static file members will be hidden unless 322 367 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 323 368 324 369 EXTRACT_ALL = NO 325 370 326 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 371 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 327 372 # will be included in the documentation. 328 373 329 374 EXTRACT_PRIVATE = NO 330 375 331 # If the EXTRACT_STATIC tag is set to YES all static members of a file 376 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. 377 378 EXTRACT_PACKAGE = NO 379 380 # If the EXTRACT_STATIC tag is set to YES all static members of a file 332 381 # will be included in the documentation. 333 382 334 383 EXTRACT_STATIC = NO 335 384 336 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 337 # defined locally in source files will be included in the documentation. 385 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 386 # defined locally in source files will be included in the documentation. 338 387 # If set to NO only classes defined in header files are included. 339 388 340 389 EXTRACT_LOCAL_CLASSES = YES 341 390 342 # This flag is only useful for Objective-C code. When set to YES local 343 # methods, which are defined in the implementation section but not in 344 # the interface are included in the documentation. 391 # This flag is only useful for Objective-C code. When set to YES local 392 # methods, which are defined in the implementation section but not in 393 # the interface are included in the documentation. 345 394 # If set to NO (the default) only methods in the interface are included. 346 395 347 396 EXTRACT_LOCAL_METHODS = NO 348 397 349 # If this flag is set to YES, the members of anonymous namespaces will be 350 # extracted and appear in the documentation as a namespace called 351 # 'anonymous_namespace{file}', where file will be replaced with the base 352 # name of the file that contains the anonymous namespace. By default 353 # anonymous namespace are hidden.398 # If this flag is set to YES, the members of anonymous namespaces will be 399 # extracted and appear in the documentation as a namespace called 400 # 'anonymous_namespace{file}', where file will be replaced with the base 401 # name of the file that contains the anonymous namespace. By default 402 # anonymous namespaces are hidden. 354 403 355 404 EXTRACT_ANON_NSPACES = NO 356 405 357 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 358 # undocumented members of documented classes, files or namespaces. 359 # If set to NO (the default) these members will be included in the 360 # various overviews, but no documentation section is generated. 406 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 407 # undocumented members of documented classes, files or namespaces. 408 # If set to NO (the default) these members will be included in the 409 # various overviews, but no documentation section is generated. 361 410 # This option has no effect if EXTRACT_ALL is enabled. 362 411 363 412 HIDE_UNDOC_MEMBERS = NO 364 413 365 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 366 # undocumented classes that are normally visible in the class hierarchy. 367 # If set to NO (the default) these classes will be included in the various 414 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 415 # undocumented classes that are normally visible in the class hierarchy. 416 # If set to NO (the default) these classes will be included in the various 368 417 # overviews. This option has no effect if EXTRACT_ALL is enabled. 369 418 370 419 HIDE_UNDOC_CLASSES = NO 371 420 372 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 373 # friend (class|struct|union) declarations. 374 # If set to NO (the default) these declarations will be included in the 421 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 422 # friend (class|struct|union) declarations. 423 # If set to NO (the default) these declarations will be included in the 375 424 # documentation. 376 425 377 426 HIDE_FRIEND_COMPOUNDS = NO 378 427 379 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 380 # documentation blocks found inside the body of a function. 381 # If set to NO (the default) these blocks will be appended to the 428 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 429 # documentation blocks found inside the body of a function. 430 # If set to NO (the default) these blocks will be appended to the 382 431 # function's detailed documentation block. 383 432 384 433 HIDE_IN_BODY_DOCS = NO 385 434 386 # The INTERNAL_DOCS tag determines if documentation 387 # that is typed after a \internal command is included. If the tag is set 388 # to NO (the default) then the documentation will be excluded. 435 # The INTERNAL_DOCS tag determines if documentation 436 # that is typed after a \internal command is included. If the tag is set 437 # to NO (the default) then the documentation will be excluded. 389 438 # Set it to YES to include the internal documentation. 390 439 391 440 INTERNAL_DOCS = YES 392 441 393 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 394 # file names in lower-case letters. If set to YES upper-case letters are also 395 # allowed. This is useful if you have classes or files whose names only differ 396 # in case and if your file system supports case sensitive file names. Windows 442 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 443 # file names in lower-case letters. If set to YES upper-case letters are also 444 # allowed. This is useful if you have classes or files whose names only differ 445 # in case and if your file system supports case sensitive file names. Windows 397 446 # and Mac users are advised to set this option to NO. 398 447 399 448 CASE_SENSE_NAMES = NO 400 449 401 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 402 # will show members with their full class and namespace scopes in the 450 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 451 # will show members with their full class and namespace scopes in the 403 452 # documentation. If set to YES the scope will be hidden. 404 453 405 454 HIDE_SCOPE_NAMES = NO 406 455 407 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 408 # will put a list of the files that are included by a file in the documentation 456 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 457 # will put a list of the files that are included by a file in the documentation 409 458 # of that file. 410 459 411 460 SHOW_INCLUDE_FILES = YES 412 461 413 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 462 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 463 # will list include files with double quotes in the documentation 464 # rather than with sharp brackets. 465 466 FORCE_LOCAL_INCLUDES = NO 467 468 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 414 469 # is inserted in the documentation for inline members. 415 470 416 471 INLINE_INFO = YES 417 472 418 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 419 # will sort the (detailed) documentation of file and class members 420 # alphabetically by member name. If set to NO the members will appear in 473 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 474 # will sort the (detailed) documentation of file and class members 475 # alphabetically by member name. If set to NO the members will appear in 421 476 # declaration order. 422 477 423 478 SORT_MEMBER_DOCS = YES 424 479 425 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 426 # brief documentation of file, namespace and class members alphabetically 427 # by member name. If set to NO (the default) the members will appear in 480 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 481 # brief documentation of file, namespace and class members alphabetically 482 # by member name. If set to NO (the default) the members will appear in 428 483 # declaration order. 429 484 … … 440 495 SORT_MEMBERS_CTORS_1ST = NO 441 496 442 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 443 # hierarchy of group names into alphabetical order. If set to NO (the default) 497 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 498 # hierarchy of group names into alphabetical order. If set to NO (the default) 444 499 # the group names will appear in their defined order. 445 500 446 501 SORT_GROUP_NAMES = NO 447 502 448 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 449 # sorted by fully-qualified names, including namespaces. If set to 450 # NO (the default), the class list will be sorted only by class name, 451 # not including the namespace part. 452 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 453 # Note: This option applies only to the class list, not to the 503 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 504 # sorted by fully-qualified names, including namespaces. If set to 505 # NO (the default), the class list will be sorted only by class name, 506 # not including the namespace part. 507 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 508 # Note: This option applies only to the class list, not to the 454 509 # alphabetical list. 455 510 456 511 SORT_BY_SCOPE_NAME = NO 457 512 458 # The GENERATE_TODOLIST tag can be used to enable (YES) or 459 # disable (NO) the todo list. This list is created by putting \todo 513 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 514 # do proper type resolution of all parameters of a function it will reject a 515 # match between the prototype and the implementation of a member function even 516 # if there is only one candidate or it is obvious which candidate to choose 517 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 518 # will still accept a match between prototype and implementation in such cases. 519 520 STRICT_PROTO_MATCHING = NO 521 522 # The GENERATE_TODOLIST tag can be used to enable (YES) or 523 # disable (NO) the todo list. This list is created by putting \todo 460 524 # commands in the documentation. 461 525 462 526 GENERATE_TODOLIST = YES 463 527 464 # The GENERATE_TESTLIST tag can be used to enable (YES) or 465 # disable (NO) the test list. This list is created by putting \test 528 # The GENERATE_TESTLIST tag can be used to enable (YES) or 529 # disable (NO) the test list. This list is created by putting \test 466 530 # commands in the documentation. 467 531 468 532 GENERATE_TESTLIST = YES 469 533 470 # The GENERATE_BUGLIST tag can be used to enable (YES) or 471 # disable (NO) the bug list. This list is created by putting \bug 534 # The GENERATE_BUGLIST tag can be used to enable (YES) or 535 # disable (NO) the bug list. This list is created by putting \bug 472 536 # commands in the documentation. 473 537 474 538 GENERATE_BUGLIST = YES 475 539 476 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 477 # disable (NO) the deprecated list. This list is created by putting 540 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 541 # disable (NO) the deprecated list. This list is created by putting 478 542 # \deprecated commands in the documentation. 479 543 480 544 GENERATE_DEPRECATEDLIST= YES 481 545 482 # The ENABLED_SECTIONS tag can be used to enable conditional 546 # The ENABLED_SECTIONS tag can be used to enable conditional 483 547 # documentation sections, marked by \if sectionname ... \endif. 484 548 485 ENABLED_SECTIONS = 486 487 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 488 # the initial value of a variable or define consists of for it to appear in489 # the documentation. If the initializer consists of more lines than specified 490 # here it will be hidden. Use a value of 0 to hide initializers completely. 491 # The appearance of the initializer of individual variables and defines in the492 # documentation can be controlled using \showinitializer or \hideinitializer 549 ENABLED_SECTIONS = 550 551 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 552 # the initial value of a variable or macro consists of for it to appear in 553 # the documentation. If the initializer consists of more lines than specified 554 # here it will be hidden. Use a value of 0 to hide initializers completely. 555 # The appearance of the initializer of individual variables and macros in the 556 # documentation can be controlled using \showinitializer or \hideinitializer 493 557 # command in the documentation regardless of this setting. 494 558 495 559 MAX_INITIALIZER_LINES = 30 496 560 497 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 498 # at the bottom of the documentation of classes and structs. If set to YES the 561 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 562 # at the bottom of the documentation of classes and structs. If set to YES the 499 563 # list will mention the files that were used to generate the documentation. 500 564 501 565 SHOW_USED_FILES = YES 502 566 503 # If the sources in your project are distributed over multiple directories 504 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 505 # in the documentation. The default is NO. 506 507 SHOW_DIRECTORIES = NO 508 509 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 510 # This will remove the Files entry from the Quick Index and from the 567 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 568 # This will remove the Files entry from the Quick Index and from the 511 569 # Folder Tree View (if specified). The default is YES. 512 570 513 571 SHOW_FILES = YES 514 572 515 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 516 # Namespaces page. This will remove the Namespaces entry from the Quick Index 573 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 574 # Namespaces page. 575 # This will remove the Namespaces entry from the Quick Index 517 576 # and from the Folder Tree View (if specified). The default is YES. 518 577 519 578 SHOW_NAMESPACES = YES 520 579 521 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 522 # doxygen should invoke to get the current version for each file (typically from 523 # the version control system). Doxygen will invoke the program by executing (via 524 # popen()) the command <command> <input-file>, where <command> is the value of 525 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 526 # provided by doxygen. Whatever the program writes to standard output 580 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 581 # doxygen should invoke to get the current version for each file (typically from 582 # the version control system). Doxygen will invoke the program by executing (via 583 # popen()) the command <command> <input-file>, where <command> is the value of 584 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 585 # provided by doxygen. Whatever the program writes to standard output 527 586 # is used as the file version. See the manual for examples. 528 587 529 FILE_VERSION_FILTER = 530 531 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 532 # doxygen. The layout file controls the global structure of the generated output files 533 # in an output format independent way. The create the layout file that represents 534 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a 535 # file name after the option, if omitted DoxygenLayout.xml will be used as the name 536 # of the layout file. 537 538 LAYOUT_FILE = 588 FILE_VERSION_FILTER = 589 590 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 591 # by doxygen. The layout file controls the global structure of the generated 592 # output files in an output format independent way. To create the layout file 593 # that represents doxygen's defaults, run doxygen with the -l option. 594 # You can optionally specify a file name after the option, if omitted 595 # DoxygenLayout.xml will be used as the name of the layout file. 596 597 LAYOUT_FILE = 598 599 # The CITE_BIB_FILES tag can be used to specify one or more bib files 600 # containing the references data. This must be a list of .bib files. The 601 # .bib extension is automatically appended if omitted. Using this command 602 # requires the bibtex tool to be installed. See also 603 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 604 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 605 # feature you need bibtex and perl available in the search path. 606 607 CITE_BIB_FILES = 539 608 540 609 #--------------------------------------------------------------------------- … … 542 611 #--------------------------------------------------------------------------- 543 612 544 # The QUIET tag can be used to turn on/off the messages that are generated 613 # The QUIET tag can be used to turn on/off the messages that are generated 545 614 # by doxygen. Possible values are YES and NO. If left blank NO is used. 546 615 547 616 QUIET = NO 548 617 549 # The WARNINGS tag can be used to turn on/off the warning messages that are 550 # generated by doxygen. Possible values are YES and NO. If left blank 618 # The WARNINGS tag can be used to turn on/off the warning messages that are 619 # generated by doxygen. Possible values are YES and NO. If left blank 551 620 # NO is used. 552 621 553 622 WARNINGS = YES 554 623 555 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 556 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 624 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 625 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 557 626 # automatically be disabled. 558 627 559 628 WARN_IF_UNDOCUMENTED = YES 560 629 561 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 562 # potential errors in the documentation, such as not documenting some 563 # parameters in a documented function, or documenting parameters that 630 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 631 # potential errors in the documentation, such as not documenting some 632 # parameters in a documented function, or documenting parameters that 564 633 # don't exist or using markup commands wrongly. 565 634 566 635 WARN_IF_DOC_ERROR = YES 567 636 568 # Th is WARN_NO_PARAMDOC option can be abled to get warnings for569 # functions that are documented, but have no documentation for their parameters 570 # or return value. If set to NO (the default) doxygen will only warn about 571 # wrong or incomplete parameter documentation, but not about the absence of 637 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 638 # functions that are documented, but have no documentation for their parameters 639 # or return value. If set to NO (the default) doxygen will only warn about 640 # wrong or incomplete parameter documentation, but not about the absence of 572 641 # documentation. 573 642 574 643 WARN_NO_PARAMDOC = NO 575 644 576 # The WARN_FORMAT tag determines the format of the warning messages that 577 # doxygen can produce. The string should contain the $file, $line, and $text 578 # tags, which will be replaced by the file and line number from which the 579 # warning originated and the warning text. Optionally the format may contain 580 # $version, which will be replaced by the version of the file (if it could 645 # The WARN_FORMAT tag determines the format of the warning messages that 646 # doxygen can produce. The string should contain the $file, $line, and $text 647 # tags, which will be replaced by the file and line number from which the 648 # warning originated and the warning text. Optionally the format may contain 649 # $version, which will be replaced by the version of the file (if it could 581 650 # be obtained via FILE_VERSION_FILTER) 582 651 583 652 WARN_FORMAT = "$file:$line: $text" 584 653 585 # The WARN_LOGFILE tag can be used to specify a file to which warning 586 # and error messages should be written. If left blank the output is written 654 # The WARN_LOGFILE tag can be used to specify a file to which warning 655 # and error messages should be written. If left blank the output is written 587 656 # to stderr. 588 657 589 WARN_LOGFILE = 658 WARN_LOGFILE = 590 659 591 660 #--------------------------------------------------------------------------- … … 593 662 #--------------------------------------------------------------------------- 594 663 595 # The INPUT tag can be used to specify the files and/or directories that contain 596 # documented source files. You may enter file names like "myfile.cpp" or 597 # directories like "/usr/src/myproject". Separate the files or directories 664 # The INPUT tag can be used to specify the files and/or directories that contain 665 # documented source files. You may enter file names like "myfile.cpp" or 666 # directories like "/usr/src/myproject". Separate the files or directories 598 667 # with spaces. 599 668 600 INPUT = src doc/dox 601 602 # This tag can be used to specify the character encoding of the source files 603 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 604 # also the default input encoding. Doxygen uses libiconv (or the iconv built 605 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 669 INPUT = src \ 670 doc/dox 671 672 # This tag can be used to specify the character encoding of the source files 673 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 674 # also the default input encoding. Doxygen uses libiconv (or the iconv built 675 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 606 676 # the list of possible encodings. 607 677 608 678 INPUT_ENCODING = UTF-8 609 679 610 # If the value of the INPUT tag contains directories, you can use the 611 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 612 # and *.h) to filter out the source-files in the directories. If left 613 # blank the following patterns are tested: 614 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 615 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 680 # If the value of the INPUT tag contains directories, you can use the 681 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 682 # and *.h) to filter out the source-files in the directories. If left 683 # blank the following patterns are tested: 684 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 685 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 686 # *.f90 *.f *.for *.vhd *.vhdl 616 687 617 688 FILE_PATTERNS = *.c \ … … 647 718 *.vhdl 648 719 649 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 650 # should be searched for input files as well. Possible values are YES and NO. 720 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 721 # should be searched for input files as well. Possible values are YES and NO. 651 722 # If left blank NO is used. 652 723 653 724 RECURSIVE = NO 654 725 655 # The EXCLUDE tag can be used to specify files and/or directories that should 656 # excluded from the INPUT source files. This way you can easily exclude a 726 # The EXCLUDE tag can be used to specify files and/or directories that should be 727 # excluded from the INPUT source files. This way you can easily exclude a 657 728 # subdirectory from a directory tree whose root is specified with the INPUT tag. 729 # Note that relative paths are relative to the directory from which doxygen is 730 # run. 658 731 659 732 EXCLUDE = src/_.h 660 733 661 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or662 # directories that are symbolic links (a Unix file system feature) are excluded734 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 735 # directories that are symbolic links (a Unix file system feature) are excluded 663 736 # from the input. 664 737 665 738 EXCLUDE_SYMLINKS = NO 666 739 667 # If the value of the INPUT tag contains directories, you can use the 668 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 669 # certain files from those directories. Note that the wildcards are matched 670 # against the file with absolute path, so to exclude all test directories 740 # If the value of the INPUT tag contains directories, you can use the 741 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 742 # certain files from those directories. Note that the wildcards are matched 743 # against the file with absolute path, so to exclude all test directories 671 744 # for example use the pattern */test/* 672 745 673 EXCLUDE_PATTERNS = 674 675 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 676 # (namespaces, classes, functions, etc.) that should be excluded from the 677 # output. The symbol name can be a fully qualified name, a word, or if the 678 # wildcard * is used, a substring. Examples: ANamespace, AClass, 746 EXCLUDE_PATTERNS = 747 748 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 749 # (namespaces, classes, functions, etc.) that should be excluded from the 750 # output. The symbol name can be a fully qualified name, a word, or if the 751 # wildcard * is used, a substring. Examples: ANamespace, AClass, 679 752 # AClass::ANamespace, ANamespace::*Test 680 753 681 EXCLUDE_SYMBOLS = 682 683 # The EXAMPLE_PATH tag can be used to specify one or more files or 684 # directories that contain example code fragments that are included (see 754 EXCLUDE_SYMBOLS = 755 756 # The EXAMPLE_PATH tag can be used to specify one or more files or 757 # directories that contain example code fragments that are included (see 685 758 # the \include command). 686 759 687 760 EXAMPLE_PATH = . 688 761 689 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 690 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 691 # and *.h) to filter out the source-files in the directories. If left 762 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 763 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 764 # and *.h) to filter out the source-files in the directories. If left 692 765 # blank all files are included. 693 766 694 767 EXAMPLE_PATTERNS = * 695 768 696 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 697 # searched for input files to be used with the \include or \dontinclude 698 # commands irrespective of the value of the RECURSIVE tag. 769 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 770 # searched for input files to be used with the \include or \dontinclude 771 # commands irrespective of the value of the RECURSIVE tag. 699 772 # Possible values are YES and NO. If left blank NO is used. 700 773 701 774 EXAMPLE_RECURSIVE = NO 702 775 703 # The IMAGE_PATH tag can be used to specify one or more files or 704 # directories that contain image that are included in the documentation (see 776 # The IMAGE_PATH tag can be used to specify one or more files or 777 # directories that contain image that are included in the documentation (see 705 778 # the \image command). 706 779 707 780 IMAGE_PATH = resources 708 781 709 # The INPUT_FILTER tag can be used to specify a program that doxygen should 710 # invoke to filter for each input file. Doxygen will invoke the filter program 711 # by executing (via popen()) the command <filter> <input-file>, where <filter> 712 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 713 # input file. Doxygen will then use the output that the filter program writes 714 # to standard output. If FILTER_PATTERNS is specified, this tag will be 782 # The INPUT_FILTER tag can be used to specify a program that doxygen should 783 # invoke to filter for each input file. Doxygen will invoke the filter program 784 # by executing (via popen()) the command <filter> <input-file>, where <filter> 785 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 786 # input file. Doxygen will then use the output that the filter program writes 787 # to standard output. 788 # If FILTER_PATTERNS is specified, this tag will be 715 789 # ignored. 716 790 717 INPUT_FILTER = 718 719 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 720 # basis. Doxygen will compare the file name with each pattern and apply the 721 # filter if there is a match. The filters are a list of the form: 722 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 723 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 724 # is applied to all files. 725 726 FILTER_PATTERNS = 727 728 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 729 # INPUT_FILTER) will be used to filter the input files when producing source 791 INPUT_FILTER = 792 793 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 794 # basis. 795 # Doxygen will compare the file name with each pattern and apply the 796 # filter if there is a match. 797 # The filters are a list of the form: 798 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 799 # info on how filters are used. If FILTER_PATTERNS is empty or if 800 # non of the patterns match the file name, INPUT_FILTER is applied. 801 802 FILTER_PATTERNS = 803 804 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 805 # INPUT_FILTER) will be used to filter the input files when producing source 730 806 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 731 807 732 808 FILTER_SOURCE_FILES = NO 733 809 810 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 811 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 812 # and it is also possible to disable source filtering for a specific pattern 813 # using *.ext= (so without naming a filter). This option only has effect when 814 # FILTER_SOURCE_FILES is enabled. 815 816 FILTER_SOURCE_PATTERNS = 817 734 818 #--------------------------------------------------------------------------- 735 819 # configuration options related to source browsing 736 820 #--------------------------------------------------------------------------- 737 821 738 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 739 # be generated. Documented entities will be cross-referenced with these sources. 740 # Note: To get rid of all source code in the generated output, make sure also 822 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 823 # be generated. Documented entities will be cross-referenced with these sources. 824 # Note: To get rid of all source code in the generated output, make sure also 741 825 # VERBATIM_HEADERS is set to NO. 742 826 743 827 SOURCE_BROWSER = NO 744 828 745 # Setting the INLINE_SOURCES tag to YES will include the body 829 # Setting the INLINE_SOURCES tag to YES will include the body 746 830 # of functions and classes directly in the documentation. 747 831 748 832 INLINE_SOURCES = NO 749 833 750 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 751 # doxygen to hide any special comment blocks from generated source code 752 # fragments. Normal C and C++comments will always remain visible.834 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 835 # doxygen to hide any special comment blocks from generated source code 836 # fragments. Normal C, C++ and Fortran comments will always remain visible. 753 837 754 838 STRIP_CODE_COMMENTS = YES 755 839 756 # If the REFERENCED_BY_RELATION tag is set to YES 757 # then for each documented function all documented 840 # If the REFERENCED_BY_RELATION tag is set to YES 841 # then for each documented function all documented 758 842 # functions referencing it will be listed. 759 843 760 844 REFERENCED_BY_RELATION = NO 761 845 762 # If the REFERENCES_RELATION tag is set to YES 763 # then for each documented function all documented entities 846 # If the REFERENCES_RELATION tag is set to YES 847 # then for each documented function all documented entities 764 848 # called/used by that function will be listed. 765 849 766 850 REFERENCES_RELATION = NO 767 851 768 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 769 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 770 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 771 # link to the source code. Otherwise they will link to the documentation. 852 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 853 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 854 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 855 # link to the source code. 856 # Otherwise they will link to the documentation. 772 857 773 858 REFERENCES_LINK_SOURCE = YES 774 859 775 # If the USE_HTAGS tag is set to YES then the references to source code 776 # will point to the HTML generated by the htags(1) tool instead of doxygen 777 # built-in source browser. The htags tool is part of GNU's global source 778 # tagging system (see http://www.gnu.org/software/global/global.html). You 860 # If the USE_HTAGS tag is set to YES then the references to source code 861 # will point to the HTML generated by the htags(1) tool instead of doxygen 862 # built-in source browser. The htags tool is part of GNU's global source 863 # tagging system (see http://www.gnu.org/software/global/global.html). You 779 864 # will need version 4.8.6 or higher. 780 865 781 866 USE_HTAGS = NO 782 867 783 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 784 # will generate a verbatim copy of the header file for each class for 868 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 869 # will generate a verbatim copy of the header file for each class for 785 870 # which an include is specified. Set to NO to disable this. 786 871 … … 791 876 #--------------------------------------------------------------------------- 792 877 793 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 794 # of all compounds will be generated. Enable this if the project 878 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 879 # of all compounds will be generated. Enable this if the project 795 880 # contains a lot of classes, structs, unions or interfaces. 796 881 797 882 ALPHABETICAL_INDEX = NO 798 883 799 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 800 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 884 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 885 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 801 886 # in which this list will be split (can be a number in the range [1..20]) 802 887 803 888 COLS_IN_ALPHA_INDEX = 5 804 889 805 # In case all classes in a project start with a common prefix, all 806 # classes will be put under the same header in the alphabetical index. 807 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 890 # In case all classes in a project start with a common prefix, all 891 # classes will be put under the same header in the alphabetical index. 892 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 808 893 # should be ignored while generating the index headers. 809 894 810 IGNORE_PREFIX = 895 IGNORE_PREFIX = 811 896 812 897 #--------------------------------------------------------------------------- … … 814 899 #--------------------------------------------------------------------------- 815 900 816 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 901 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 817 902 # generate HTML output. 818 903 819 904 GENERATE_HTML = YES 820 905 821 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 822 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 906 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 907 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 823 908 # put in front of it. If left blank `html' will be used as the default path. 824 909 825 910 HTML_OUTPUT = html 826 911 827 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 828 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 912 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 913 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 829 914 # doxygen will generate files with .html extension. 830 915 831 916 HTML_FILE_EXTENSION = .html 832 917 833 # The HTML_HEADER tag can be used to specify a personal HTML header for 834 # each generated HTML page. If it is left blank doxygen will generate a 835 # standard header. 836 837 HTML_HEADER = 838 839 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 840 # each generated HTML page. If it is left blank doxygen will generate a 918 # The HTML_HEADER tag can be used to specify a personal HTML header for 919 # each generated HTML page. If it is left blank doxygen will generate a 920 # standard header. Note that when using a custom header you are responsible 921 # for the proper inclusion of any scripts and style sheets that doxygen 922 # needs, which is dependent on the configuration options used. 923 # It is advised to generate a default header using "doxygen -w html 924 # header.html footer.html stylesheet.css YourConfigFile" and then modify 925 # that header. Note that the header is subject to change so you typically 926 # have to redo this when upgrading to a newer version of doxygen or when 927 # changing the value of configuration settings such as GENERATE_TREEVIEW! 928 929 HTML_HEADER = 930 931 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 932 # each generated HTML page. If it is left blank doxygen will generate a 841 933 # standard footer. 842 934 843 HTML_FOOTER = 844 845 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 846 # style sheet that is used by each HTML page. It can be used to 847 # fine-tune the look of the HTML output. If the tag is left blank doxygen 848 # will generate a default style sheet. Note that doxygen will try to copy 849 # the style sheet file to the HTML output directory, so don't put your own 850 # stylesheet in the HTML output directory as well, or it will be erased! 851 852 HTML_STYLESHEET = 853 854 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 855 # files or namespaces will be aligned in HTML using tables. If set to 856 # NO a bullet list will be used. 857 858 HTML_ALIGN_MEMBERS = YES 859 860 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 861 # documentation will contain sections that can be hidden and shown after the 862 # page has loaded. For this to work a browser that supports 863 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 864 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 935 HTML_FOOTER = 936 937 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 938 # style sheet that is used by each HTML page. It can be used to 939 # fine-tune the look of the HTML output. If the tag is left blank doxygen 940 # will generate a default style sheet. Note that doxygen will try to copy 941 # the style sheet file to the HTML output directory, so don't put your own 942 # style sheet in the HTML output directory as well, or it will be erased! 943 944 HTML_STYLESHEET = 945 946 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 947 # other source files which should be copied to the HTML output directory. Note 948 # that these files will be copied to the base HTML output directory. Use the 949 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 950 # files. In the HTML_STYLESHEET file, use the file name only. Also note that 951 # the files will be copied as-is; there are no commands or markers available. 952 953 HTML_EXTRA_FILES = 954 955 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 956 # Doxygen will adjust the colors in the style sheet and background images 957 # according to this color. Hue is specified as an angle on a colorwheel, 958 # see http://en.wikipedia.org/wiki/Hue for more information. 959 # For instance the value 0 represents red, 60 is yellow, 120 is green, 960 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 961 # The allowed range is 0 to 359. 962 963 HTML_COLORSTYLE_HUE = 220 964 965 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 966 # the colors in the HTML output. For a value of 0 the output will use 967 # grayscales only. A value of 255 will produce the most vivid colors. 968 969 HTML_COLORSTYLE_SAT = 100 970 971 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 972 # the luminance component of the colors in the HTML output. Values below 973 # 100 gradually make the output lighter, whereas values above 100 make 974 # the output darker. The value divided by 100 is the actual gamma applied, 975 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 976 # and 100 does not change the gamma. 977 978 HTML_COLORSTYLE_GAMMA = 80 979 980 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 981 # page will contain the date and time when the page was generated. Setting 982 # this to NO can help when comparing the output of multiple runs. 983 984 HTML_TIMESTAMP = YES 985 986 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 987 # documentation will contain sections that can be hidden and shown after the 988 # page has loaded. 865 989 866 990 HTML_DYNAMIC_SECTIONS = YES 867 991 868 # If the GENERATE_DOCSET tag is set to YES, additional index files 869 # will be generated that can be used as input for Apple's Xcode 3 870 # integrated development environment, introduced with OSX 10.5 (Leopard). 871 # To create a documentation set, doxygen will generate a Makefile in the 872 # HTML output directory. Running make will produce the docset in that 873 # directory and running "make install" will install the docset in 874 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 875 # it at startup. 876 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 992 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of 993 # entries shown in the various tree structured indices initially; the user 994 # can expand and collapse entries dynamically later on. Doxygen will expand 995 # the tree to such a level that at most the specified number of entries are 996 # visible (unless a fully collapsed tree already exceeds this amount). 997 # So setting the number of entries 1 will produce a full collapsed tree by 998 # default. 0 is a special value representing an infinite number of entries 999 # and will result in a full expanded tree by default. 1000 1001 HTML_INDEX_NUM_ENTRIES = 100 1002 1003 # If the GENERATE_DOCSET tag is set to YES, additional index files 1004 # will be generated that can be used as input for Apple's Xcode 3 1005 # integrated development environment, introduced with OSX 10.5 (Leopard). 1006 # To create a documentation set, doxygen will generate a Makefile in the 1007 # HTML output directory. Running make will produce the docset in that 1008 # directory and running "make install" will install the docset in 1009 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 1010 # it at startup. 1011 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1012 # for more information. 877 1013 878 1014 GENERATE_DOCSET = NO 879 1015 880 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 881 # feed. A documentation feed provides an umbrella under which multiple 882 # documentation sets from a single provider (such as a company or product suite) 1016 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 1017 # feed. A documentation feed provides an umbrella under which multiple 1018 # documentation sets from a single provider (such as a company or product suite) 883 1019 # can be grouped. 884 1020 885 1021 DOCSET_FEEDNAME = "Doxygen generated docs" 886 1022 887 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 888 # should uniquely identify the documentation set bundle. This should be a 889 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 1023 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 1024 # should uniquely identify the documentation set bundle. This should be a 1025 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 890 1026 # will append .docset to the name. 891 1027 892 1028 DOCSET_BUNDLE_ID = org.doxygen.Project 893 1029 894 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 895 # will be generated that can be used as input for tools like the 896 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 1030 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 1031 # the documentation publisher. This should be a reverse domain-name style 1032 # string, e.g. com.mycompany.MyDocSet.documentation. 1033 1034 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1035 1036 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. 1037 1038 DOCSET_PUBLISHER_NAME = Publisher 1039 1040 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 1041 # will be generated that can be used as input for tools like the 1042 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 897 1043 # of the generated HTML documentation. 898 1044 899 1045 GENERATE_HTMLHELP = NO 900 1046 901 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 902 # be used to specify the file name of the resulting .chm file. You 903 # can add a path in front of the file if the result should not be 1047 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 1048 # be used to specify the file name of the resulting .chm file. You 1049 # can add a path in front of the file if the result should not be 904 1050 # written to the html output directory. 905 1051 906 CHM_FILE = 907 908 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 909 # be used to specify the location (absolute path including file name) of 910 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1052 CHM_FILE = 1053 1054 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1055 # be used to specify the location (absolute path including file name) of 1056 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 911 1057 # the HTML help compiler on the generated index.hhp. 912 1058 913 HHC_LOCATION = 914 915 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 916 # controls if a separate .chi index file is generated (YES) or that 1059 HHC_LOCATION = 1060 1061 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1062 # controls if a separate .chi index file is generated (YES) or that 917 1063 # it should be included in the master .chm file (NO). 918 1064 919 1065 GENERATE_CHI = NO 920 1066 921 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 922 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 1067 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 1068 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 923 1069 # content. 924 1070 925 CHM_INDEX_ENCODING = 926 927 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 928 # controls whether a binary table of contents is generated (YES) or a 1071 CHM_INDEX_ENCODING = 1072 1073 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1074 # controls whether a binary table of contents is generated (YES) or a 929 1075 # normal table of contents (NO) in the .chm file. 930 1076 931 1077 BINARY_TOC = NO 932 1078 933 # The TOC_EXPAND flag can be set to YES to add extra items for group members 1079 # The TOC_EXPAND flag can be set to YES to add extra items for group members 934 1080 # to the contents of the HTML help documentation and to the tree view. 935 1081 936 1082 TOC_EXPAND = NO 937 1083 938 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER939 # are set, an additional index file will be generated that can be used as input for940 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated941 # HTML documentation.1084 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1085 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 1086 # that can be used as input for Qt's qhelpgenerator to generate a 1087 # Qt Compressed Help (.qch) of the generated HTML documentation. 942 1088 943 1089 GENERATE_QHP = NO 944 1090 945 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 946 # be used to specify the file name of the resulting .qch file. 1091 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 1092 # be used to specify the file name of the resulting .qch file. 947 1093 # The path specified is relative to the HTML output folder. 948 1094 949 QCH_FILE = 950 951 # The QHP_NAMESPACE tag specifies the namespace to use when generating 952 # Qt Help Project output. For more information please see 1095 QCH_FILE = 1096 1097 # The QHP_NAMESPACE tag specifies the namespace to use when generating 1098 # Qt Help Project output. For more information please see 953 1099 # http://doc.trolltech.com/qthelpproject.html#namespace 954 1100 955 QHP_NAMESPACE = 956 957 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 958 # Qt Help Project output. For more information please see 1101 QHP_NAMESPACE = 1102 1103 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 1104 # Qt Help Project output. For more information please see 959 1105 # http://doc.trolltech.com/qthelpproject.html#virtual-folders 960 1106 961 1107 QHP_VIRTUAL_FOLDER = doc 962 1108 963 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.964 # For more information please see1109 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 1110 # add. For more information please see 965 1111 # http://doc.trolltech.com/qthelpproject.html#custom-filters 966 1112 967 QHP_CUST_FILTER_NAME = 968 969 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 970 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 971 972 QHP_CUST_FILTER_ATTRS = 973 974 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 975 # filter section matches. 976 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 977 978 QHP_SECT_FILTER_ATTRS = 979 980 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 981 # be used to specify the location of Qt's qhelpgenerator. 982 # If non-empty doxygen will try to run qhelpgenerator on the generated 1113 QHP_CUST_FILTER_NAME = 1114 1115 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 1116 # custom filter to add. For more information please see 1117 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 1118 # Qt Help Project / Custom Filters</a>. 1119 1120 QHP_CUST_FILTER_ATTRS = 1121 1122 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1123 # project's 1124 # filter section matches. 1125 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 1126 # Qt Help Project / Filter Attributes</a>. 1127 1128 QHP_SECT_FILTER_ATTRS = 1129 1130 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 1131 # be used to specify the location of Qt's qhelpgenerator. 1132 # If non-empty doxygen will try to run qhelpgenerator on the generated 983 1133 # .qhp file. 984 1134 985 QHG_LOCATION = 986 987 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 988 # top of each HTML page. The value NO (the default) enables the index and 989 # the value YES disables it. 1135 QHG_LOCATION = 1136 1137 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files 1138 # will be generated, which together with the HTML files, form an Eclipse help 1139 # plugin. To install this plugin and make it available under the help contents 1140 # menu in Eclipse, the contents of the directory containing the HTML and XML 1141 # files needs to be copied into the plugins directory of eclipse. The name of 1142 # the directory within the plugins directory should be the same as 1143 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 1144 # the help appears. 1145 1146 GENERATE_ECLIPSEHELP = NO 1147 1148 # A unique identifier for the eclipse help plugin. When installing the plugin 1149 # the directory name containing the HTML and XML files should also have 1150 # this name. 1151 1152 ECLIPSE_DOC_ID = org.doxygen.Project 1153 1154 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 1155 # at top of each HTML page. The value NO (the default) enables the index and 1156 # the value YES disables it. Since the tabs have the same information as the 1157 # navigation tree you can set this option to NO if you already set 1158 # GENERATE_TREEVIEW to YES. 990 1159 991 1160 DISABLE_INDEX = NO 992 1161 993 # This tag can be used to set the number of enum values (range [1..20]) 994 # that doxygen will group on one line in the generated HTML documentation. 1162 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1163 # structure should be generated to display hierarchical information. 1164 # If the tag value is set to YES, a side panel will be generated 1165 # containing a tree-like index structure (just like the one that 1166 # is generated for HTML Help). For this to work a browser that supports 1167 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1168 # Windows users are probably better off using the HTML help feature. 1169 # Since the tree basically has the same information as the tab index you 1170 # could consider to set DISABLE_INDEX to NO when enabling this option. 1171 1172 GENERATE_TREEVIEW = NO 1173 1174 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 1175 # (range [0,1..20]) that doxygen will group on one line in the generated HTML 1176 # documentation. Note that a value of 0 will completely suppress the enum 1177 # values from appearing in the overview section. 995 1178 996 1179 ENUM_VALUES_PER_LINE = 4 997 1180 998 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 999 # structure should be generated to display hierarchical information. 1000 # If the tag value is set to YES, a side panel will be generated 1001 # containing a tree-like index structure (just like the one that 1002 # is generated for HTML Help). For this to work a browser that supports 1003 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 1004 # Windows users are probably better off using the HTML help feature. 1005 1006 GENERATE_TREEVIEW = NO 1007 1008 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 1009 # and Class Hierarchy pages using a tree view instead of an ordered list. 1010 1011 USE_INLINE_TREES = NO 1012 1013 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1014 # used to set the initial width (in pixels) of the frame in which the tree 1181 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1182 # used to set the initial width (in pixels) of the frame in which the tree 1015 1183 # is shown. 1016 1184 1017 1185 TREEVIEW_WIDTH = 250 1018 1186 1019 # Use this tag to change the font size of Latex formulas included 1020 # as images in the HTML documentation. The default is 10. Note that 1021 # when you change the font size after a successful doxygen run you need 1022 # to manually remove any form_*.png images from the HTML output directory 1187 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 1188 # links to external symbols imported via tag files in a separate window. 1189 1190 EXT_LINKS_IN_WINDOW = NO 1191 1192 # Use this tag to change the font size of Latex formulas included 1193 # as images in the HTML documentation. The default is 10. Note that 1194 # when you change the font size after a successful doxygen run you need 1195 # to manually remove any form_*.png images from the HTML output directory 1023 1196 # to force them to be regenerated. 1024 1197 1025 1198 FORMULA_FONTSIZE = 10 1026 1199 1027 # When the SEARCHENGINE tag is enable doxygen will generate a search box 1028 # for the HTML output. The underlying search engine uses javascript 1200 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1201 # generated for formulas are transparent PNGs. Transparent PNGs are 1202 # not supported properly for IE 6.0, but are supported on all modern browsers. 1203 # Note that when changing this option you need to delete any form_*.png files 1204 # in the HTML output before the changes have effect. 1205 1206 FORMULA_TRANSPARENT = YES 1207 1208 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 1209 # (see http://www.mathjax.org) which uses client side Javascript for the 1210 # rendering instead of using prerendered bitmaps. Use this if you do not 1211 # have LaTeX installed or if you want to formulas look prettier in the HTML 1212 # output. When enabled you may also need to install MathJax separately and 1213 # configure the path to it using the MATHJAX_RELPATH option. 1214 1215 USE_MATHJAX = NO 1216 1217 # When MathJax is enabled you need to specify the location relative to the 1218 # HTML output directory using the MATHJAX_RELPATH option. The destination 1219 # directory should contain the MathJax.js script. For instance, if the mathjax 1220 # directory is located at the same level as the HTML output directory, then 1221 # MATHJAX_RELPATH should be ../mathjax. The default value points to 1222 # the MathJax Content Delivery Network so you can quickly see the result without 1223 # installing MathJax. 1224 # However, it is strongly recommended to install a local 1225 # copy of MathJax from http://www.mathjax.org before deployment. 1226 1227 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1228 1229 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 1230 # names that should be enabled during MathJax rendering. 1231 1232 MATHJAX_EXTENSIONS = 1233 1234 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 1235 # for the HTML output. The underlying search engine uses javascript 1029 1236 # and DHTML and should work on any modern browser. Note that when using 1030 # HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) 1031 # there is already a search function so this one should typically 1032 # be disabled. 1237 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 1238 # (GENERATE_DOCSET) there is already a search function so this one should 1239 # typically be disabled. For large projects the javascript based search engine 1240 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. 1033 1241 1034 1242 SEARCHENGINE = YES 1035 1243 1244 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1245 # implemented using a PHP enabled web server instead of at the web client 1246 # using Javascript. Doxygen will generate the search PHP script and index 1247 # file to put on the web server. The advantage of the server 1248 # based approach is that it scales better to large projects and allows 1249 # full text search. The disadvantages are that it is more difficult to setup 1250 # and does not have live searching capabilities. 1251 1252 SERVER_BASED_SEARCH = NO 1253 1036 1254 #--------------------------------------------------------------------------- 1037 1255 # configuration options related to the LaTeX output 1038 1256 #--------------------------------------------------------------------------- 1039 1257 1040 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1258 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1041 1259 # generate Latex output. 1042 1260 1043 1261 GENERATE_LATEX = NO 1044 1262 1045 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1046 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1263 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1264 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1047 1265 # put in front of it. If left blank `latex' will be used as the default path. 1048 1266 1049 1267 LATEX_OUTPUT = latex 1050 1268 1051 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1269 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1052 1270 # invoked. If left blank `latex' will be used as the default command name. 1271 # Note that when enabling USE_PDFLATEX this option is only used for 1272 # generating bitmaps for formulas in the HTML output, but not in the 1273 # Makefile that is written to the output directory. 1053 1274 1054 1275 LATEX_CMD_NAME = latex 1055 1276 1056 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1057 # generate index for LaTeX. If left blank `makeindex' will be used as the 1277 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1278 # generate index for LaTeX. If left blank `makeindex' will be used as the 1058 1279 # default command name. 1059 1280 1060 1281 MAKEINDEX_CMD_NAME = makeindex 1061 1282 1062 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1063 # LaTeX documents. This may be useful for small projects and may help to 1283 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1284 # LaTeX documents. This may be useful for small projects and may help to 1064 1285 # save some trees in general. 1065 1286 1066 1287 COMPACT_LATEX = NO 1067 1288 1068 # The PAPER_TYPE tag can be used to set the paper type that is used 1069 # by the printer. Possible values are: a4, a4wide, letter, legal and1289 # The PAPER_TYPE tag can be used to set the paper type that is used 1290 # by the printer. Possible values are: a4, letter, legal and 1070 1291 # executive. If left blank a4wide will be used. 1071 1292 1072 1293 PAPER_TYPE = a4wide 1073 1294 1074 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1295 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1075 1296 # packages that should be included in the LaTeX output. 1076 1297 1077 EXTRA_PACKAGES = 1078 1079 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1080 # the generated latex document. The header should contain everything until 1081 # the first chapter. If it is left blank doxygen will generate a 1298 EXTRA_PACKAGES = 1299 1300 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1301 # the generated latex document. The header should contain everything until 1302 # the first chapter. If it is left blank doxygen will generate a 1082 1303 # standard header. Notice: only use this tag if you know what you are doing! 1083 1304 1084 LATEX_HEADER = 1085 1086 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1087 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1088 # contain links (just like the HTML output) instead of page references 1305 LATEX_HEADER = 1306 1307 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 1308 # the generated latex document. The footer should contain everything after 1309 # the last chapter. If it is left blank doxygen will generate a 1310 # standard footer. Notice: only use this tag if you know what you are doing! 1311 1312 LATEX_FOOTER = 1313 1314 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1315 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1316 # contain links (just like the HTML output) instead of page references 1089 1317 # This makes the output suitable for online browsing using a pdf viewer. 1090 1318 1091 1319 PDF_HYPERLINKS = YES 1092 1320 1093 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1094 # plain latex in the generated Makefile. Set this option to YES to get a 1321 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1322 # plain latex in the generated Makefile. Set this option to YES to get a 1095 1323 # higher quality PDF documentation. 1096 1324 1097 1325 USE_PDFLATEX = YES 1098 1326 1099 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1100 # command to the generated LaTeX files. This will instruct LaTeX to keep 1101 # running if errors occur, instead of asking the user for help. 1327 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1328 # command to the generated LaTeX files. This will instruct LaTeX to keep 1329 # running if errors occur, instead of asking the user for help. 1102 1330 # This option is also used when generating formulas in HTML. 1103 1331 1104 1332 LATEX_BATCHMODE = NO 1105 1333 1106 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1107 # include the index chapters (such as File Index, Compound Index, etc.) 1334 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1335 # include the index chapters (such as File Index, Compound Index, etc.) 1108 1336 # in the output. 1109 1337 … … 1117 1345 LATEX_SOURCE_CODE = NO 1118 1346 1347 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1348 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 1349 # http://en.wikipedia.org/wiki/BibTeX for more info. 1350 1351 LATEX_BIB_STYLE = plain 1352 1119 1353 #--------------------------------------------------------------------------- 1120 1354 # configuration options related to the RTF output 1121 1355 #--------------------------------------------------------------------------- 1122 1356 1123 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1124 # The RTF output is optimized for Word 97 and may not look very pretty with 1357 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1358 # The RTF output is optimized for Word 97 and may not look very pretty with 1125 1359 # other RTF readers or editors. 1126 1360 1127 1361 GENERATE_RTF = NO 1128 1362 1129 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1130 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1363 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1364 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1131 1365 # put in front of it. If left blank `rtf' will be used as the default path. 1132 1366 1133 1367 RTF_OUTPUT = rtf 1134 1368 1135 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1136 # RTF documents. This may be useful for small projects and may help to 1369 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1370 # RTF documents. This may be useful for small projects and may help to 1137 1371 # save some trees in general. 1138 1372 1139 1373 COMPACT_RTF = NO 1140 1374 1141 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1142 # will contain hyperlink fields. The RTF file will 1143 # contain links (just like the HTML output) instead of page references. 1144 # This makes the output suitable for online browsing using WORD or other 1145 # programs which support those fields. 1375 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1376 # will contain hyperlink fields. The RTF file will 1377 # contain links (just like the HTML output) instead of page references. 1378 # This makes the output suitable for online browsing using WORD or other 1379 # programs which support those fields. 1146 1380 # Note: wordpad (write) and others do not support links. 1147 1381 1148 1382 RTF_HYPERLINKS = NO 1149 1383 1150 # Load style sheet definitions from file. Syntax is similar to doxygen's1151 # config file, i.e. a series of assignments. You only have to provide 1384 # Load style sheet definitions from file. Syntax is similar to doxygen's 1385 # config file, i.e. a series of assignments. You only have to provide 1152 1386 # replacements, missing definitions are set to their default value. 1153 1387 1154 RTF_STYLESHEET_FILE = 1155 1156 # Set optional variables used in the generation of an rtf document. 1388 RTF_STYLESHEET_FILE = 1389 1390 # Set optional variables used in the generation of an rtf document. 1157 1391 # Syntax is similar to doxygen's config file. 1158 1392 1159 RTF_EXTENSIONS_FILE = 1393 RTF_EXTENSIONS_FILE = 1160 1394 1161 1395 #--------------------------------------------------------------------------- … … 1163 1397 #--------------------------------------------------------------------------- 1164 1398 1165 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1399 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1166 1400 # generate man pages 1167 1401 1168 1402 GENERATE_MAN = NO 1169 1403 1170 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1171 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1404 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1405 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1172 1406 # put in front of it. If left blank `man' will be used as the default path. 1173 1407 1174 1408 MAN_OUTPUT = man 1175 1409 1176 # The MAN_EXTENSION tag determines the extension that is added to 1410 # The MAN_EXTENSION tag determines the extension that is added to 1177 1411 # the generated man pages (default is the subroutine's section .3) 1178 1412 1179 1413 MAN_EXTENSION = .3 1180 1414 1181 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1182 # then it will generate one additional man file for each entity 1183 # documented in the real man page(s). These additional files 1184 # only source the real man page, but without them the man command 1415 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1416 # then it will generate one additional man file for each entity 1417 # documented in the real man page(s). These additional files 1418 # only source the real man page, but without them the man command 1185 1419 # would be unable to find the correct page. The default is NO. 1186 1420 … … 1191 1425 #--------------------------------------------------------------------------- 1192 1426 1193 # If the GENERATE_XML tag is set to YES Doxygen will 1194 # generate an XML file that captures the structure of 1427 # If the GENERATE_XML tag is set to YES Doxygen will 1428 # generate an XML file that captures the structure of 1195 1429 # the code including all documentation. 1196 1430 1197 1431 GENERATE_XML = NO 1198 1432 1199 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1200 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1433 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1434 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1201 1435 # put in front of it. If left blank `xml' will be used as the default path. 1202 1436 1203 1437 XML_OUTPUT = xml 1204 1438 1205 # The XML_SCHEMA tag can be used to specify an XML schema, 1206 # which can be used by a validating XML parser to check the 1439 # The XML_SCHEMA tag can be used to specify an XML schema, 1440 # which can be used by a validating XML parser to check the 1207 1441 # syntax of the XML files. 1208 1442 1209 XML_SCHEMA = 1210 1211 # The XML_DTD tag can be used to specify an XML DTD, 1212 # which can be used by a validating XML parser to check the 1443 XML_SCHEMA = 1444 1445 # The XML_DTD tag can be used to specify an XML DTD, 1446 # which can be used by a validating XML parser to check the 1213 1447 # syntax of the XML files. 1214 1448 1215 XML_DTD = 1216 1217 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1218 # dump the program listings (including syntax highlighting 1219 # and cross-referencing information) to the XML output. Note that 1449 XML_DTD = 1450 1451 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1452 # dump the program listings (including syntax highlighting 1453 # and cross-referencing information) to the XML output. Note that 1220 1454 # enabling this will significantly increase the size of the XML output. 1221 1455 … … 1226 1460 #--------------------------------------------------------------------------- 1227 1461 1228 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1229 # generate an AutoGen Definitions (see autogen.sf.net) file 1230 # that captures the structure of the code including all 1231 # documentation. Note that this feature is still experimental 1462 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1463 # generate an AutoGen Definitions (see autogen.sf.net) file 1464 # that captures the structure of the code including all 1465 # documentation. Note that this feature is still experimental 1232 1466 # and incomplete at the moment. 1233 1467 … … 1238 1472 #--------------------------------------------------------------------------- 1239 1473 1240 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1241 # generate a Perl module file that captures the structure of 1242 # the code including all documentation. Note that this 1243 # feature is still experimental and incomplete at the 1474 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1475 # generate a Perl module file that captures the structure of 1476 # the code including all documentation. Note that this 1477 # feature is still experimental and incomplete at the 1244 1478 # moment. 1245 1479 1246 1480 GENERATE_PERLMOD = NO 1247 1481 1248 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1249 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1482 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1483 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1250 1484 # to generate PDF and DVI output from the Perl module output. 1251 1485 1252 1486 PERLMOD_LATEX = NO 1253 1487 1254 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1255 # nicely formatted so it can be parsed by a human reader. This is useful 1256 # if you want to understand what is going on. On the other hand, if this 1257 # tag is set to NO the size of the Perl module output will be much smaller 1488 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1489 # nicely formatted so it can be parsed by a human reader. 1490 # This is useful 1491 # if you want to understand what is going on. 1492 # On the other hand, if this 1493 # tag is set to NO the size of the Perl module output will be much smaller 1258 1494 # and Perl will parse it just the same. 1259 1495 1260 1496 PERLMOD_PRETTY = YES 1261 1497 1262 # The names of the make variables in the generated doxyrules.make file 1263 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1264 # This is useful so different doxyrules.make files included by the same 1498 # The names of the make variables in the generated doxyrules.make file 1499 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1500 # This is useful so different doxyrules.make files included by the same 1265 1501 # Makefile don't overwrite each other's variables. 1266 1502 1267 PERLMOD_MAKEVAR_PREFIX = 1503 PERLMOD_MAKEVAR_PREFIX = 1268 1504 1269 1505 #--------------------------------------------------------------------------- … … 1271 1507 #--------------------------------------------------------------------------- 1272 1508 1273 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1274 # evaluate all C-preprocessor directives found in the sources and include 1509 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1510 # evaluate all C-preprocessor directives found in the sources and include 1275 1511 # files. 1276 1512 1277 1513 ENABLE_PREPROCESSING = YES 1278 1514 1279 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1280 # names in the source code. If set to NO (the default) only conditional 1281 # compilation will be performed. Macro expansion can be done in a controlled 1515 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1516 # names in the source code. If set to NO (the default) only conditional 1517 # compilation will be performed. Macro expansion can be done in a controlled 1282 1518 # way by setting EXPAND_ONLY_PREDEF to YES. 1283 1519 1284 1520 MACRO_EXPANSION = NO 1285 1521 1286 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1287 # then the macro expansion is limited to the macros specified with the 1522 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1523 # then the macro expansion is limited to the macros specified with the 1288 1524 # PREDEFINED and EXPAND_AS_DEFINED tags. 1289 1525 1290 1526 EXPAND_ONLY_PREDEF = NO 1291 1527 1292 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1293 # in the INCLUDE_PATH (see below) will be search ifa #include is found.1528 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1529 # pointed to by INCLUDE_PATH will be searched when a #include is found. 1294 1530 1295 1531 SEARCH_INCLUDES = YES 1296 1532 1297 # The INCLUDE_PATH tag can be used to specify one or more directories that 1298 # contain include files that are not input files but should be processed by 1533 # The INCLUDE_PATH tag can be used to specify one or more directories that 1534 # contain include files that are not input files but should be processed by 1299 1535 # the preprocessor. 1300 1536 1301 INCLUDE_PATH = 1302 1303 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1304 # patterns (like *.h and *.hpp) to filter out the header-files in the 1305 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1537 INCLUDE_PATH = 1538 1539 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1540 # patterns (like *.h and *.hpp) to filter out the header-files in the 1541 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1306 1542 # be used. 1307 1543 1308 INCLUDE_FILE_PATTERNS = 1309 1310 # The PREDEFINED tag can be used to specify one or more macro names that 1311 # are defined before the preprocessor is started (similar to the -D option of 1312 # gcc). The argument of the tag is a list of macros of the form: name 1313 # or name=definition (no spaces). If the definition and the = are 1314 # omitted =1 is assumed. To prevent a macro definition from being 1315 # undefined via #undef or recursively expanded use the := operator 1544 INCLUDE_FILE_PATTERNS = 1545 1546 # The PREDEFINED tag can be used to specify one or more macro names that 1547 # are defined before the preprocessor is started (similar to the -D option of 1548 # gcc). The argument of the tag is a list of macros of the form: name 1549 # or name=definition (no spaces). If the definition and the = are 1550 # omitted =1 is assumed. To prevent a macro definition from being 1551 # undefined via #undef or recursively expanded use the := operator 1316 1552 # instead of the = operator. 1317 1553 1318 PREDEFINED = __i386__ Q_OS_WIN32 DOXYGEN_EXCLUDE 1319 1320 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1321 # this tag can be used to specify a list of macro names that should be expanded. 1322 # The macro definition that is found in the sources will be used. 1323 # Use the PREDEFINED tag if you want to use a different macro definition. 1324 1325 EXPAND_AS_DEFINED = 1326 1327 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1328 # doxygen's preprocessor will remove all function-like macros that are alone 1329 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1330 # function macros are typically used for boiler-plate code, and will confuse 1331 # the parser if not removed. 1554 PREDEFINED = __i386__ \ 1555 Q_OS_WIN32 \ 1556 DOXYGEN_EXCLUDE 1557 1558 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1559 # this tag can be used to specify a list of macro names that should be expanded. 1560 # The macro definition that is found in the sources will be used. 1561 # Use the PREDEFINED tag if you want to use a different macro definition that 1562 # overrules the definition found in the source code. 1563 1564 EXPAND_AS_DEFINED = 1565 1566 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1567 # doxygen's preprocessor will remove all references to function-like macros 1568 # that are alone on a line, have an all uppercase name, and do not end with a 1569 # semicolon, because these will confuse the parser if not removed. 1332 1570 1333 1571 SKIP_FUNCTION_MACROS = YES … … 1337 1575 #--------------------------------------------------------------------------- 1338 1576 1339 # The TAGFILES option can be used to specify one or more tagfiles. 1340 # Optionally an initial location of the external documentation 1341 # can be added for each tagfile. The format of a tag file without 1342 # this location is as follows: 1343 # TAGFILES = file1 file2 ... 1344 # Adding location for the tag files is done as follows: 1345 # TAGFILES = file1=loc1 "file2 = loc2" ... 1346 # where "loc1" and "loc2" can be relative or absolute paths or 1347 # URLs. If a location is present for each tag, the installdox tool 1348 # does not have to be run to correct the links. 1349 # Note that each tag file must have a unique name 1350 # (where the name does NOT include the path) 1351 # If a tag file is not located in the directory in which doxygen 1352 # is run, you must also specify the path to the tagfile here. 1577 # The TAGFILES option can be used to specify one or more tagfiles. For each 1578 # tag file the location of the external documentation should be added. The 1579 # format of a tag file without this location is as follows: 1580 # 1581 # TAGFILES = file1 file2 ... 1582 # Adding location for the tag files is done as follows: 1583 # 1584 # TAGFILES = file1=loc1 "file2 = loc2" ... 1585 # where "loc1" and "loc2" can be relative or absolute paths 1586 # or URLs. Note that each tag file must have a unique name (where the name does 1587 # NOT include the path). If a tag file is not located in the directory in which 1588 # doxygen is run, you must also specify the path to the tagfile here. 1353 1589 1354 1590 TAGFILES = doc/qt-4.8.tags=http://qt-project.org/doc/qt-4.8 1355 1591 1356 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1592 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1357 1593 # a tag file that is based on the input files it reads. 1358 1594 1359 1595 GENERATE_TAGFILE = doc/tspsg.tags 1360 1596 1361 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1362 # in the class index. If set to NO only the inherited external classes 1597 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1598 # in the class index. If set to NO only the inherited external classes 1363 1599 # will be listed. 1364 1600 1365 1601 ALLEXTERNALS = NO 1366 1602 1367 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1368 # in the modules index. If set to NO, only the current project's groups will 1603 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1604 # in the modules index. If set to NO, only the current project's groups will 1369 1605 # be listed. 1370 1606 1371 1607 EXTERNAL_GROUPS = YES 1372 1608 1373 # The PERL_PATH should be the absolute path and name of the perl script 1609 # The PERL_PATH should be the absolute path and name of the perl script 1374 1610 # interpreter (i.e. the result of `which perl'). 1375 1611 … … 1380 1616 #--------------------------------------------------------------------------- 1381 1617 1382 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1383 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1384 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1385 # this option is superseded by the HAVE_DOT option below. This is only a 1386 # fallback. It is recommended to install and use dot, since it yields more 1387 # powerful graphs. 1618 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1619 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1620 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1621 # this option also works with HAVE_DOT disabled, but it is recommended to 1622 # install and use dot, since it yields more powerful graphs. 1388 1623 1389 1624 CLASS_DIAGRAMS = YES 1390 1625 1391 # You can define message sequence charts within doxygen comments using the \msc 1392 # command. Doxygen will then run the mscgen tool (see 1393 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1394 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1395 # the mscgen tool resides. If left empty the tool is assumed to be found in the 1626 # You can define message sequence charts within doxygen comments using the \msc 1627 # command. Doxygen will then run the mscgen tool (see 1628 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1629 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1630 # the mscgen tool resides. If left empty the tool is assumed to be found in the 1396 1631 # default search path. 1397 1632 1398 MSCGEN_PATH = 1399 1400 # If set to YES, the inheritance and collaboration graphs will hide 1401 # inheritance and usage relations if the target is undocumented 1633 MSCGEN_PATH = 1634 1635 # If set to YES, the inheritance and collaboration graphs will hide 1636 # inheritance and usage relations if the target is undocumented 1402 1637 # or is not a class. 1403 1638 1404 1639 HIDE_UNDOC_RELATIONS = YES 1405 1640 1406 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1407 # available from the path. This tool is part of Graphviz, a graph visualization 1408 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1641 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1642 # available from the path. This tool is part of Graphviz, a graph visualization 1643 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1409 1644 # have no effect if this option is set to NO (the default) 1410 1645 1411 1646 HAVE_DOT = YES 1412 1647 1413 # By default doxygen will write a font called FreeSans.ttf to the output 1414 # directory and reference it in all dot files that doxygen generates. This 1415 # font does not include all possible unicode characters however, so when you need 1416 # these (or just want a differently looking font) you can specify the font name 1417 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1418 # which can be done by putting it in a standard location or by setting the 1419 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1420 # containing the font. 1648 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 1649 # allowed to run in parallel. When set to 0 (the default) doxygen will 1650 # base this on the number of processors available in the system. You can set it 1651 # explicitly to a value larger than 0 to get control over the balance 1652 # between CPU load and processing speed. 1653 1654 DOT_NUM_THREADS = 0 1655 1656 # By default doxygen will use the Helvetica font for all dot files that 1657 # doxygen generates. When you want a differently looking font you can specify 1658 # the font name using DOT_FONTNAME. You need to make sure dot is able to find 1659 # the font, which can be done by putting it in a standard location or by setting 1660 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 1661 # directory containing the font. 1421 1662 1422 1663 DOT_FONTNAME = FreeSans 1423 1664 1424 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1665 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1425 1666 # The default size is 10pt. 1426 1667 1427 1668 DOT_FONTSIZE = 10 1428 1669 1429 # By default doxygen will tell dot to use the output directory to look for the 1430 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1431 # different font using DOT_FONTNAME you can set the path where dot 1432 # can find it using this tag. 1433 1434 DOT_FONTPATH = 1435 1436 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1437 # will generate a graph for each documented class showing the direct and 1438 # indirect inheritance relations. Setting this tag to YES will force the 1439 # the CLASS_DIAGRAMS tag to NO. 1670 # By default doxygen will tell dot to use the Helvetica font. 1671 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 1672 # set the path where dot can find it. 1673 1674 DOT_FONTPATH = 1675 1676 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1677 # will generate a graph for each documented class showing the direct and 1678 # indirect inheritance relations. Setting this tag to YES will force the 1679 # CLASS_DIAGRAMS tag to NO. 1440 1680 1441 1681 CLASS_GRAPH = YES 1442 1682 1443 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1444 # will generate a graph for each documented class showing the direct and 1445 # indirect implementation dependencies (inheritance, containment, and 1683 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1684 # will generate a graph for each documented class showing the direct and 1685 # indirect implementation dependencies (inheritance, containment, and 1446 1686 # class references variables) of the class with other documented classes. 1447 1687 1448 1688 COLLABORATION_GRAPH = YES 1449 1689 1450 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1690 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1451 1691 # will generate a graph for groups, showing the direct groups dependencies 1452 1692 1453 1693 GROUP_GRAPHS = YES 1454 1694 1455 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1456 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1695 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1696 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1457 1697 # Language. 1458 1698 1459 1699 UML_LOOK = NO 1460 1700 1461 # If set to YES, the inheritance and collaboration graphs will show the 1701 # If the UML_LOOK tag is enabled, the fields and methods are shown inside 1702 # the class node. If there are many fields or methods and many nodes the 1703 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS 1704 # threshold limits the number of items for each type to make the size more 1705 # managable. Set this to 0 for no limit. Note that the threshold may be 1706 # exceeded by 50% before the limit is enforced. 1707 1708 UML_LIMIT_NUM_FIELDS = 10 1709 1710 # If set to YES, the inheritance and collaboration graphs will show the 1462 1711 # relations between templates and their instances. 1463 1712 1464 1713 TEMPLATE_RELATIONS = NO 1465 1714 1466 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1467 # tags are set to YES then doxygen will generate a graph for each documented 1468 # file showing the direct and indirect include dependencies of the file with 1715 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1716 # tags are set to YES then doxygen will generate a graph for each documented 1717 # file showing the direct and indirect include dependencies of the file with 1469 1718 # other documented files. 1470 1719 1471 1720 INCLUDE_GRAPH = YES 1472 1721 1473 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1474 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1475 # documented header file showing the documented files that directly or 1722 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1723 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1724 # documented header file showing the documented files that directly or 1476 1725 # indirectly include this file. 1477 1726 1478 1727 INCLUDED_BY_GRAPH = YES 1479 1728 1480 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1481 # doxygen will generate a call dependency graph for every global function 1482 # or class method. Note that enabling this option will significantly increase 1483 # the time of a run. So in most cases it will be better to enable call graphs 1729 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1730 # doxygen will generate a call dependency graph for every global function 1731 # or class method. Note that enabling this option will significantly increase 1732 # the time of a run. So in most cases it will be better to enable call graphs 1484 1733 # for selected functions only using the \callgraph command. 1485 1734 1486 1735 CALL_GRAPH = YES 1487 1736 1488 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1489 # doxygen will generate a caller dependency graph for every global function 1490 # or class method. Note that enabling this option will significantly increase 1491 # the time of a run. So in most cases it will be better to enable caller 1737 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1738 # doxygen will generate a caller dependency graph for every global function 1739 # or class method. Note that enabling this option will significantly increase 1740 # the time of a run. So in most cases it will be better to enable caller 1492 1741 # graphs for selected functions only using the \callergraph command. 1493 1742 1494 1743 CALLER_GRAPH = YES 1495 1744 1496 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1497 # will g raphical hierarchy of all classes instead of a textual one.1745 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1746 # will generate a graphical hierarchy of all classes instead of a textual one. 1498 1747 1499 1748 GRAPHICAL_HIERARCHY = YES 1500 1749 1501 # If the DIRECTORY_GRAPH , SHOW_DIRECTORIES and HAVE_DOT tags are set to YES1502 # then doxygen will show the dependencies a directory has on other directories 1503 # in a graphical way. The dependency relations are determined by the #include 1750 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES 1751 # then doxygen will show the dependencies a directory has on other directories 1752 # in a graphical way. The dependency relations are determined by the #include 1504 1753 # relations between the files in the directories. 1505 1754 1506 1755 DIRECTORY_GRAPH = YES 1507 1756 1508 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1509 # generated by dot. Possible values are png, jpg, or gif 1510 # If left blank png will be used. 1757 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1758 # generated by dot. Possible values are svg, png, jpg, or gif. 1759 # If left blank png will be used. If you choose svg you need to set 1760 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1761 # visible in IE 9+ (other browsers do not have this requirement). 1511 1762 1512 1763 DOT_IMAGE_FORMAT = png 1513 1764 1514 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1765 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 1766 # enable generation of interactive SVG images that allow zooming and panning. 1767 # Note that this requires a modern browser other than Internet Explorer. 1768 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 1769 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 1770 # visible. Older versions of IE do not have SVG support. 1771 1772 INTERACTIVE_SVG = NO 1773 1774 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1515 1775 # found. If left blank, it is assumed the dot tool can be found in the path. 1516 1776 1517 DOT_PATH = 1518 1519 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1520 # contain dot files that are included in the documentation (see the 1777 DOT_PATH = 1778 1779 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1780 # contain dot files that are included in the documentation (see the 1521 1781 # \dotfile command). 1522 1782 1523 DOTFILE_DIRS = 1524 1525 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1526 # nodes that will be shown in the graph. If the number of nodes in a graph 1527 # becomes larger than this value, doxygen will truncate the graph, which is 1528 # visualized by representing a node as a red box. Note that doxygen if the 1529 # number of direct children of the root node in a graph is already larger than 1530 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1783 DOTFILE_DIRS = 1784 1785 # The MSCFILE_DIRS tag can be used to specify one or more directories that 1786 # contain msc files that are included in the documentation (see the 1787 # \mscfile command). 1788 1789 MSCFILE_DIRS = 1790 1791 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1792 # nodes that will be shown in the graph. If the number of nodes in a graph 1793 # becomes larger than this value, doxygen will truncate the graph, which is 1794 # visualized by representing a node as a red box. Note that doxygen if the 1795 # number of direct children of the root node in a graph is already larger than 1796 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1531 1797 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1532 1798 1533 1799 DOT_GRAPH_MAX_NODES = 50 1534 1800 1535 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1536 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1537 # from the root by following a path via at most 3 edges will be shown. Nodes 1538 # that lay further from the root node will be omitted. Note that setting this 1539 # option to 1 or 2 may greatly reduce the computation time needed for large 1540 # code bases. Also note that the size of a graph can be further restricted by 1801 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1802 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1803 # from the root by following a path via at most 3 edges will be shown. Nodes 1804 # that lay further from the root node will be omitted. Note that setting this 1805 # option to 1 or 2 may greatly reduce the computation time needed for large 1806 # code bases. Also note that the size of a graph can be further restricted by 1541 1807 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1542 1808 1543 1809 MAX_DOT_GRAPH_DEPTH = 0 1544 1810 1545 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1546 # background. This is disabled by default, because dot on Windows does not 1547 # seem to support this out of the box. Warning: Depending on the platform used, 1548 # enabling this option may lead to badly anti-aliased labels on the edges of 1811 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1812 # background. This is disabled by default, because dot on Windows does not 1813 # seem to support this out of the box. Warning: Depending on the platform used, 1814 # enabling this option may lead to badly anti-aliased labels on the edges of 1549 1815 # a graph (i.e. they become hard to read). 1550 1816 1551 1817 DOT_TRANSPARENT = YES 1552 1818 1553 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1554 # files in one run (i.e. multiple -o and -T options on the command line). This 1555 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1819 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1820 # files in one run (i.e. multiple -o and -T options on the command line). This 1821 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1556 1822 # support this, this feature is disabled by default. 1557 1823 1558 1824 DOT_MULTI_TARGETS = YES 1559 1825 1560 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1561 # generate a legend page explaining the meaning of the various boxes and 1826 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1827 # generate a legend page explaining the meaning of the various boxes and 1562 1828 # arrows in the dot generated graphs. 1563 1829 1564 1830 GENERATE_LEGEND = YES 1565 1831 1566 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1567 # remove the intermediate dot files that are used to generate 1832 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1833 # remove the intermediate dot files that are used to generate 1568 1834 # the various graphs. 1569 1835
Note: See TracChangeset
for help on using the changeset viewer.