Mon, 18 Aug 2003 04:18:46 +0000
[gaim-migrate @ 7001]
Turning on HAVE_DOT. If you don't have graphviz, go get it now. Yes, right
now. Don't tempt me, I'm not playing around here.
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1 | # Doxyfile 1.3.3 |
| 4554 | 2 | |
| 3 | # This file describes the settings to be used by the documentation system | |
| 4 | # doxygen (www.doxygen.org) for a project | |
| 5 | # | |
| 6 | # All text after a hash (#) is considered a comment and will be ignored | |
| 7 | # The format is: | |
| 8 | # TAG = value [value, ...] | |
| 9 | # For lists items can also be appended using: | |
| 10 | # TAG += value [value, ...] | |
| 11 | # Values that contain spaces should be placed between quotes (" ") | |
| 12 | ||
| 13 | #--------------------------------------------------------------------------- | |
| 14 | # General configuration options | |
| 15 | #--------------------------------------------------------------------------- | |
| 16 | ||
| 17 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded | |
| 18 | # by quotes) that should identify the project. | |
| 19 | ||
| 20 | PROJECT_NAME = @PACKAGE@ | |
| 21 | ||
| 22 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. | |
| 23 | # This could be handy for archiving the generated documentation or | |
| 24 | # if some version control system is used. | |
| 25 | ||
| 26 | PROJECT_NUMBER = @VERSION@ | |
| 27 | ||
| 28 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) | |
| 29 | # base path where the generated documentation will be put. | |
| 30 | # If a relative path is entered, it will be relative to the location | |
| 31 | # where doxygen was started. If left blank the current directory will be used. | |
| 32 | ||
| 33 | OUTPUT_DIRECTORY = doc | |
| 34 | ||
| 35 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all | |
| 36 | # documentation generated by doxygen is written. Doxygen will use this | |
| 37 | # information to generate all constant output in the proper language. | |
| 38 | # The default language is English, other supported languages are: | |
| 39 | # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, | |
| 40 | # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
41 | # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
42 | # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. |
| 4554 | 43 | |
| 44 | OUTPUT_LANGUAGE = English | |
| 45 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
46 | # This tag can be used to specify the encoding used in the generated output. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
47 | # The encoding is not always determined by the language that is chosen, |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
48 | # but also whether or not the output is meant for Windows or non-Windows users. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
49 | # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
50 | # forces the Windows encoding (this is the default for the Windows binary), |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
51 | # whereas setting the tag to NO uses a Unix-style encoding (the default for |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
52 | # all platforms other than Windows). |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
53 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
54 | USE_WINDOWS_ENCODING = NO |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
55 | |
| 4554 | 56 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
| 57 | # documentation are documented, even if no documentation was available. | |
| 58 | # Private class members and static file members will be hidden unless | |
| 59 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES | |
| 60 | ||
| 61 | EXTRACT_ALL = NO | |
| 62 | ||
| 63 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class | |
| 64 | # will be included in the documentation. | |
| 65 | ||
| 66 | EXTRACT_PRIVATE = NO | |
| 67 | ||
| 68 | # If the EXTRACT_STATIC tag is set to YES all static members of a file | |
| 69 | # will be included in the documentation. | |
| 70 | ||
| 71 | EXTRACT_STATIC = NO | |
| 72 | ||
| 73 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) | |
| 74 | # defined locally in source files will be included in the documentation. | |
| 75 | # If set to NO only classes defined in header files are included. | |
| 76 | ||
| 77 | EXTRACT_LOCAL_CLASSES = YES | |
| 78 | ||
| 79 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | |
| 80 | # undocumented members of documented classes, files or namespaces. | |
| 81 | # If set to NO (the default) these members will be included in the | |
| 82 | # various overviews, but no documentation section is generated. | |
| 83 | # This option has no effect if EXTRACT_ALL is enabled. | |
| 84 | ||
| 85 | HIDE_UNDOC_MEMBERS = NO | |
| 86 | ||
| 87 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all | |
| 88 | # undocumented classes that are normally visible in the class hierarchy. | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
89 | # If set to NO (the default) these classes will be included in the various |
| 4554 | 90 | # overviews. This option has no effect if EXTRACT_ALL is enabled. |
| 91 | ||
| 92 | HIDE_UNDOC_CLASSES = NO | |
| 93 | ||
| 94 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all | |
| 95 | # friend (class|struct|union) declarations. | |
| 96 | # If set to NO (the default) these declarations will be included in the | |
| 97 | # documentation. | |
| 98 | ||
| 99 | HIDE_FRIEND_COMPOUNDS = NO | |
| 100 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
101 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
102 | # documentation blocks found inside the body of a function. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
103 | # If set to NO (the default) these blocks will be appended to the |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
104 | # function's detailed documentation block. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
105 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
106 | HIDE_IN_BODY_DOCS = NO |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
107 | |
| 4554 | 108 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
| 109 | # include brief member descriptions after the members that are listed in | |
| 110 | # the file and class documentation (similar to JavaDoc). | |
| 111 | # Set to NO to disable this. | |
| 112 | ||
| 113 | BRIEF_MEMBER_DESC = YES | |
| 114 | ||
| 115 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend | |
| 116 | # the brief description of a member or function before the detailed description. | |
| 117 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | |
| 118 | # brief descriptions will be completely suppressed. | |
| 119 | ||
| 120 | REPEAT_BRIEF = YES | |
| 121 | ||
| 122 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | |
| 123 | # Doxygen will generate a detailed section even if there is only a brief | |
| 124 | # description. | |
| 125 | ||
| 126 | ALWAYS_DETAILED_SEC = NO | |
| 127 | ||
| 128 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited | |
| 129 | # members of a class in the documentation of that class as if those members were | |
| 130 | # ordinary class members. Constructors, destructors and assignment operators of | |
| 131 | # the base classes will not be shown. | |
| 132 | ||
| 133 | INLINE_INHERITED_MEMB = NO | |
| 134 | ||
| 135 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | |
| 136 | # path before files name in the file list and in the header files. If set | |
| 137 | # to NO the shortest path that makes the file name unique will be used. | |
| 138 | ||
| 139 | FULL_PATH_NAMES = NO | |
| 140 | ||
| 141 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
142 | # can be used to strip a user-defined part of the path. Stripping is |
| 4554 | 143 | # only done if one of the specified strings matches the left-hand part of |
| 144 | # the path. It is allowed to use relative paths in the argument list. | |
| 145 | ||
| 146 | STRIP_FROM_PATH = | |
| 147 | ||
| 148 | # The INTERNAL_DOCS tag determines if documentation | |
| 149 | # that is typed after a \internal command is included. If the tag is set | |
| 150 | # to NO (the default) then the documentation will be excluded. | |
| 151 | # Set it to YES to include the internal documentation. | |
| 152 | ||
| 153 | INTERNAL_DOCS = NO | |
| 154 | ||
| 155 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
156 | # file names in lower-case letters. If set to YES upper-case letters are also |
| 4554 | 157 | # allowed. This is useful if you have classes or files whose names only differ |
| 158 | # in case and if your file system supports case sensitive file names. Windows | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
159 | # users are advised to set this option to NO. |
| 4554 | 160 | |
| 161 | CASE_SENSE_NAMES = YES | |
| 162 | ||
| 163 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | |
| 164 | # (but less readable) file names. This can be useful is your file systems | |
| 165 | # doesn't support long names like on DOS, Mac, or CD-ROM. | |
| 166 | ||
| 167 | SHORT_NAMES = NO | |
| 168 | ||
| 169 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | |
| 170 | # will show members with their full class and namespace scopes in the | |
| 171 | # documentation. If set to YES the scope will be hidden. | |
| 172 | ||
| 173 | HIDE_SCOPE_NAMES = NO | |
| 174 | ||
| 175 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
176 | # will put a list of the files that are included by a file in the documentation |
| 4554 | 177 | # of that file. |
| 178 | ||
| 179 | SHOW_INCLUDE_FILES = YES | |
| 180 | ||
| 181 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | |
| 182 | # will interpret the first line (until the first dot) of a JavaDoc-style | |
| 183 | # comment as the brief description. If set to NO, the JavaDoc | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
184 | # comments will behave just like the Qt-style comments (thus requiring an |
| 4554 | 185 | # explict @brief command for a brief description. |
| 186 | ||
| 187 | JAVADOC_AUTOBRIEF = YES | |
| 188 | ||
| 189 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | |
| 190 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// | |
| 191 | # comments) as a brief description. This used to be the default behaviour. | |
| 192 | # The new default is to treat a multi-line C++ comment block as a detailed | |
| 193 | # description. Set this tag to YES if you prefer the old behaviour instead. | |
| 194 | ||
| 195 | MULTILINE_CPP_IS_BRIEF = NO | |
| 196 | ||
| 197 | # If the DETAILS_AT_TOP tag is set to YES then Doxygen | |
| 198 | # will output the detailed description near the top, like JavaDoc. | |
| 199 | # If set to NO, the detailed description appears after the member | |
| 200 | # documentation. | |
| 201 | ||
| 202 | DETAILS_AT_TOP = NO | |
| 203 | ||
| 204 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | |
| 205 | # member inherits the documentation from any documented member that it | |
| 206 | # reimplements. | |
| 207 | ||
| 208 | INHERIT_DOCS = YES | |
| 209 | ||
| 210 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] | |
| 211 | # is inserted in the documentation for inline members. | |
| 212 | ||
| 213 | INLINE_INFO = YES | |
| 214 | ||
| 215 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen | |
| 216 | # will sort the (detailed) documentation of file and class members | |
| 217 | # alphabetically by member name. If set to NO the members will appear in | |
| 218 | # declaration order. | |
| 219 | ||
| 220 | SORT_MEMBER_DOCS = YES | |
| 221 | ||
| 222 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | |
| 223 | # tag is set to YES, then doxygen will reuse the documentation of the first | |
| 224 | # member in the group (if any) for the other members of the group. By default | |
| 225 | # all members of a group must be documented explicitly. | |
| 226 | ||
| 227 | DISTRIBUTE_GROUP_DOC = NO | |
| 228 | ||
| 229 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. | |
| 230 | # Doxygen uses this value to replace tabs by spaces in code fragments. | |
| 231 | ||
| 232 | TAB_SIZE = 4 | |
| 233 | ||
| 234 | # The GENERATE_TODOLIST tag can be used to enable (YES) or | |
| 235 | # disable (NO) the todo list. This list is created by putting \todo | |
| 236 | # commands in the documentation. | |
| 237 | ||
| 238 | GENERATE_TODOLIST = YES | |
| 239 | ||
| 240 | # The GENERATE_TESTLIST tag can be used to enable (YES) or | |
| 241 | # disable (NO) the test list. This list is created by putting \test | |
| 242 | # commands in the documentation. | |
| 243 | ||
| 244 | GENERATE_TESTLIST = YES | |
| 245 | ||
| 246 | # The GENERATE_BUGLIST tag can be used to enable (YES) or | |
| 247 | # disable (NO) the bug list. This list is created by putting \bug | |
| 248 | # commands in the documentation. | |
| 249 | ||
| 250 | GENERATE_BUGLIST = YES | |
| 251 | ||
| 252 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
253 | # disable (NO) the deprecated list. This list is created by putting |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
254 | # \deprecated commands in the documentation. |
| 4554 | 255 | |
| 256 | GENERATE_DEPRECATEDLIST= YES | |
| 257 | ||
| 258 | # This tag can be used to specify a number of aliases that acts | |
| 259 | # as commands in the documentation. An alias has the form "name=value". | |
| 260 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to | |
| 261 | # put the command \sideeffect (or @sideeffect) in the documentation, which | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
262 | # will result in a user-defined paragraph with heading "Side Effects:". |
| 4554 | 263 | # You can put \n's in the value part of an alias to insert newlines. |
| 264 | ||
| 265 | ALIASES = | |
| 266 | ||
| 267 | # The ENABLED_SECTIONS tag can be used to enable conditional | |
| 268 | # documentation sections, marked by \if sectionname ... \endif. | |
| 269 | ||
| 270 | ENABLED_SECTIONS = | |
| 271 | ||
| 272 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
273 | # the initial value of a variable or define consists of for it to appear in |
| 4554 | 274 | # the documentation. If the initializer consists of more lines than specified |
| 275 | # here it will be hidden. Use a value of 0 to hide initializers completely. | |
| 276 | # The appearance of the initializer of individual variables and defines in the | |
| 277 | # documentation can be controlled using \showinitializer or \hideinitializer | |
| 278 | # command in the documentation regardless of this setting. | |
| 279 | ||
| 280 | MAX_INITIALIZER_LINES = 30 | |
| 281 | ||
| 282 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | |
| 283 | # only. Doxygen will then generate output that is more tailored for C. | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
284 | # For instance, some of the names that are used will be different. The list |
| 4554 | 285 | # of all members will be omitted, etc. |
| 286 | ||
| 287 | OPTIMIZE_OUTPUT_FOR_C = YES | |
| 288 | ||
| 289 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources | |
| 290 | # only. Doxygen will then generate output that is more tailored for Java. | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
291 | # For instance, namespaces will be presented as packages, qualified scopes |
| 4554 | 292 | # will look different, etc. |
| 293 | ||
| 294 | OPTIMIZE_OUTPUT_JAVA = NO | |
| 295 | ||
| 296 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated | |
| 297 | # at the bottom of the documentation of classes and structs. If set to YES the | |
| 298 | # list will mention the files that were used to generate the documentation. | |
| 299 | ||
| 300 | SHOW_USED_FILES = YES | |
| 301 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
302 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
303 | # the same type (for instance a group of public functions) to be put as a |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
304 | # subgroup of that type (e.g. under the Public Functions section). Set it to |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
305 | # NO to prevent subgrouping. Alternatively, this can be done per class using |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
306 | # the \nosubgrouping command. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
307 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
308 | SUBGROUPING = YES |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
309 | |
| 4554 | 310 | #--------------------------------------------------------------------------- |
| 311 | # configuration options related to warning and progress messages | |
| 312 | #--------------------------------------------------------------------------- | |
| 313 | ||
| 314 | # The QUIET tag can be used to turn on/off the messages that are generated | |
| 315 | # by doxygen. Possible values are YES and NO. If left blank NO is used. | |
| 316 | ||
| 317 | QUIET = NO | |
| 318 | ||
| 319 | # The WARNINGS tag can be used to turn on/off the warning messages that are | |
| 320 | # generated by doxygen. Possible values are YES and NO. If left blank | |
| 321 | # NO is used. | |
| 322 | ||
| 323 | WARNINGS = YES | |
| 324 | ||
| 325 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings | |
| 326 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will | |
| 327 | # automatically be disabled. | |
| 328 | ||
| 329 | WARN_IF_UNDOCUMENTED = NO | |
| 330 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
331 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
332 | # potential errors in the documentation, such as not documenting some |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
333 | # parameters in a documented function, or documenting parameters that |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
334 | # don't exist or using markup commands wrongly. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
335 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
336 | WARN_IF_DOC_ERROR = YES |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
337 | |
| 4554 | 338 | # The WARN_FORMAT tag determines the format of the warning messages that |
| 339 | # doxygen can produce. The string should contain the $file, $line, and $text | |
| 340 | # tags, which will be replaced by the file and line number from which the | |
| 341 | # warning originated and the warning text. | |
| 342 | ||
| 343 | WARN_FORMAT = "$file:$line: $text" | |
| 344 | ||
| 345 | # The WARN_LOGFILE tag can be used to specify a file to which warning | |
| 346 | # and error messages should be written. If left blank the output is written | |
| 347 | # to stderr. | |
| 348 | ||
| 349 | WARN_LOGFILE = | |
| 350 | ||
| 351 | #--------------------------------------------------------------------------- | |
| 352 | # configuration options related to the input files | |
| 353 | #--------------------------------------------------------------------------- | |
| 354 | ||
| 355 | # The INPUT tag can be used to specify the files and/or directories that contain | |
| 356 | # documented source files. You may enter file names like "myfile.cpp" or | |
| 357 | # directories like "/usr/src/myproject". Separate the files or directories | |
| 358 | # with spaces. | |
| 359 | ||
| 360 | INPUT = src | |
| 361 | ||
| 362 | # If the value of the INPUT tag contains directories, you can use the | |
| 363 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | |
| 364 | # and *.h) to filter out the source-files in the directories. If left | |
| 365 | # blank the following patterns are tested: | |
| 366 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
367 | # *.h++ *.idl *.odl *.cs |
| 4554 | 368 | |
| 369 | FILE_PATTERNS = *.h | |
| 370 | ||
| 371 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories | |
| 372 | # should be searched for input files as well. Possible values are YES and NO. | |
| 373 | # If left blank NO is used. | |
| 374 | ||
| 375 | RECURSIVE = NO | |
| 376 | ||
| 377 | # The EXCLUDE tag can be used to specify files and/or directories that should | |
| 378 | # excluded from the INPUT source files. This way you can easily exclude a | |
| 379 | # subdirectory from a directory tree whose root is specified with the INPUT tag. | |
| 380 | ||
| 381 | EXCLUDE = | |
| 382 | ||
| 383 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories | |
| 384 | # that are symbolic links (a Unix filesystem feature) are excluded from the input. | |
| 385 | ||
| 386 | EXCLUDE_SYMLINKS = NO | |
| 387 | ||
| 388 | # If the value of the INPUT tag contains directories, you can use the | |
| 389 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | |
| 390 | # certain files from those directories. | |
| 391 | ||
| 392 | EXCLUDE_PATTERNS = | |
| 393 | ||
| 394 | # The EXAMPLE_PATH tag can be used to specify one or more files or | |
| 395 | # directories that contain example code fragments that are included (see | |
| 396 | # the \include command). | |
| 397 | ||
| 398 | EXAMPLE_PATH = | |
| 399 | ||
| 400 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the | |
| 401 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | |
| 402 | # and *.h) to filter out the source-files in the directories. If left | |
| 403 | # blank all files are included. | |
| 404 | ||
| 405 | EXAMPLE_PATTERNS = | |
| 406 | ||
| 407 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be | |
| 408 | # searched for input files to be used with the \include or \dontinclude | |
| 409 | # commands irrespective of the value of the RECURSIVE tag. | |
| 410 | # Possible values are YES and NO. If left blank NO is used. | |
| 411 | ||
| 412 | EXAMPLE_RECURSIVE = NO | |
| 413 | ||
| 414 | # The IMAGE_PATH tag can be used to specify one or more files or | |
| 415 | # directories that contain image that are included in the documentation (see | |
| 416 | # the \image command). | |
| 417 | ||
| 418 | IMAGE_PATH = | |
| 419 | ||
| 420 | # The INPUT_FILTER tag can be used to specify a program that doxygen should | |
| 421 | # invoke to filter for each input file. Doxygen will invoke the filter program | |
| 422 | # by executing (via popen()) the command <filter> <input-file>, where <filter> | |
| 423 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | |
| 424 | # input file. Doxygen will then use the output that the filter program writes | |
| 425 | # to standard output. | |
| 426 | ||
| 427 | INPUT_FILTER = | |
| 428 | ||
| 429 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | |
| 430 | # INPUT_FILTER) will be used to filter the input files when producing source | |
| 431 | # files to browse (i.e. when SOURCE_BROWSER is set to YES). | |
| 432 | ||
| 433 | FILTER_SOURCE_FILES = NO | |
| 434 | ||
| 435 | #--------------------------------------------------------------------------- | |
| 436 | # configuration options related to source browsing | |
| 437 | #--------------------------------------------------------------------------- | |
| 438 | ||
| 439 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will | |
| 440 | # be generated. Documented entities will be cross-referenced with these sources. | |
| 441 | ||
| 442 | SOURCE_BROWSER = NO | |
| 443 | ||
| 444 | # Setting the INLINE_SOURCES tag to YES will include the body | |
| 445 | # of functions and classes directly in the documentation. | |
| 446 | ||
| 447 | INLINE_SOURCES = NO | |
| 448 | ||
| 449 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct | |
| 450 | # doxygen to hide any special comment blocks from generated source code | |
| 451 | # fragments. Normal C and C++ comments will always remain visible. | |
| 452 | ||
| 453 | STRIP_CODE_COMMENTS = YES | |
| 454 | ||
| 455 | # If the REFERENCED_BY_RELATION tag is set to YES (the default) | |
| 456 | # then for each documented function all documented | |
| 457 | # functions referencing it will be listed. | |
| 458 | ||
| 459 | REFERENCED_BY_RELATION = YES | |
| 460 | ||
| 461 | # If the REFERENCES_RELATION tag is set to YES (the default) | |
| 462 | # then for each documented function all documented entities | |
| 463 | # called/used by that function will be listed. | |
| 464 | ||
| 465 | REFERENCES_RELATION = YES | |
| 466 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
467 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
468 | # will generate a verbatim copy of the header file for each class for |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
469 | # which an include is specified. Set to NO to disable this. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
470 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
471 | VERBATIM_HEADERS = YES |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
472 | |
| 4554 | 473 | #--------------------------------------------------------------------------- |
| 474 | # configuration options related to the alphabetical class index | |
| 475 | #--------------------------------------------------------------------------- | |
| 476 | ||
| 477 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index | |
| 478 | # of all compounds will be generated. Enable this if the project | |
| 479 | # contains a lot of classes, structs, unions or interfaces. | |
| 480 | ||
| 481 | ALPHABETICAL_INDEX = NO | |
| 482 | ||
| 483 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then | |
| 484 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns | |
| 485 | # in which this list will be split (can be a number in the range [1..20]) | |
| 486 | ||
| 487 | COLS_IN_ALPHA_INDEX = 5 | |
| 488 | ||
| 489 | # In case all classes in a project start with a common prefix, all | |
| 490 | # classes will be put under the same header in the alphabetical index. | |
| 491 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that | |
| 492 | # should be ignored while generating the index headers. | |
| 493 | ||
| 494 | IGNORE_PREFIX = | |
| 495 | ||
| 496 | #--------------------------------------------------------------------------- | |
| 497 | # configuration options related to the HTML output | |
| 498 | #--------------------------------------------------------------------------- | |
| 499 | ||
| 500 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will | |
| 501 | # generate HTML output. | |
| 502 | ||
| 503 | GENERATE_HTML = YES | |
| 504 | ||
| 505 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. | |
| 506 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 507 | # put in front of it. If left blank `html' will be used as the default path. | |
| 508 | ||
| 509 | HTML_OUTPUT = html | |
| 510 | ||
| 511 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for | |
| 512 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank | |
| 513 | # doxygen will generate files with .html extension. | |
| 514 | ||
| 515 | HTML_FILE_EXTENSION = .html | |
| 516 | ||
| 517 | # The HTML_HEADER tag can be used to specify a personal HTML header for | |
| 518 | # each generated HTML page. If it is left blank doxygen will generate a | |
| 519 | # standard header. | |
| 520 | ||
| 521 | HTML_HEADER = | |
| 522 | ||
| 523 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for | |
| 524 | # each generated HTML page. If it is left blank doxygen will generate a | |
| 525 | # standard footer. | |
| 526 | ||
| 527 | HTML_FOOTER = | |
| 528 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
529 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
| 4554 | 530 | # style sheet that is used by each HTML page. It can be used to |
| 531 | # fine-tune the look of the HTML output. If the tag is left blank doxygen | |
| 532 | # will generate a default style sheet | |
| 533 | ||
| 534 | HTML_STYLESHEET = | |
| 535 | ||
| 536 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, | |
| 537 | # files or namespaces will be aligned in HTML using tables. If set to | |
| 538 | # NO a bullet list will be used. | |
| 539 | ||
| 540 | HTML_ALIGN_MEMBERS = YES | |
| 541 | ||
| 542 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files | |
| 543 | # will be generated that can be used as input for tools like the | |
| 544 | # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | |
| 545 | # of the generated HTML documentation. | |
| 546 | ||
| 547 | GENERATE_HTMLHELP = NO | |
| 548 | ||
| 549 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | |
| 550 | # be used to specify the file name of the resulting .chm file. You | |
| 551 | # can add a path in front of the file if the result should not be | |
| 552 | # written to the html output dir. | |
| 553 | ||
| 554 | CHM_FILE = | |
| 555 | ||
| 556 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | |
| 557 | # be used to specify the location (absolute path including file name) of | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
558 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
559 | # the HTML help compiler on the generated index.hhp. |
| 4554 | 560 | |
| 561 | HHC_LOCATION = | |
| 562 | ||
| 563 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag | |
| 564 | # controls if a separate .chi index file is generated (YES) or that | |
| 565 | # it should be included in the master .chm file (NO). | |
| 566 | ||
| 567 | GENERATE_CHI = NO | |
| 568 | ||
| 569 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | |
| 570 | # controls whether a binary table of contents is generated (YES) or a | |
| 571 | # normal table of contents (NO) in the .chm file. | |
| 572 | ||
| 573 | BINARY_TOC = NO | |
| 574 | ||
| 575 | # The TOC_EXPAND flag can be set to YES to add extra items for group members | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
576 | # to the contents of the HTML help documentation and to the tree view. |
| 4554 | 577 | |
| 578 | TOC_EXPAND = NO | |
| 579 | ||
| 580 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at | |
| 581 | # top of each HTML page. The value NO (the default) enables the index and | |
| 582 | # the value YES disables it. | |
| 583 | ||
| 584 | DISABLE_INDEX = NO | |
| 585 | ||
| 586 | # This tag can be used to set the number of enum values (range [1..20]) | |
| 587 | # that doxygen will group on one line in the generated HTML documentation. | |
| 588 | ||
| 589 | ENUM_VALUES_PER_LINE = 4 | |
| 590 | ||
| 591 | # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | |
| 592 | # generated containing a tree-like index structure (just like the one that | |
| 593 | # is generated for HTML Help). For this to work a browser that supports | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
594 | # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
595 | # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
596 | # probably better off using the HTML help feature. |
| 4554 | 597 | |
| 598 | GENERATE_TREEVIEW = NO | |
| 599 | ||
| 600 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | |
| 601 | # used to set the initial width (in pixels) of the frame in which the tree | |
| 602 | # is shown. | |
| 603 | ||
| 604 | TREEVIEW_WIDTH = 250 | |
| 605 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
606 | # If the GENERATE_DEVHELP tag is set to YES, an index file for the |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
607 | # DevHelp documentation viewer will be generated. For more information, |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
608 | # see http://www.imendio.com/projects/devhelp/ |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
609 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
610 | GENERATE_DEVHELP = YES |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
611 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
612 | # The DEVHELP_TITLE tag is used to specify the displayed name of the |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
613 | # generated DevHelp book file. If left blank, the project name will |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
614 | # be used. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
615 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
616 | DEVHELP_TITLE = Gaim |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
617 | |
| 4554 | 618 | #--------------------------------------------------------------------------- |
| 619 | # configuration options related to the LaTeX output | |
| 620 | #--------------------------------------------------------------------------- | |
| 621 | ||
| 622 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will | |
| 623 | # generate Latex output. | |
| 624 | ||
| 625 | GENERATE_LATEX = NO | |
| 626 | ||
| 627 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. | |
| 628 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 629 | # put in front of it. If left blank `latex' will be used as the default path. | |
| 630 | ||
| 631 | LATEX_OUTPUT = latex | |
| 632 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
633 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
634 | # invoked. If left blank `latex' will be used as the default command name. |
| 4554 | 635 | |
| 636 | LATEX_CMD_NAME = latex | |
| 637 | ||
| 638 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to | |
| 639 | # generate index for LaTeX. If left blank `makeindex' will be used as the | |
| 640 | # default command name. | |
| 641 | ||
| 642 | MAKEINDEX_CMD_NAME = makeindex | |
| 643 | ||
| 644 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact | |
| 645 | # LaTeX documents. This may be useful for small projects and may help to | |
| 646 | # save some trees in general. | |
| 647 | ||
| 648 | COMPACT_LATEX = NO | |
| 649 | ||
| 650 | # The PAPER_TYPE tag can be used to set the paper type that is used | |
| 651 | # by the printer. Possible values are: a4, a4wide, letter, legal and | |
| 652 | # executive. If left blank a4wide will be used. | |
| 653 | ||
| 654 | PAPER_TYPE = a4wide | |
| 655 | ||
| 656 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX | |
| 657 | # packages that should be included in the LaTeX output. | |
| 658 | ||
| 659 | EXTRA_PACKAGES = | |
| 660 | ||
| 661 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for | |
| 662 | # the generated latex document. The header should contain everything until | |
| 663 | # the first chapter. If it is left blank doxygen will generate a | |
| 664 | # standard header. Notice: only use this tag if you know what you are doing! | |
| 665 | ||
| 666 | LATEX_HEADER = | |
| 667 | ||
| 668 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated | |
| 669 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will | |
| 670 | # contain links (just like the HTML output) instead of page references | |
| 671 | # This makes the output suitable for online browsing using a pdf viewer. | |
| 672 | ||
| 673 | PDF_HYPERLINKS = NO | |
| 674 | ||
| 675 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of | |
| 676 | # plain latex in the generated Makefile. Set this option to YES to get a | |
| 677 | # higher quality PDF documentation. | |
| 678 | ||
| 679 | USE_PDFLATEX = NO | |
| 680 | ||
| 681 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. | |
| 682 | # command to the generated LaTeX files. This will instruct LaTeX to keep | |
| 683 | # running if errors occur, instead of asking the user for help. | |
| 684 | # This option is also used when generating formulas in HTML. | |
| 685 | ||
| 686 | LATEX_BATCHMODE = NO | |
| 687 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
688 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
689 | # include the index chapters (such as File Index, Compound Index, etc.) |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
690 | # in the output. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
691 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
692 | LATEX_HIDE_INDICES = NO |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
693 | |
| 4554 | 694 | #--------------------------------------------------------------------------- |
| 695 | # configuration options related to the RTF output | |
| 696 | #--------------------------------------------------------------------------- | |
| 697 | ||
| 698 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | |
| 699 | # The RTF output is optimised for Word 97 and may not look very pretty with | |
| 700 | # other RTF readers or editors. | |
| 701 | ||
| 702 | GENERATE_RTF = NO | |
| 703 | ||
| 704 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | |
| 705 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 706 | # put in front of it. If left blank `rtf' will be used as the default path. | |
| 707 | ||
| 708 | RTF_OUTPUT = rtf | |
| 709 | ||
| 710 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact | |
| 711 | # RTF documents. This may be useful for small projects and may help to | |
| 712 | # save some trees in general. | |
| 713 | ||
| 714 | COMPACT_RTF = NO | |
| 715 | ||
| 716 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated | |
| 717 | # will contain hyperlink fields. The RTF file will | |
| 718 | # contain links (just like the HTML output) instead of page references. | |
| 719 | # This makes the output suitable for online browsing using WORD or other | |
| 720 | # programs which support those fields. | |
| 721 | # Note: wordpad (write) and others do not support links. | |
| 722 | ||
| 723 | RTF_HYPERLINKS = NO | |
| 724 | ||
| 725 | # Load stylesheet definitions from file. Syntax is similar to doxygen's | |
| 726 | # config file, i.e. a series of assigments. You only have to provide | |
| 727 | # replacements, missing definitions are set to their default value. | |
| 728 | ||
| 729 | RTF_STYLESHEET_FILE = | |
| 730 | ||
| 731 | # Set optional variables used in the generation of an rtf document. | |
| 732 | # Syntax is similar to doxygen's config file. | |
| 733 | ||
| 734 | RTF_EXTENSIONS_FILE = | |
| 735 | ||
| 736 | #--------------------------------------------------------------------------- | |
| 737 | # configuration options related to the man page output | |
| 738 | #--------------------------------------------------------------------------- | |
| 739 | ||
| 740 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will | |
| 741 | # generate man pages | |
| 742 | ||
| 743 | GENERATE_MAN = NO | |
| 744 | ||
| 745 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. | |
| 746 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be | |
| 747 | # put in front of it. If left blank `man' will be used as the default path. | |
| 748 | ||
| 749 | MAN_OUTPUT = man | |
| 750 | ||
| 751 | # The MAN_EXTENSION tag determines the extension that is added to | |
| 752 | # the generated man pages (default is the subroutine's section .3) | |
| 753 | ||
| 754 | MAN_EXTENSION = .3 | |
| 755 | ||
| 756 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, | |
| 757 | # then it will generate one additional man file for each entity | |
| 758 | # documented in the real man page(s). These additional files | |
| 759 | # only source the real man page, but without them the man command | |
| 760 | # would be unable to find the correct page. The default is NO. | |
| 761 | ||
| 762 | MAN_LINKS = NO | |
| 763 | ||
| 764 | #--------------------------------------------------------------------------- | |
| 765 | # configuration options related to the XML output | |
| 766 | #--------------------------------------------------------------------------- | |
| 767 | ||
| 768 | # If the GENERATE_XML tag is set to YES Doxygen will | |
| 769 | # generate an XML file that captures the structure of | |
| 770 | # the code including all documentation. Note that this | |
| 771 | # feature is still experimental and incomplete at the | |
| 772 | # moment. | |
| 773 | ||
| 774 | GENERATE_XML = NO | |
| 775 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
776 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
777 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
778 | # put in front of it. If left blank `xml' will be used as the default path. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
779 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
780 | XML_OUTPUT = xml |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
781 | |
| 4554 | 782 | # The XML_SCHEMA tag can be used to specify an XML schema, |
| 783 | # which can be used by a validating XML parser to check the | |
| 784 | # syntax of the XML files. | |
| 785 | ||
| 786 | XML_SCHEMA = | |
| 787 | ||
| 788 | # The XML_DTD tag can be used to specify an XML DTD, | |
| 789 | # which can be used by a validating XML parser to check the | |
| 790 | # syntax of the XML files. | |
| 791 | ||
| 792 | XML_DTD = | |
| 793 | ||
| 794 | #--------------------------------------------------------------------------- | |
| 795 | # configuration options for the AutoGen Definitions output | |
| 796 | #--------------------------------------------------------------------------- | |
| 797 | ||
| 798 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will | |
| 799 | # generate an AutoGen Definitions (see autogen.sf.net) file | |
| 800 | # that captures the structure of the code including all | |
| 801 | # documentation. Note that this feature is still experimental | |
| 802 | # and incomplete at the moment. | |
| 803 | ||
| 804 | GENERATE_AUTOGEN_DEF = NO | |
| 805 | ||
| 806 | #--------------------------------------------------------------------------- | |
| 807 | # configuration options related to the Perl module output | |
| 808 | #--------------------------------------------------------------------------- | |
| 809 | ||
| 810 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will | |
| 811 | # generate a Perl module file that captures the structure of | |
| 812 | # the code including all documentation. Note that this | |
| 813 | # feature is still experimental and incomplete at the | |
| 814 | # moment. | |
| 815 | ||
| 816 | GENERATE_PERLMOD = NO | |
| 817 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
818 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
819 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
820 | # to generate PDF and DVI output from the Perl module output. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
821 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
822 | PERLMOD_LATEX = NO |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
823 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
824 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
825 | # nicely formatted so it can be parsed by a human reader. This is useful |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
826 | # if you want to understand what is going on. On the other hand, if this |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
827 | # tag is set to NO the size of the Perl module output will be much smaller |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
828 | # and Perl will parse it just the same. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
829 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
830 | PERLMOD_PRETTY = YES |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
831 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
832 | # The names of the make variables in the generated doxyrules.make file |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
833 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
834 | # This is useful so different doxyrules.make files included by the same |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
835 | # Makefile don't overwrite each other's variables. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
836 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
837 | PERLMOD_MAKEVAR_PREFIX = |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
838 | |
| 4554 | 839 | #--------------------------------------------------------------------------- |
| 840 | # Configuration options related to the preprocessor | |
| 841 | #--------------------------------------------------------------------------- | |
| 842 | ||
| 843 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will | |
| 844 | # evaluate all C-preprocessor directives found in the sources and include | |
| 845 | # files. | |
| 846 | ||
| 847 | ENABLE_PREPROCESSING = YES | |
| 848 | ||
| 849 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro | |
| 850 | # names in the source code. If set to NO (the default) only conditional | |
| 851 | # compilation will be performed. Macro expansion can be done in a controlled | |
| 852 | # way by setting EXPAND_ONLY_PREDEF to YES. | |
| 853 | ||
| 854 | MACRO_EXPANSION = NO | |
| 855 | ||
| 856 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | |
| 857 | # then the macro expansion is limited to the macros specified with the | |
| 858 | # PREDEFINED and EXPAND_AS_PREDEFINED tags. | |
| 859 | ||
| 860 | EXPAND_ONLY_PREDEF = NO | |
| 861 | ||
| 862 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | |
| 863 | # in the INCLUDE_PATH (see below) will be search if a #include is found. | |
| 864 | ||
| 865 | SEARCH_INCLUDES = YES | |
| 866 | ||
| 867 | # The INCLUDE_PATH tag can be used to specify one or more directories that | |
| 868 | # contain include files that are not input files but should be processed by | |
| 869 | # the preprocessor. | |
| 870 | ||
| 871 | INCLUDE_PATH = | |
| 872 | ||
| 873 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard | |
| 874 | # patterns (like *.h and *.hpp) to filter out the header-files in the | |
| 875 | # directories. If left blank, the patterns specified with FILE_PATTERNS will | |
| 876 | # be used. | |
| 877 | ||
| 878 | INCLUDE_FILE_PATTERNS = | |
| 879 | ||
| 880 | # The PREDEFINED tag can be used to specify one or more macro names that | |
| 881 | # are defined before the preprocessor is started (similar to the -D option of | |
| 882 | # gcc). The argument of the tag is a list of macros of the form: name | |
| 883 | # or name=definition (no spaces). If the definition and the = are | |
| 884 | # omitted =1 is assumed. | |
| 885 | ||
| 886 | PREDEFINED = | |
| 887 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
888 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
| 4554 | 889 | # this tag can be used to specify a list of macro names that should be expanded. |
| 890 | # The macro definition that is found in the sources will be used. | |
| 891 | # Use the PREDEFINED tag if you want to use a different macro definition. | |
| 892 | ||
| 893 | EXPAND_AS_DEFINED = | |
| 894 | ||
| 895 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | |
| 896 | # doxygen's preprocessor will remove all function-like macros that are alone | |
| 897 | # on a line, have an all uppercase name, and do not end with a semicolon. Such | |
| 898 | # function macros are typically used for boiler-plate code, and will confuse the | |
| 899 | # parser if not removed. | |
| 900 | ||
| 901 | SKIP_FUNCTION_MACROS = YES | |
| 902 | ||
| 903 | #--------------------------------------------------------------------------- | |
| 904 | # Configuration::addtions related to external references | |
| 905 | #--------------------------------------------------------------------------- | |
| 906 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
907 | # The TAGFILES option can be used to specify one or more tagfiles. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
908 | # Optionally an initial location of the external documentation |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
909 | # can be added for each tagfile. The format of a tag file without |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
910 | # this location is as follows: |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
911 | # TAGFILES = file1 file2 ... |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
912 | # Adding location for the tag files is done as follows: |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
913 | # TAGFILES = file1=loc1 "file2 = loc2" ... |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
914 | # where "loc1" and "loc2" can be relative or absolute paths or |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
915 | # URLs. If a location is present for each tag, the installdox tool |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
916 | # does not have to be run to correct the links. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
917 | # Note that each tag file must have a unique name |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
918 | # (where the name does NOT include the path) |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
919 | # If a tag file is not located in the directory in which doxygen |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
920 | # is run, you must also specify the path to the tagfile here. |
| 4554 | 921 | |
| 922 | TAGFILES = | |
| 923 | ||
| 924 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create | |
| 925 | # a tag file that is based on the input files it reads. | |
| 926 | ||
| 927 | GENERATE_TAGFILE = | |
| 928 | ||
| 929 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed | |
| 930 | # in the class index. If set to NO only the inherited external classes | |
| 931 | # will be listed. | |
| 932 | ||
| 933 | ALLEXTERNALS = NO | |
| 934 | ||
| 935 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed | |
| 936 | # in the modules index. If set to NO, only the current project's groups will | |
| 937 | # be listed. | |
| 938 | ||
| 939 | EXTERNAL_GROUPS = YES | |
| 940 | ||
| 941 | # The PERL_PATH should be the absolute path and name of the perl script | |
| 942 | # interpreter (i.e. the result of `which perl'). | |
| 943 | ||
| 944 | PERL_PATH = /usr/bin/perl | |
| 945 | ||
| 946 | #--------------------------------------------------------------------------- | |
| 947 | # Configuration options related to the dot tool | |
| 948 | #--------------------------------------------------------------------------- | |
| 949 | ||
| 950 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
951 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or |
| 4554 | 952 | # super classes. Setting the tag to NO turns the diagrams off. Note that this |
| 953 | # option is superceded by the HAVE_DOT option below. This is only a fallback. It is | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
954 | # recommended to install and use dot, since it yields more powerful graphs. |
| 4554 | 955 | |
| 956 | CLASS_DIAGRAMS = YES | |
| 957 | ||
| 958 | # If set to YES, the inheritance and collaboration graphs will hide | |
| 959 | # inheritance and usage relations if the target is undocumented | |
| 960 | # or is not a class. | |
| 961 | ||
| 962 | HIDE_UNDOC_RELATIONS = YES | |
| 963 | ||
| 964 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is | |
| 965 | # available from the path. This tool is part of Graphviz, a graph visualization | |
| 966 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section | |
| 967 | # have no effect if this option is set to NO (the default) | |
| 968 | ||
|
6487
b540738b5cf8
[gaim-migrate @ 7001]
Christian Hammond <chipx86@chipx86.com>
parents:
6317
diff
changeset
|
969 | HAVE_DOT = YES |
| 4554 | 970 | |
| 971 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | |
| 972 | # will generate a graph for each documented class showing the direct and | |
| 973 | # indirect inheritance relations. Setting this tag to YES will force the | |
| 974 | # the CLASS_DIAGRAMS tag to NO. | |
| 975 | ||
| 976 | CLASS_GRAPH = YES | |
| 977 | ||
| 978 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen | |
| 979 | # will generate a graph for each documented class showing the direct and | |
| 980 | # indirect implementation dependencies (inheritance, containment, and | |
| 981 | # class references variables) of the class with other documented classes. | |
| 982 | ||
| 983 | COLLABORATION_GRAPH = YES | |
| 984 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
985 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
986 | # collaboration diagrams in a style similiar to the OMG's Unified Modeling |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
987 | # Language. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
988 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
989 | UML_LOOK = NO |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
990 | |
| 4554 | 991 | # If set to YES, the inheritance and collaboration graphs will show the |
| 992 | # relations between templates and their instances. | |
| 993 | ||
| 994 | TEMPLATE_RELATIONS = YES | |
| 995 | ||
| 996 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT | |
| 997 | # tags are set to YES then doxygen will generate a graph for each documented | |
| 998 | # file showing the direct and indirect include dependencies of the file with | |
| 999 | # other documented files. | |
| 1000 | ||
| 1001 | INCLUDE_GRAPH = YES | |
| 1002 | ||
| 1003 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and | |
| 1004 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each | |
| 1005 | # documented header file showing the documented files that directly or | |
| 1006 | # indirectly include this file. | |
| 1007 | ||
| 1008 | INCLUDED_BY_GRAPH = YES | |
| 1009 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1010 | # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1011 | # generate a call dependency graph for every global function or class method. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1012 | # Note that enabling this option will significantly increase the time of a run. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1013 | # So in most cases it will be better to enable call graphs for selected |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1014 | # functions only using the \callgraph command. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1015 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1016 | CALL_GRAPH = NO |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1017 | |
| 4554 | 1018 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
| 1019 | # will graphical hierarchy of all classes instead of a textual one. | |
| 1020 | ||
| 1021 | GRAPHICAL_HIERARCHY = YES | |
| 1022 | ||
| 1023 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | |
| 1024 | # generated by dot. Possible values are png, jpg, or gif | |
| 1025 | # If left blank png will be used. | |
| 1026 | ||
| 1027 | DOT_IMAGE_FORMAT = png | |
| 1028 | ||
| 1029 | # The tag DOT_PATH can be used to specify the path where the dot tool can be | |
| 1030 | # found. If left blank, it is assumed the dot tool can be found on the path. | |
| 1031 | ||
| 1032 | DOT_PATH = | |
| 1033 | ||
| 1034 | # The DOTFILE_DIRS tag can be used to specify one or more directories that | |
| 1035 | # contain dot files that are included in the documentation (see the | |
| 1036 | # \dotfile command). | |
| 1037 | ||
| 1038 | DOTFILE_DIRS = | |
| 1039 | ||
| 1040 | # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width | |
| 1041 | # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
| 1042 | # this value, doxygen will try to truncate the graph, so that it fits within | |
| 1043 | # the specified constraint. Beware that most browsers cannot cope with very | |
| 1044 | # large images. | |
| 1045 | ||
| 1046 | MAX_DOT_GRAPH_WIDTH = 1024 | |
| 1047 | ||
| 1048 | # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height | |
| 1049 | # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
| 1050 | # this value, doxygen will try to truncate the graph, so that it fits within | |
| 1051 | # the specified constraint. Beware that most browsers cannot cope with very | |
| 1052 | # large images. | |
| 1053 | ||
| 1054 | MAX_DOT_GRAPH_HEIGHT = 1024 | |
| 1055 | ||
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1056 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1057 | # graphs generated by dot. A depth value of 3 means that only nodes reachable |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1058 | # from the root by following a path via at most 3 edges will be shown. Nodes that |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1059 | # lay further from the root node will be omitted. Note that setting this option to |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1060 | # 1 or 2 may greatly reduce the computation time needed for large code bases. Also |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1061 | # note that a graph may be further truncated if the graph's image dimensions are |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1062 | # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1063 | # If 0 is used for the depth value (the default), the graph is not depth-constrained. |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1064 | |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1065 | MAX_DOT_GRAPH_DEPTH = 0 |
|
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1066 | |
| 4554 | 1067 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
| 1068 | # generate a legend page explaining the meaning of the various boxes and | |
| 1069 | # arrows in the dot generated graphs. | |
| 1070 | ||
| 1071 | GENERATE_LEGEND = YES | |
| 1072 | ||
| 1073 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will | |
|
6317
b40515160b51
[gaim-migrate @ 6816]
Christian Hammond <chipx86@chipx86.com>
parents:
4554
diff
changeset
|
1074 | # remove the intermediate dot files that are used to generate |
| 4554 | 1075 | # the various graphs. |
| 1076 | ||
| 1077 | DOT_CLEANUP = YES | |
| 1078 | ||
| 1079 | #--------------------------------------------------------------------------- | |
| 1080 | # Configuration::addtions related to the search engine | |
| 1081 | #--------------------------------------------------------------------------- | |
| 1082 | ||
| 1083 | # The SEARCHENGINE tag specifies whether or not a search engine should be | |
| 1084 | # used. If set to NO the values of all tags below this one will be ignored. | |
| 1085 | ||
| 1086 | SEARCHENGINE = NO | |
| 1087 | ||
| 1088 | # The CGI_NAME tag should be the name of the CGI script that | |
| 1089 | # starts the search engine (doxysearch) with the correct parameters. | |
| 1090 | # A script with this name will be generated by doxygen. | |
| 1091 | ||
| 1092 | CGI_NAME = search.cgi | |
| 1093 | ||
| 1094 | # The CGI_URL tag should be the absolute URL to the directory where the | |
| 1095 | # cgi binaries are located. See the documentation of your http daemon for | |
| 1096 | # details. | |
| 1097 | ||
| 1098 | CGI_URL = | |
| 1099 | ||
| 1100 | # The DOC_URL tag should be the absolute URL to the directory where the | |
| 1101 | # documentation is located. If left blank the absolute path to the | |
| 1102 | # documentation, with file:// prepended to it, will be used. | |
| 1103 | ||
| 1104 | DOC_URL = | |
| 1105 | ||
| 1106 | # The DOC_ABSPATH tag should be the absolute path to the directory where the | |
| 1107 | # documentation is located. If left blank the directory on the local machine | |
| 1108 | # will be used. | |
| 1109 | ||
| 1110 | DOC_ABSPATH = | |
| 1111 | ||
| 1112 | # The BIN_ABSPATH tag must point to the directory where the doxysearch binary | |
| 1113 | # is installed. | |
| 1114 | ||
| 1115 | BIN_ABSPATH = /usr/local/bin/ | |
| 1116 | ||
| 1117 | # The EXT_DOC_PATHS tag can be used to specify one or more paths to | |
| 1118 | # documentation generated for other projects. This allows doxysearch to search | |
| 1119 | # the documentation for these projects as well. | |
| 1120 | ||
| 1121 | EXT_DOC_PATHS = |