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