+1635 -984

Doxyfile

reviewed

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

+4 -12

include/SDL_gpu.h

reviewed

··· 29 29 30 30 /*! 31 31 * \defgroup Initialization Initialization 32 32 - * SDL_gpu has a fairly simple initialization process. If you need nothing more than the default initialization, call: 33 33 - * <pre>GPU_Target* screen = GPU_Init(width, height, GPU_DEFAULT_INIT_FLAGS);</pre> 34 34 - * Then when you're done, clean up with: 35 35 - * <pre>GPU_Quit();</pre> 36 36 - * 37 37 - * Other functions in the Initialization module control how initialization is performed. 38 38 - * 39 32 * \defgroup Logging Debugging, Logging, and Error Handling 40 40 - * Use GPU_Log() for normal logging output (e.g. to replace printf). Other logging priorities are handled by GPU_LogWarning() and GPU_LogError(). 41 41 - * 42 42 - * SDL_gpu stores an error queue that you can read and manipulate using GPU_PopErrorCode() and GPU_PushErrorCode(). If you set the debug level using GPU_SetDebugLevel(), you can have any errors automatically logged as they are generated. 43 43 - * 44 33 * \defgroup RendererSetup Renderer Setup 45 34 * \defgroup RendererControls Renderer Controls 46 35 * \defgroup ContextControls Context Controls ··· 959 948 /*! Load surface from an image file that is supported by this renderer. Don't forget to SDL_FreeSurface() it. */ 960 949 DECLSPEC SDL_Surface* SDLCALL GPU_LoadSurface(const char* filename); 961 950 951 951 + /*! Load surface from an image file in memory. Don't forget to SDL_FreeSurface() it. */ 952 952 + DECLSPEC SDL_Surface* SDLCALL GPU_LoadSurface_RW(SDL_RWops* rwops, Uint8 free_rwops); 953 953 + 962 954 /*! Save surface to a file. 963 955 * With a format of GPU_FILE_AUTO, the file type is deduced from the extension. Supported formats are: png, bmp, tga. 964 956 * Returns 0 on failure. */ ··· 1450 1442 DECLSPEC void SDLCALL GPU_FreeShaderProgram(Uint32 program_object); 1451 1443 1452 1444 /*! Loads shader source from an SDL_RWops, compiles it, and returns the new shader object. */ 1453 1453 - DECLSPEC Uint32 SDLCALL GPU_CompileShader_RW(GPU_ShaderEnum shader_type, SDL_RWops* shader_source); 1445 1445 + DECLSPEC Uint32 SDLCALL GPU_CompileShader_RW(GPU_ShaderEnum shader_type, SDL_RWops* shader_source, Uint8 free_rwops); 1454 1446 1455 1447 /*! Compiles shader source and returns the new shader object. */ 1456 1448 DECLSPEC Uint32 SDLCALL GPU_CompileShader(GPU_ShaderEnum shader_type, const char* shader_source);

+1 -1

include/SDL_gpu_RendererImpl.h

reviewed

··· 154 154 void (SDLCALL *FreeShaderProgram)(GPU_Renderer* renderer, Uint32 program_object); 155 155 156 156 /*! \see GPU_CompileShader_RW() */ 157 157 - Uint32 (SDLCALL *CompileShader_RW)(GPU_Renderer* renderer, GPU_ShaderEnum shader_type, SDL_RWops* shader_source); 157 157 + Uint32 (SDLCALL *CompileShader_RW)(GPU_Renderer* renderer, GPU_ShaderEnum shader_type, SDL_RWops* shader_source, Uint8 free_rwops); 158 158 159 159 /*! \see GPU_CompileShader() */ 160 160 Uint32 (SDLCALL *CompileShader)(GPU_Renderer* renderer, GPU_ShaderEnum shader_type, const char* shader_source);

+95 -52

src/SDL_gpu.c

reviewed

··· 942 942 return _gpu_current_renderer->impl->ReplaceImage(_gpu_current_renderer, image, surface, surface_rect); 943 943 } 944 944 945 945 - SDL_Surface* GPU_LoadSurface(const char* filename) 945 945 + static SDL_Surface* gpu_copy_raw_surface_data(unsigned char* data, int width, int height, int channels) 946 946 { 947 947 int i; 948 948 - int width, height, channels; 949 948 Uint32 Rmask, Gmask, Bmask, Amask = 0; 950 950 - unsigned char* data; 951 949 SDL_Surface* result; 952 952 - 953 953 - if(filename == NULL) 954 954 - { 955 955 - GPU_PushErrorCode("GPU_LoadSurface", GPU_ERROR_NULL_ARGUMENT, "filename"); 956 956 - return NULL; 957 957 - } 958 958 - 959 959 - #ifdef __ANDROID__ 960 960 - if(strlen(filename) > 0 && filename[0] != '/') 961 961 - { 962 962 - // Must use SDL_RWops to access the assets directory automatically 963 963 - SDL_RWops* rwops = SDL_RWFromFile(filename, "r"); 964 964 - if(rwops == NULL) 965 965 - return NULL; 966 966 - int data_bytes = SDL_RWseek(rwops, 0, SEEK_END); 967 967 - SDL_RWseek(rwops, 0, SEEK_SET); 968 968 - unsigned char* c_data = (unsigned char*)SDL_malloc(data_bytes); 969 969 - SDL_RWread(rwops, c_data, 1, data_bytes); 970 970 - data = stbi_load_from_memory(c_data, data_bytes, &width, &height, &channels, 0); 971 971 - SDL_free(c_data); 972 972 - SDL_FreeRW(rwops); 973 973 - } 974 974 - else 975 975 - { 976 976 - // Absolute filename 977 977 - data = stbi_load(filename, &width, &height, &channels, 0); 978 978 - } 979 979 - #else 980 980 - data = stbi_load(filename, &width, &height, &channels, 0); 981 981 - #endif 982 982 - 950 950 + 983 951 if(data == NULL) 984 952 { 985 985 - GPU_PushErrorCode(__func__, GPU_ERROR_DATA_ERROR, "Failed to load \"%s\": %s", filename, stbi_failure_reason()); 953 953 + GPU_PushErrorCode(__func__, GPU_ERROR_DATA_ERROR, "Got NULL data"); 986 954 return NULL; 987 955 } 988 988 - if(channels < 1 || channels > 4) 989 989 - { 990 990 - GPU_PushErrorCode(__func__, GPU_ERROR_DATA_ERROR, "Failed to load \"%s\": Unsupported pixel format", filename); 991 991 - stbi_image_free(data); 992 992 - return NULL; 993 993 - } 994 994 - 956 956 + 995 957 switch(channels) 996 958 { 997 959 case 1: ··· 1020 982 break; 1021 983 default: 1022 984 Rmask = Gmask = Bmask = 0; 985 985 + GPU_PushErrorCode(__func__, GPU_ERROR_DATA_ERROR, "Invalid number of channels: %d", channels); 986 986 + return NULL; 1023 987 break; 1024 988 } 1025 989 ··· 1027 991 if(result == NULL) 1028 992 { 1029 993 GPU_PushErrorCode(__func__, GPU_ERROR_DATA_ERROR, "Failed to create new %dx%d surface", width, height); 1030 1030 - stbi_image_free(data); 1031 994 return NULL; 1032 995 } 1033 996 ··· 1036 999 { 1037 1000 memcpy((Uint8*)result->pixels + i*result->pitch, data + channels*width*i, channels*width); 1038 1001 } 1039 1039 - 1040 1040 - stbi_image_free(data); 1041 1041 - 1002 1002 + 1042 1003 if(result != NULL && result->format->palette != NULL) 1043 1004 { 1044 1005 // SDL_CreateRGBSurface has no idea what palette to use, so it uses a blank one. ··· 1059 1020 SDL_SetPalette(result, SDL_LOGPAL, colors, 0, 256); 1060 1021 #endif 1061 1022 } 1023 1023 + 1024 1024 + return result; 1025 1025 + } 1026 1026 + 1027 1027 + SDL_Surface* GPU_LoadSurface_RW(SDL_RWops* rwops, Uint8 free_rwops) 1028 1028 + { 1029 1029 + int width, height, channels; 1030 1030 + unsigned char* data; 1031 1031 + SDL_Surface* result; 1032 1032 + 1033 1033 + int data_bytes; 1034 1034 + unsigned char* c_data; 1035 1035 + 1036 1036 + if(rwops == NULL) 1037 1037 + { 1038 1038 + GPU_PushErrorCode(__func__, GPU_ERROR_NULL_ARGUMENT, "rwops"); 1039 1039 + return NULL; 1040 1040 + } 1041 1041 + 1042 1042 + // Get count of bytes 1043 1043 + SDL_RWseek(rwops, 0, SEEK_SET); 1044 1044 + data_bytes = SDL_RWseek(rwops, 0, SEEK_END); 1045 1045 + SDL_RWseek(rwops, 0, SEEK_SET); 1046 1046 + 1047 1047 + // Read in the rwops data 1048 1048 + c_data = (unsigned char*)SDL_malloc(data_bytes); 1049 1049 + SDL_RWread(rwops, c_data, 1, data_bytes); 1050 1050 + 1051 1051 + // Load image 1052 1052 + data = stbi_load_from_memory(c_data, data_bytes, &width, &height, &channels, 0); 1053 1053 + 1054 1054 + // Clean up temp data 1055 1055 + SDL_free(c_data); 1056 1056 + if(free_rwops) 1057 1057 + SDL_RWclose(rwops); 1058 1058 + 1059 1059 + if(data == NULL) 1060 1060 + { 1061 1061 + GPU_PushErrorCode(__func__, GPU_ERROR_DATA_ERROR, "Failed to load from rwops: %s", stbi_failure_reason()); 1062 1062 + return NULL; 1063 1063 + } 1064 1064 + 1065 1065 + // Copy into a surface 1066 1066 + result = gpu_copy_raw_surface_data(data, width, height, channels); 1067 1067 + 1068 1068 + stbi_image_free(data); 1069 1069 + 1070 1070 + return result; 1071 1071 + } 1072 1072 + 1073 1073 + SDL_Surface* GPU_LoadSurface(const char* filename) 1074 1074 + { 1075 1075 + int width, height, channels; 1076 1076 + unsigned char* data; 1077 1077 + SDL_Surface* result; 1078 1078 + 1079 1079 + if(filename == NULL) 1080 1080 + { 1081 1081 + GPU_PushErrorCode("GPU_LoadSurface", GPU_ERROR_NULL_ARGUMENT, "filename"); 1082 1082 + return NULL; 1083 1083 + } 1084 1084 + 1085 1085 + #ifdef __ANDROID__ 1086 1086 + // Must use SDL_RWops to access the assets directory automatically 1087 1087 + if(strlen(filename) > 0 && filename[0] != '/') 1088 1088 + return GPU_LoadSurface_RW(SDL_RWFromFile(filename, "r"), 1); 1089 1089 + #endif 1090 1090 + 1091 1091 + data = stbi_load(filename, &width, &height, &channels, 0); 1092 1092 + 1093 1093 + if(data == NULL) 1094 1094 + { 1095 1095 + GPU_PushErrorCode(__func__, GPU_ERROR_DATA_ERROR, "Failed to load \"%s\": %s", filename, stbi_failure_reason()); 1096 1096 + return NULL; 1097 1097 + } 1098 1098 + 1099 1099 + result = gpu_copy_raw_surface_data(data, width, height, channels); 1100 1100 + 1101 1101 + stbi_image_free(data); 1062 1102 1063 1103 return result; 1064 1104 } ··· 1734 1774 // Shader API 1735 1775 1736 1776 1737 1737 - Uint32 GPU_CompileShader_RW(GPU_ShaderEnum shader_type, SDL_RWops* shader_source) 1777 1777 + Uint32 GPU_CompileShader_RW(GPU_ShaderEnum shader_type, SDL_RWops* shader_source, Uint8 free_rwops) 1738 1778 { 1739 1779 if(_gpu_current_renderer == NULL || _gpu_current_renderer->current_context_target == NULL) 1780 1780 + { 1781 1781 + if(free_rwops) 1782 1782 + SDL_RWclose(shader_source); 1740 1783 return 0; 1784 1784 + } 1741 1785 1742 1742 - return _gpu_current_renderer->impl->CompileShader_RW(_gpu_current_renderer, shader_type, shader_source); 1786 1786 + return _gpu_current_renderer->impl->CompileShader_RW(_gpu_current_renderer, shader_type, shader_source, free_rwops); 1743 1787 } 1744 1788 1745 1789 Uint32 GPU_LoadShader(GPU_ShaderEnum shader_type, const char* filename) 1746 1790 { 1747 1791 SDL_RWops* rwops; 1748 1748 - Uint32 result; 1749 1792 1750 1793 if(filename == NULL) 1751 1794 { 1752 1795 GPU_PushErrorCode(__func__, GPU_ERROR_NULL_ARGUMENT, "filename"); 1753 1796 return 0; 1754 1797 } 1798 1798 + 1755 1799 rwops = SDL_RWFromFile(filename, "r"); 1756 1800 if(rwops == NULL) 1757 1801 { 1758 1802 GPU_PushErrorCode(__func__, GPU_ERROR_FILE_NOT_FOUND, "%s", filename); 1759 1803 return 0; 1760 1804 } 1761 1761 - result = GPU_CompileShader_RW(shader_type, rwops); 1762 1762 - SDL_RWclose(rwops); 1763 1763 - return result; 1805 1805 + 1806 1806 + return GPU_CompileShader_RW(shader_type, rwops, 1); 1764 1807 } 1765 1808 1766 1809 Uint32 GPU_CompileShader(GPU_ShaderEnum shader_type, const char* shader_source)

+32

src/groups.dox

reviewed

··· 1 1 + 2 2 + /*! 3 3 + * \defgroup Initialization Initialization 4 4 + * SDL_gpu has a fairly simple initialization process. If you need nothing more than the default initialization, call: 5 5 + * <pre>GPU_Target* screen = GPU_Init(width, height, GPU_DEFAULT_INIT_FLAGS);</pre> 6 6 + * Then when you're done, clean up with: 7 7 + * <pre>GPU_Quit();</pre> 8 8 + * 9 9 + * Other functions in the Initialization module control how initialization is performed. 10 10 + * 11 11 + * \defgroup Logging Debugging, Logging, and Error Handling 12 12 + * Use GPU_Log() for normal logging output (e.g. to replace printf). Other logging priorities are handled by GPU_LogWarning() and GPU_LogError(). 13 13 + * 14 14 + * SDL_gpu stores an error queue that you can read and manipulate using GPU_PopErrorCode() and GPU_PushErrorCode(). If you set the debug level using GPU_SetDebugLevel(), you can have any errors automatically logged as they are generated. 15 15 + * 16 16 + * \defgroup RendererSetup Renderer Setup 17 17 + * \defgroup RendererControls Renderer Controls 18 18 + * \defgroup ContextControls Context Controls 19 19 + * \defgroup TargetControls Target Controls 20 20 + * \defgroup SurfaceControls Surface Controls 21 21 + * \defgroup ImageControls Image Controls 22 22 + * \defgroup Conversions Surface, Image, and Target Conversions 23 23 + * \defgroup Matrix Matrix Controls 24 24 + * \defgroup Rendering Rendering 25 25 + * \defgroup Shapes Shapes 26 26 + * \defgroup ShaderInterface Shader Interface 27 27 + */ 28 28 + 29 29 + 30 30 + 31 31 + 32 32 +

+5 -4

src/renderer_GL_common.inl

reviewed

··· 5537 5537 } 5538 5538 5539 5539 5540 5540 - static Uint32 CompileShader_RW(GPU_Renderer* renderer, GPU_ShaderEnum shader_type, SDL_RWops* shader_source) 5540 5540 + static Uint32 CompileShader_RW(GPU_Renderer* renderer, GPU_ShaderEnum shader_type, SDL_RWops* shader_source, Uint8 free_rwops) 5541 5541 { 5542 5542 // Read in the shader source code 5543 5543 Uint32 size = GetShaderSourceSize_RW(shader_source); ··· 5546 5546 Uint32 result2; 5547 5547 (void)renderer; 5548 5548 5549 5549 + if(free_rwops) 5550 5550 + SDL_RWclose(shader_source); 5551 5551 + 5549 5552 if(!result) 5550 5553 { 5551 5554 GPU_PushErrorCode("GPU_CompileShader", GPU_ERROR_DATA_ERROR, "Failed to read shader source"); ··· 5567 5570 if(size == 0) 5568 5571 return 0; 5569 5572 rwops = SDL_RWFromConstMem(shader_source, size); 5570 5570 - size = renderer->impl->CompileShader_RW(renderer, shader_type, rwops); 5571 5571 - SDL_RWclose(rwops); 5572 5572 - return size; 5573 5573 + return renderer->impl->CompileShader_RW(renderer, shader_type, rwops, 1); 5573 5574 } 5574 5575 5575 5576 static Uint32 CreateShaderProgram(GPU_Renderer* renderer)

+1 -1

tests/renderer/main.c

reviewed

··· 834 834 GPU_Log(" %s (dummy)\n", __func__); 835 835 } 836 836 837 837 - static Uint32 CompileShader_RW(GPU_Renderer* renderer, GPU_ShaderEnum shader_type, SDL_RWops* shader_source) 837 837 + static Uint32 CompileShader_RW(GPU_Renderer* renderer, GPU_ShaderEnum shader_type, SDL_RWops* shader_source, Uint8 free_rwops) 838 838 { 839 839 GPU_Log(" %s (dummy)\n", __func__); 840 840