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