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