Change core show help output format.
[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
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of 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
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         = YES
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, Esperanto, Farsi, Finnish, French, German,
58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62
63 OUTPUT_LANGUAGE        = English
64
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
69
70 BRIEF_MEMBER_DESC      = YES
71
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
76
77 REPEAT_BRIEF           = YES
78
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
88
89 ABBREVIATE_BRIEF       =
90
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92 # Doxygen will generate a detailed section even if there is only a brief
93 # description.
94
95 ALWAYS_DETAILED_SEC    = NO
96
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98 # inherited members of a class in the documentation of that class as if those
99 # members were ordinary class members. Constructors, destructors and assignment
100 # operators of the base classes will not be shown.
101
102 INLINE_INHERITED_MEMB  = NO
103
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
106 # to NO the shortest path that makes the file name unique will be used.
107
108 FULL_PATH_NAMES        = NO
109
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 # can be used to strip a user-defined part of the path. Stripping is
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
115 # path to strip.
116
117 STRIP_FROM_PATH        =
118
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
124 # are normally passed to the compiler using the -I flag.
125
126 STRIP_FROM_INC_PATH    =
127
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129 # (but less readable) file names. This can be useful is your file systems
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
131
132 SHORT_NAMES            = NO
133
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comment as the brief description. If set to NO, the JavaDoc
137 # comments will behave just like regular Qt-style comments
138 # (thus requiring an explicit @brief command for a brief description.)
139
140 JAVADOC_AUTOBRIEF      = NO
141
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
147
148 QT_AUTOBRIEF           = NO
149
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
154 # description. Set this tag to YES if you prefer the old behaviour instead.
155
156 MULTILINE_CPP_IS_BRIEF = NO
157
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159 # member inherits the documentation from any documented member that it
160 # re-implements.
161
162 INHERIT_DOCS           = YES
163
164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165 # a new page for each member. If set to NO, the documentation of a member will
166 # be part of the file/class/namespace that contains it.
167
168 SEPARATE_MEMBER_PAGES  = NO
169
170 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
171 # Doxygen uses this value to replace tabs by spaces in code fragments.
172
173 TAB_SIZE               = 3
174
175 # This tag can be used to specify a number of aliases that acts
176 # as commands in the documentation. An alias has the form "name=value".
177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
178 # put the command \sideeffect (or @sideeffect) in the documentation, which
179 # will result in a user-defined paragraph with heading "Side Effects:".
180 # You can put \n's in the value part of an alias to insert newlines.
181
182 ALIASES                = "extref=\xrefitem extref \"ExtRef\" \"External references\""
183 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."
184
185 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
186 # sources only. Doxygen will then generate output that is more tailored for C.
187 # For instance, some of the names that are used will be different. The list
188 # of all members will be omitted, etc.
189
190 OPTIMIZE_OUTPUT_FOR_C  = YES
191
192 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
193 # sources only. Doxygen will then generate output that is more tailored for
194 # Java. For instance, namespaces will be presented as packages, qualified
195 # scopes will look different, etc.
196
197 OPTIMIZE_OUTPUT_JAVA   = NO
198
199 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
200 # sources only. Doxygen will then generate output that is more tailored for
201 # Fortran.
202
203 OPTIMIZE_FOR_FORTRAN   = NO
204
205 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
206 # sources. Doxygen will then generate output that is tailored for
207 # VHDL.
208
209 OPTIMIZE_OUTPUT_VHDL   = NO
210
211 # Doxygen selects the parser to use depending on the extension of the files it
212 # parses. With this tag you can assign which parser to use for a given extension.
213 # Doxygen has a built-in mapping, but you can override or extend it using this
214 # tag. The format is ext=language, where ext is a file extension, and language
215 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
216 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
217 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
218 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
219 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
220
221 EXTENSION_MAPPING      =
222
223 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
224 # to include (a tag file for) the STL sources as input, then you should
225 # set this tag to YES in order to let doxygen match functions declarations and
226 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
227 # func(std::string) {}). This also make the inheritance and collaboration
228 # diagrams that involve STL classes more complete and accurate.
229
230 BUILTIN_STL_SUPPORT    = NO
231
232 # If you use Microsoft's C++/CLI language, you should set this option to YES to
233 # enable parsing support.
234
235 CPP_CLI_SUPPORT        = NO
236
237 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
238 # Doxygen will parse them like normal C++ but will assume all classes use public
239 # instead of private inheritance when no explicit protection keyword is present.
240
241 SIP_SUPPORT            = NO
242
243 # For Microsoft's IDL there are propget and propput attributes to indicate getter
244 # and setter methods for a property. Setting this option to YES (the default)
245 # will make doxygen to replace the get and set methods by a property in the
246 # documentation. This will only work if the methods are indeed getting or
247 # setting a simple type. If this is not the case, or you want to show the
248 # methods anyway, you should set this option to NO.
249
250 IDL_PROPERTY_SUPPORT   = YES
251
252 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
253 # tag is set to YES, then doxygen will reuse the documentation of the first
254 # member in the group (if any) for the other members of the group. By default
255 # all members of a group must be documented explicitly.
256
257 DISTRIBUTE_GROUP_DOC   = NO
258
259 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
260 # the same type (for instance a group of public functions) to be put as a
261 # subgroup of that type (e.g. under the Public Functions section). Set it to
262 # NO to prevent subgrouping. Alternatively, this can be done per class using
263 # the \nosubgrouping command.
264
265 SUBGROUPING            = YES
266
267 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
268 # is documented as struct, union, or enum with the name of the typedef. So
269 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
270 # with name TypeT. When disabled the typedef will appear as a member of a file,
271 # namespace, or class. And the struct will be named TypeS. This can typically
272 # be useful for C code in case the coding convention dictates that all compound
273 # types are typedef'ed and only the typedef is referenced, never the tag name.
274
275 TYPEDEF_HIDES_STRUCT   = NO
276
277 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
278 # determine which symbols to keep in memory and which to flush to disk.
279 # When the cache is full, less often used symbols will be written to disk.
280 # For small to medium size projects (<1000 input files) the default value is
281 # probably good enough. For larger projects a too small cache size can cause
282 # doxygen to be busy swapping symbols to and from disk most of the time
283 # causing a significant performance penality.
284 # If the system has enough physical memory increasing the cache will improve the
285 # performance by keeping more symbols in memory. Note that the value works on
286 # a logarithmic scale so increasing the size by one will rougly double the
287 # memory usage. The cache size is given by this formula:
288 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
289 # corresponding to a cache size of 2^16 = 65536 symbols
290
291 SYMBOL_CACHE_SIZE      = 0
292
293 #---------------------------------------------------------------------------
294 # Build related configuration options
295 #---------------------------------------------------------------------------
296
297 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
298 # documentation are documented, even if no documentation was available.
299 # Private class members and static file members will be hidden unless
300 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
301
302 EXTRACT_ALL            = YES
303
304 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
305 # will be included in the documentation.
306
307 EXTRACT_PRIVATE        = NO
308
309 # If the EXTRACT_STATIC tag is set to YES all static members of a file
310 # will be included in the documentation.
311
312 EXTRACT_STATIC         = YES
313
314 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
315 # defined locally in source files will be included in the documentation.
316 # If set to NO only classes defined in header files are included.
317
318 EXTRACT_LOCAL_CLASSES  = YES
319
320 # This flag is only useful for Objective-C code. When set to YES local
321 # methods, which are defined in the implementation section but not in
322 # the interface are included in the documentation.
323 # If set to NO (the default) only methods in the interface are included.
324
325 EXTRACT_LOCAL_METHODS  = NO
326
327 # If this flag is set to YES, the members of anonymous namespaces will be
328 # extracted and appear in the documentation as a namespace called
329 # 'anonymous_namespace{file}', where file will be replaced with the base
330 # name of the file that contains the anonymous namespace. By default
331 # anonymous namespace are hidden.
332
333 EXTRACT_ANON_NSPACES   = NO
334
335 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
336 # undocumented members of documented classes, files or namespaces.
337 # If set to NO (the default) these members will be included in the
338 # various overviews, but no documentation section is generated.
339 # This option has no effect if EXTRACT_ALL is enabled.
340
341 HIDE_UNDOC_MEMBERS     = NO
342
343 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
344 # undocumented classes that are normally visible in the class hierarchy.
345 # If set to NO (the default) these classes will be included in the various
346 # overviews. This option has no effect if EXTRACT_ALL is enabled.
347
348 HIDE_UNDOC_CLASSES     = NO
349
350 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
351 # friend (class|struct|union) declarations.
352 # If set to NO (the default) these declarations will be included in the
353 # documentation.
354
355 HIDE_FRIEND_COMPOUNDS  = NO
356
357 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
358 # documentation blocks found inside the body of a function.
359 # If set to NO (the default) these blocks will be appended to the
360 # function's detailed documentation block.
361
362 HIDE_IN_BODY_DOCS      = NO
363
364 # The INTERNAL_DOCS tag determines if documentation
365 # that is typed after a \internal command is included. If the tag is set
366 # to NO (the default) then the documentation will be excluded.
367 # Set it to YES to include the internal documentation.
368
369 INTERNAL_DOCS          = NO
370
371 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
372 # file names in lower-case letters. If set to YES upper-case letters are also
373 # allowed. This is useful if you have classes or files whose names only differ
374 # in case and if your file system supports case sensitive file names. Windows
375 # and Mac users are advised to set this option to NO.
376
377 CASE_SENSE_NAMES       = YES
378
379 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
380 # will show members with their full class and namespace scopes in the
381 # documentation. If set to YES the scope will be hidden.
382
383 HIDE_SCOPE_NAMES       = YES
384
385 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
386 # will put a list of the files that are included by a file in the documentation
387 # of that file.
388
389 SHOW_INCLUDE_FILES     = YES
390
391 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
392 # will list include files with double quotes in the documentation
393 # rather than with sharp brackets.
394
395 FORCE_LOCAL_INCLUDES   = NO
396
397 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
398 # is inserted in the documentation for inline members.
399
400 INLINE_INFO            = YES
401
402 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
403 # will sort the (detailed) documentation of file and class members
404 # alphabetically by member name. If set to NO the members will appear in
405 # declaration order.
406
407 SORT_MEMBER_DOCS       = YES
408
409 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
410 # brief documentation of file, namespace and class members alphabetically
411 # by member name. If set to NO (the default) the members will appear in
412 # declaration order.
413
414 SORT_BRIEF_DOCS        = YES
415
416 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
417 # will sort the (brief and detailed) documentation of class members so that
418 # constructors and destructors are listed first. If set to NO (the default)
419 # the constructors will appear in the respective orders defined by
420 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
421 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
422 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
423
424 SORT_MEMBERS_CTORS_1ST = NO
425
426 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
427 # hierarchy of group names into alphabetical order. If set to NO (the default)
428 # the group names will appear in their defined order.
429
430 SORT_GROUP_NAMES       = NO
431
432 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
433 # sorted by fully-qualified names, including namespaces. If set to
434 # NO (the default), the class list will be sorted only by class name,
435 # not including the namespace part.
436 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
437 # Note: This option applies only to the class list, not to the
438 # alphabetical list.
439
440 SORT_BY_SCOPE_NAME     = NO
441
442 # The GENERATE_TODOLIST tag can be used to enable (YES) or
443 # disable (NO) the todo list. This list is created by putting \todo
444 # commands in the documentation.
445
446 GENERATE_TODOLIST      = YES
447
448 # The GENERATE_TESTLIST tag can be used to enable (YES) or
449 # disable (NO) the test list. This list is created by putting \test
450 # commands in the documentation.
451
452 GENERATE_TESTLIST      = YES
453
454 # The GENERATE_BUGLIST tag can be used to enable (YES) or
455 # disable (NO) the bug list. This list is created by putting \bug
456 # commands in the documentation.
457
458 GENERATE_BUGLIST       = YES
459
460 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
461 # disable (NO) the deprecated list. This list is created by putting
462 # \deprecated commands in the documentation.
463
464 GENERATE_DEPRECATEDLIST= YES
465
466 # The ENABLED_SECTIONS tag can be used to enable conditional
467 # documentation sections, marked by \if sectionname ... \endif.
468
469 ENABLED_SECTIONS       =
470
471 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
472 # the initial value of a variable or define consists of for it to appear in
473 # the documentation. If the initializer consists of more lines than specified
474 # here it will be hidden. Use a value of 0 to hide initializers completely.
475 # The appearance of the initializer of individual variables and defines in the
476 # documentation can be controlled using \showinitializer or \hideinitializer
477 # command in the documentation regardless of this setting.
478
479 MAX_INITIALIZER_LINES  = 5
480
481 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
482 # at the bottom of the documentation of classes and structs. If set to YES the
483 # list will mention the files that were used to generate the documentation.
484
485 SHOW_USED_FILES        = YES
486
487 # If the sources in your project are distributed over multiple directories
488 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
489 # in the documentation. The default is NO.
490
491 SHOW_DIRECTORIES       = YES
492
493 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
494 # This will remove the Files entry from the Quick Index and from the
495 # Folder Tree View (if specified). The default is YES.
496
497 SHOW_FILES             = YES
498
499 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
500 # Namespaces page.
501 # This will remove the Namespaces entry from the Quick Index
502 # and from the Folder Tree View (if specified). The default is YES.
503
504 SHOW_NAMESPACES        = YES
505
506 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
507 # doxygen should invoke to get the current version for each file (typically from
508 # the version control system). Doxygen will invoke the program by executing (via
509 # popen()) the command <command> <input-file>, where <command> is the value of
510 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
511 # provided by doxygen. Whatever the program writes to standard output
512 # is used as the file version. See the manual for examples.
513
514 FILE_VERSION_FILTER    =
515
516 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
517 # by doxygen. The layout file controls the global structure of the generated
518 # output files in an output format independent way. The create the layout file
519 # that represents doxygen's defaults, run doxygen with the -l option.
520 # You can optionally specify a file name after the option, if omitted
521 # DoxygenLayout.xml will be used as the name of the layout file.
522
523 LAYOUT_FILE            =
524
525 #---------------------------------------------------------------------------
526 # configuration options related to warning and progress messages
527 #---------------------------------------------------------------------------
528
529 # The QUIET tag can be used to turn on/off the messages that are generated
530 # by doxygen. Possible values are YES and NO. If left blank NO is used.
531
532 QUIET                  = NO
533
534 # The WARNINGS tag can be used to turn on/off the warning messages that are
535 # generated by doxygen. Possible values are YES and NO. If left blank
536 # NO is used.
537
538 WARNINGS               = YES
539
540 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
541 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
542 # automatically be disabled.
543
544 WARN_IF_UNDOCUMENTED   = YES
545
546 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
547 # potential errors in the documentation, such as not documenting some
548 # parameters in a documented function, or documenting parameters that
549 # don't exist or using markup commands wrongly.
550
551 WARN_IF_DOC_ERROR      = NO
552
553 # This WARN_NO_PARAMDOC option can be abled to get warnings for
554 # functions that are documented, but have no documentation for their parameters
555 # or return value. If set to NO (the default) doxygen will only warn about
556 # wrong or incomplete parameter documentation, but not about the absence of
557 # documentation.
558
559 WARN_NO_PARAMDOC       = NO
560
561 # The WARN_FORMAT tag determines the format of the warning messages that
562 # doxygen can produce. The string should contain the $file, $line, and $text
563 # tags, which will be replaced by the file and line number from which the
564 # warning originated and the warning text. Optionally the format may contain
565 # $version, which will be replaced by the version of the file (if it could
566 # be obtained via FILE_VERSION_FILTER)
567
568 WARN_FORMAT            =
569
570 # The WARN_LOGFILE tag can be used to specify a file to which warning
571 # and error messages should be written. If left blank the output is written
572 # to stderr.
573
574 WARN_LOGFILE           = doxygen.log
575
576 #---------------------------------------------------------------------------
577 # configuration options related to the input files
578 #---------------------------------------------------------------------------
579
580 # The INPUT tag can be used to specify the files and/or directories that contain
581 # documented source files. You may enter file names like "myfile.cpp" or
582 # directories like "/usr/src/myproject". Separate the files or directories
583 # with spaces.
584
585 INPUT                  =
586
587 # This tag can be used to specify the character encoding of the source files
588 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
589 # also the default input encoding. Doxygen uses libiconv (or the iconv built
590 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
591 # the list of possible encodings.
592
593 INPUT_ENCODING         = UTF-8
594
595 # If the value of the INPUT tag contains directories, you can use the
596 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
597 # and *.h) to filter out the source-files in the directories. If left
598 # blank the following patterns are tested:
599 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
600 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
601
602 FILE_PATTERNS          = *.c \
603                          *.h \
604                          *.py
605
606 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
607 # should be searched for input files as well. Possible values are YES and NO.
608 # If left blank NO is used.
609
610 RECURSIVE              = yes
611
612 # The EXCLUDE tag can be used to specify files and/or directories that should
613 # excluded from the INPUT source files. This way you can easily exclude a
614 # subdirectory from a directory tree whose root is specified with the INPUT tag.
615
616 EXCLUDE                = doc/api \
617                          menuselect \
618                          res/pjproject \
619                          addons/ooh323c/src
620
621 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
622 # directories that are symbolic links (a Unix filesystem feature) are excluded
623 # from the input.
624
625 EXCLUDE_SYMLINKS       = YES
626
627 # If the value of the INPUT tag contains directories, you can use the
628 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
629 # certain files from those directories. Note that the wildcards are matched
630 # against the file with absolute path, so to exclude all test directories
631 # for example use the pattern */test/*
632
633 EXCLUDE_PATTERNS       = *.o \
634                          *.o.d \
635                          .*
636
637 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
638 # (namespaces, classes, functions, etc.) that should be excluded from the
639 # output. The symbol name can be a fully qualified name, a word, or if the
640 # wildcard * is used, a substring. Examples: ANamespace, AClass,
641 # AClass::ANamespace, ANamespace::*Test
642
643 EXCLUDE_SYMBOLS        =
644
645 # The EXAMPLE_PATH tag can be used to specify one or more files or
646 # directories that contain example code fragments that are included (see
647 # the \include command).
648
649 EXAMPLE_PATH           = ./ \
650                          doc \
651                          configs
652
653 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
654 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
655 # and *.h) to filter out the source-files in the directories. If left
656 # blank all files are included.
657
658 EXAMPLE_PATTERNS       =
659
660 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
661 # searched for input files to be used with the \include or \dontinclude
662 # commands irrespective of the value of the RECURSIVE tag.
663 # Possible values are YES and NO. If left blank NO is used.
664
665 EXAMPLE_RECURSIVE      = YES
666
667 # The IMAGE_PATH tag can be used to specify one or more files or
668 # directories that contain image that are included in the documentation (see
669 # the \image command).
670
671 IMAGE_PATH             = images
672
673 # The INPUT_FILTER tag can be used to specify a program that doxygen should
674 # invoke to filter for each input file. Doxygen will invoke the filter program
675 # by executing (via popen()) the command <filter> <input-file>, where <filter>
676 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
677 # input file. Doxygen will then use the output that the filter program writes
678 # to standard output.
679 # If FILTER_PATTERNS is specified, this tag will be
680 # ignored.
681
682 INPUT_FILTER           =
683
684 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
685 # basis.
686 # Doxygen will compare the file name with each pattern and apply the
687 # filter if there is a match.
688 # The filters are a list of the form:
689 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
690 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
691 # is applied to all files.
692
693 FILTER_PATTERNS        =
694
695 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
696 # INPUT_FILTER) will be used to filter the input files when producing source
697 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
698
699 FILTER_SOURCE_FILES    = NO
700
701 #---------------------------------------------------------------------------
702 # configuration options related to source browsing
703 #---------------------------------------------------------------------------
704
705 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
706 # be generated. Documented entities will be cross-referenced with these sources.
707 # Note: To get rid of all source code in the generated output, make sure also
708 # VERBATIM_HEADERS is set to NO.
709
710 SOURCE_BROWSER         = YES
711
712 # Setting the INLINE_SOURCES tag to YES will include the body
713 # of functions and classes directly in the documentation.
714
715 INLINE_SOURCES         = YES
716
717 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
718 # doxygen to hide any special comment blocks from generated source code
719 # fragments. Normal C and C++ comments will always remain visible.
720
721 STRIP_CODE_COMMENTS    = NO
722
723 # If the REFERENCED_BY_RELATION tag is set to YES
724 # then for each documented function all documented
725 # functions referencing it will be listed.
726
727 REFERENCED_BY_RELATION = YES
728
729 # If the REFERENCES_RELATION tag is set to YES
730 # then for each documented function all documented entities
731 # called/used by that function will be listed.
732
733 REFERENCES_RELATION    = YES
734
735 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
736 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
737 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
738 # link to the source code.
739 # Otherwise they will link to the documentation.
740
741 REFERENCES_LINK_SOURCE = YES
742
743 # If the USE_HTAGS tag is set to YES then the references to source code
744 # will point to the HTML generated by the htags(1) tool instead of doxygen
745 # built-in source browser. The htags tool is part of GNU's global source
746 # tagging system (see http://www.gnu.org/software/global/global.html). You
747 # will need version 4.8.6 or higher.
748
749 USE_HTAGS              = NO
750
751 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
752 # will generate a verbatim copy of the header file for each class for
753 # which an include is specified. Set to NO to disable this.
754
755 VERBATIM_HEADERS       = YES
756
757 #---------------------------------------------------------------------------
758 # configuration options related to the alphabetical class index
759 #---------------------------------------------------------------------------
760
761 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
762 # of all compounds will be generated. Enable this if the project
763 # contains a lot of classes, structs, unions or interfaces.
764
765 ALPHABETICAL_INDEX     = YES
766
767 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
768 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
769 # in which this list will be split (can be a number in the range [1..20])
770
771 COLS_IN_ALPHA_INDEX    = 5
772
773 # In case all classes in a project start with a common prefix, all
774 # classes will be put under the same header in the alphabetical index.
775 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
776 # should be ignored while generating the index headers.
777
778 IGNORE_PREFIX          =
779
780 #---------------------------------------------------------------------------
781 # configuration options related to the HTML output
782 #---------------------------------------------------------------------------
783
784 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
785 # generate HTML output.
786
787 GENERATE_HTML          = YES
788
789 # The HTML_OUTPUT tag is used to specify where the HTML 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 `html' will be used as the default path.
792
793 HTML_OUTPUT            = api
794
795 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
796 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
797 # doxygen will generate files with .html extension.
798
799 HTML_FILE_EXTENSION    = .html
800
801 # The HTML_HEADER tag can be used to specify a personal HTML header for
802 # each generated HTML page. If it is left blank doxygen will generate a
803 # standard header.
804
805 HTML_HEADER            =
806
807 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
808 # each generated HTML page. If it is left blank doxygen will generate a
809 # standard footer.
810
811 HTML_FOOTER            =
812
813 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
814 # style sheet that is used by each HTML page. It can be used to
815 # fine-tune the look of the HTML output. If the tag is left blank doxygen
816 # will generate a default style sheet. Note that doxygen will try to copy
817 # the style sheet file to the HTML output directory, so don't put your own
818 # stylesheet in the HTML output directory as well, or it will be erased!
819
820 HTML_STYLESHEET        =
821
822 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
823 # Doxygen will adjust the colors in the stylesheet and background images
824 # according to this color. Hue is specified as an angle on a colorwheel,
825 # see http://en.wikipedia.org/wiki/Hue for more information.
826 # For instance the value 0 represents red, 60 is yellow, 120 is green,
827 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
828 # The allowed range is 0 to 359.
829
830 HTML_COLORSTYLE_HUE    = 220
831
832 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
833 # the colors in the HTML output. For a value of 0 the output will use
834 # grayscales only. A value of 255 will produce the most vivid colors.
835
836 HTML_COLORSTYLE_SAT    = 100
837
838 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
839 # the luminance component of the colors in the HTML output. Values below
840 # 100 gradually make the output lighter, whereas values above 100 make
841 # the output darker. The value divided by 100 is the actual gamma applied,
842 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
843 # and 100 does not change the gamma.
844
845 HTML_COLORSTYLE_GAMMA  = 80
846
847 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
848 # page will contain the date and time when the page was generated. Setting
849 # this to NO can help when comparing the output of multiple runs.
850
851 HTML_TIMESTAMP         = YES
852
853 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
854 # files or namespaces will be aligned in HTML using tables. If set to
855 # NO a bullet list will be used.
856
857 HTML_ALIGN_MEMBERS     = YES
858
859 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
860 # documentation will contain sections that can be hidden and shown after the
861 # page has loaded. For this to work a browser that supports
862 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
863 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
864
865 HTML_DYNAMIC_SECTIONS  = NO
866
867 # If the GENERATE_DOCSET tag is set to YES, additional index files
868 # will be generated that can be used as input for Apple's Xcode 3
869 # integrated development environment, introduced with OSX 10.5 (Leopard).
870 # To create a documentation set, doxygen will generate a Makefile in the
871 # HTML output directory. Running make will produce the docset in that
872 # directory and running "make install" will install the docset in
873 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
874 # it at startup.
875 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
876 # for more information.
877
878 GENERATE_DOCSET        = NO
879
880 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
881 # feed. A documentation feed provides an umbrella under which multiple
882 # documentation sets from a single provider (such as a company or product suite)
883 # can be grouped.
884
885 DOCSET_FEEDNAME        = "Doxygen generated docs"
886
887 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
888 # should uniquely identify the documentation set bundle. This should be a
889 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
890 # will append .docset to the name.
891
892 DOCSET_BUNDLE_ID       = org.doxygen.Project
893
894 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
895 # the documentation publisher. This should be a reverse domain-name style
896 # string, e.g. com.mycompany.MyDocSet.documentation.
897
898 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
899
900 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
901
902 DOCSET_PUBLISHER_NAME  = Publisher
903
904 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
905 # will be generated that can be used as input for tools like the
906 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
907 # of the generated HTML documentation.
908
909 GENERATE_HTMLHELP      = NO
910
911 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
912 # be used to specify the file name of the resulting .chm file. You
913 # can add a path in front of the file if the result should not be
914 # written to the html output directory.
915
916 CHM_FILE               =
917
918 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
919 # be used to specify the location (absolute path including file name) of
920 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
921 # the HTML help compiler on the generated index.hhp.
922
923 HHC_LOCATION           =
924
925 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
926 # controls if a separate .chi index file is generated (YES) or that
927 # it should be included in the master .chm file (NO).
928
929 GENERATE_CHI           = NO
930
931 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
932 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
933 # content.
934
935 CHM_INDEX_ENCODING     =
936
937 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
938 # controls whether a binary table of contents is generated (YES) or a
939 # normal table of contents (NO) in the .chm file.
940
941 BINARY_TOC             = NO
942
943 # The TOC_EXPAND flag can be set to YES to add extra items for group members
944 # to the contents of the HTML help documentation and to the tree view.
945
946 TOC_EXPAND             = NO
947
948 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
949 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
950 # that can be used as input for Qt's qhelpgenerator to generate a
951 # Qt Compressed Help (.qch) of the generated HTML documentation.
952
953 GENERATE_QHP           = NO
954
955 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
956 # be used to specify the file name of the resulting .qch file.
957 # The path specified is relative to the HTML output folder.
958
959 QCH_FILE               =
960
961 # The QHP_NAMESPACE tag specifies the namespace to use when generating
962 # Qt Help Project output. For more information please see
963 # http://doc.trolltech.com/qthelpproject.html#namespace
964
965 QHP_NAMESPACE          = org.doxygen.Project
966
967 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
968 # Qt Help Project output. For more information please see
969 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
970
971 QHP_VIRTUAL_FOLDER     = doc
972
973 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
974 # add. For more information please see
975 # http://doc.trolltech.com/qthelpproject.html#custom-filters
976
977 QHP_CUST_FILTER_NAME   =
978
979 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
980 # custom filter to add. For more information please see
981 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
982 # Qt Help Project / Custom Filters</a>.
983
984 QHP_CUST_FILTER_ATTRS  =
985
986 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
987 # project's
988 # filter section matches.
989 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
990 # Qt Help Project / Filter Attributes</a>.
991
992 QHP_SECT_FILTER_ATTRS  =
993
994 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
995 # be used to specify the location of Qt's qhelpgenerator.
996 # If non-empty doxygen will try to run qhelpgenerator on the generated
997 # .qhp file.
998
999 QHG_LOCATION           =
1000
1001 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1002 #  will be generated, which together with the HTML files, form an Eclipse help
1003 # plugin. To install this plugin and make it available under the help contents
1004 # menu in Eclipse, the contents of the directory containing the HTML and XML
1005 # files needs to be copied into the plugins directory of eclipse. The name of
1006 # the directory within the plugins directory should be the same as
1007 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1008 # the help appears.
1009
1010 GENERATE_ECLIPSEHELP   = NO
1011
1012 # A unique identifier for the eclipse help plugin. When installing the plugin
1013 # the directory name containing the HTML and XML files should also have
1014 # this name.
1015
1016 ECLIPSE_DOC_ID         = org.doxygen.Project
1017
1018 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1019 # top of each HTML page. The value NO (the default) enables the index and
1020 # the value YES disables it.
1021
1022 DISABLE_INDEX          = NO
1023
1024 # This tag can be used to set the number of enum values (range [1..20])
1025 # that doxygen will group on one line in the generated HTML documentation.
1026
1027 ENUM_VALUES_PER_LINE   = 4
1028
1029 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1030 # structure should be generated to display hierarchical information.
1031 # If the tag value is set to YES, a side panel will be generated
1032 # containing a tree-like index structure (just like the one that
1033 # is generated for HTML Help). For this to work a browser that supports
1034 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1035 # Windows users are probably better off using the HTML help feature.
1036
1037 GENERATE_TREEVIEW      = YES
1038
1039 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1040 # and Class Hierarchy pages using a tree view instead of an ordered list.
1041
1042 USE_INLINE_TREES       = NO
1043
1044 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1045 # used to set the initial width (in pixels) of the frame in which the tree
1046 # is shown.
1047
1048 TREEVIEW_WIDTH         = 250
1049
1050 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1051 # links to external symbols imported via tag files in a separate window.
1052
1053 EXT_LINKS_IN_WINDOW    = NO
1054
1055 # Use this tag to change the font size of Latex formulas included
1056 # as images in the HTML documentation. The default is 10. Note that
1057 # when you change the font size after a successful doxygen run you need
1058 # to manually remove any form_*.png images from the HTML output directory
1059 # to force them to be regenerated.
1060
1061 FORMULA_FONTSIZE       = 10
1062
1063 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1064 # generated for formulas are transparent PNGs. Transparent PNGs are
1065 # not supported properly for IE 6.0, but are supported on all modern browsers.
1066 # Note that when changing this option you need to delete any form_*.png files
1067 # in the HTML output before the changes have effect.
1068
1069 FORMULA_TRANSPARENT    = YES
1070
1071 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1072 # for the HTML output. The underlying search engine uses javascript
1073 # and DHTML and should work on any modern browser. Note that when using
1074 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1075 # (GENERATE_DOCSET) there is already a search function so this one should
1076 # typically be disabled. For large projects the javascript based search engine
1077 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1078
1079 SEARCHENGINE           = YES
1080
1081 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1082 # implemented using a PHP enabled web server instead of at the web client
1083 # using Javascript. Doxygen will generate the search PHP script and index
1084 # file to put on the web server. The advantage of the server
1085 # based approach is that it scales better to large projects and allows
1086 # full text search. The disadvances is that it is more difficult to setup
1087 # and does not have live searching capabilities.
1088
1089 SERVER_BASED_SEARCH    = NO
1090
1091 #---------------------------------------------------------------------------
1092 # configuration options related to the LaTeX output
1093 #---------------------------------------------------------------------------
1094
1095 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1096 # generate Latex output.
1097
1098 GENERATE_LATEX         = NO
1099
1100 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1101 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1102 # put in front of it. If left blank `latex' will be used as the default path.
1103
1104 LATEX_OUTPUT           =
1105
1106 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1107 # invoked. If left blank `latex' will be used as the default command name.
1108 # Note that when enabling USE_PDFLATEX this option is only used for
1109 # generating bitmaps for formulas in the HTML output, but not in the
1110 # Makefile that is written to the output directory.
1111
1112 LATEX_CMD_NAME         = latex
1113
1114 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1115 # generate index for LaTeX. If left blank `makeindex' will be used as the
1116 # default command name.
1117
1118 MAKEINDEX_CMD_NAME     = makeindex
1119
1120 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1121 # LaTeX documents. This may be useful for small projects and may help to
1122 # save some trees in general.
1123
1124 COMPACT_LATEX          = NO
1125
1126 # The PAPER_TYPE tag can be used to set the paper type that is used
1127 # by the printer. Possible values are: a4, a4wide, letter, legal and
1128 # executive. If left blank a4wide will be used.
1129
1130 PAPER_TYPE             = letter
1131
1132 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1133 # packages that should be included in the LaTeX output.
1134
1135 EXTRA_PACKAGES         =
1136
1137 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1138 # the generated latex document. The header should contain everything until
1139 # the first chapter. If it is left blank doxygen will generate a
1140 # standard header. Notice: only use this tag if you know what you are doing!
1141
1142 LATEX_HEADER           =
1143
1144 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1145 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1146 # contain links (just like the HTML output) instead of page references
1147 # This makes the output suitable for online browsing using a pdf viewer.
1148
1149 PDF_HYPERLINKS         = NO
1150
1151 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1152 # plain latex in the generated Makefile. Set this option to YES to get a
1153 # higher quality PDF documentation.
1154
1155 USE_PDFLATEX           = NO
1156
1157 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1158 # command to the generated LaTeX files. This will instruct LaTeX to keep
1159 # running if errors occur, instead of asking the user for help.
1160 # This option is also used when generating formulas in HTML.
1161
1162 LATEX_BATCHMODE        = NO
1163
1164 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1165 # include the index chapters (such as File Index, Compound Index, etc.)
1166 # in the output.
1167
1168 LATEX_HIDE_INDICES     = NO
1169
1170 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1171 # source code with syntax highlighting in the LaTeX output.
1172 # Note that which sources are shown also depends on other settings
1173 # such as SOURCE_BROWSER.
1174
1175 LATEX_SOURCE_CODE      = NO
1176
1177 #---------------------------------------------------------------------------
1178 # configuration options related to the RTF output
1179 #---------------------------------------------------------------------------
1180
1181 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1182 # The RTF output is optimized for Word 97 and may not look very pretty with
1183 # other RTF readers or editors.
1184
1185 GENERATE_RTF           = NO
1186
1187 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1188 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1189 # put in front of it. If left blank `rtf' will be used as the default path.
1190
1191 RTF_OUTPUT             =
1192
1193 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1194 # RTF documents. This may be useful for small projects and may help to
1195 # save some trees in general.
1196
1197 COMPACT_RTF            = NO
1198
1199 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1200 # will contain hyperlink fields. The RTF file will
1201 # contain links (just like the HTML output) instead of page references.
1202 # This makes the output suitable for online browsing using WORD or other
1203 # programs which support those fields.
1204 # Note: wordpad (write) and others do not support links.
1205
1206 RTF_HYPERLINKS         = NO
1207
1208 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1209 # config file, i.e. a series of assignments. You only have to provide
1210 # replacements, missing definitions are set to their default value.
1211
1212 RTF_STYLESHEET_FILE    =
1213
1214 # Set optional variables used in the generation of an rtf document.
1215 # Syntax is similar to doxygen's config file.
1216
1217 RTF_EXTENSIONS_FILE    =
1218
1219 #---------------------------------------------------------------------------
1220 # configuration options related to the man page output
1221 #---------------------------------------------------------------------------
1222
1223 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1224 # generate man pages
1225
1226 GENERATE_MAN           = NO
1227
1228 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1229 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1230 # put in front of it. If left blank `man' will be used as the default path.
1231
1232 MAN_OUTPUT             =
1233
1234 # The MAN_EXTENSION tag determines the extension that is added to
1235 # the generated man pages (default is the subroutine's section .3)
1236
1237 MAN_EXTENSION          =
1238
1239 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1240 # then it will generate one additional man file for each entity
1241 # documented in the real man page(s). These additional files
1242 # only source the real man page, but without them the man command
1243 # would be unable to find the correct page. The default is NO.
1244
1245 MAN_LINKS              = NO
1246
1247 #---------------------------------------------------------------------------
1248 # configuration options related to the XML output
1249 #---------------------------------------------------------------------------
1250
1251 # If the GENERATE_XML tag is set to YES Doxygen will
1252 # generate an XML file that captures the structure of
1253 # the code including all documentation.
1254
1255 GENERATE_XML           = NO
1256
1257 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1258 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1259 # put in front of it. If left blank `xml' will be used as the default path.
1260
1261 XML_OUTPUT             = xml
1262
1263 # The XML_SCHEMA tag can be used to specify an XML schema,
1264 # which can be used by a validating XML parser to check the
1265 # syntax of the XML files.
1266
1267 XML_SCHEMA             =
1268
1269 # The XML_DTD tag can be used to specify an XML DTD,
1270 # which can be used by a validating XML parser to check the
1271 # syntax of the XML files.
1272
1273 XML_DTD                =
1274
1275 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1276 # dump the program listings (including syntax highlighting
1277 # and cross-referencing information) to the XML output. Note that
1278 # enabling this will significantly increase the size of the XML output.
1279
1280 XML_PROGRAMLISTING     = YES
1281
1282 #---------------------------------------------------------------------------
1283 # configuration options for the AutoGen Definitions output
1284 #---------------------------------------------------------------------------
1285
1286 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1287 # generate an AutoGen Definitions (see autogen.sf.net) file
1288 # that captures the structure of the code including all
1289 # documentation. Note that this feature is still experimental
1290 # and incomplete at the moment.
1291
1292 GENERATE_AUTOGEN_DEF   = NO
1293
1294 #---------------------------------------------------------------------------
1295 # configuration options related to the Perl module output
1296 #---------------------------------------------------------------------------
1297
1298 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1299 # generate a Perl module file that captures the structure of
1300 # the code including all documentation. Note that this
1301 # feature is still experimental and incomplete at the
1302 # moment.
1303
1304 GENERATE_PERLMOD       = NO
1305
1306 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1307 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1308 # to generate PDF and DVI output from the Perl module output.
1309
1310 PERLMOD_LATEX          = NO
1311
1312 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1313 # nicely formatted so it can be parsed by a human reader.
1314 # This is useful
1315 # if you want to understand what is going on.
1316 # On the other hand, if this
1317 # tag is set to NO the size of the Perl module output will be much smaller
1318 # and Perl will parse it just the same.
1319
1320 PERLMOD_PRETTY         = YES
1321
1322 # The names of the make variables in the generated doxyrules.make file
1323 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1324 # This is useful so different doxyrules.make files included by the same
1325 # Makefile don't overwrite each other's variables.
1326
1327 PERLMOD_MAKEVAR_PREFIX =
1328
1329 #---------------------------------------------------------------------------
1330 # Configuration options related to the preprocessor
1331 #---------------------------------------------------------------------------
1332
1333 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1334 # evaluate all C-preprocessor directives found in the sources and include
1335 # files.
1336
1337 ENABLE_PREPROCESSING   = YES
1338
1339 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1340 # names in the source code. If set to NO (the default) only conditional
1341 # compilation will be performed. Macro expansion can be done in a controlled
1342 # way by setting EXPAND_ONLY_PREDEF to YES.
1343
1344 MACRO_EXPANSION        = YES
1345
1346 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1347 # then the macro expansion is limited to the macros specified with the
1348 # PREDEFINED and EXPAND_AS_DEFINED tags.
1349
1350 EXPAND_ONLY_PREDEF     = YES
1351
1352 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1353 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1354
1355 SEARCH_INCLUDES        = YES
1356
1357 # The INCLUDE_PATH tag can be used to specify one or more directories that
1358 # contain include files that are not input files but should be processed by
1359 # the preprocessor.
1360
1361 INCLUDE_PATH           = ./ \
1362                          include/ \
1363                          include/asterisk/
1364
1365 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1366 # patterns (like *.h and *.hpp) to filter out the header-files in the
1367 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1368 # be used.
1369
1370 INCLUDE_FILE_PATTERNS  =
1371
1372 # The PREDEFINED tag can be used to specify one or more macro names that
1373 # are defined before the preprocessor is started (similar to the -D option of
1374 # gcc). The argument of the tag is a list of macros of the form: name
1375 # or name=definition (no spaces). If the definition and the = are
1376 # omitted =1 is assumed. To prevent a macro definition from being
1377 # undefined via #undef or recursively expanded use the := operator
1378 # instead of the = operator.
1379
1380 PREDEFINED             = __GNUC__ \
1381                          __attribute__(x)=
1382
1383 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1384 # this tag can be used to specify a list of macro names that should be expanded.
1385 # The macro definition that is found in the sources will be used.
1386 # Use the PREDEFINED tag if you want to use a different macro definition.
1387
1388 EXPAND_AS_DEFINED      = \
1389             AST_INLINE_API \
1390             AST_DECLARE_STRING_FIELDS \
1391             AST_STRING_FIELD \
1392             AST_THREADSTORAGE \
1393             AST_THREADSTORAGE_CUSTOM \
1394             AST_MODULE_INFO \
1395             AST_MODULE_INFO_STANDARD \
1396             __AST_MUTEX_DEFINE \
1397             AST_MUTEX_DEFINE_STATIC \
1398             AST_MUTEX_DEFINE_STATIC_NOTRACKING \
1399             __AST_RWLOCK_DEFINE \
1400             AST_RWLOCK_DEFINE_STATIC \
1401             AST_LIST_HEAD \
1402             AST_RWLIST_HEAD \
1403             AST_LIST_HEAD_NOLOCK \
1404             AST_LIST_HEAD_STATIC \
1405             AST_RWLIST_HEAD_STATIC \
1406             AST_LIST_HEAD_NOLOCK_STATIC \
1407             AST_LIST_ENTRY \
1408             AST_RWLIST_ENTRY \
1409             __ASTOBJ_HASH \
1410             ASTOBJ_COMPONENTS_NOLOCK_FULL \
1411             ASTOBJ_COMPONENTS_NOLOCK \
1412             ASTOBJ_COMPONENTS_FULL \
1413             ASTOBJ_COMPONENTS \
1414             AST_IVR_DECLARE_MENU \
1415             AST_DECLARE_APP_ARGS \
1416             AST_DEFINE_APP_ARGS_TYPE \
1417             AST_APP_ARG \
1418             BEGIN_OPTIONS \
1419             END_OPTIONS \
1420             AST_APP_OPTIONS \
1421             AST_APP_OPTION \
1422             AST_APP_OPTION_ARG \
1423             AST_DLLIST_HEAD \
1424             AST_DLLIST_HEAD_STATIC \
1425             AST_DLLIST_HEAD_NOLOCK \
1426             AST_DLLIST_HEAD_NOLOCK_STATIC \
1427             AST_RWDLLIST_HEAD \
1428             AST_RWDLLIST_HEAD_STATIC \
1429             AST_DLLIST_ENTRY \
1430             AST_RWDLLIST_ENTRY \
1431             AST_CLI_DEFINE \
1432             AST_OPTIONAL_API \
1433             AST_OPTIONAL_API_ATTR
1434
1435 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1436 # doxygen's preprocessor will remove all function-like macros that are alone
1437 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1438 # function macros are typically used for boiler-plate code, and will confuse
1439 # the parser if not removed.
1440
1441 SKIP_FUNCTION_MACROS   = YES
1442
1443 #---------------------------------------------------------------------------
1444 # Configuration::additions related to external references
1445 #---------------------------------------------------------------------------
1446
1447 # The TAGFILES option can be used to specify one or more tagfiles.
1448 # Optionally an initial location of the external documentation
1449 # can be added for each tagfile. The format of a tag file without
1450 # this location is as follows:
1451 #
1452 # TAGFILES = file1 file2 ...
1453 # Adding location for the tag files is done as follows:
1454 #
1455 # TAGFILES = file1=loc1 "file2 = loc2" ...
1456 # where "loc1" and "loc2" can be relative or absolute paths or
1457 # URLs. If a location is present for each tag, the installdox tool
1458 # does not have to be run to correct the links.
1459 # Note that each tag file must have a unique name
1460 # (where the name does NOT include the path)
1461 # If a tag file is not located in the directory in which doxygen
1462 # is run, you must also specify the path to the tagfile here.
1463
1464 TAGFILES               =
1465
1466 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1467 # a tag file that is based on the input files it reads.
1468
1469 GENERATE_TAGFILE       =
1470
1471 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1472 # in the class index. If set to NO only the inherited external classes
1473 # will be listed.
1474
1475 ALLEXTERNALS           = NO
1476
1477 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1478 # in the modules index. If set to NO, only the current project's groups will
1479 # be listed.
1480
1481 EXTERNAL_GROUPS        = YES
1482
1483 # The PERL_PATH should be the absolute path and name of the perl script
1484 # interpreter (i.e. the result of `which perl').
1485
1486 PERL_PATH              = /usr/bin/perl
1487
1488 #---------------------------------------------------------------------------
1489 # Configuration options related to the dot tool
1490 #---------------------------------------------------------------------------
1491
1492 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1493 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1494 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1495 # this option is superseded by the HAVE_DOT option below. This is only a
1496 # fallback. It is recommended to install and use dot, since it yields more
1497 # powerful graphs.
1498
1499 CLASS_DIAGRAMS         = NO
1500
1501 # You can define message sequence charts within doxygen comments using the \msc
1502 # command. Doxygen will then run the mscgen tool (see
1503 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1504 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1505 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1506 # default search path.
1507
1508 MSCGEN_PATH            =
1509
1510 # If set to YES, the inheritance and collaboration graphs will hide
1511 # inheritance and usage relations if the target is undocumented
1512 # or is not a class.
1513
1514 HIDE_UNDOC_RELATIONS   = YES
1515
1516 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1517 # available from the path. This tool is part of Graphviz, a graph visualization
1518 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1519 # have no effect if this option is set to NO (the default)
1520
1521 HAVE_DOT               = NO
1522
1523 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1524 # allowed to run in parallel. When set to 0 (the default) doxygen will
1525 # base this on the number of processors available in the system. You can set it
1526 # explicitly to a value larger than 0 to get control over the balance
1527 # between CPU load and processing speed.
1528
1529 DOT_NUM_THREADS        = 0
1530
1531 # By default doxygen will write a font called FreeSans.ttf to the output
1532 # directory and reference it in all dot files that doxygen generates. This
1533 # font does not include all possible unicode characters however, so when you need
1534 # these (or just want a differently looking font) you can specify the font name
1535 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1536 # which can be done by putting it in a standard location or by setting the
1537 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1538 # containing the font.
1539
1540 DOT_FONTNAME           = FreeSans.ttf
1541
1542 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1543 # The default size is 10pt.
1544
1545 DOT_FONTSIZE           = 10
1546
1547 # By default doxygen will tell dot to use the output directory to look for the
1548 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1549 # different font using DOT_FONTNAME you can set the path where dot
1550 # can find it using this tag.
1551
1552 DOT_FONTPATH           =
1553
1554 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1555 # will generate a graph for each documented class showing the direct and
1556 # indirect inheritance relations. Setting this tag to YES will force the
1557 # the CLASS_DIAGRAMS tag to NO.
1558
1559 CLASS_GRAPH            = YES
1560
1561 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1562 # will generate a graph for each documented class showing the direct and
1563 # indirect implementation dependencies (inheritance, containment, and
1564 # class references variables) of the class with other documented classes.
1565
1566 COLLABORATION_GRAPH    = YES
1567
1568 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1569 # will generate a graph for groups, showing the direct groups dependencies
1570
1571 GROUP_GRAPHS           = YES
1572
1573 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1574 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1575 # Language.
1576
1577 UML_LOOK               = NO
1578
1579 # If set to YES, the inheritance and collaboration graphs will show the
1580 # relations between templates and their instances.
1581
1582 TEMPLATE_RELATIONS     = YES
1583
1584 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1585 # tags are set to YES then doxygen will generate a graph for each documented
1586 # file showing the direct and indirect include dependencies of the file with
1587 # other documented files.
1588
1589 INCLUDE_GRAPH          = YES
1590
1591 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1592 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1593 # documented header file showing the documented files that directly or
1594 # indirectly include this file.
1595
1596 INCLUDED_BY_GRAPH      = YES
1597
1598 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1599 # doxygen will generate a call dependency graph for every global function
1600 # or class method. Note that enabling this option will significantly increase
1601 # the time of a run. So in most cases it will be better to enable call graphs
1602 # for selected functions only using the \callgraph command.
1603
1604 CALL_GRAPH             = NO
1605
1606 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1607 # doxygen will generate a caller dependency graph for every global function
1608 # or class method. Note that enabling this option will significantly increase
1609 # the time of a run. So in most cases it will be better to enable caller
1610 # graphs for selected functions only using the \callergraph command.
1611
1612 CALLER_GRAPH           = NO
1613
1614 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1615 # will graphical hierarchy of all classes instead of a textual one.
1616
1617 GRAPHICAL_HIERARCHY    = YES
1618
1619 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1620 # then doxygen will show the dependencies a directory has on other directories
1621 # in a graphical way. The dependency relations are determined by the #include
1622 # relations between the files in the directories.
1623
1624 DIRECTORY_GRAPH        = YES
1625
1626 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1627 # generated by dot. Possible values are png, jpg, or gif
1628 # If left blank png will be used.
1629
1630 DOT_IMAGE_FORMAT       = png
1631
1632 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1633 # found. If left blank, it is assumed the dot tool can be found in the path.
1634
1635 DOT_PATH               =
1636
1637 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1638 # contain dot files that are included in the documentation (see the
1639 # \dotfile command).
1640
1641 DOTFILE_DIRS           =
1642
1643 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1644 # nodes that will be shown in the graph. If the number of nodes in a graph
1645 # becomes larger than this value, doxygen will truncate the graph, which is
1646 # visualized by representing a node as a red box. Note that doxygen if the
1647 # number of direct children of the root node in a graph is already larger than
1648 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1649 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1650
1651 DOT_GRAPH_MAX_NODES    = 50
1652
1653 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1654 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1655 # from the root by following a path via at most 3 edges will be shown. Nodes
1656 # that lay further from the root node will be omitted. Note that setting this
1657 # option to 1 or 2 may greatly reduce the computation time needed for large
1658 # code bases. Also note that the size of a graph can be further restricted by
1659 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1660
1661 MAX_DOT_GRAPH_DEPTH    = 3
1662
1663 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1664 # background. This is disabled by default, because dot on Windows does not
1665 # seem to support this out of the box. Warning: Depending on the platform used,
1666 # enabling this option may lead to badly anti-aliased labels on the edges of
1667 # a graph (i.e. they become hard to read).
1668
1669 DOT_TRANSPARENT        = NO
1670
1671 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1672 # files in one run (i.e. multiple -o and -T options on the command line). This
1673 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1674 # support this, this feature is disabled by default.
1675
1676 DOT_MULTI_TARGETS      = NO
1677
1678 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1679 # generate a legend page explaining the meaning of the various boxes and
1680 # arrows in the dot generated graphs.
1681
1682 GENERATE_LEGEND        = YES
1683
1684 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1685 # remove the intermediate dot files that are used to generate
1686 # the various graphs.
1687
1688 DOT_CLEANUP            = YES