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