Mercurial > pidgin
comparison Doxyfile.in @ 21563:1b174854bb80
merge of '30fcf2f336afb635b62a5c3ed3adb3e1fa1dd2d1'
and 'bb60447c0a8c79afca320f4dc689096f4788e7fa'
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Sat, 17 Nov 2007 01:55:21 +0000 |
parents | cc0df68f6fa9 |
children | 1db2bc34ea61 |
comparison
equal
deleted
inserted
replaced
20755:774f4924e74e | 21563:1b174854bb80 |
---|---|
1 # Doxyfile 1.4.4 | 1 # Doxyfile 1.5.3 |
2 | 2 |
3 # This file describes the settings to be used by the documentation system | 3 # This file describes the settings to be used by the documentation system |
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 |
12 | 12 |
13 #--------------------------------------------------------------------------- | 13 #--------------------------------------------------------------------------- |
14 # Project related configuration options | 14 # Project related configuration options |
15 #--------------------------------------------------------------------------- | 15 #--------------------------------------------------------------------------- |
16 | 16 |
17 # This tag specifies the encoding used for all characters in the config file that | |
18 # follow. The default is UTF-8 which is also the encoding used for all text before | |
19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into | |
20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of | |
21 # possible encodings. | |
22 | |
23 DOXYFILE_ENCODING = UTF-8 | |
24 | |
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded | 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
18 # by quotes) that should identify the project. | 26 # by quotes) that should identify the project. |
19 | 27 |
20 PROJECT_NAME = @PACKAGE@ | 28 PROJECT_NAME = @PACKAGE@ |
21 | 29 |
43 | 51 |
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all | 52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
45 # documentation generated by doxygen is written. Doxygen will use this | 53 # documentation generated by doxygen is written. Doxygen will use this |
46 # information to generate all constant output in the proper language. | 54 # information to generate all constant output in the proper language. |
47 # The default language is English, other supported languages are: | 55 # The default language is English, other supported languages are: |
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, | 56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
49 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en | 57 # Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, |
50 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, | 58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean, |
51 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. | 59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, |
60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. | |
52 | 61 |
53 OUTPUT_LANGUAGE = English | 62 OUTPUT_LANGUAGE = English |
54 | |
55 # This tag can be used to specify the encoding used in the generated output. | |
56 # The encoding is not always determined by the language that is chosen, | |
57 # but also whether or not the output is meant for Windows or non-Windows users. | |
58 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES | |
59 # forces the Windows encoding (this is the default for the Windows binary), | |
60 # whereas setting the tag to NO uses a Unix-style encoding (the default for | |
61 # all platforms other than Windows). | |
62 | |
63 USE_WINDOWS_ENCODING = NO | |
64 | 63 |
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | 64 # 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 | 65 # include brief member descriptions after the members that are listed in |
67 # the file and class documentation (similar to JavaDoc). | 66 # the file and class documentation (similar to JavaDoc). |
68 # Set to NO to disable this. | 67 # Set to NO to disable this. |
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the | 73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
75 # brief descriptions will be completely suppressed. | 74 # brief descriptions will be completely suppressed. |
76 | 75 |
77 REPEAT_BRIEF = YES | 76 REPEAT_BRIEF = YES |
78 | 77 |
78 # This tag implements a quasi-intelligent brief description abbreviator | |
79 # that is used to form the text in various listings. Each string | |
80 # in this list, if found as the leading text of the brief description, will be | |
81 # stripped from the text and the result after processing the whole list, is | |
82 # used as the annotated text. Otherwise, the brief description is used as-is. | |
83 # If left blank, the following values are used ("$name" is automatically | |
84 # replaced with the name of the entity): "The $name class" "The $name widget" | |
85 # "The $name file" "is" "provides" "specifies" "contains" | |
86 # "represents" "a" "an" "the" | |
87 | |
88 ABBREVIATE_BRIEF = | |
89 | |
79 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | 90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
80 # Doxygen will generate a detailed section even if there is only a brief | 91 # Doxygen will generate a detailed section even if there is only a brief |
81 # description. | 92 # description. |
82 | 93 |
83 ALWAYS_DETAILED_SEC = NO | 94 ALWAYS_DETAILED_SEC = NO |
84 | 95 |
85 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited | 96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
86 # members of a class in the documentation of that class as if those members were | 97 # inherited members of a class in the documentation of that class as if those |
87 # ordinary class members. Constructors, destructors and assignment operators of | 98 # members were ordinary class members. Constructors, destructors and assignment |
88 # the base classes will not be shown. | 99 # operators of the base classes will not be shown. |
89 | 100 |
90 INLINE_INHERITED_MEMB = NO | 101 INLINE_INHERITED_MEMB = NO |
91 | 102 |
92 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | 103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
93 # path before files name in the file list and in the header files. If set | 104 # path before files name in the file list and in the header files. If set |
96 FULL_PATH_NAMES = NO | 107 FULL_PATH_NAMES = NO |
97 | 108 |
98 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag | 109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
99 # can be used to strip a user-defined part of the path. Stripping is | 110 # can be used to strip a user-defined part of the path. Stripping is |
100 # only done if one of the specified strings matches the left-hand part of | 111 # only done if one of the specified strings matches the left-hand part of |
101 # the path. It is allowed to use relative paths in the argument list. | 112 # the path. The tag can be used to show relative paths in the file list. |
113 # If left blank the directory from which doxygen is run is used as the | |
114 # path to strip. | |
102 | 115 |
103 STRIP_FROM_PATH = | 116 STRIP_FROM_PATH = |
117 | |
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of | |
119 # the path mentioned in the documentation of a class, which tells | |
120 # the reader which header file to include in order to use a class. | |
121 # If left blank only the name of the header file containing the class | |
122 # definition is used. Otherwise one should specify the include paths that | |
123 # are normally passed to the compiler using the -I flag. | |
124 | |
125 STRIP_FROM_INC_PATH = | |
104 | 126 |
105 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter | 127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
106 # (but less readable) file names. This can be useful is your file systems | 128 # (but less readable) file names. This can be useful is your file systems |
107 # doesn't support long names like on DOS, Mac, or CD-ROM. | 129 # doesn't support long names like on DOS, Mac, or CD-ROM. |
108 | 130 |
109 SHORT_NAMES = NO | 131 SHORT_NAMES = NO |
110 | 132 |
111 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | 133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
112 # will interpret the first line (until the first dot) of a JavaDoc-style | 134 # will interpret the first line (until the first dot) of a JavaDoc-style |
113 # comment as the brief description. If set to NO, the JavaDoc | 135 # comment as the brief description. If set to NO, the JavaDoc |
114 # comments will behave just like the Qt-style comments (thus requiring an | 136 # comments will behave just like regular Qt-style comments |
115 # explict @brief command for a brief description. | 137 # (thus requiring an explicit @brief command for a brief description.) |
116 | 138 |
117 JAVADOC_AUTOBRIEF = YES | 139 JAVADOC_AUTOBRIEF = YES |
140 | |
141 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will | |
142 # interpret the first line (until the first dot) of a Qt-style | |
143 # comment as the brief description. If set to NO, the comments | |
144 # will behave just like regular Qt-style comments (thus requiring | |
145 # an explicit \brief command for a brief description.) | |
146 | |
147 QT_AUTOBRIEF = NO | |
118 | 148 |
119 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | 149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
120 # treat a multi-line C++ special comment block (i.e. a block of //! or /// | 150 # treat a multi-line C++ special comment block (i.e. a block of //! or /// |
121 # comments) as a brief description. This used to be the default behaviour. | 151 # comments) as a brief description. This used to be the default behaviour. |
122 # The new default is to treat a multi-line C++ comment block as a detailed | 152 # The new default is to treat a multi-line C++ comment block as a detailed |
131 | 161 |
132 DETAILS_AT_TOP = NO | 162 DETAILS_AT_TOP = NO |
133 | 163 |
134 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented | 164 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
135 # member inherits the documentation from any documented member that it | 165 # member inherits the documentation from any documented member that it |
136 # reimplements. | 166 # re-implements. |
137 | 167 |
138 INHERIT_DOCS = YES | 168 INHERIT_DOCS = YES |
139 | |
140 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | |
141 # tag is set to YES, then doxygen will reuse the documentation of the first | |
142 # member in the group (if any) for the other members of the group. By default | |
143 # all members of a group must be documented explicitly. | |
144 | |
145 DISTRIBUTE_GROUP_DOC = NO | |
146 | 169 |
147 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce | 170 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
148 # a new page for each member. If set to NO, the documentation of a member will | 171 # a new page for each member. If set to NO, the documentation of a member will |
149 # be part of the file/class/namespace that contains it. | 172 # be part of the file/class/namespace that contains it. |
150 | 173 |
160 # For example adding "sideeffect=\par Side Effects:\n" will allow you to | 183 # For example adding "sideeffect=\par Side Effects:\n" will allow you to |
161 # put the command \sideeffect (or @sideeffect) in the documentation, which | 184 # put the command \sideeffect (or @sideeffect) in the documentation, which |
162 # will result in a user-defined paragraph with heading "Side Effects:". | 185 # will result in a user-defined paragraph with heading "Side Effects:". |
163 # You can put \n's in the value part of an alias to insert newlines. | 186 # You can put \n's in the value part of an alias to insert newlines. |
164 | 187 |
165 ALIASES = "signal=- @ref" \ | 188 ALIASES = "signal=- @ref " \ |
166 "signaldef=@section" \ | 189 "signaldef=@section " \ |
167 "endsignaldef=" \ | 190 "endsignaldef= " \ |
168 "signalproto=@code" \ | 191 "signalproto=@code " \ |
169 "endsignalproto=@endcode" \ | 192 "endsignalproto=@endcode " \ |
170 "signaldesc=@par Description:" \ | 193 "signaldesc=@par Description: " \ |
171 "signals=@b Signals:" \ | 194 "signals=@b Signals: " \ |
172 "endsignals=" | 195 "endsignals= " \ |
173 | 196 "constreturn=@note The return value of this function must not be modified or freed. @return " |
174 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | 197 |
175 # only. Doxygen will then generate output that is more tailored for C. | 198 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
199 # sources only. Doxygen will then generate output that is more tailored for C. | |
176 # For instance, some of the names that are used will be different. The list | 200 # For instance, some of the names that are used will be different. The list |
177 # of all members will be omitted, etc. | 201 # of all members will be omitted, etc. |
178 | 202 |
179 OPTIMIZE_OUTPUT_FOR_C = YES | 203 OPTIMIZE_OUTPUT_FOR_C = YES |
180 | 204 |
181 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources | 205 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
182 # only. Doxygen will then generate output that is more tailored for Java. | 206 # sources only. Doxygen will then generate output that is more tailored for Java. |
183 # For instance, namespaces will be presented as packages, qualified scopes | 207 # For instance, namespaces will be presented as packages, qualified scopes |
184 # will look different, etc. | 208 # will look different, etc. |
185 | 209 |
186 OPTIMIZE_OUTPUT_JAVA = NO | 210 OPTIMIZE_OUTPUT_JAVA = NO |
211 | |
212 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to | |
213 # include (a tag file for) the STL sources as input, then you should | |
214 # set this tag to YES in order to let doxygen match functions declarations and | |
215 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | |
216 # func(std::string) {}). This also make the inheritance and collaboration | |
217 # diagrams that involve STL classes more complete and accurate. | |
218 | |
219 BUILTIN_STL_SUPPORT = NO | |
220 | |
221 # If you use Microsoft's C++/CLI language, you should set this option to YES to | |
222 # enable parsing support. | |
223 | |
224 CPP_CLI_SUPPORT = NO | |
225 | |
226 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | |
227 # tag is set to YES, then doxygen will reuse the documentation of the first | |
228 # member in the group (if any) for the other members of the group. By default | |
229 # all members of a group must be documented explicitly. | |
230 | |
231 DISTRIBUTE_GROUP_DOC = NO | |
187 | 232 |
188 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | 233 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
189 # the same type (for instance a group of public functions) to be put as a | 234 # the same type (for instance a group of public functions) to be put as a |
190 # subgroup of that type (e.g. under the Public Functions section). Set it to | 235 # subgroup of that type (e.g. under the Public Functions section). Set it to |
191 # NO to prevent subgrouping. Alternatively, this can be done per class using | 236 # NO to prevent subgrouping. Alternatively, this can be done per class using |
225 # the interface are included in the documentation. | 270 # the interface are included in the documentation. |
226 # If set to NO (the default) only methods in the interface are included. | 271 # If set to NO (the default) only methods in the interface are included. |
227 | 272 |
228 EXTRACT_LOCAL_METHODS = YES | 273 EXTRACT_LOCAL_METHODS = YES |
229 | 274 |
275 # If this flag is set to YES, the members of anonymous namespaces will be extracted | |
276 # and appear in the documentation as a namespace called 'anonymous_namespace{file}', | |
277 # where file will be replaced with the base name of the file that contains the anonymous | |
278 # namespace. By default anonymous namespace are hidden. | |
279 | |
280 EXTRACT_ANON_NSPACES = NO | |
281 | |
230 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | 282 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
231 # undocumented members of documented classes, files or namespaces. | 283 # undocumented members of documented classes, files or namespaces. |
232 # If set to NO (the default) these members will be included in the | 284 # If set to NO (the default) these members will be included in the |
233 # various overviews, but no documentation section is generated. | 285 # various overviews, but no documentation section is generated. |
234 # This option has no effect if EXTRACT_ALL is enabled. | 286 # This option has no effect if EXTRACT_ALL is enabled. |
265 | 317 |
266 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | 318 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
267 # file names in lower-case letters. If set to YES upper-case letters are also | 319 # file names in lower-case letters. If set to YES upper-case letters are also |
268 # allowed. This is useful if you have classes or files whose names only differ | 320 # allowed. This is useful if you have classes or files whose names only differ |
269 # in case and if your file system supports case sensitive file names. Windows | 321 # in case and if your file system supports case sensitive file names. Windows |
270 # users are advised to set this option to NO. | 322 # and Mac users are advised to set this option to NO. |
271 | 323 |
272 CASE_SENSE_NAMES = YES | 324 CASE_SENSE_NAMES = YES |
273 | 325 |
274 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | 326 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
275 # will show members with their full class and namespace scopes in the | 327 # will show members with their full class and namespace scopes in the |
357 | 409 |
358 SHOW_USED_FILES = YES | 410 SHOW_USED_FILES = YES |
359 | 411 |
360 # If the sources in your project are distributed over multiple directories | 412 # If the sources in your project are distributed over multiple directories |
361 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy | 413 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
362 # in the documentation. The default is YES. | 414 # in the documentation. The default is NO. |
363 | 415 |
364 SHOW_DIRECTORIES = YES | 416 SHOW_DIRECTORIES = YES |
365 | 417 |
366 # The FILE_VERSION_FILTER tag can be used to specify a program or script that | 418 # The FILE_VERSION_FILTER tag can be used to specify a program or script that |
367 # doxygen should invoke to get the current version for each file (typically from the | 419 # doxygen should invoke to get the current version for each file (typically from the |
368 # version control system). Doxygen will invoke the program by executing (via | 420 # version control system). Doxygen will invoke the program by executing (via |
369 # popen()) the command <command> <input-file>, where <command> is the value of | 421 # popen()) the command <command> <input-file>, where <command> is the value of |
370 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | 422 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
371 # provided by doxygen. Whatever the progam writes to standard output | 423 # provided by doxygen. Whatever the program writes to standard output |
372 # is used as the file version. See the manual for examples. | 424 # is used as the file version. See the manual for examples. |
373 | 425 |
374 FILE_VERSION_FILTER = | 426 FILE_VERSION_FILTER = |
375 | 427 |
376 #--------------------------------------------------------------------------- | 428 #--------------------------------------------------------------------------- |
410 WARN_NO_PARAMDOC = YES | 462 WARN_NO_PARAMDOC = YES |
411 | 463 |
412 # The WARN_FORMAT tag determines the format of the warning messages that | 464 # The WARN_FORMAT tag determines the format of the warning messages that |
413 # doxygen can produce. The string should contain the $file, $line, and $text | 465 # doxygen can produce. The string should contain the $file, $line, and $text |
414 # tags, which will be replaced by the file and line number from which the | 466 # tags, which will be replaced by the file and line number from which the |
415 # warning originated and the warning text. | 467 # warning originated and the warning text. Optionally the format may contain |
416 | 468 # $version, which will be replaced by the version of the file (if it could |
417 WARN_FORMAT = "$file:$line: $text" | 469 # be obtained via FILE_VERSION_FILTER) |
470 | |
471 WARN_FORMAT = "$file:$line: $text " | |
418 | 472 |
419 # The WARN_LOGFILE tag can be used to specify a file to which warning | 473 # The WARN_LOGFILE tag can be used to specify a file to which warning |
420 # and error messages should be written. If left blank the output is written | 474 # and error messages should be written. If left blank the output is written |
421 # to stderr. | 475 # to stderr. |
422 | 476 |
430 # documented source files. You may enter file names like "myfile.cpp" or | 484 # documented source files. You may enter file names like "myfile.cpp" or |
431 # directories like "/usr/src/myproject". Separate the files or directories | 485 # directories like "/usr/src/myproject". Separate the files or directories |
432 # with spaces. | 486 # with spaces. |
433 | 487 |
434 INPUT = libpurple \ | 488 INPUT = libpurple \ |
435 finch \ | 489 finch \ |
436 finch/libgnt \ | 490 finch/libgnt \ |
437 pidgin \ | 491 pidgin \ |
438 doc | 492 doc |
493 | |
494 # This tag can be used to specify the character encoding of the source files that | |
495 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default | |
496 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. | |
497 # See http://www.gnu.org/software/libiconv for the list of possible encodings. | |
498 | |
499 INPUT_ENCODING = UTF-8 | |
439 | 500 |
440 # If the value of the INPUT tag contains directories, you can use the | 501 # If the value of the INPUT tag contains directories, you can use the |
441 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | 502 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
442 # and *.h) to filter out the source-files in the directories. If left | 503 # and *.h) to filter out the source-files in the directories. If left |
443 # blank the following patterns are tested: | 504 # blank the following patterns are tested: |
444 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp | 505 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
445 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc | 506 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py |
446 | 507 |
447 FILE_PATTERNS = *.h \ | 508 FILE_PATTERNS = *.h \ |
448 *.dox | 509 *.dox |
449 | 510 |
450 # The RECURSIVE tag can be used to turn specify whether or not subdirectories | 511 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
455 | 516 |
456 # The EXCLUDE tag can be used to specify files and/or directories that should | 517 # The EXCLUDE tag can be used to specify files and/or directories that should |
457 # excluded from the INPUT source files. This way you can easily exclude a | 518 # excluded from the INPUT source files. This way you can easily exclude a |
458 # subdirectory from a directory tree whose root is specified with the INPUT tag. | 519 # subdirectory from a directory tree whose root is specified with the INPUT tag. |
459 | 520 |
460 EXCLUDE = | 521 EXCLUDE = libpurple/purple-client.h \ |
461 | 522 libpurple/purple-client-bindings.h |
462 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories | 523 |
463 # that are symbolic links (a Unix filesystem feature) are excluded from the input. | 524 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
525 # directories that are symbolic links (a Unix filesystem feature) are excluded | |
526 # from the input. | |
464 | 527 |
465 EXCLUDE_SYMLINKS = NO | 528 EXCLUDE_SYMLINKS = NO |
466 | 529 |
467 # If the value of the INPUT tag contains directories, you can use the | 530 # If the value of the INPUT tag contains directories, you can use the |
468 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | 531 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
469 # certain files from those directories. | 532 # certain files from those directories. Note that the wildcards are matched |
533 # against the file with absolute path, so to exclude all test directories | |
534 # for example use the pattern */test/* | |
470 | 535 |
471 EXCLUDE_PATTERNS = | 536 EXCLUDE_PATTERNS = |
537 | |
538 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | |
539 # (namespaces, classes, functions, etc.) that should be excluded from the output. | |
540 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used, | |
541 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test | |
542 | |
543 EXCLUDE_SYMBOLS = | |
472 | 544 |
473 # The EXAMPLE_PATH tag can be used to specify one or more files or | 545 # The EXAMPLE_PATH tag can be used to specify one or more files or |
474 # directories that contain example code fragments that are included (see | 546 # directories that contain example code fragments that are included (see |
475 # the \include command). | 547 # the \include command). |
476 | 548 |
499 # The INPUT_FILTER tag can be used to specify a program that doxygen should | 571 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
500 # invoke to filter for each input file. Doxygen will invoke the filter program | 572 # invoke to filter for each input file. Doxygen will invoke the filter program |
501 # by executing (via popen()) the command <filter> <input-file>, where <filter> | 573 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
502 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | 574 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
503 # input file. Doxygen will then use the output that the filter program writes | 575 # input file. Doxygen will then use the output that the filter program writes |
504 # to standard output. | 576 # to standard output. If FILTER_PATTERNS is specified, this tag will be |
577 # ignored. | |
505 | 578 |
506 INPUT_FILTER = | 579 INPUT_FILTER = |
507 | 580 |
508 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | 581 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
509 # basis. Doxygen will compare the file name with each pattern and apply the | 582 # basis. Doxygen will compare the file name with each pattern and apply the |
523 #--------------------------------------------------------------------------- | 596 #--------------------------------------------------------------------------- |
524 # configuration options related to source browsing | 597 # configuration options related to source browsing |
525 #--------------------------------------------------------------------------- | 598 #--------------------------------------------------------------------------- |
526 | 599 |
527 # If the SOURCE_BROWSER tag is set to YES then a list of source files will | 600 # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
528 # be generated. Documented entities will be cross-referenced with these sources. | 601 # be generated. Documented entities will be cross-referenced with these sources. |
529 | 602 # Note: To get rid of all source code in the generated output, make sure also |
530 SOURCE_BROWSER = NO | 603 # VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH |
604 # then you must also enable this option. If you don't then doxygen will produce | |
605 # a warning and turn it on anyway | |
606 | |
607 SOURCE_BROWSER = YES | |
531 | 608 |
532 # Setting the INLINE_SOURCES tag to YES will include the body | 609 # Setting the INLINE_SOURCES tag to YES will include the body |
533 # of functions and classes directly in the documentation. | 610 # of functions and classes directly in the documentation. |
534 | 611 |
535 INLINE_SOURCES = NO | 612 INLINE_SOURCES = NO |
549 # If the REFERENCES_RELATION tag is set to YES (the default) | 626 # If the REFERENCES_RELATION tag is set to YES (the default) |
550 # then for each documented function all documented entities | 627 # then for each documented function all documented entities |
551 # called/used by that function will be listed. | 628 # called/used by that function will be listed. |
552 | 629 |
553 REFERENCES_RELATION = YES | 630 REFERENCES_RELATION = YES |
631 | |
632 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | |
633 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | |
634 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | |
635 # link to the source code. Otherwise they will link to the documentstion. | |
636 | |
637 REFERENCES_LINK_SOURCE = YES | |
554 | 638 |
555 # If the USE_HTAGS tag is set to YES then the references to source code | 639 # If the USE_HTAGS tag is set to YES then the references to source code |
556 # will point to the HTML generated by the htags(1) tool instead of doxygen | 640 # will point to the HTML generated by the htags(1) tool instead of doxygen |
557 # built-in source browser. The htags tool is part of GNU's global source | 641 # built-in source browser. The htags tool is part of GNU's global source |
558 # tagging system (see http://www.gnu.org/software/global/global.html). You | 642 # tagging system (see http://www.gnu.org/software/global/global.html). You |
625 HTML_FOOTER = @top_srcdir@/doc/TracFooter.html | 709 HTML_FOOTER = @top_srcdir@/doc/TracFooter.html |
626 | 710 |
627 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading | 711 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
628 # style sheet that is used by each HTML page. It can be used to | 712 # style sheet that is used by each HTML page. It can be used to |
629 # fine-tune the look of the HTML output. If the tag is left blank doxygen | 713 # fine-tune the look of the HTML output. If the tag is left blank doxygen |
630 # will generate a default style sheet | 714 # will generate a default style sheet. Note that doxygen will try to copy |
715 # the style sheet file to the HTML output directory, so don't put your own | |
716 # stylesheet in the HTML output directory as well, or it will be erased! | |
631 | 717 |
632 HTML_STYLESHEET = | 718 HTML_STYLESHEET = |
633 | 719 |
634 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, | 720 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
635 # files or namespaces will be aligned in HTML using tables. If set to | 721 # files or namespaces will be aligned in HTML using tables. If set to |
642 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | 728 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
643 # of the generated HTML documentation. | 729 # of the generated HTML documentation. |
644 | 730 |
645 GENERATE_HTMLHELP = YES | 731 GENERATE_HTMLHELP = YES |
646 | 732 |
733 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | |
734 # documentation will contain sections that can be hidden and shown after the | |
735 # page has loaded. For this to work a browser that supports | |
736 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox | |
737 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). | |
738 | |
739 HTML_DYNAMIC_SECTIONS = NO | |
740 | |
647 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | 741 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
648 # be used to specify the file name of the resulting .chm file. You | 742 # be used to specify the file name of the resulting .chm file. You |
649 # can add a path in front of the file if the result should not be | 743 # can add a path in front of the file if the result should not be |
650 # written to the html output dir. | 744 # written to the html output directory. |
651 | 745 |
652 CHM_FILE = | 746 CHM_FILE = |
653 | 747 |
654 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can | 748 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
655 # be used to specify the location (absolute path including file name) of | 749 # be used to specify the location (absolute path including file name) of |
780 #--------------------------------------------------------------------------- | 874 #--------------------------------------------------------------------------- |
781 # configuration options related to the RTF output | 875 # configuration options related to the RTF output |
782 #--------------------------------------------------------------------------- | 876 #--------------------------------------------------------------------------- |
783 | 877 |
784 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output | 878 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
785 # The RTF output is optimised for Word 97 and may not look very pretty with | 879 # The RTF output is optimized for Word 97 and may not look very pretty with |
786 # other RTF readers or editors. | 880 # other RTF readers or editors. |
787 | 881 |
788 GENERATE_RTF = NO | 882 GENERATE_RTF = NO |
789 | 883 |
790 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. | 884 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
807 # Note: wordpad (write) and others do not support links. | 901 # Note: wordpad (write) and others do not support links. |
808 | 902 |
809 RTF_HYPERLINKS = NO | 903 RTF_HYPERLINKS = NO |
810 | 904 |
811 # Load stylesheet definitions from file. Syntax is similar to doxygen's | 905 # Load stylesheet definitions from file. Syntax is similar to doxygen's |
812 # config file, i.e. a series of assigments. You only have to provide | 906 # config file, i.e. a series of assignments. You only have to provide |
813 # replacements, missing definitions are set to their default value. | 907 # replacements, missing definitions are set to their default value. |
814 | 908 |
815 RTF_STYLESHEET_FILE = | 909 RTF_STYLESHEET_FILE = |
816 | 910 |
817 # Set optional variables used in the generation of an rtf document. | 911 # Set optional variables used in the generation of an rtf document. |
851 # configuration options related to the XML output | 945 # configuration options related to the XML output |
852 #--------------------------------------------------------------------------- | 946 #--------------------------------------------------------------------------- |
853 | 947 |
854 # If the GENERATE_XML tag is set to YES Doxygen will | 948 # If the GENERATE_XML tag is set to YES Doxygen will |
855 # generate an XML file that captures the structure of | 949 # generate an XML file that captures the structure of |
856 # the code including all documentation. Note that this | 950 # the code including all documentation. |
857 # feature is still experimental and incomplete at the | 951 |
858 # moment. | 952 GENERATE_XML = YES |
859 | |
860 GENERATE_XML = NO | |
861 | 953 |
862 # The XML_OUTPUT tag is used to specify where the XML pages will be put. | 954 # The XML_OUTPUT tag is used to specify where the XML pages will be put. |
863 # If a relative path is entered the value of OUTPUT_DIRECTORY will be | 955 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
864 # put in front of it. If left blank `xml' will be used as the default path. | 956 # put in front of it. If left blank `xml' will be used as the default path. |
865 | 957 |
874 # The XML_DTD tag can be used to specify an XML DTD, | 966 # The XML_DTD tag can be used to specify an XML DTD, |
875 # which can be used by a validating XML parser to check the | 967 # which can be used by a validating XML parser to check the |
876 # syntax of the XML files. | 968 # syntax of the XML files. |
877 | 969 |
878 XML_DTD = | 970 XML_DTD = |
971 | |
972 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will | |
973 # dump the program listings (including syntax highlighting | |
974 # and cross-referencing information) to the XML output. Note that | |
975 # enabling this will significantly increase the size of the XML output. | |
976 | |
977 XML_PROGRAMLISTING = YES | |
879 | 978 |
880 #--------------------------------------------------------------------------- | 979 #--------------------------------------------------------------------------- |
881 # configuration options for the AutoGen Definitions output | 980 # configuration options for the AutoGen Definitions output |
882 #--------------------------------------------------------------------------- | 981 #--------------------------------------------------------------------------- |
883 | 982 |
939 | 1038 |
940 MACRO_EXPANSION = NO | 1039 MACRO_EXPANSION = NO |
941 | 1040 |
942 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | 1041 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
943 # then the macro expansion is limited to the macros specified with the | 1042 # then the macro expansion is limited to the macros specified with the |
944 # PREDEFINED and EXPAND_AS_PREDEFINED tags. | 1043 # PREDEFINED and EXPAND_AS_DEFINED tags. |
945 | 1044 |
946 EXPAND_ONLY_PREDEF = NO | 1045 EXPAND_ONLY_PREDEF = NO |
947 | 1046 |
948 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | 1047 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
949 # in the INCLUDE_PATH (see below) will be search if a #include is found. | 1048 # in the INCLUDE_PATH (see below) will be search if a #include is found. |
965 | 1064 |
966 # The PREDEFINED tag can be used to specify one or more macro names that | 1065 # The PREDEFINED tag can be used to specify one or more macro names that |
967 # are defined before the preprocessor is started (similar to the -D option of | 1066 # are defined before the preprocessor is started (similar to the -D option of |
968 # gcc). The argument of the tag is a list of macros of the form: name | 1067 # gcc). The argument of the tag is a list of macros of the form: name |
969 # or name=definition (no spaces). If the definition and the = are | 1068 # or name=definition (no spaces). If the definition and the = are |
970 # omitted =1 is assumed. | 1069 # omitted =1 is assumed. To prevent a macro definition from being |
1070 # undefined via #undef or recursively expanded use the := operator | |
1071 # instead of the = operator. | |
971 | 1072 |
972 PREDEFINED = | 1073 PREDEFINED = |
973 | 1074 |
974 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then | 1075 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
975 # this tag can be used to specify a list of macro names that should be expanded. | 1076 # this tag can be used to specify a list of macro names that should be expanded. |
979 EXPAND_AS_DEFINED = | 1080 EXPAND_AS_DEFINED = |
980 | 1081 |
981 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | 1082 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
982 # doxygen's preprocessor will remove all function-like macros that are alone | 1083 # doxygen's preprocessor will remove all function-like macros that are alone |
983 # on a line, have an all uppercase name, and do not end with a semicolon. Such | 1084 # on a line, have an all uppercase name, and do not end with a semicolon. Such |
984 # function macros are typically used for boiler-plate code, and will confuse the | 1085 # function macros are typically used for boiler-plate code, and will confuse |
985 # parser if not removed. | 1086 # the parser if not removed. |
986 | 1087 |
987 SKIP_FUNCTION_MACROS = YES | 1088 SKIP_FUNCTION_MACROS = YES |
988 | 1089 |
989 #--------------------------------------------------------------------------- | 1090 #--------------------------------------------------------------------------- |
990 # Configuration::addtions related to external references | 1091 # Configuration::additions related to external references |
991 #--------------------------------------------------------------------------- | 1092 #--------------------------------------------------------------------------- |
992 | 1093 |
993 # The TAGFILES option can be used to specify one or more tagfiles. | 1094 # The TAGFILES option can be used to specify one or more tagfiles. |
994 # Optionally an initial location of the external documentation | 1095 # Optionally an initial location of the external documentation |
995 # can be added for each tagfile. The format of a tag file without | 1096 # can be added for each tagfile. The format of a tag file without |
1032 #--------------------------------------------------------------------------- | 1133 #--------------------------------------------------------------------------- |
1033 # Configuration options related to the dot tool | 1134 # Configuration options related to the dot tool |
1034 #--------------------------------------------------------------------------- | 1135 #--------------------------------------------------------------------------- |
1035 | 1136 |
1036 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | 1137 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
1037 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or | 1138 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
1038 # super classes. Setting the tag to NO turns the diagrams off. Note that this | 1139 # or super classes. Setting the tag to NO turns the diagrams off. Note that |
1039 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is | 1140 # this option is superseded by the HAVE_DOT option below. This is only a |
1040 # recommended to install and use dot, since it yields more powerful graphs. | 1141 # fallback. It is recommended to install and use dot, since it yields more |
1142 # powerful graphs. | |
1041 | 1143 |
1042 CLASS_DIAGRAMS = YES | 1144 CLASS_DIAGRAMS = YES |
1145 | |
1146 # You can define message sequence charts within doxygen comments using the \msc | |
1147 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to | |
1148 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to | |
1149 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to | |
1150 # be found in the default search path. | |
1151 | |
1152 MSCGEN_PATH = | |
1043 | 1153 |
1044 # If set to YES, the inheritance and collaboration graphs will hide | 1154 # If set to YES, the inheritance and collaboration graphs will hide |
1045 # inheritance and usage relations if the target is undocumented | 1155 # inheritance and usage relations if the target is undocumented |
1046 # or is not a class. | 1156 # or is not a class. |
1047 | 1157 |
1072 # will generate a graph for groups, showing the direct groups dependencies | 1182 # will generate a graph for groups, showing the direct groups dependencies |
1073 | 1183 |
1074 GROUP_GRAPHS = YES | 1184 GROUP_GRAPHS = YES |
1075 | 1185 |
1076 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | 1186 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
1077 # collaboration diagrams in a style similiar to the OMG's Unified Modeling | 1187 # collaboration diagrams in a style similar to the OMG's Unified Modeling |
1078 # Language. | 1188 # Language. |
1079 | 1189 |
1080 UML_LOOK = YES | 1190 UML_LOOK = YES |
1081 | 1191 |
1082 # If set to YES, the inheritance and collaboration graphs will show the | 1192 # If set to YES, the inheritance and collaboration graphs will show the |
1096 # documented header file showing the documented files that directly or | 1206 # documented header file showing the documented files that directly or |
1097 # indirectly include this file. | 1207 # indirectly include this file. |
1098 | 1208 |
1099 INCLUDED_BY_GRAPH = YES | 1209 INCLUDED_BY_GRAPH = YES |
1100 | 1210 |
1101 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will | 1211 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will |
1102 # generate a call dependency graph for every global function or class method. | 1212 # generate a call dependency graph for every global function or class method. |
1103 # Note that enabling this option will significantly increase the time of a run. | 1213 # Note that enabling this option will significantly increase the time of a run. |
1104 # So in most cases it will be better to enable call graphs for selected | 1214 # So in most cases it will be better to enable call graphs for selected |
1105 # functions only using the \callgraph command. | 1215 # functions only using the \callgraph command. |
1106 | 1216 |
1107 CALL_GRAPH = YES | 1217 CALL_GRAPH = YES |
1108 | 1218 |
1219 # If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will | |
1220 # generate a caller dependency graph for every global function or class method. | |
1221 # Note that enabling this option will significantly increase the time of a run. | |
1222 # So in most cases it will be better to enable caller graphs for selected | |
1223 # functions only using the \callergraph command. | |
1224 | |
1225 CALLER_GRAPH = NO | |
1226 | |
1109 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | 1227 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
1110 # will graphical hierarchy of all classes instead of a textual one. | 1228 # will graphical hierarchy of all classes instead of a textual one. |
1111 | 1229 |
1112 GRAPHICAL_HIERARCHY = YES | 1230 GRAPHICAL_HIERARCHY = YES |
1113 | 1231 |
1123 # If left blank png will be used. | 1241 # If left blank png will be used. |
1124 | 1242 |
1125 DOT_IMAGE_FORMAT = png | 1243 DOT_IMAGE_FORMAT = png |
1126 | 1244 |
1127 # The tag DOT_PATH can be used to specify the path where the dot tool can be | 1245 # The tag DOT_PATH can be used to specify the path where the dot tool can be |
1128 # found. If left blank, it is assumed the dot tool can be found on the path. | 1246 # found. If left blank, it is assumed the dot tool can be found in the path. |
1129 | 1247 |
1130 DOT_PATH = | 1248 DOT_PATH = |
1131 | 1249 |
1132 # The DOTFILE_DIRS tag can be used to specify one or more directories that | 1250 # The DOTFILE_DIRS tag can be used to specify one or more directories that |
1133 # contain dot files that are included in the documentation (see the | 1251 # contain dot files that are included in the documentation (see the |
1134 # \dotfile command). | 1252 # \dotfile command). |
1135 | 1253 |
1136 DOTFILE_DIRS = | 1254 DOTFILE_DIRS = |
1137 | 1255 |
1138 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width | 1256 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
1139 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | 1257 # nodes that will be shown in the graph. If the number of nodes in a graph |
1140 # this value, doxygen will try to truncate the graph, so that it fits within | 1258 # becomes larger than this value, doxygen will truncate the graph, which is |
1141 # the specified constraint. Beware that most browsers cannot cope with very | 1259 # visualized by representing a node as a red box. Note that doxygen if the number |
1142 # large images. | 1260 # of direct children of the root node in a graph is already larger than |
1143 | 1261 # MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note |
1144 MAX_DOT_GRAPH_WIDTH = 1024 | 1262 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
1145 | 1263 |
1146 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height | 1264 DOT_GRAPH_MAX_NODES = 50 |
1147 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
1148 # this value, doxygen will try to truncate the graph, so that it fits within | |
1149 # the specified constraint. Beware that most browsers cannot cope with very | |
1150 # large images. | |
1151 | |
1152 MAX_DOT_GRAPH_HEIGHT = 1024 | |
1153 | 1265 |
1154 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | 1266 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
1155 # graphs generated by dot. A depth value of 3 means that only nodes reachable | 1267 # graphs generated by dot. A depth value of 3 means that only nodes reachable |
1156 # from the root by following a path via at most 3 edges will be shown. Nodes that | 1268 # from the root by following a path via at most 3 edges will be shown. Nodes |
1157 # lay further from the root node will be omitted. Note that setting this option to | 1269 # that lay further from the root node will be omitted. Note that setting this |
1158 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also | 1270 # option to 1 or 2 may greatly reduce the computation time needed for large |
1159 # note that a graph may be further truncated if the graph's image dimensions are | 1271 # code bases. Also note that the size of a graph can be further restricted by |
1160 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). | 1272 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
1161 # If 0 is used for the depth value (the default), the graph is not depth-constrained. | 1273 |
1162 | 1274 MAX_DOT_GRAPH_DEPTH = 2 |
1163 MAX_DOT_GRAPH_DEPTH = 0 | |
1164 | 1275 |
1165 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | 1276 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
1166 # background. This is disabled by default, which results in a white background. | 1277 # background. This is disabled by default, which results in a white background. |
1167 # Warning: Depending on the platform used, enabling this option may lead to | 1278 # Warning: Depending on the platform used, enabling this option may lead to |
1168 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to | 1279 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to |
1188 # the various graphs. | 1299 # the various graphs. |
1189 | 1300 |
1190 DOT_CLEANUP = YES | 1301 DOT_CLEANUP = YES |
1191 | 1302 |
1192 #--------------------------------------------------------------------------- | 1303 #--------------------------------------------------------------------------- |
1193 # Configuration::addtions related to the search engine | 1304 # Configuration::additions related to the search engine |
1194 #--------------------------------------------------------------------------- | 1305 #--------------------------------------------------------------------------- |
1195 | 1306 |
1196 # The SEARCHENGINE tag specifies whether or not a search engine should be | 1307 # The SEARCHENGINE tag specifies whether or not a search engine should be |
1197 # used. If set to NO the values of all tags below this one will be ignored. | 1308 # used. If set to NO the values of all tags below this one will be ignored. |
1198 | 1309 |