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