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