Mercurial > mplayer.hg
comparison DOCS/tech/Doxyfile @ 33273:8c4a81b0bd5f
Update Doxyfile from doxygen 1.3.7 to 1.5.6.
The latter is the version available in Debian oldstable and should thus be a
suitable baseline that can be expected to be available on all systems.
The update makes new Doxygen features available in the configuration file
and avoids several deprecation warnings when using newer doxygen versions.
author | diego |
---|---|
date | Wed, 04 May 2011 14:27:35 +0000 |
parents | 4e2e688b2c6f |
children | 99e361d92a03 |
comparison
equal
deleted
inserted
replaced
33272:4e2e688b2c6f | 33273:8c4a81b0bd5f |
---|---|
1 # Doxyfile 1.3.7 | 1 # Doxyfile 1.5.6 |
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 | |
18 # that follow. The default is UTF-8 which is also the encoding used for all | |
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the | |
20 # iconv built into libc) for the transcoding. See | |
21 # http://www.gnu.org/software/libiconv for the list of 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 = MPlayer | 28 PROJECT_NAME = MPlayer |
21 | 29 |
31 # where doxygen was started. If left blank the current directory will be used. | 39 # where doxygen was started. If left blank the current directory will be used. |
32 | 40 |
33 OUTPUT_DIRECTORY = DOCS/tech/doxygen | 41 OUTPUT_DIRECTORY = DOCS/tech/doxygen |
34 | 42 |
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create | 43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
36 # 2 levels of 10 sub-directories under the output directory of each output | 44 # 4096 sub-directories (in 2 levels) under the output directory of each output |
37 # format and will distribute the generated files over these directories. | 45 # format and will distribute the generated files over these directories. |
38 # Enabling this option can be useful when feeding doxygen a huge amount of source | 46 # Enabling this option can be useful when feeding doxygen a huge amount of |
39 # files, where putting all generated files in the same directory would otherwise | 47 # source files, where putting all generated files in the same directory would |
40 # cause performance problems for the file system. | 48 # otherwise cause performance problems for the file system. |
41 | 49 |
42 CREATE_SUBDIRS = YES | 50 CREATE_SUBDIRS = YES |
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, Farsi, Finnish, French, German, Greek, |
50 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, | 58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), |
51 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. | 59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, |
60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, | |
61 # and Ukrainian. | |
52 | 62 |
53 OUTPUT_LANGUAGE = English | 63 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 | 64 |
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will | 65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
66 # include brief member descriptions after the members that are listed in | 66 # include brief member descriptions after the members that are listed in |
67 # the file and class documentation (similar to JavaDoc). | 67 # the file and class documentation (similar to JavaDoc). |
68 # Set to NO to disable this. | 68 # Set to NO to disable this. |
77 REPEAT_BRIEF = YES | 77 REPEAT_BRIEF = YES |
78 | 78 |
79 # This tag implements a quasi-intelligent brief description abbreviator | 79 # This tag implements a quasi-intelligent brief description abbreviator |
80 # that is used to form the text in various listings. Each string | 80 # that is used to form the text in various listings. Each string |
81 # in this list, if found as the leading text of the brief description, will be | 81 # in this list, if found as the leading text of the brief description, will be |
82 # stripped from the text and the result after processing the whole list, is used | 82 # stripped from the text and the result after processing the whole list, is |
83 # as the annotated text. Otherwise, the brief description is used as-is. If left | 83 # used as the annotated text. Otherwise, the brief description is used as-is. |
84 # blank, the following values are used ("$name" is automatically replaced with the | 84 # If left blank, the following values are used ("$name" is automatically |
85 # name of the entity): "The $name class" "The $name widget" "The $name file" | 85 # replaced with the name of the entity): "The $name class" "The $name widget" |
86 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the" | 86 # "The $name file" "is" "provides" "specifies" "contains" |
87 # "represents" "a" "an" "the" | |
87 | 88 |
88 ABBREVIATE_BRIEF = | 89 ABBREVIATE_BRIEF = |
89 | 90 |
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then | 91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
91 # Doxygen will generate a detailed section even if there is only a brief | 92 # Doxygen will generate a detailed section even if there is only a brief |
92 # description. | 93 # description. |
93 | 94 |
94 ALWAYS_DETAILED_SEC = NO | 95 ALWAYS_DETAILED_SEC = NO |
95 | 96 |
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited | 97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
97 # members of a class in the documentation of that class as if those members were | 98 # inherited members of a class in the documentation of that class as if those |
98 # ordinary class members. Constructors, destructors and assignment operators of | 99 # members were ordinary class members. Constructors, destructors and assignment |
99 # the base classes will not be shown. | 100 # operators of the base classes will not be shown. |
100 | 101 |
101 INLINE_INHERITED_MEMB = YES | 102 INLINE_INHERITED_MEMB = YES |
102 | 103 |
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full | 104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
104 # path before files name in the file list and in the header files. If set | 105 # path before files name in the file list and in the header files. If set |
131 SHORT_NAMES = NO | 132 SHORT_NAMES = NO |
132 | 133 |
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen | 134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
134 # will interpret the first line (until the first dot) of a JavaDoc-style | 135 # will interpret the first line (until the first dot) of a JavaDoc-style |
135 # comment as the brief description. If set to NO, the JavaDoc | 136 # comment as the brief description. If set to NO, the JavaDoc |
136 # comments will behave just like the Qt-style comments (thus requiring an | 137 # comments will behave just like regular Qt-style comments |
137 # explicit @brief command for a brief description. | 138 # (thus requiring an explicit @brief command for a brief description.) |
138 | 139 |
139 JAVADOC_AUTOBRIEF = NO | 140 JAVADOC_AUTOBRIEF = NO |
141 | |
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will | |
143 # interpret the first line (until the first dot) of a Qt-style | |
144 # comment as the brief description. If set to NO, the comments | |
145 # will behave just like regular Qt-style comments (thus requiring | |
146 # an explicit \brief command for a brief description.) | |
147 | |
148 QT_AUTOBRIEF = NO | |
140 | 149 |
141 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen | 150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
142 # treat a multi-line C++ special comment block (i.e. a block of //! or /// | 151 # treat a multi-line C++ special comment block (i.e. a block of //! or /// |
143 # comments) as a brief description. This used to be the default behaviour. | 152 # comments) as a brief description. This used to be the default behaviour. |
144 # The new default is to treat a multi-line C++ comment block as a detailed | 153 # The new default is to treat a multi-line C++ comment block as a detailed |
157 # member inherits the documentation from any documented member that it | 166 # member inherits the documentation from any documented member that it |
158 # re-implements. | 167 # re-implements. |
159 | 168 |
160 INHERIT_DOCS = YES | 169 INHERIT_DOCS = YES |
161 | 170 |
162 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | 171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
163 # tag is set to YES, then doxygen will reuse the documentation of the first | 172 # a new page for each member. If set to NO, the documentation of a member will |
164 # member in the group (if any) for the other members of the group. By default | 173 # be part of the file/class/namespace that contains it. |
165 # all members of a group must be documented explicitly. | 174 |
166 | 175 SEPARATE_MEMBER_PAGES = NO |
167 DISTRIBUTE_GROUP_DOC = NO | |
168 | 176 |
169 # The TAB_SIZE tag can be used to set the number of spaces in a tab. | 177 # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
170 # Doxygen uses this value to replace tabs by spaces in code fragments. | 178 # Doxygen uses this value to replace tabs by spaces in code fragments. |
171 | 179 |
172 TAB_SIZE = 8 | 180 TAB_SIZE = 8 |
178 # will result in a user-defined paragraph with heading "Side Effects:". | 186 # will result in a user-defined paragraph with heading "Side Effects:". |
179 # You can put \n's in the value part of an alias to insert newlines. | 187 # You can put \n's in the value part of an alias to insert newlines. |
180 | 188 |
181 ALIASES = | 189 ALIASES = |
182 | 190 |
183 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | 191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
184 # only. Doxygen will then generate output that is more tailored for C. | 192 # sources only. Doxygen will then generate output that is more tailored for C. |
185 # For instance, some of the names that are used will be different. The list | 193 # For instance, some of the names that are used will be different. The list |
186 # of all members will be omitted, etc. | 194 # of all members will be omitted, etc. |
187 | 195 |
188 OPTIMIZE_OUTPUT_FOR_C = NO | 196 OPTIMIZE_OUTPUT_FOR_C = NO |
189 | 197 |
190 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources | 198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
191 # only. Doxygen will then generate output that is more tailored for Java. | 199 # sources only. Doxygen will then generate output that is more tailored for |
192 # For instance, namespaces will be presented as packages, qualified scopes | 200 # Java. For instance, namespaces will be presented as packages, qualified |
193 # will look different, etc. | 201 # scopes will look different, etc. |
194 | 202 |
195 OPTIMIZE_OUTPUT_JAVA = NO | 203 OPTIMIZE_OUTPUT_JAVA = NO |
204 | |
205 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran | |
206 # sources only. Doxygen will then generate output that is more tailored for | |
207 # Fortran. | |
208 | |
209 OPTIMIZE_FOR_FORTRAN = NO | |
210 | |
211 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL | |
212 # sources. Doxygen will then generate output that is tailored for | |
213 # VHDL. | |
214 | |
215 OPTIMIZE_OUTPUT_VHDL = NO | |
216 | |
217 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want | |
218 # to include (a tag file for) the STL sources as input, then you should | |
219 # set this tag to YES in order to let doxygen match functions declarations and | |
220 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. | |
221 # func(std::string) {}). This also make the inheritance and collaboration | |
222 # diagrams that involve STL classes more complete and accurate. | |
223 | |
224 BUILTIN_STL_SUPPORT = NO | |
225 | |
226 # If you use Microsoft's C++/CLI language, you should set this option to YES to | |
227 # enable parsing support. | |
228 | |
229 CPP_CLI_SUPPORT = NO | |
230 | |
231 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. | |
232 # Doxygen will parse them like normal C++ but will assume all classes use public | |
233 # instead of private inheritance when no explicit protection keyword is present. | |
234 | |
235 SIP_SUPPORT = NO | |
236 | |
237 # For Microsoft's IDL there are propget and propput attributes to indicate getter | |
238 # and setter methods for a property. Setting this option to YES (the default) | |
239 # will make doxygen to replace the get and set methods by a property in the | |
240 # documentation. This will only work if the methods are indeed getting or | |
241 # setting a simple type. If this is not the case, or you want to show the | |
242 # methods anyway, you should set this option to NO. | |
243 | |
244 IDL_PROPERTY_SUPPORT = YES | |
245 | |
246 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC | |
247 # tag is set to YES, then doxygen will reuse the documentation of the first | |
248 # member in the group (if any) for the other members of the group. By default | |
249 # all members of a group must be documented explicitly. | |
250 | |
251 DISTRIBUTE_GROUP_DOC = NO | |
196 | 252 |
197 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of | 253 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
198 # the same type (for instance a group of public functions) to be put as a | 254 # the same type (for instance a group of public functions) to be put as a |
199 # subgroup of that type (e.g. under the Public Functions section). Set it to | 255 # subgroup of that type (e.g. under the Public Functions section). Set it to |
200 # NO to prevent subgrouping. Alternatively, this can be done per class using | 256 # NO to prevent subgrouping. Alternatively, this can be done per class using |
201 # the \nosubgrouping command. | 257 # the \nosubgrouping command. |
202 | 258 |
203 SUBGROUPING = YES | 259 SUBGROUPING = YES |
204 | 260 |
261 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum | |
262 # is documented as struct, union, or enum with the name of the typedef. So | |
263 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct | |
264 # with name TypeT. When disabled the typedef will appear as a member of a file, | |
265 # namespace, or class. And the struct will be named TypeS. This can typically | |
266 # be useful for C code in case the coding convention dictates that all compound | |
267 # types are typedef'ed and only the typedef is referenced, never the tag name. | |
268 | |
269 TYPEDEF_HIDES_STRUCT = NO | |
270 | |
205 #--------------------------------------------------------------------------- | 271 #--------------------------------------------------------------------------- |
206 # Build related configuration options | 272 # Build related configuration options |
207 #--------------------------------------------------------------------------- | 273 #--------------------------------------------------------------------------- |
208 | 274 |
209 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in | 275 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
233 # methods, which are defined in the implementation section but not in | 299 # methods, which are defined in the implementation section but not in |
234 # the interface are included in the documentation. | 300 # the interface are included in the documentation. |
235 # If set to NO (the default) only methods in the interface are included. | 301 # If set to NO (the default) only methods in the interface are included. |
236 | 302 |
237 EXTRACT_LOCAL_METHODS = NO | 303 EXTRACT_LOCAL_METHODS = NO |
304 | |
305 # If this flag is set to YES, the members of anonymous namespaces will be | |
306 # extracted and appear in the documentation as a namespace called | |
307 # 'anonymous_namespace{file}', where file will be replaced with the base | |
308 # name of the file that contains the anonymous namespace. By default | |
309 # anonymous namespace are hidden. | |
310 | |
311 EXTRACT_ANON_NSPACES = NO | |
238 | 312 |
239 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all | 313 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
240 # undocumented members of documented classes, files or namespaces. | 314 # undocumented members of documented classes, files or namespaces. |
241 # If set to NO (the default) these members will be included in the | 315 # If set to NO (the default) these members will be included in the |
242 # various overviews, but no documentation section is generated. | 316 # various overviews, but no documentation section is generated. |
274 | 348 |
275 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate | 349 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
276 # file names in lower-case letters. If set to YES upper-case letters are also | 350 # file names in lower-case letters. If set to YES upper-case letters are also |
277 # allowed. This is useful if you have classes or files whose names only differ | 351 # allowed. This is useful if you have classes or files whose names only differ |
278 # in case and if your file system supports case sensitive file names. Windows | 352 # in case and if your file system supports case sensitive file names. Windows |
279 # users are advised to set this option to NO. | 353 # and Mac users are advised to set this option to NO. |
280 | 354 |
281 CASE_SENSE_NAMES = YES | 355 CASE_SENSE_NAMES = YES |
282 | 356 |
283 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen | 357 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
284 # will show members with their full class and namespace scopes in the | 358 # will show members with their full class and namespace scopes in the |
308 # brief documentation of file, namespace and class members alphabetically | 382 # brief documentation of file, namespace and class members alphabetically |
309 # by member name. If set to NO (the default) the members will appear in | 383 # by member name. If set to NO (the default) the members will appear in |
310 # declaration order. | 384 # declaration order. |
311 | 385 |
312 SORT_BRIEF_DOCS = NO | 386 SORT_BRIEF_DOCS = NO |
387 | |
388 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the | |
389 # hierarchy of group names into alphabetical order. If set to NO (the default) | |
390 # the group names will appear in their defined order. | |
391 | |
392 SORT_GROUP_NAMES = NO | |
313 | 393 |
314 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be | 394 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
315 # sorted by fully-qualified names, including namespaces. If set to | 395 # sorted by fully-qualified names, including namespaces. If set to |
316 # NO (the default), the class list will be sorted only by class name, | 396 # NO (the default), the class list will be sorted only by class name, |
317 # not including the namespace part. | 397 # not including the namespace part. |
364 # at the bottom of the documentation of classes and structs. If set to YES the | 444 # at the bottom of the documentation of classes and structs. If set to YES the |
365 # list will mention the files that were used to generate the documentation. | 445 # list will mention the files that were used to generate the documentation. |
366 | 446 |
367 SHOW_USED_FILES = YES | 447 SHOW_USED_FILES = YES |
368 | 448 |
449 # If the sources in your project are distributed over multiple directories | |
450 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy | |
451 # in the documentation. The default is NO. | |
452 | |
453 SHOW_DIRECTORIES = NO | |
454 | |
455 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. | |
456 # This will remove the Files entry from the Quick Index and from the | |
457 # Folder Tree View (if specified). The default is YES. | |
458 | |
459 SHOW_FILES = YES | |
460 | |
461 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the | |
462 # Namespaces page. This will remove the Namespaces entry from the Quick Index | |
463 # and from the Folder Tree View (if specified). The default is YES. | |
464 | |
465 SHOW_NAMESPACES = YES | |
466 | |
467 # The FILE_VERSION_FILTER tag can be used to specify a program or script that | |
468 # doxygen should invoke to get the current version for each file (typically from | |
469 # the version control system). Doxygen will invoke the program by executing (via | |
470 # popen()) the command <command> <input-file>, where <command> is the value of | |
471 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file | |
472 # provided by doxygen. Whatever the program writes to standard output | |
473 # is used as the file version. See the manual for examples. | |
474 | |
475 FILE_VERSION_FILTER = | |
476 | |
369 #--------------------------------------------------------------------------- | 477 #--------------------------------------------------------------------------- |
370 # configuration options related to warning and progress messages | 478 # configuration options related to warning and progress messages |
371 #--------------------------------------------------------------------------- | 479 #--------------------------------------------------------------------------- |
372 | 480 |
373 # The QUIET tag can be used to turn on/off the messages that are generated | 481 # The QUIET tag can be used to turn on/off the messages that are generated |
392 # parameters in a documented function, or documenting parameters that | 500 # parameters in a documented function, or documenting parameters that |
393 # don't exist or using markup commands wrongly. | 501 # don't exist or using markup commands wrongly. |
394 | 502 |
395 WARN_IF_DOC_ERROR = NO | 503 WARN_IF_DOC_ERROR = NO |
396 | 504 |
505 # This WARN_NO_PARAMDOC option can be abled to get warnings for | |
506 # functions that are documented, but have no documentation for their parameters | |
507 # or return value. If set to NO (the default) doxygen will only warn about | |
508 # wrong or incomplete parameter documentation, but not about the absence of | |
509 # documentation. | |
510 | |
511 WARN_NO_PARAMDOC = NO | |
512 | |
397 # The WARN_FORMAT tag determines the format of the warning messages that | 513 # The WARN_FORMAT tag determines the format of the warning messages that |
398 # doxygen can produce. The string should contain the $file, $line, and $text | 514 # doxygen can produce. The string should contain the $file, $line, and $text |
399 # tags, which will be replaced by the file and line number from which the | 515 # tags, which will be replaced by the file and line number from which the |
400 # warning originated and the warning text. | 516 # warning originated and the warning text. Optionally the format may contain |
517 # $version, which will be replaced by the version of the file (if it could | |
518 # be obtained via FILE_VERSION_FILTER) | |
401 | 519 |
402 WARN_FORMAT = "$file:$line: $text" | 520 WARN_FORMAT = "$file:$line: $text" |
403 | 521 |
404 # The WARN_LOGFILE tag can be used to specify a file to which warning | 522 # The WARN_LOGFILE tag can be used to specify a file to which warning |
405 # and error messages should be written. If left blank the output is written | 523 # and error messages should be written. If left blank the output is written |
416 # directories like "/usr/src/myproject". Separate the files or directories | 534 # directories like "/usr/src/myproject". Separate the files or directories |
417 # with spaces. | 535 # with spaces. |
418 | 536 |
419 INPUT = | 537 INPUT = |
420 | 538 |
539 # This tag can be used to specify the character encoding of the source files | |
540 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is | |
541 # also the default input encoding. Doxygen uses libiconv (or the iconv built | |
542 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for | |
543 # the list of possible encodings. | |
544 | |
545 INPUT_ENCODING = UTF-8 | |
546 | |
421 # If the value of the INPUT tag contains directories, you can use the | 547 # If the value of the INPUT tag contains directories, you can use the |
422 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp | 548 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
423 # and *.h) to filter out the source-files in the directories. If left | 549 # and *.h) to filter out the source-files in the directories. If left |
424 # blank the following patterns are tested: | 550 # blank the following patterns are tested: |
425 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp | 551 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
426 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm | 552 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
427 | 553 |
428 FILE_PATTERNS = | 554 FILE_PATTERNS = |
429 | 555 |
430 # The RECURSIVE tag can be used to turn specify whether or not subdirectories | 556 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
431 # should be searched for input files as well. Possible values are YES and NO. | 557 # should be searched for input files as well. Possible values are YES and NO. |
435 | 561 |
436 # The EXCLUDE tag can be used to specify files and/or directories that should | 562 # The EXCLUDE tag can be used to specify files and/or directories that should |
437 # excluded from the INPUT source files. This way you can easily exclude a | 563 # excluded from the INPUT source files. This way you can easily exclude a |
438 # subdirectory from a directory tree whose root is specified with the INPUT tag. | 564 # subdirectory from a directory tree whose root is specified with the INPUT tag. |
439 | 565 |
440 EXCLUDE = DOCS TOOLS ffmpeg libass libdvdcss libdvdnav libdvdread4 libmpeg2 mp3lib stream/freesdp stream/librtsp stream/realrtsp tremor | 566 EXCLUDE = DOCS \ |
441 | 567 TOOLS \ |
442 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories | 568 ffmpeg \ |
443 # that are symbolic links (a Unix filesystem feature) are excluded from the input. | 569 libass \ |
570 libdvdcss \ | |
571 libdvdnav \ | |
572 libdvdread4 \ | |
573 libmpeg2 \ | |
574 mp3lib \ | |
575 stream/freesdp \ | |
576 stream/librtsp \ | |
577 stream/realrtsp \ | |
578 tremor | |
579 | |
580 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or | |
581 # directories that are symbolic links (a Unix filesystem feature) are excluded | |
582 # from the input. | |
444 | 583 |
445 EXCLUDE_SYMLINKS = NO | 584 EXCLUDE_SYMLINKS = NO |
446 | 585 |
447 # If the value of the INPUT tag contains directories, you can use the | 586 # If the value of the INPUT tag contains directories, you can use the |
448 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude | 587 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
449 # certain files from those directories. | 588 # certain files from those directories. Note that the wildcards are matched |
589 # against the file with absolute path, so to exclude all test directories | |
590 # for example use the pattern */test/* | |
450 | 591 |
451 EXCLUDE_PATTERNS = | 592 EXCLUDE_PATTERNS = |
593 | |
594 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names | |
595 # (namespaces, classes, functions, etc.) that should be excluded from the | |
596 # output. The symbol name can be a fully qualified name, a word, or if the | |
597 # wildcard * is used, a substring. Examples: ANamespace, AClass, | |
598 # AClass::ANamespace, ANamespace::*Test | |
599 | |
600 EXCLUDE_SYMBOLS = | |
452 | 601 |
453 # The EXAMPLE_PATH tag can be used to specify one or more files or | 602 # The EXAMPLE_PATH tag can be used to specify one or more files or |
454 # directories that contain example code fragments that are included (see | 603 # directories that contain example code fragments that are included (see |
455 # the \include command). | 604 # the \include command). |
456 | 605 |
479 # The INPUT_FILTER tag can be used to specify a program that doxygen should | 628 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
480 # invoke to filter for each input file. Doxygen will invoke the filter program | 629 # invoke to filter for each input file. Doxygen will invoke the filter program |
481 # by executing (via popen()) the command <filter> <input-file>, where <filter> | 630 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
482 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an | 631 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
483 # input file. Doxygen will then use the output that the filter program writes | 632 # input file. Doxygen will then use the output that the filter program writes |
484 # to standard output. | 633 # to standard output. If FILTER_PATTERNS is specified, this tag will be |
634 # ignored. | |
485 | 635 |
486 INPUT_FILTER = | 636 INPUT_FILTER = |
637 | |
638 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern | |
639 # basis. Doxygen will compare the file name with each pattern and apply the | |
640 # filter if there is a match. The filters are a list of the form: | |
641 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further | |
642 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER | |
643 # is applied to all files. | |
644 | |
645 FILTER_PATTERNS = | |
487 | 646 |
488 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using | 647 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
489 # INPUT_FILTER) will be used to filter the input files when producing source | 648 # INPUT_FILTER) will be used to filter the input files when producing source |
490 # files to browse (i.e. when SOURCE_BROWSER is set to YES). | 649 # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
491 | 650 |
511 # doxygen to hide any special comment blocks from generated source code | 670 # doxygen to hide any special comment blocks from generated source code |
512 # fragments. Normal C and C++ comments will always remain visible. | 671 # fragments. Normal C and C++ comments will always remain visible. |
513 | 672 |
514 STRIP_CODE_COMMENTS = YES | 673 STRIP_CODE_COMMENTS = YES |
515 | 674 |
516 # If the REFERENCED_BY_RELATION tag is set to YES (the default) | 675 # If the REFERENCED_BY_RELATION tag is set to YES |
517 # then for each documented function all documented | 676 # then for each documented function all documented |
518 # functions referencing it will be listed. | 677 # functions referencing it will be listed. |
519 | 678 |
520 REFERENCED_BY_RELATION = YES | 679 REFERENCED_BY_RELATION = YES |
521 | 680 |
522 # If the REFERENCES_RELATION tag is set to YES (the default) | 681 # If the REFERENCES_RELATION tag is set to YES |
523 # then for each documented function all documented entities | 682 # then for each documented function all documented entities |
524 # called/used by that function will be listed. | 683 # called/used by that function will be listed. |
525 | 684 |
526 REFERENCES_RELATION = YES | 685 REFERENCES_RELATION = YES |
686 | |
687 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) | |
688 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from | |
689 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will | |
690 # link to the source code. Otherwise they will link to the documentstion. | |
691 | |
692 REFERENCES_LINK_SOURCE = YES | |
693 | |
694 # If the USE_HTAGS tag is set to YES then the references to source code | |
695 # will point to the HTML generated by the htags(1) tool instead of doxygen | |
696 # built-in source browser. The htags tool is part of GNU's global source | |
697 # tagging system (see http://www.gnu.org/software/global/global.html). You | |
698 # will need version 4.8.6 or higher. | |
699 | |
700 USE_HTAGS = NO | |
527 | 701 |
528 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen | 702 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
529 # will generate a verbatim copy of the header file for each class for | 703 # will generate a verbatim copy of the header file for each class for |
530 # which an include is specified. Set to NO to disable this. | 704 # which an include is specified. Set to NO to disable this. |
531 | 705 |
602 | 776 |
603 HTML_ALIGN_MEMBERS = YES | 777 HTML_ALIGN_MEMBERS = YES |
604 | 778 |
605 # If the GENERATE_HTMLHELP tag is set to YES, additional index files | 779 # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
606 # will be generated that can be used as input for tools like the | 780 # will be generated that can be used as input for tools like the |
607 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) | 781 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
608 # of the generated HTML documentation. | 782 # of the generated HTML documentation. |
609 | 783 |
610 GENERATE_HTMLHELP = NO | 784 GENERATE_HTMLHELP = NO |
785 | |
786 # If the GENERATE_DOCSET tag is set to YES, additional index files | |
787 # will be generated that can be used as input for Apple's Xcode 3 | |
788 # integrated development environment, introduced with OSX 10.5 (Leopard). | |
789 # To create a documentation set, doxygen will generate a Makefile in the | |
790 # HTML output directory. Running make will produce the docset in that | |
791 # directory and running "make install" will install the docset in | |
792 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find | |
793 # it at startup. | |
794 | |
795 GENERATE_DOCSET = NO | |
796 | |
797 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the | |
798 # feed. A documentation feed provides an umbrella under which multiple | |
799 # documentation sets from a single provider (such as a company or product suite) | |
800 # can be grouped. | |
801 | |
802 DOCSET_FEEDNAME = "Doxygen generated docs" | |
803 | |
804 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that | |
805 # should uniquely identify the documentation set bundle. This should be a | |
806 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen | |
807 # will append .docset to the name. | |
808 | |
809 DOCSET_BUNDLE_ID = org.doxygen.Project | |
810 | |
811 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML | |
812 # documentation will contain sections that can be hidden and shown after the | |
813 # page has loaded. For this to work a browser that supports | |
814 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox | |
815 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). | |
816 | |
817 HTML_DYNAMIC_SECTIONS = NO | |
611 | 818 |
612 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can | 819 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
613 # be used to specify the file name of the resulting .chm file. You | 820 # be used to specify the file name of the resulting .chm file. You |
614 # can add a path in front of the file if the result should not be | 821 # can add a path in front of the file if the result should not be |
615 # written to the html output directory. | 822 # written to the html output directory. |
627 # controls if a separate .chi index file is generated (YES) or that | 834 # controls if a separate .chi index file is generated (YES) or that |
628 # it should be included in the master .chm file (NO). | 835 # it should be included in the master .chm file (NO). |
629 | 836 |
630 GENERATE_CHI = NO | 837 GENERATE_CHI = NO |
631 | 838 |
839 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING | |
840 # is used to encode HtmlHelp index (hhk), content (hhc) and project file | |
841 # content. | |
842 | |
843 CHM_INDEX_ENCODING = | |
844 | |
632 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag | 845 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
633 # controls whether a binary table of contents is generated (YES) or a | 846 # controls whether a binary table of contents is generated (YES) or a |
634 # normal table of contents (NO) in the .chm file. | 847 # normal table of contents (NO) in the .chm file. |
635 | 848 |
636 BINARY_TOC = NO | 849 BINARY_TOC = NO |
649 # This tag can be used to set the number of enum values (range [1..20]) | 862 # This tag can be used to set the number of enum values (range [1..20]) |
650 # that doxygen will group on one line in the generated HTML documentation. | 863 # that doxygen will group on one line in the generated HTML documentation. |
651 | 864 |
652 ENUM_VALUES_PER_LINE = 4 | 865 ENUM_VALUES_PER_LINE = 4 |
653 | 866 |
654 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be | 867 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
655 # generated containing a tree-like index structure (just like the one that | 868 # structure should be generated to display hierarchical information. |
869 # If the tag value is set to FRAME, a side panel will be generated | |
870 # containing a tree-like index structure (just like the one that | |
656 # is generated for HTML Help). For this to work a browser that supports | 871 # is generated for HTML Help). For this to work a browser that supports |
657 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, | 872 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
658 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are | 873 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
659 # probably better off using the HTML help feature. | 874 # probably better off using the HTML help feature. Other possible values |
875 # for this tag are: HIERARCHIES, which will generate the Groups, Directories, | |
876 # and Class Hiererachy pages using a tree view instead of an ordered list; | |
877 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which | |
878 # disables this behavior completely. For backwards compatibility with previous | |
879 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE | |
880 # respectively. | |
660 | 881 |
661 GENERATE_TREEVIEW = NO | 882 GENERATE_TREEVIEW = NO |
662 | 883 |
663 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be | 884 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
664 # used to set the initial width (in pixels) of the frame in which the tree | 885 # used to set the initial width (in pixels) of the frame in which the tree |
665 # is shown. | 886 # is shown. |
666 | 887 |
667 TREEVIEW_WIDTH = 250 | 888 TREEVIEW_WIDTH = 250 |
889 | |
890 # Use this tag to change the font size of Latex formulas included | |
891 # as images in the HTML documentation. The default is 10. Note that | |
892 # when you change the font size after a successful doxygen run you need | |
893 # to manually remove any form_*.png images from the HTML output directory | |
894 # to force them to be regenerated. | |
895 | |
896 FORMULA_FONTSIZE = 10 | |
668 | 897 |
669 #--------------------------------------------------------------------------- | 898 #--------------------------------------------------------------------------- |
670 # configuration options related to the LaTeX output | 899 # configuration options related to the LaTeX output |
671 #--------------------------------------------------------------------------- | 900 #--------------------------------------------------------------------------- |
672 | 901 |
909 | 1138 |
910 MACRO_EXPANSION = NO | 1139 MACRO_EXPANSION = NO |
911 | 1140 |
912 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES | 1141 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
913 # then the macro expansion is limited to the macros specified with the | 1142 # then the macro expansion is limited to the macros specified with the |
914 # PREDEFINED and EXPAND_AS_PREDEFINED tags. | 1143 # PREDEFINED and EXPAND_AS_DEFINED tags. |
915 | 1144 |
916 EXPAND_ONLY_PREDEF = NO | 1145 EXPAND_ONLY_PREDEF = NO |
917 | 1146 |
918 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files | 1147 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
919 # in the INCLUDE_PATH (see below) will be search if a #include is found. | 1148 # in the INCLUDE_PATH (see below) will be search if a #include is found. |
935 | 1164 |
936 # The PREDEFINED tag can be used to specify one or more macro names that | 1165 # The PREDEFINED tag can be used to specify one or more macro names that |
937 # are defined before the preprocessor is started (similar to the -D option of | 1166 # are defined before the preprocessor is started (similar to the -D option of |
938 # gcc). The argument of the tag is a list of macros of the form: name | 1167 # gcc). The argument of the tag is a list of macros of the form: name |
939 # or name=definition (no spaces). If the definition and the = are | 1168 # or name=definition (no spaces). If the definition and the = are |
940 # omitted =1 is assumed. | 1169 # omitted =1 is assumed. To prevent a macro definition from being |
1170 # undefined via #undef or recursively expanded use the := operator | |
1171 # instead of the = operator. | |
941 | 1172 |
942 PREDEFINED = | 1173 PREDEFINED = |
943 | 1174 |
944 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then | 1175 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
945 # this tag can be used to specify a list of macro names that should be expanded. | 1176 # this tag can be used to specify a list of macro names that should be expanded. |
949 EXPAND_AS_DEFINED = | 1180 EXPAND_AS_DEFINED = |
950 | 1181 |
951 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then | 1182 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
952 # doxygen's preprocessor will remove all function-like macros that are alone | 1183 # doxygen's preprocessor will remove all function-like macros that are alone |
953 # on a line, have an all uppercase name, and do not end with a semicolon. Such | 1184 # on a line, have an all uppercase name, and do not end with a semicolon. Such |
954 # function macros are typically used for boiler-plate code, and will confuse the | 1185 # function macros are typically used for boiler-plate code, and will confuse |
955 # parser if not removed. | 1186 # the parser if not removed. |
956 | 1187 |
957 SKIP_FUNCTION_MACROS = YES | 1188 SKIP_FUNCTION_MACROS = YES |
958 | 1189 |
959 #--------------------------------------------------------------------------- | 1190 #--------------------------------------------------------------------------- |
960 # Configuration::additions related to external references | 1191 # Configuration::additions related to external references |
1002 #--------------------------------------------------------------------------- | 1233 #--------------------------------------------------------------------------- |
1003 # Configuration options related to the dot tool | 1234 # Configuration options related to the dot tool |
1004 #--------------------------------------------------------------------------- | 1235 #--------------------------------------------------------------------------- |
1005 | 1236 |
1006 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will | 1237 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
1007 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or | 1238 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
1008 # super classes. Setting the tag to NO turns the diagrams off. Note that this | 1239 # or super classes. Setting the tag to NO turns the diagrams off. Note that |
1009 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is | 1240 # this option is superseded by the HAVE_DOT option below. This is only a |
1010 # recommended to install and use dot, since it yields more powerful graphs. | 1241 # fallback. It is recommended to install and use dot, since it yields more |
1242 # powerful graphs. | |
1011 | 1243 |
1012 CLASS_DIAGRAMS = NO | 1244 CLASS_DIAGRAMS = NO |
1245 | |
1246 # You can define message sequence charts within doxygen comments using the \msc | |
1247 # command. Doxygen will then run the mscgen tool (see | |
1248 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the | |
1249 # documentation. The MSCGEN_PATH tag allows you to specify the directory where | |
1250 # the mscgen tool resides. If left empty the tool is assumed to be found in the | |
1251 # default search path. | |
1252 | |
1253 MSCGEN_PATH = | |
1013 | 1254 |
1014 # If set to YES, the inheritance and collaboration graphs will hide | 1255 # If set to YES, the inheritance and collaboration graphs will hide |
1015 # inheritance and usage relations if the target is undocumented | 1256 # inheritance and usage relations if the target is undocumented |
1016 # or is not a class. | 1257 # or is not a class. |
1017 | 1258 |
1022 # toolkit from AT&T and Lucent Bell Labs. The other options in this section | 1263 # toolkit from AT&T and Lucent Bell Labs. The other options in this section |
1023 # have no effect if this option is set to NO (the default) | 1264 # have no effect if this option is set to NO (the default) |
1024 | 1265 |
1025 HAVE_DOT = NO | 1266 HAVE_DOT = NO |
1026 | 1267 |
1268 # By default doxygen will write a font called FreeSans.ttf to the output | |
1269 # directory and reference it in all dot files that doxygen generates. This | |
1270 # font does not include all possible unicode characters however, so when you need | |
1271 # these (or just want a differently looking font) you can specify the font name | |
1272 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, | |
1273 # which can be done by putting it in a standard location or by setting the | |
1274 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory | |
1275 # containing the font. | |
1276 | |
1277 DOT_FONTNAME = FreeSans | |
1278 | |
1279 # By default doxygen will tell dot to use the output directory to look for the | |
1280 # FreeSans.ttf font (which doxygen will put there itself). If you specify a | |
1281 # different font using DOT_FONTNAME you can set the path where dot | |
1282 # can find it using this tag. | |
1283 | |
1284 DOT_FONTPATH = | |
1285 | |
1027 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen | 1286 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1028 # will generate a graph for each documented class showing the direct and | 1287 # will generate a graph for each documented class showing the direct and |
1029 # indirect inheritance relations. Setting this tag to YES will force the | 1288 # indirect inheritance relations. Setting this tag to YES will force the |
1030 # the CLASS_DIAGRAMS tag to NO. | 1289 # the CLASS_DIAGRAMS tag to NO. |
1031 | 1290 |
1036 # indirect implementation dependencies (inheritance, containment, and | 1295 # indirect implementation dependencies (inheritance, containment, and |
1037 # class references variables) of the class with other documented classes. | 1296 # class references variables) of the class with other documented classes. |
1038 | 1297 |
1039 COLLABORATION_GRAPH = YES | 1298 COLLABORATION_GRAPH = YES |
1040 | 1299 |
1300 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen | |
1301 # will generate a graph for groups, showing the direct groups dependencies | |
1302 | |
1303 GROUP_GRAPHS = YES | |
1304 | |
1041 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and | 1305 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
1042 # collaboration diagrams in a style similar to the OMG's Unified Modeling | 1306 # collaboration diagrams in a style similar to the OMG's Unified Modeling |
1043 # Language. | 1307 # Language. |
1044 | 1308 |
1045 UML_LOOK = NO | 1309 UML_LOOK = NO |
1061 # documented header file showing the documented files that directly or | 1325 # documented header file showing the documented files that directly or |
1062 # indirectly include this file. | 1326 # indirectly include this file. |
1063 | 1327 |
1064 INCLUDED_BY_GRAPH = YES | 1328 INCLUDED_BY_GRAPH = YES |
1065 | 1329 |
1066 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will | 1330 # If the CALL_GRAPH and HAVE_DOT options are set to YES then |
1067 # generate a call dependency graph for every global function or class method. | 1331 # doxygen will generate a call dependency graph for every global function |
1068 # Note that enabling this option will significantly increase the time of a run. | 1332 # or class method. Note that enabling this option will significantly increase |
1069 # So in most cases it will be better to enable call graphs for selected | 1333 # the time of a run. So in most cases it will be better to enable call graphs |
1070 # functions only using the \callgraph command. | 1334 # for selected functions only using the \callgraph command. |
1071 | 1335 |
1072 CALL_GRAPH = NO | 1336 CALL_GRAPH = NO |
1337 | |
1338 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then | |
1339 # doxygen will generate a caller dependency graph for every global function | |
1340 # or class method. Note that enabling this option will significantly increase | |
1341 # the time of a run. So in most cases it will be better to enable caller | |
1342 # graphs for selected functions only using the \callergraph command. | |
1343 | |
1344 CALLER_GRAPH = NO | |
1073 | 1345 |
1074 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen | 1346 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
1075 # will graphical hierarchy of all classes instead of a textual one. | 1347 # will graphical hierarchy of all classes instead of a textual one. |
1076 | 1348 |
1077 GRAPHICAL_HIERARCHY = YES | 1349 GRAPHICAL_HIERARCHY = YES |
1350 | |
1351 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES | |
1352 # then doxygen will show the dependencies a directory has on other directories | |
1353 # in a graphical way. The dependency relations are determined by the #include | |
1354 # relations between the files in the directories. | |
1355 | |
1356 DIRECTORY_GRAPH = YES | |
1078 | 1357 |
1079 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | 1358 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
1080 # generated by dot. Possible values are png, jpg, or gif | 1359 # generated by dot. Possible values are png, jpg, or gif |
1081 # If left blank png will be used. | 1360 # If left blank png will be used. |
1082 | 1361 |
1083 DOT_IMAGE_FORMAT = png | 1362 DOT_IMAGE_FORMAT = png |
1084 | 1363 |
1085 # The tag DOT_PATH can be used to specify the path where the dot tool can be | 1364 # The tag DOT_PATH can be used to specify the path where the dot tool can be |
1086 # found. If left blank, it is assumed the dot tool can be found on the path. | 1365 # found. If left blank, it is assumed the dot tool can be found in the path. |
1087 | 1366 |
1088 DOT_PATH = | 1367 DOT_PATH = |
1089 | 1368 |
1090 # The DOTFILE_DIRS tag can be used to specify one or more directories that | 1369 # The DOTFILE_DIRS tag can be used to specify one or more directories that |
1091 # contain dot files that are included in the documentation (see the | 1370 # contain dot files that are included in the documentation (see the |
1092 # \dotfile command). | 1371 # \dotfile command). |
1093 | 1372 |
1094 DOTFILE_DIRS = | 1373 DOTFILE_DIRS = |
1095 | 1374 |
1096 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width | 1375 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
1097 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | 1376 # nodes that will be shown in the graph. If the number of nodes in a graph |
1098 # this value, doxygen will try to truncate the graph, so that it fits within | 1377 # becomes larger than this value, doxygen will truncate the graph, which is |
1099 # the specified constraint. Beware that most browsers cannot cope with very | 1378 # visualized by representing a node as a red box. Note that doxygen if the |
1100 # large images. | 1379 # number of direct children of the root node in a graph is already larger than |
1101 | 1380 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
1102 MAX_DOT_GRAPH_WIDTH = 1024 | 1381 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
1103 | 1382 |
1104 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height | 1383 DOT_GRAPH_MAX_NODES = 50 |
1105 # (in pixels) of the graphs generated by dot. If a graph becomes larger than | |
1106 # this value, doxygen will try to truncate the graph, so that it fits within | |
1107 # the specified constraint. Beware that most browsers cannot cope with very | |
1108 # large images. | |
1109 | |
1110 MAX_DOT_GRAPH_HEIGHT = 1024 | |
1111 | 1384 |
1112 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the | 1385 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
1113 # graphs generated by dot. A depth value of 3 means that only nodes reachable | 1386 # graphs generated by dot. A depth value of 3 means that only nodes reachable |
1114 # from the root by following a path via at most 3 edges will be shown. Nodes that | 1387 # from the root by following a path via at most 3 edges will be shown. Nodes |
1115 # lay further from the root node will be omitted. Note that setting this option to | 1388 # that lay further from the root node will be omitted. Note that setting this |
1116 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also | 1389 # option to 1 or 2 may greatly reduce the computation time needed for large |
1117 # note that a graph may be further truncated if the graph's image dimensions are | 1390 # code bases. Also note that the size of a graph can be further restricted by |
1118 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). | 1391 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
1119 # If 0 is used for the depth value (the default), the graph is not depth-constrained. | |
1120 | 1392 |
1121 MAX_DOT_GRAPH_DEPTH = 0 | 1393 MAX_DOT_GRAPH_DEPTH = 0 |
1394 | |
1395 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | |
1396 # background. This is enabled by default, which results in a transparent | |
1397 # background. Warning: Depending on the platform used, enabling this option | |
1398 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they | |
1399 # become hard to read). | |
1400 | |
1401 DOT_TRANSPARENT = YES | |
1402 | |
1403 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output | |
1404 # files in one run (i.e. multiple -o and -T options on the command line). This | |
1405 # makes dot run faster, but since only newer versions of dot (>1.8.10) | |
1406 # support this, this feature is disabled by default. | |
1407 | |
1408 DOT_MULTI_TARGETS = NO | |
1122 | 1409 |
1123 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will | 1410 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
1124 # generate a legend page explaining the meaning of the various boxes and | 1411 # generate a legend page explaining the meaning of the various boxes and |
1125 # arrows in the dot generated graphs. | 1412 # arrows in the dot generated graphs. |
1126 | 1413 |