Add an "Asterisk Architecture Overview" section to the doxygen documentation.
[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 Telephony Project"
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                          include/asterisk/doxygen \
479                          main \
480                          main/stdtime \
481                          pbx \
482                          res \
483                          res/ael \
484                          res/ais \
485                          res/snmp
486
487 # This tag can be used to specify the character encoding of the source files that 
488 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
489 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
490 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
491
492 INPUT_ENCODING         = UTF-8
493
494 # If the value of the INPUT tag contains directories, you can use the 
495 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
496 # and *.h) to filter out the source-files in the directories. If left 
497 # blank the following patterns are tested: 
498 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
499 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
500
501 FILE_PATTERNS          = *.c \
502                          *.h
503
504 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
505 # should be searched for input files as well. Possible values are YES and NO. 
506 # If left blank NO is used.
507
508 RECURSIVE              = NO
509
510 # The EXCLUDE tag can be used to specify files and/or directories that should 
511 # excluded from the INPUT source files. This way you can easily exclude a 
512 # subdirectory from a directory tree whose root is specified with the INPUT tag.
513
514 EXCLUDE                = 
515
516 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
517 # directories that are symbolic links (a Unix filesystem feature) are excluded 
518 # from the input.
519
520 EXCLUDE_SYMLINKS       = NO
521
522 # If the value of the INPUT tag contains directories, you can use the 
523 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
524 # certain files from those directories. Note that the wildcards are matched 
525 # against the file with absolute path, so to exclude all test directories 
526 # for example use the pattern */test/*
527
528 EXCLUDE_PATTERNS       = 
529
530 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
531 # (namespaces, classes, functions, etc.) that should be excluded from the output. 
532 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 
533 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
534
535 EXCLUDE_SYMBOLS        = 
536
537 # The EXAMPLE_PATH tag can be used to specify one or more files or 
538 # directories that contain example code fragments that are included (see 
539 # the \include command).
540
541 EXAMPLE_PATH           = ./ \
542                          doc \
543                          configs
544
545 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
546 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
547 # and *.h) to filter out the source-files in the directories. If left 
548 # blank all files are included.
549
550 EXAMPLE_PATTERNS       = 
551
552 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
553 # searched for input files to be used with the \include or \dontinclude 
554 # commands irrespective of the value of the RECURSIVE tag. 
555 # Possible values are YES and NO. If left blank NO is used.
556
557 EXAMPLE_RECURSIVE      = NO
558
559 # The IMAGE_PATH tag can be used to specify one or more files or 
560 # directories that contain image that are included in the documentation (see 
561 # the \image command).
562
563 IMAGE_PATH             = images
564
565 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
566 # invoke to filter for each input file. Doxygen will invoke the filter program 
567 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
568 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
569 # input file. Doxygen will then use the output that the filter program writes 
570 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
571 # ignored.
572
573 INPUT_FILTER           = 
574
575 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
576 # basis.  Doxygen will compare the file name with each pattern and apply the 
577 # filter if there is a match.  The filters are a list of the form: 
578 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
579 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
580 # is applied to all files.
581
582 FILTER_PATTERNS        = 
583
584 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
585 # INPUT_FILTER) will be used to filter the input files when producing source 
586 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
587
588 FILTER_SOURCE_FILES    = NO
589
590 #---------------------------------------------------------------------------
591 # configuration options related to source browsing
592 #---------------------------------------------------------------------------
593
594 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
595 # be generated. Documented entities will be cross-referenced with these sources. 
596 # Note: To get rid of all source code in the generated output, make sure also 
597 # VERBATIM_HEADERS is set to NO.
598
599 SOURCE_BROWSER         = YES
600
601 # Setting the INLINE_SOURCES tag to YES will include the body 
602 # of functions and classes directly in the documentation.
603
604 INLINE_SOURCES         = YES
605
606 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
607 # doxygen to hide any special comment blocks from generated source code 
608 # fragments. Normal C and C++ comments will always remain visible.
609
610 STRIP_CODE_COMMENTS    = NO
611
612 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 
613 # then for each documented function all documented 
614 # functions referencing it will be listed.
615
616 REFERENCED_BY_RELATION = YES
617
618 # If the REFERENCES_RELATION tag is set to YES (the default) 
619 # then for each documented function all documented entities 
620 # called/used by that function will be listed.
621
622 REFERENCES_RELATION    = YES
623
624 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
625 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
626 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
627 # link to the source code.  Otherwise they will link to the documentstion.
628
629 REFERENCES_LINK_SOURCE = YES
630
631 # If the USE_HTAGS tag is set to YES then the references to source code 
632 # will point to the HTML generated by the htags(1) tool instead of doxygen 
633 # built-in source browser. The htags tool is part of GNU's global source 
634 # tagging system (see http://www.gnu.org/software/global/global.html). You 
635 # will need version 4.8.6 or higher.
636
637 USE_HTAGS              = NO
638
639 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
640 # will generate a verbatim copy of the header file for each class for 
641 # which an include is specified. Set to NO to disable this.
642
643 VERBATIM_HEADERS       = YES
644
645 #---------------------------------------------------------------------------
646 # configuration options related to the alphabetical class index
647 #---------------------------------------------------------------------------
648
649 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
650 # of all compounds will be generated. Enable this if the project 
651 # contains a lot of classes, structs, unions or interfaces.
652
653 ALPHABETICAL_INDEX     = YES
654
655 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
656 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
657 # in which this list will be split (can be a number in the range [1..20])
658
659 COLS_IN_ALPHA_INDEX    = 5
660
661 # In case all classes in a project start with a common prefix, all 
662 # classes will be put under the same header in the alphabetical index. 
663 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
664 # should be ignored while generating the index headers.
665
666 IGNORE_PREFIX          = 
667
668 #---------------------------------------------------------------------------
669 # configuration options related to the HTML output
670 #---------------------------------------------------------------------------
671
672 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
673 # generate HTML output.
674
675 GENERATE_HTML          = YES
676
677 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
678 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
679 # put in front of it. If left blank `html' will be used as the default path.
680
681 HTML_OUTPUT            = 
682
683 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
684 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
685 # doxygen will generate files with .html extension.
686
687 HTML_FILE_EXTENSION    = .html
688
689 # The HTML_HEADER tag can be used to specify a personal HTML header for 
690 # each generated HTML page. If it is left blank doxygen will generate a 
691 # standard header.
692
693 HTML_HEADER            = contrib/asterisk-doxygen-header
694
695 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
696 # each generated HTML page. If it is left blank doxygen will generate a 
697 # standard footer.
698
699 HTML_FOOTER            = 
700
701 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
702 # style sheet that is used by each HTML page. It can be used to 
703 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
704 # will generate a default style sheet. Note that doxygen will try to copy 
705 # the style sheet file to the HTML output directory, so don't put your own 
706 # stylesheet in the HTML output directory as well, or it will be erased!
707
708 HTML_STYLESHEET        = 
709
710 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
711 # files or namespaces will be aligned in HTML using tables. If set to 
712 # NO a bullet list will be used.
713
714 HTML_ALIGN_MEMBERS     = YES
715
716 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
717 # will be generated that can be used as input for tools like the 
718 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
719 # of the generated HTML documentation.
720
721 GENERATE_HTMLHELP      = NO
722
723 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
724 # be used to specify the file name of the resulting .chm file. You 
725 # can add a path in front of the file if the result should not be 
726 # written to the html output directory.
727
728 CHM_FILE               = 
729
730 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
731 # be used to specify the location (absolute path including file name) of 
732 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
733 # the HTML help compiler on the generated index.hhp.
734
735 HHC_LOCATION           = 
736
737 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
738 # controls if a separate .chi index file is generated (YES) or that 
739 # it should be included in the master .chm file (NO).
740
741 GENERATE_CHI           = NO
742
743 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
744 # controls whether a binary table of contents is generated (YES) or a 
745 # normal table of contents (NO) in the .chm file.
746
747 BINARY_TOC             = NO
748
749 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
750 # to the contents of the HTML help documentation and to the tree view.
751
752 TOC_EXPAND             = NO
753
754 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
755 # top of each HTML page. The value NO (the default) enables the index and 
756 # the value YES disables it.
757
758 DISABLE_INDEX          = NO
759
760 # This tag can be used to set the number of enum values (range [1..20]) 
761 # that doxygen will group on one line in the generated HTML documentation.
762
763 ENUM_VALUES_PER_LINE   = 4
764
765 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
766 # generated containing a tree-like index structure (just like the one that 
767 # is generated for HTML Help). For this to work a browser that supports 
768 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
769 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
770 # probably better off using the HTML help feature.
771
772 GENERATE_TREEVIEW      = YES
773
774 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
775 # used to set the initial width (in pixels) of the frame in which the tree 
776 # is shown.
777
778 TREEVIEW_WIDTH         = 250
779
780 #---------------------------------------------------------------------------
781 # configuration options related to the LaTeX output
782 #---------------------------------------------------------------------------
783
784 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
785 # generate Latex output.
786
787 GENERATE_LATEX         = NO
788
789 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
790 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
791 # put in front of it. If left blank `latex' will be used as the default path.
792
793 LATEX_OUTPUT           = 
794
795 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
796 # invoked. If left blank `latex' will be used as the default command name.
797
798 LATEX_CMD_NAME         = latex
799
800 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
801 # generate index for LaTeX. If left blank `makeindex' will be used as the 
802 # default command name.
803
804 MAKEINDEX_CMD_NAME     = makeindex
805
806 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
807 # LaTeX documents. This may be useful for small projects and may help to 
808 # save some trees in general.
809
810 COMPACT_LATEX          = NO
811
812 # The PAPER_TYPE tag can be used to set the paper type that is used 
813 # by the printer. Possible values are: a4, a4wide, letter, legal and 
814 # executive. If left blank a4wide will be used.
815
816 PAPER_TYPE             = a4wide
817
818 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
819 # packages that should be included in the LaTeX output.
820
821 EXTRA_PACKAGES         = 
822
823 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
824 # the generated latex document. The header should contain everything until 
825 # the first chapter. If it is left blank doxygen will generate a 
826 # standard header. Notice: only use this tag if you know what you are doing!
827
828 LATEX_HEADER           = 
829
830 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
831 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
832 # contain links (just like the HTML output) instead of page references 
833 # This makes the output suitable for online browsing using a pdf viewer.
834
835 PDF_HYPERLINKS         = NO
836
837 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
838 # plain latex in the generated Makefile. Set this option to YES to get a 
839 # higher quality PDF documentation.
840
841 USE_PDFLATEX           = NO
842
843 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
844 # command to the generated LaTeX files. This will instruct LaTeX to keep 
845 # running if errors occur, instead of asking the user for help. 
846 # This option is also used when generating formulas in HTML.
847
848 LATEX_BATCHMODE        = NO
849
850 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
851 # include the index chapters (such as File Index, Compound Index, etc.) 
852 # in the output.
853
854 LATEX_HIDE_INDICES     = NO
855
856 #---------------------------------------------------------------------------
857 # configuration options related to the RTF output
858 #---------------------------------------------------------------------------
859
860 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
861 # The RTF output is optimized for Word 97 and may not look very pretty with 
862 # other RTF readers or editors.
863
864 GENERATE_RTF           = NO
865
866 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
867 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
868 # put in front of it. If left blank `rtf' will be used as the default path.
869
870 RTF_OUTPUT             = 
871
872 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
873 # RTF documents. This may be useful for small projects and may help to 
874 # save some trees in general.
875
876 COMPACT_RTF            = NO
877
878 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
879 # will contain hyperlink fields. The RTF file will 
880 # contain links (just like the HTML output) instead of page references. 
881 # This makes the output suitable for online browsing using WORD or other 
882 # programs which support those fields. 
883 # Note: wordpad (write) and others do not support links.
884
885 RTF_HYPERLINKS         = NO
886
887 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
888 # config file, i.e. a series of assignments. You only have to provide 
889 # replacements, missing definitions are set to their default value.
890
891 RTF_STYLESHEET_FILE    = 
892
893 # Set optional variables used in the generation of an rtf document. 
894 # Syntax is similar to doxygen's config file.
895
896 RTF_EXTENSIONS_FILE    = 
897
898 #---------------------------------------------------------------------------
899 # configuration options related to the man page output
900 #---------------------------------------------------------------------------
901
902 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
903 # generate man pages
904
905 GENERATE_MAN           = NO
906
907 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
908 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
909 # put in front of it. If left blank `man' will be used as the default path.
910
911 MAN_OUTPUT             = 
912
913 # The MAN_EXTENSION tag determines the extension that is added to 
914 # the generated man pages (default is the subroutine's section .3)
915
916 MAN_EXTENSION          = 
917
918 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
919 # then it will generate one additional man file for each entity 
920 # documented in the real man page(s). These additional files 
921 # only source the real man page, but without them the man command 
922 # would be unable to find the correct page. The default is NO.
923
924 MAN_LINKS              = NO
925
926 #---------------------------------------------------------------------------
927 # configuration options related to the XML output
928 #---------------------------------------------------------------------------
929
930 # If the GENERATE_XML tag is set to YES Doxygen will 
931 # generate an XML file that captures the structure of 
932 # the code including all documentation.
933
934 GENERATE_XML           = NO
935
936 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
937 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
938 # put in front of it. If left blank `xml' will be used as the default path.
939
940 XML_OUTPUT             = xml
941
942 # The XML_SCHEMA tag can be used to specify an XML schema, 
943 # which can be used by a validating XML parser to check the 
944 # syntax of the XML files.
945
946 XML_SCHEMA             = 
947
948 # The XML_DTD tag can be used to specify an XML DTD, 
949 # which can be used by a validating XML parser to check the 
950 # syntax of the XML files.
951
952 XML_DTD                = 
953
954 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
955 # dump the program listings (including syntax highlighting 
956 # and cross-referencing information) to the XML output. Note that 
957 # enabling this will significantly increase the size of the XML output.
958
959 XML_PROGRAMLISTING     = YES
960
961 #---------------------------------------------------------------------------
962 # configuration options for the AutoGen Definitions output
963 #---------------------------------------------------------------------------
964
965 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
966 # generate an AutoGen Definitions (see autogen.sf.net) file 
967 # that captures the structure of the code including all 
968 # documentation. Note that this feature is still experimental 
969 # and incomplete at the moment.
970
971 GENERATE_AUTOGEN_DEF   = NO
972
973 #---------------------------------------------------------------------------
974 # configuration options related to the Perl module output
975 #---------------------------------------------------------------------------
976
977 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
978 # generate a Perl module file that captures the structure of 
979 # the code including all documentation. Note that this 
980 # feature is still experimental and incomplete at the 
981 # moment.
982
983 GENERATE_PERLMOD       = NO
984
985 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
986 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
987 # to generate PDF and DVI output from the Perl module output.
988
989 PERLMOD_LATEX          = NO
990
991 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
992 # nicely formatted so it can be parsed by a human reader.  This is useful 
993 # if you want to understand what is going on.  On the other hand, if this 
994 # tag is set to NO the size of the Perl module output will be much smaller 
995 # and Perl will parse it just the same.
996
997 PERLMOD_PRETTY         = YES
998
999 # The names of the make variables in the generated doxyrules.make file 
1000 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1001 # This is useful so different doxyrules.make files included by the same 
1002 # Makefile don't overwrite each other's variables.
1003
1004 PERLMOD_MAKEVAR_PREFIX = 
1005
1006 #---------------------------------------------------------------------------
1007 # Configuration options related to the preprocessor   
1008 #---------------------------------------------------------------------------
1009
1010 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1011 # evaluate all C-preprocessor directives found in the sources and include 
1012 # files.
1013
1014 ENABLE_PREPROCESSING   = YES
1015
1016 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1017 # names in the source code. If set to NO (the default) only conditional 
1018 # compilation will be performed. Macro expansion can be done in a controlled 
1019 # way by setting EXPAND_ONLY_PREDEF to YES.
1020
1021 MACRO_EXPANSION        = YES
1022
1023 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1024 # then the macro expansion is limited to the macros specified with the 
1025 # PREDEFINED and EXPAND_AS_DEFINED tags.
1026
1027 EXPAND_ONLY_PREDEF     = YES
1028
1029 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1030 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1031
1032 SEARCH_INCLUDES        = YES
1033
1034 # The INCLUDE_PATH tag can be used to specify one or more directories that 
1035 # contain include files that are not input files but should be processed by 
1036 # the preprocessor.
1037
1038 INCLUDE_PATH           = include/ include/asterisk/
1039
1040 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1041 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1042 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1043 # be used.
1044
1045 INCLUDE_FILE_PATTERNS  = 
1046
1047 # The PREDEFINED tag can be used to specify one or more macro names that 
1048 # are defined before the preprocessor is started (similar to the -D option of 
1049 # gcc). The argument of the tag is a list of macros of the form: name 
1050 # or name=definition (no spaces). If the definition and the = are 
1051 # omitted =1 is assumed. To prevent a macro definition from being 
1052 # undefined via #undef or recursively expanded use the := operator 
1053 # instead of the = operator.
1054
1055 PREDEFINED             = \
1056             __GNUC__ \
1057             __attribute__(x)=
1058
1059 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1060 # this tag can be used to specify a list of macro names that should be expanded. 
1061 # The macro definition that is found in the sources will be used. 
1062 # Use the PREDEFINED tag if you want to use a different macro definition.
1063
1064 EXPAND_AS_DEFINED      = \
1065             AST_INLINE_API \
1066             AST_DECLARE_STRING_FIELDS \
1067             AST_STRING_FIELD \
1068             AST_THREADSTORAGE \
1069             AST_THREADSTORAGE_CUSTOM \
1070             AST_MODULE_INFO \
1071             AST_MODULE_INFO_STANDARD \
1072             __AST_MUTEX_DEFINE \
1073             AST_MUTEX_DEFINE_STATIC \
1074             AST_MUTEX_DEFINE_STATIC_NOTRACKING \
1075             __AST_RWLOCK_DEFINE \
1076             AST_RWLOCK_DEFINE_STATIC \
1077             AST_LIST_HEAD \
1078             AST_RWLIST_HEAD \
1079             AST_LIST_HEAD_NOLOCK \
1080             AST_LIST_HEAD_STATIC \
1081             AST_RWLIST_HEAD_STATIC \
1082             AST_LIST_HEAD_NOLOCK_STATIC \
1083             AST_LIST_ENTRY \
1084             AST_RWLIST_ENTRY \
1085             __ASTOBJ_HASH \
1086             ASTOBJ_COMPONENTS_NOLOCK_FULL \
1087             ASTOBJ_COMPONENTS_NOLOCK \
1088             ASTOBJ_COMPONENTS_FULL \
1089             ASTOBJ_COMPONENTS \
1090             AST_IVR_DECLARE_MENU \
1091             AST_DECLARE_APP_ARGS \
1092             AST_DEFINE_APP_ARGS_TYPE \
1093             AST_APP_ARG \
1094             BEGIN_OPTIONS \
1095             END_OPTIONS \
1096             AST_APP_OPTIONS \
1097             AST_APP_OPTION \
1098             AST_APP_OPTION_ARG \
1099             AST_DLLIST_HEAD \
1100             AST_DLLIST_HEAD_STATIC \
1101             AST_DLLIST_HEAD_NOLOCK \
1102             AST_DLLIST_HEAD_NOLOCK_STATIC \
1103             AST_RWDLLIST_HEAD \
1104             AST_RWDLLIST_HEAD_STATIC \
1105             AST_DLLIST_ENTRY \
1106             AST_RWDLLIST_ENTRY \
1107             AST_CLI_DEFINE \
1108             AST_OPTIONAL_API \
1109             AST_OPTIONAL_API_ATTR
1110
1111 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1112 # doxygen's preprocessor will remove all function-like macros that are alone 
1113 # on a line, have an all uppercase name, and do not end with a semicolon. Such 
1114 # function macros are typically used for boiler-plate code, and will confuse 
1115 # the parser if not removed.
1116
1117 SKIP_FUNCTION_MACROS   = YES
1118
1119 #---------------------------------------------------------------------------
1120 # Configuration::additions related to external references   
1121 #---------------------------------------------------------------------------
1122
1123 # The TAGFILES option can be used to specify one or more tagfiles. 
1124 # Optionally an initial location of the external documentation 
1125 # can be added for each tagfile. The format of a tag file without 
1126 # this location is as follows: 
1127 #   TAGFILES = file1 file2 ... 
1128 # Adding location for the tag files is done as follows: 
1129 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1130 # where "loc1" and "loc2" can be relative or absolute paths or 
1131 # URLs. If a location is present for each tag, the installdox tool 
1132 # does not have to be run to correct the links.
1133 # Note that each tag file must have a unique name
1134 # (where the name does NOT include the path)
1135 # If a tag file is not located in the directory in which doxygen 
1136 # is run, you must also specify the path to the tagfile here.
1137
1138 TAGFILES               = 
1139
1140 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1141 # a tag file that is based on the input files it reads.
1142
1143 GENERATE_TAGFILE       = 
1144
1145 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1146 # in the class index. If set to NO only the inherited external classes 
1147 # will be listed.
1148
1149 ALLEXTERNALS           = NO
1150
1151 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1152 # in the modules index. If set to NO, only the current project's groups will 
1153 # be listed.
1154
1155 EXTERNAL_GROUPS        = YES
1156
1157 # The PERL_PATH should be the absolute path and name of the perl script 
1158 # interpreter (i.e. the result of `which perl').
1159
1160 PERL_PATH              = /usr/bin/perl
1161
1162 #---------------------------------------------------------------------------
1163 # Configuration options related to the dot tool   
1164 #---------------------------------------------------------------------------
1165
1166 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1167 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1168 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
1169 # this option is superseded by the HAVE_DOT option below. This is only a 
1170 # fallback. It is recommended to install and use dot, since it yields more 
1171 # powerful graphs.
1172
1173 CLASS_DIAGRAMS         = NO
1174
1175 # You can define message sequence charts within doxygen comments using the \msc 
1176 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 
1177 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 
1178 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
1179 # be found in the default search path.
1180
1181 MSCGEN_PATH            = 
1182
1183 # If set to YES, the inheritance and collaboration graphs will hide 
1184 # inheritance and usage relations if the target is undocumented 
1185 # or is not a class.
1186
1187 HIDE_UNDOC_RELATIONS   = YES
1188
1189 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1190 # available from the path. This tool is part of Graphviz, a graph visualization 
1191 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1192 # have no effect if this option is set to NO (the default)
1193
1194 HAVE_DOT               = NO
1195
1196 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1197 # will generate a graph for each documented class showing the direct and 
1198 # indirect inheritance relations. Setting this tag to YES will force the 
1199 # the CLASS_DIAGRAMS tag to NO.
1200
1201 CLASS_GRAPH            = YES
1202
1203 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1204 # will generate a graph for each documented class showing the direct and 
1205 # indirect implementation dependencies (inheritance, containment, and 
1206 # class references variables) of the class with other documented classes.
1207
1208 COLLABORATION_GRAPH    = YES
1209
1210 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1211 # will generate a graph for groups, showing the direct groups dependencies
1212
1213 GROUP_GRAPHS           = YES
1214
1215 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1216 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1217 # Language.
1218
1219 UML_LOOK               = NO
1220
1221 # If set to YES, the inheritance and collaboration graphs will show the 
1222 # relations between templates and their instances.
1223
1224 TEMPLATE_RELATIONS     = YES
1225
1226 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1227 # tags are set to YES then doxygen will generate a graph for each documented 
1228 # file showing the direct and indirect include dependencies of the file with 
1229 # other documented files.
1230
1231 INCLUDE_GRAPH          = YES
1232
1233 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1234 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1235 # documented header file showing the documented files that directly or 
1236 # indirectly include this file.
1237
1238 INCLUDED_BY_GRAPH      = YES
1239
1240 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1241 # generate a call 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 call graphs for selected 
1244 # functions only using the \callgraph command.
1245
1246 CALL_GRAPH             = NO
1247
1248 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1249 # generate a caller dependency graph for every global function or class method. 
1250 # Note that enabling this option will significantly increase the time of a run. 
1251 # So in most cases it will be better to enable caller graphs for selected 
1252 # functions only using the \callergraph command.
1253
1254 CALLER_GRAPH           = NO
1255
1256 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1257 # will graphical hierarchy of all classes instead of a textual one.
1258
1259 GRAPHICAL_HIERARCHY    = YES
1260
1261 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1262 # then doxygen will show the dependencies a directory has on other directories 
1263 # in a graphical way. The dependency relations are determined by the #include
1264 # relations between the files in the directories.
1265
1266 DIRECTORY_GRAPH        = YES
1267
1268 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1269 # generated by dot. Possible values are png, jpg, or gif
1270 # If left blank png will be used.
1271
1272 DOT_IMAGE_FORMAT       = png
1273
1274 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1275 # found. If left blank, it is assumed the dot tool can be found in the path.
1276
1277 DOT_PATH               = 
1278
1279 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1280 # contain dot files that are included in the documentation (see the 
1281 # \dotfile command).
1282
1283 DOTFILE_DIRS           = 
1284
1285 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1286 # nodes that will be shown in the graph. If the number of nodes in a graph 
1287 # becomes larger than this value, doxygen will truncate the graph, which is 
1288 # visualized by representing a node as a red box. Note that doxygen will always 
1289 # show the root nodes and its direct children regardless of this setting.
1290
1291 DOT_GRAPH_MAX_NODES    = 50
1292
1293 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1294 # background. This is disabled by default, which results in a white background. 
1295 # Warning: Depending on the platform used, enabling this option may lead to 
1296 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
1297 # read).
1298
1299 DOT_TRANSPARENT        = NO
1300
1301 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1302 # files in one run (i.e. multiple -o and -T options on the command line). This 
1303 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1304 # support this, this feature is disabled by default.
1305
1306 DOT_MULTI_TARGETS      = NO
1307
1308 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1309 # generate a legend page explaining the meaning of the various boxes and 
1310 # arrows in the dot generated graphs.
1311
1312 GENERATE_LEGEND        = YES
1313
1314 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1315 # remove the intermediate dot files that are used to generate 
1316 # the various graphs.
1317
1318 DOT_CLEANUP            = YES
1319
1320 #---------------------------------------------------------------------------
1321 # Configuration::additions related to the search engine   
1322 #---------------------------------------------------------------------------
1323
1324 # The SEARCHENGINE tag specifies whether or not a search engine should be 
1325 # used. If set to NO the values of all tags below this one will be ignored.
1326
1327 SEARCHENGINE           = NO