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