wav: simplify reporting of unknown encodings
[sox.git] / Doxyfile
blob451d4b4a1688ea8c70856b06ea27e9f7e26f06c4
1 # Doxyfile 1.7.6.1
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
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 (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
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.
23 DOXYFILE_ENCODING      = UTF-8
25 # The PROJECT_NAME tag is a single word (or sequence of words) that should 
26 # identify the project. Note that if you do not use Doxywizard you need 
27 # to put quotes around the project name if it contains spaces.
29 PROJECT_NAME           = "SoX - Sound eXchange"
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
32 # This could be handy for archiving the generated documentation or 
33 # if some version control system is used.
35 PROJECT_NUMBER         = 
37 # Using the PROJECT_BRIEF tag one can provide an optional one line description 
38 # for a project that appears at the top of each page and should give viewer 
39 # a quick idea about the purpose of the project. Keep the description short.
41 PROJECT_BRIEF          = "Audio file processing tool."
43 # With the PROJECT_LOGO tag one can specify an logo or icon that is 
44 # included in the documentation. The maximum height of the logo should not 
45 # exceed 55 pixels and the maximum width should not exceed 200 pixels. 
46 # Doxygen will copy the logo to the output directory.
48 PROJECT_LOGO           = 
50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
51 # base path where the generated documentation will be put. 
52 # If a relative path is entered, it will be relative to the location 
53 # where doxygen was started. If left blank the current directory will be used.
55 OUTPUT_DIRECTORY       = doc
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
58 # 4096 sub-directories (in 2 levels) under the output directory of each output 
59 # format and will distribute the generated files over these directories. 
60 # Enabling this option can be useful when feeding doxygen a huge amount of 
61 # source files, where putting all generated files in the same directory would 
62 # otherwise cause performance problems for the file system.
64 CREATE_SUBDIRS         = NO
66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
67 # documentation generated by doxygen is written. Doxygen will use this 
68 # information to generate all constant output in the proper language. 
69 # The default language is English, other supported languages are: 
70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 
75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
77 OUTPUT_LANGUAGE        = English
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
80 # include brief member descriptions after the members that are listed in 
81 # the file and class documentation (similar to JavaDoc). 
82 # Set to NO to disable this.
84 BRIEF_MEMBER_DESC      = YES
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
87 # the brief description of a member or function before the detailed description. 
88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
89 # brief descriptions will be completely suppressed.
91 REPEAT_BRIEF           = YES
93 # This tag implements a quasi-intelligent brief description abbreviator 
94 # that is used to form the text in various listings. Each string 
95 # in this list, if found as the leading text of the brief description, will be 
96 # stripped from the text and the result after processing the whole list, is 
97 # used as the annotated text. Otherwise, the brief description is used as-is. 
98 # If left blank, the following values are used ("$name" is automatically 
99 # replaced with the name of the entity): "The $name class" "The $name widget" 
100 # "The $name file" "is" "provides" "specifies" "contains" 
101 # "represents" "a" "an" "the"
103 ABBREVIATE_BRIEF       = "The $name class" \
104                          "The $name widget" \
105                          "The $name file" \
106                          is \
107                          provides \
108                          specifies \
109                          contains \
110                          represents \
111                          a \
112                          an \
113                          the
115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
116 # Doxygen will generate a detailed section even if there is only a brief 
117 # description.
119 ALWAYS_DETAILED_SEC    = NO
121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
122 # inherited members of a class in the documentation of that class as if those 
123 # members were ordinary class members. Constructors, destructors and assignment 
124 # operators of the base classes will not be shown.
126 INLINE_INHERITED_MEMB  = NO
128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
129 # path before files name in the file list and in the header files. If set 
130 # to NO the shortest path that makes the file name unique will be used.
132 FULL_PATH_NAMES        = YES
134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
135 # can be used to strip a user-defined part of the path. Stripping is 
136 # only done if one of the specified strings matches the left-hand part of 
137 # the path. The tag can be used to show relative paths in the file list. 
138 # If left blank the directory from which doxygen is run is used as the 
139 # path to strip.
141 STRIP_FROM_PATH        = 
143 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
144 # the path mentioned in the documentation of a class, which tells 
145 # the reader which header file to include in order to use a class. 
146 # If left blank only the name of the header file containing the class 
147 # definition is used. Otherwise one should specify the include paths that 
148 # are normally passed to the compiler using the -I flag.
150 STRIP_FROM_INC_PATH    = 
152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
153 # (but less readable) file names. This can be useful if your file system 
154 # doesn't support long names like on DOS, Mac, or CD-ROM.
156 SHORT_NAMES            = NO
158 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
159 # will interpret the first line (until the first dot) of a JavaDoc-style 
160 # comment as the brief description. If set to NO, the JavaDoc 
161 # comments will behave just like regular Qt-style comments 
162 # (thus requiring an explicit @brief command for a brief description.)
164 JAVADOC_AUTOBRIEF      = YES
166 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
167 # interpret the first line (until the first dot) of a Qt-style 
168 # comment as the brief description. If set to NO, the comments 
169 # will behave just like regular Qt-style comments (thus requiring 
170 # an explicit \brief command for a brief description.)
172 QT_AUTOBRIEF           = NO
174 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
175 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
176 # comments) as a brief description. This used to be the default behaviour. 
177 # The new default is to treat a multi-line C++ comment block as a detailed 
178 # description. Set this tag to YES if you prefer the old behaviour instead.
180 MULTILINE_CPP_IS_BRIEF = NO
182 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
183 # member inherits the documentation from any documented member that it 
184 # re-implements.
186 INHERIT_DOCS           = YES
188 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
189 # a new page for each member. If set to NO, the documentation of a member will 
190 # be part of the file/class/namespace that contains it.
192 SEPARATE_MEMBER_PAGES  = NO
194 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
195 # Doxygen uses this value to replace tabs by spaces in code fragments.
197 TAB_SIZE               = 8
199 # This tag can be used to specify a number of aliases that acts 
200 # as commands in the documentation. An alias has the form "name=value". 
201 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
202 # put the command \sideeffect (or @sideeffect) in the documentation, which 
203 # will result in a user-defined paragraph with heading "Side Effects:". 
204 # You can put \n's in the value part of an alias to insert newlines.
206 ALIASES                = 
208 # This tag can be used to specify a number of word-keyword mappings (TCL only). 
209 # A mapping has the form "name=value". For example adding 
210 # "class=itcl::class" will allow you to use the command class in the 
211 # itcl::class meaning.
213 TCL_SUBST              = 
215 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
216 # sources only. Doxygen will then generate output that is more tailored for C. 
217 # For instance, some of the names that are used will be different. The list 
218 # of all members will be omitted, etc.
220 OPTIMIZE_OUTPUT_FOR_C  = NO
222 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
223 # sources only. Doxygen will then generate output that is more tailored for 
224 # Java. For instance, namespaces will be presented as packages, qualified 
225 # scopes will look different, etc.
227 OPTIMIZE_OUTPUT_JAVA   = NO
229 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
230 # sources only. Doxygen will then generate output that is more tailored for 
231 # Fortran.
233 OPTIMIZE_FOR_FORTRAN   = NO
235 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
236 # sources. Doxygen will then generate output that is tailored for 
237 # VHDL.
239 OPTIMIZE_OUTPUT_VHDL   = NO
241 # Doxygen selects the parser to use depending on the extension of the files it 
242 # parses. With this tag you can assign which parser to use for a given extension. 
243 # Doxygen has a built-in mapping, but you can override or extend it using this 
244 # tag. The format is ext=language, where ext is a file extension, and language 
245 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 
246 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 
247 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 
248 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 
249 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
251 EXTENSION_MAPPING      = 
253 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
254 # to include (a tag file for) the STL sources as input, then you should 
255 # set this tag to YES in order to let doxygen match functions declarations and 
256 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
257 # func(std::string) {}). This also makes the inheritance and collaboration 
258 # diagrams that involve STL classes more complete and accurate.
260 BUILTIN_STL_SUPPORT    = NO
262 # If you use Microsoft's C++/CLI language, you should set this option to YES to 
263 # enable parsing support.
265 CPP_CLI_SUPPORT        = NO
267 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
268 # Doxygen will parse them like normal C++ but will assume all classes use public 
269 # instead of private inheritance when no explicit protection keyword is present.
271 SIP_SUPPORT            = NO
273 # For Microsoft's IDL there are propget and propput attributes to indicate getter 
274 # and setter methods for a property. Setting this option to YES (the default) 
275 # will make doxygen replace the get and set methods by a property in the 
276 # documentation. This will only work if the methods are indeed getting or 
277 # setting a simple type. If this is not the case, or you want to show the 
278 # methods anyway, you should set this option to NO.
280 IDL_PROPERTY_SUPPORT   = YES
282 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
283 # tag is set to YES, then doxygen will reuse the documentation of the first 
284 # member in the group (if any) for the other members of the group. By default 
285 # all members of a group must be documented explicitly.
287 DISTRIBUTE_GROUP_DOC   = NO
289 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
290 # the same type (for instance a group of public functions) to be put as a 
291 # subgroup of that type (e.g. under the Public Functions section). Set it to 
292 # NO to prevent subgrouping. Alternatively, this can be done per class using 
293 # the \nosubgrouping command.
295 SUBGROUPING            = YES
297 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and 
298 # unions are shown inside the group in which they are included (e.g. using 
299 # @ingroup) instead of on a separate page (for HTML and Man pages) or 
300 # section (for LaTeX and RTF).
302 INLINE_GROUPED_CLASSES = NO
304 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and 
305 # unions with only public data fields will be shown inline in the documentation 
306 # of the scope in which they are defined (i.e. file, namespace, or group 
307 # documentation), provided this scope is documented. If set to NO (the default), 
308 # structs, classes, and unions are shown on a separate page (for HTML and Man 
309 # pages) or section (for LaTeX and RTF).
311 INLINE_SIMPLE_STRUCTS  = NO
313 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
314 # is documented as struct, union, or enum with the name of the typedef. So 
315 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
316 # with name TypeT. When disabled the typedef will appear as a member of a file, 
317 # namespace, or class. And the struct will be named TypeS. This can typically 
318 # be useful for C code in case the coding convention dictates that all compound 
319 # types are typedef'ed and only the typedef is referenced, never the tag name.
321 TYPEDEF_HIDES_STRUCT   = YES
323 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
324 # determine which symbols to keep in memory and which to flush to disk. 
325 # When the cache is full, less often used symbols will be written to disk. 
326 # For small to medium size projects (<1000 input files) the default value is 
327 # probably good enough. For larger projects a too small cache size can cause 
328 # doxygen to be busy swapping symbols to and from disk most of the time 
329 # causing a significant performance penalty. 
330 # If the system has enough physical memory increasing the cache will improve the 
331 # performance by keeping more symbols in memory. Note that the value works on 
332 # a logarithmic scale so increasing the size by one will roughly double the 
333 # memory usage. The cache size is given by this formula: 
334 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
335 # corresponding to a cache size of 2^16 = 65536 symbols.
337 SYMBOL_CACHE_SIZE      = 0
339 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be 
340 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given 
341 # their name and scope. Since this can be an expensive process and often the 
342 # same symbol appear multiple times in the code, doxygen keeps a cache of 
343 # pre-resolved symbols. If the cache is too small doxygen will become slower. 
344 # If the cache is too large, memory is wasted. The cache size is given by this 
345 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, 
346 # corresponding to a cache size of 2^16 = 65536 symbols.
348 LOOKUP_CACHE_SIZE      = 0
350 #---------------------------------------------------------------------------
351 # Build related configuration options
352 #---------------------------------------------------------------------------
354 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
355 # documentation are documented, even if no documentation was available. 
356 # Private class members and static file members will be hidden unless 
357 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
359 EXTRACT_ALL            = NO
361 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
362 # will be included in the documentation.
364 EXTRACT_PRIVATE        = NO
366 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
367 # will be included in the documentation.
369 EXTRACT_STATIC         = NO
371 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
372 # defined locally in source files will be included in the documentation. 
373 # If set to NO only classes defined in header files are included.
375 EXTRACT_LOCAL_CLASSES  = YES
377 # This flag is only useful for Objective-C code. When set to YES local 
378 # methods, which are defined in the implementation section but not in 
379 # the interface are included in the documentation. 
380 # If set to NO (the default) only methods in the interface are included.
382 EXTRACT_LOCAL_METHODS  = NO
384 # If this flag is set to YES, the members of anonymous namespaces will be 
385 # extracted and appear in the documentation as a namespace called 
386 # 'anonymous_namespace{file}', where file will be replaced with the base 
387 # name of the file that contains the anonymous namespace. By default 
388 # anonymous namespaces are hidden.
390 EXTRACT_ANON_NSPACES   = NO
392 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
393 # undocumented members of documented classes, files or namespaces. 
394 # If set to NO (the default) these members will be included in the 
395 # various overviews, but no documentation section is generated. 
396 # This option has no effect if EXTRACT_ALL is enabled.
398 HIDE_UNDOC_MEMBERS     = NO
400 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
401 # undocumented classes that are normally visible in the class hierarchy. 
402 # If set to NO (the default) these classes will be included in the various 
403 # overviews. This option has no effect if EXTRACT_ALL is enabled.
405 HIDE_UNDOC_CLASSES     = NO
407 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
408 # friend (class|struct|union) declarations. 
409 # If set to NO (the default) these declarations will be included in the 
410 # documentation.
412 HIDE_FRIEND_COMPOUNDS  = NO
414 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
415 # documentation blocks found inside the body of a function. 
416 # If set to NO (the default) these blocks will be appended to the 
417 # function's detailed documentation block.
419 HIDE_IN_BODY_DOCS      = NO
421 # The INTERNAL_DOCS tag determines if documentation 
422 # that is typed after a \internal command is included. If the tag is set 
423 # to NO (the default) then the documentation will be excluded. 
424 # Set it to YES to include the internal documentation.
426 INTERNAL_DOCS          = NO
428 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
429 # file names in lower-case letters. If set to YES upper-case letters are also 
430 # allowed. This is useful if you have classes or files whose names only differ 
431 # in case and if your file system supports case sensitive file names. Windows 
432 # and Mac users are advised to set this option to NO.
434 CASE_SENSE_NAMES       = NO
436 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
437 # will show members with their full class and namespace scopes in the 
438 # documentation. If set to YES the scope will be hidden.
440 HIDE_SCOPE_NAMES       = YES
442 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
443 # will put a list of the files that are included by a file in the documentation 
444 # of that file.
446 SHOW_INCLUDE_FILES     = YES
448 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 
449 # will list include files with double quotes in the documentation 
450 # rather than with sharp brackets.
452 FORCE_LOCAL_INCLUDES   = NO
454 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
455 # is inserted in the documentation for inline members.
457 INLINE_INFO            = YES
459 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
460 # will sort the (detailed) documentation of file and class members 
461 # alphabetically by member name. If set to NO the members will appear in 
462 # declaration order.
464 SORT_MEMBER_DOCS       = YES
466 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
467 # brief documentation of file, namespace and class members alphabetically 
468 # by member name. If set to NO (the default) the members will appear in 
469 # declaration order.
471 SORT_BRIEF_DOCS        = NO
473 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 
474 # will sort the (brief and detailed) documentation of class members so that 
475 # constructors and destructors are listed first. If set to NO (the default) 
476 # the constructors will appear in the respective orders defined by 
477 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 
478 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 
479 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
481 SORT_MEMBERS_CTORS_1ST = NO
483 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
484 # hierarchy of group names into alphabetical order. If set to NO (the default) 
485 # the group names will appear in their defined order.
487 SORT_GROUP_NAMES       = NO
489 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
490 # sorted by fully-qualified names, including namespaces. If set to 
491 # NO (the default), the class list will be sorted only by class name, 
492 # not including the namespace part. 
493 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
494 # Note: This option applies only to the class list, not to the 
495 # alphabetical list.
497 SORT_BY_SCOPE_NAME     = NO
499 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to 
500 # do proper type resolution of all parameters of a function it will reject a 
501 # match between the prototype and the implementation of a member function even 
502 # if there is only one candidate or it is obvious which candidate to choose 
503 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 
504 # will still accept a match between prototype and implementation in such cases.
506 STRICT_PROTO_MATCHING  = NO
508 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
509 # disable (NO) the todo list. This list is created by putting \todo 
510 # commands in the documentation.
512 GENERATE_TODOLIST      = YES
514 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
515 # disable (NO) the test list. This list is created by putting \test 
516 # commands in the documentation.
518 GENERATE_TESTLIST      = YES
520 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
521 # disable (NO) the bug list. This list is created by putting \bug 
522 # commands in the documentation.
524 GENERATE_BUGLIST       = YES
526 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
527 # disable (NO) the deprecated list. This list is created by putting 
528 # \deprecated commands in the documentation.
530 GENERATE_DEPRECATEDLIST= YES
532 # The ENABLED_SECTIONS tag can be used to enable conditional 
533 # documentation sections, marked by \if sectionname ... \endif.
535 ENABLED_SECTIONS       = 
537 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
538 # the initial value of a variable or macro consists of for it to appear in 
539 # the documentation. If the initializer consists of more lines than specified 
540 # here it will be hidden. Use a value of 0 to hide initializers completely. 
541 # The appearance of the initializer of individual variables and macros in the 
542 # documentation can be controlled using \showinitializer or \hideinitializer 
543 # command in the documentation regardless of this setting.
545 MAX_INITIALIZER_LINES  = 30
547 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
548 # at the bottom of the documentation of classes and structs. If set to YES the 
549 # list will mention the files that were used to generate the documentation.
551 SHOW_USED_FILES        = YES
553 # If the sources in your project are distributed over multiple directories 
554 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
555 # in the documentation. The default is NO.
557 SHOW_DIRECTORIES       = NO
559 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
560 # This will remove the Files entry from the Quick Index and from the 
561 # Folder Tree View (if specified). The default is YES.
563 SHOW_FILES             = YES
565 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
566 # Namespaces page.  This will remove the Namespaces entry from the Quick Index 
567 # and from the Folder Tree View (if specified). The default is YES.
569 SHOW_NAMESPACES        = YES
571 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
572 # doxygen should invoke to get the current version for each file (typically from 
573 # the version control system). Doxygen will invoke the program by executing (via 
574 # popen()) the command <command> <input-file>, where <command> is the value of 
575 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
576 # provided by doxygen. Whatever the program writes to standard output 
577 # is used as the file version. See the manual for examples.
579 FILE_VERSION_FILTER    = 
581 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 
582 # by doxygen. The layout file controls the global structure of the generated 
583 # output files in an output format independent way. The create the layout file 
584 # that represents doxygen's defaults, run doxygen with the -l option. 
585 # You can optionally specify a file name after the option, if omitted 
586 # DoxygenLayout.xml will be used as the name of the layout file.
588 LAYOUT_FILE            = 
590 # The CITE_BIB_FILES tag can be used to specify one or more bib files 
591 # containing the references data. This must be a list of .bib files. The 
592 # .bib extension is automatically appended if omitted. Using this command 
593 # requires the bibtex tool to be installed. See also 
594 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style 
595 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this 
596 # feature you need bibtex and perl available in the search path.
598 CITE_BIB_FILES         = 
600 #---------------------------------------------------------------------------
601 # configuration options related to warning and progress messages
602 #---------------------------------------------------------------------------
604 # The QUIET tag can be used to turn on/off the messages that are generated 
605 # by doxygen. Possible values are YES and NO. If left blank NO is used.
607 QUIET                  = NO
609 # The WARNINGS tag can be used to turn on/off the warning messages that are 
610 # generated by doxygen. Possible values are YES and NO. If left blank 
611 # NO is used.
613 WARNINGS               = YES
615 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
616 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
617 # automatically be disabled.
619 WARN_IF_UNDOCUMENTED   = YES
621 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
622 # potential errors in the documentation, such as not documenting some 
623 # parameters in a documented function, or documenting parameters that 
624 # don't exist or using markup commands wrongly.
626 WARN_IF_DOC_ERROR      = YES
628 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 
629 # functions that are documented, but have no documentation for their parameters 
630 # or return value. If set to NO (the default) doxygen will only warn about 
631 # wrong or incomplete parameter documentation, but not about the absence of 
632 # documentation.
634 WARN_NO_PARAMDOC       = YES
636 # The WARN_FORMAT tag determines the format of the warning messages that 
637 # doxygen can produce. The string should contain the $file, $line, and $text 
638 # tags, which will be replaced by the file and line number from which the 
639 # warning originated and the warning text. Optionally the format may contain 
640 # $version, which will be replaced by the version of the file (if it could 
641 # be obtained via FILE_VERSION_FILTER)
643 WARN_FORMAT            = "$file:$line: $text"
645 # The WARN_LOGFILE tag can be used to specify a file to which warning 
646 # and error messages should be written. If left blank the output is written 
647 # to stderr.
649 WARN_LOGFILE           = 
651 #---------------------------------------------------------------------------
652 # configuration options related to the input files
653 #---------------------------------------------------------------------------
655 # The INPUT tag can be used to specify the files and/or directories that contain 
656 # documented source files. You may enter file names like "myfile.cpp" or 
657 # directories like "/usr/src/myproject". Separate the files or directories 
658 # with spaces.
660 INPUT                  = src
662 # This tag can be used to specify the character encoding of the source files 
663 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
664 # also the default input encoding. Doxygen uses libiconv (or the iconv built 
665 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
666 # the list of possible encodings.
668 INPUT_ENCODING         = UTF-8
670 # If the value of the INPUT tag contains directories, you can use the 
671 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
672 # and *.h) to filter out the source-files in the directories. If left 
673 # blank the following patterns are tested: 
674 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 
675 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 
676 # *.f90 *.f *.for *.vhd *.vhdl
678 FILE_PATTERNS          = sox.h
680 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
681 # should be searched for input files as well. Possible values are YES and NO. 
682 # If left blank NO is used.
684 RECURSIVE              = NO
686 # The EXCLUDE tag can be used to specify files and/or directories that should be 
687 # excluded from the INPUT source files. This way you can easily exclude a 
688 # subdirectory from a directory tree whose root is specified with the INPUT tag. 
689 # Note that relative paths are relative to the directory from which doxygen is 
690 # run.
692 EXCLUDE                = 
694 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 
695 # directories that are symbolic links (a Unix file system feature) are excluded 
696 # from the input.
698 EXCLUDE_SYMLINKS       = NO
700 # If the value of the INPUT tag contains directories, you can use the 
701 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
702 # certain files from those directories. Note that the wildcards are matched 
703 # against the file with absolute path, so to exclude all test directories 
704 # for example use the pattern */test/*
706 EXCLUDE_PATTERNS       = lsx_static_assert_*
708 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
709 # (namespaces, classes, functions, etc.) that should be excluded from the 
710 # output. The symbol name can be a fully qualified name, a word, or if the 
711 # wildcard * is used, a substring. Examples: ANamespace, AClass, 
712 # AClass::ANamespace, ANamespace::*Test
714 EXCLUDE_SYMBOLS        = 
716 # The EXAMPLE_PATH tag can be used to specify one or more files or 
717 # directories that contain example code fragments that are included (see 
718 # the \include command).
720 EXAMPLE_PATH           = 
722 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
723 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
724 # and *.h) to filter out the source-files in the directories. If left 
725 # blank all files are included.
727 EXAMPLE_PATTERNS       = *
729 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
730 # searched for input files to be used with the \include or \dontinclude 
731 # commands irrespective of the value of the RECURSIVE tag. 
732 # Possible values are YES and NO. If left blank NO is used.
734 EXAMPLE_RECURSIVE      = NO
736 # The IMAGE_PATH tag can be used to specify one or more files or 
737 # directories that contain image that are included in the documentation (see 
738 # the \image command).
740 IMAGE_PATH             = 
742 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
743 # invoke to filter for each input file. Doxygen will invoke the filter program 
744 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
745 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
746 # input file. Doxygen will then use the output that the filter program writes 
747 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
748 # ignored.
750 INPUT_FILTER           = 
752 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
753 # basis.  Doxygen will compare the file name with each pattern and apply the 
754 # filter if there is a match.  The filters are a list of the form: 
755 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
756 # info on how filters are used. If FILTER_PATTERNS is empty or if 
757 # non of the patterns match the file name, INPUT_FILTER is applied.
759 FILTER_PATTERNS        = 
761 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
762 # INPUT_FILTER) will be used to filter the input files when producing source 
763 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
765 FILTER_SOURCE_FILES    = NO
767 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 
768 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 
769 # and it is also possible to disable source filtering for a specific pattern 
770 # using *.ext= (so without naming a filter). This option only has effect when 
771 # FILTER_SOURCE_FILES is enabled.
773 FILTER_SOURCE_PATTERNS = 
775 #---------------------------------------------------------------------------
776 # configuration options related to source browsing
777 #---------------------------------------------------------------------------
779 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
780 # be generated. Documented entities will be cross-referenced with these sources. 
781 # Note: To get rid of all source code in the generated output, make sure also 
782 # VERBATIM_HEADERS is set to NO.
784 SOURCE_BROWSER         = NO
786 # Setting the INLINE_SOURCES tag to YES will include the body 
787 # of functions and classes directly in the documentation.
789 INLINE_SOURCES         = NO
791 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
792 # doxygen to hide any special comment blocks from generated source code 
793 # fragments. Normal C and C++ comments will always remain visible.
795 STRIP_CODE_COMMENTS    = YES
797 # If the REFERENCED_BY_RELATION tag is set to YES 
798 # then for each documented function all documented 
799 # functions referencing it will be listed.
801 REFERENCED_BY_RELATION = NO
803 # If the REFERENCES_RELATION tag is set to YES 
804 # then for each documented function all documented entities 
805 # called/used by that function will be listed.
807 REFERENCES_RELATION    = NO
809 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
810 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
811 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
812 # link to the source code.  Otherwise they will link to the documentation.
814 REFERENCES_LINK_SOURCE = YES
816 # If the USE_HTAGS tag is set to YES then the references to source code 
817 # will point to the HTML generated by the htags(1) tool instead of doxygen 
818 # built-in source browser. The htags tool is part of GNU's global source 
819 # tagging system (see http://www.gnu.org/software/global/global.html). You 
820 # will need version 4.8.6 or higher.
822 USE_HTAGS              = NO
824 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
825 # will generate a verbatim copy of the header file for each class for 
826 # which an include is specified. Set to NO to disable this.
828 VERBATIM_HEADERS       = YES
830 #---------------------------------------------------------------------------
831 # configuration options related to the alphabetical class index
832 #---------------------------------------------------------------------------
834 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
835 # of all compounds will be generated. Enable this if the project 
836 # contains a lot of classes, structs, unions or interfaces.
838 ALPHABETICAL_INDEX     = YES
840 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
841 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
842 # in which this list will be split (can be a number in the range [1..20])
844 COLS_IN_ALPHA_INDEX    = 5
846 # In case all classes in a project start with a common prefix, all 
847 # classes will be put under the same header in the alphabetical index. 
848 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
849 # should be ignored while generating the index headers.
851 IGNORE_PREFIX          = 
853 #---------------------------------------------------------------------------
854 # configuration options related to the HTML output
855 #---------------------------------------------------------------------------
857 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
858 # generate HTML output.
860 GENERATE_HTML          = YES
862 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
863 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
864 # put in front of it. If left blank `html' will be used as the default path.
866 HTML_OUTPUT            = html
868 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
869 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
870 # doxygen will generate files with .html extension.
872 HTML_FILE_EXTENSION    = .html
874 # The HTML_HEADER tag can be used to specify a personal HTML header for 
875 # each generated HTML page. If it is left blank doxygen will generate a 
876 # standard header. Note that when using a custom header you are responsible  
877 # for the proper inclusion of any scripts and style sheets that doxygen 
878 # needs, which is dependent on the configuration options used. 
879 # It is advised to generate a default header using "doxygen -w html 
880 # header.html footer.html stylesheet.css YourConfigFile" and then modify 
881 # that header. Note that the header is subject to change so you typically 
882 # have to redo this when upgrading to a newer version of doxygen or when 
883 # changing the value of configuration settings such as GENERATE_TREEVIEW!
885 HTML_HEADER            = 
887 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
888 # each generated HTML page. If it is left blank doxygen will generate a 
889 # standard footer.
891 HTML_FOOTER            = 
893 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
894 # style sheet that is used by each HTML page. It can be used to 
895 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
896 # will generate a default style sheet. Note that doxygen will try to copy 
897 # the style sheet file to the HTML output directory, so don't put your own 
898 # style sheet in the HTML output directory as well, or it will be erased!
900 HTML_STYLESHEET        = 
902 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 
903 # other source files which should be copied to the HTML output directory. Note 
904 # that these files will be copied to the base HTML output directory. Use the 
905 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 
906 # files. In the HTML_STYLESHEET file, use the file name only. Also note that 
907 # the files will be copied as-is; there are no commands or markers available.
909 HTML_EXTRA_FILES       = 
911 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 
912 # Doxygen will adjust the colors in the style sheet and background images 
913 # according to this color. Hue is specified as an angle on a colorwheel, 
914 # see http://en.wikipedia.org/wiki/Hue for more information. 
915 # For instance the value 0 represents red, 60 is yellow, 120 is green, 
916 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 
917 # The allowed range is 0 to 359.
919 HTML_COLORSTYLE_HUE    = 220
921 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 
922 # the colors in the HTML output. For a value of 0 the output will use 
923 # grayscales only. A value of 255 will produce the most vivid colors.
925 HTML_COLORSTYLE_SAT    = 100
927 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 
928 # the luminance component of the colors in the HTML output. Values below 
929 # 100 gradually make the output lighter, whereas values above 100 make 
930 # the output darker. The value divided by 100 is the actual gamma applied, 
931 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 
932 # and 100 does not change the gamma.
934 HTML_COLORSTYLE_GAMMA  = 80
936 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 
937 # page will contain the date and time when the page was generated. Setting 
938 # this to NO can help when comparing the output of multiple runs.
940 HTML_TIMESTAMP         = YES
942 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
943 # files or namespaces will be aligned in HTML using tables. If set to 
944 # NO a bullet list will be used.
946 HTML_ALIGN_MEMBERS     = YES
948 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
949 # documentation will contain sections that can be hidden and shown after the 
950 # page has loaded. For this to work a browser that supports 
951 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
952 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
954 HTML_DYNAMIC_SECTIONS  = NO
956 # If the GENERATE_DOCSET tag is set to YES, additional index files 
957 # will be generated that can be used as input for Apple's Xcode 3 
958 # integrated development environment, introduced with OSX 10.5 (Leopard). 
959 # To create a documentation set, doxygen will generate a Makefile in the 
960 # HTML output directory. Running make will produce the docset in that 
961 # directory and running "make install" will install the docset in 
962 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
963 # it at startup. 
964 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 
965 # for more information.
967 GENERATE_DOCSET        = NO
969 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
970 # feed. A documentation feed provides an umbrella under which multiple 
971 # documentation sets from a single provider (such as a company or product suite) 
972 # can be grouped.
974 DOCSET_FEEDNAME        = "Doxygen generated docs"
976 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
977 # should uniquely identify the documentation set bundle. This should be a 
978 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
979 # will append .docset to the name.
981 DOCSET_BUNDLE_ID       = org.doxygen.Project
983 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 
984 # the documentation publisher. This should be a reverse domain-name style 
985 # string, e.g. com.mycompany.MyDocSet.documentation.
987 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
989 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
991 DOCSET_PUBLISHER_NAME  = Publisher
993 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
994 # will be generated that can be used as input for tools like the 
995 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
996 # of the generated HTML documentation.
998 GENERATE_HTMLHELP      = NO
1000 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
1001 # be used to specify the file name of the resulting .chm file. You 
1002 # can add a path in front of the file if the result should not be 
1003 # written to the html output directory.
1005 CHM_FILE               = 
1007 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
1008 # be used to specify the location (absolute path including file name) of 
1009 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
1010 # the HTML help compiler on the generated index.hhp.
1012 HHC_LOCATION           = 
1014 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
1015 # controls if a separate .chi index file is generated (YES) or that 
1016 # it should be included in the master .chm file (NO).
1018 GENERATE_CHI           = NO
1020 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
1021 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 
1022 # content.
1024 CHM_INDEX_ENCODING     = 
1026 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
1027 # controls whether a binary table of contents is generated (YES) or a 
1028 # normal table of contents (NO) in the .chm file.
1030 BINARY_TOC             = NO
1032 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
1033 # to the contents of the HTML help documentation and to the tree view.
1035 TOC_EXPAND             = NO
1037 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 
1038 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 
1039 # that can be used as input for Qt's qhelpgenerator to generate a 
1040 # Qt Compressed Help (.qch) of the generated HTML documentation.
1042 GENERATE_QHP           = NO
1044 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
1045 # be used to specify the file name of the resulting .qch file. 
1046 # The path specified is relative to the HTML output folder.
1048 QCH_FILE               = 
1050 # The QHP_NAMESPACE tag specifies the namespace to use when generating 
1051 # Qt Help Project output. For more information please see 
1052 # http://doc.trolltech.com/qthelpproject.html#namespace
1054 QHP_NAMESPACE          = org.doxygen.Project
1056 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
1057 # Qt Help Project output. For more information please see 
1058 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1060 QHP_VIRTUAL_FOLDER     = doc
1062 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 
1063 # add. For more information please see 
1064 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1066 QHP_CUST_FILTER_NAME   = 
1068 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 
1069 # custom filter to add. For more information please see 
1070 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 
1071 # Qt Help Project / Custom Filters</a>.
1073 QHP_CUST_FILTER_ATTRS  = 
1075 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 
1076 # project's 
1077 # filter section matches. 
1078 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 
1079 # Qt Help Project / Filter Attributes</a>.
1081 QHP_SECT_FILTER_ATTRS  = 
1083 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
1084 # be used to specify the location of Qt's qhelpgenerator. 
1085 # If non-empty doxygen will try to run qhelpgenerator on the generated 
1086 # .qhp file.
1088 QHG_LOCATION           = 
1090 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  
1091 # will be generated, which together with the HTML files, form an Eclipse help 
1092 # plugin. To install this plugin and make it available under the help contents 
1093 # menu in Eclipse, the contents of the directory containing the HTML and XML 
1094 # files needs to be copied into the plugins directory of eclipse. The name of 
1095 # the directory within the plugins directory should be the same as 
1096 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 
1097 # the help appears.
1099 GENERATE_ECLIPSEHELP   = NO
1101 # A unique identifier for the eclipse help plugin. When installing the plugin 
1102 # the directory name containing the HTML and XML files should also have 
1103 # this name.
1105 ECLIPSE_DOC_ID         = org.doxygen.Project
1107 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 
1108 # at top of each HTML page. The value NO (the default) enables the index and 
1109 # the value YES disables it. Since the tabs have the same information as the 
1110 # navigation tree you can set this option to NO if you already set 
1111 # GENERATE_TREEVIEW to YES.
1113 DISABLE_INDEX          = NO
1115 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
1116 # structure should be generated to display hierarchical information. 
1117 # If the tag value is set to YES, a side panel will be generated 
1118 # containing a tree-like index structure (just like the one that 
1119 # is generated for HTML Help). For this to work a browser that supports 
1120 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 
1121 # Windows users are probably better off using the HTML help feature. 
1122 # Since the tree basically has the same information as the tab index you 
1123 # could consider to set DISABLE_INDEX to NO when enabling this option.
1125 GENERATE_TREEVIEW      = NO
1127 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values 
1128 # (range [0,1..20]) that doxygen will group on one line in the generated HTML 
1129 # documentation. Note that a value of 0 will completely suppress the enum 
1130 # values from appearing in the overview section.
1132 ENUM_VALUES_PER_LINE   = 4
1134 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 
1135 # and Class Hierarchy pages using a tree view instead of an ordered list.
1137 USE_INLINE_TREES       = NO
1139 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
1140 # used to set the initial width (in pixels) of the frame in which the tree 
1141 # is shown.
1143 TREEVIEW_WIDTH         = 250
1145 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 
1146 # links to external symbols imported via tag files in a separate window.
1148 EXT_LINKS_IN_WINDOW    = NO
1150 # Use this tag to change the font size of Latex formulas included 
1151 # as images in the HTML documentation. The default is 10. Note that 
1152 # when you change the font size after a successful doxygen run you need 
1153 # to manually remove any form_*.png images from the HTML output directory 
1154 # to force them to be regenerated.
1156 FORMULA_FONTSIZE       = 10
1158 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 
1159 # generated for formulas are transparent PNGs. Transparent PNGs are 
1160 # not supported properly for IE 6.0, but are supported on all modern browsers. 
1161 # Note that when changing this option you need to delete any form_*.png files 
1162 # in the HTML output before the changes have effect.
1164 FORMULA_TRANSPARENT    = YES
1166 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 
1167 # (see http://www.mathjax.org) which uses client side Javascript for the 
1168 # rendering instead of using prerendered bitmaps. Use this if you do not 
1169 # have LaTeX installed or if you want to formulas look prettier in the HTML 
1170 # output. When enabled you also need to install MathJax separately and 
1171 # configure the path to it using the MATHJAX_RELPATH option.
1173 USE_MATHJAX            = NO
1175 # When MathJax is enabled you need to specify the location relative to the 
1176 # HTML output directory using the MATHJAX_RELPATH option. The destination 
1177 # directory should contain the MathJax.js script. For instance, if the mathjax 
1178 # directory is located at the same level as the HTML output directory, then 
1179 # MATHJAX_RELPATH should be ../mathjax. The default value points to the 
1180 # mathjax.org site, so you can quickly see the result without installing 
1181 # MathJax, but it is strongly recommended to install a local copy of MathJax 
1182 # before deployment.
1184 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1186 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension 
1187 # names that should be enabled during MathJax rendering.
1189 MATHJAX_EXTENSIONS     = 
1191 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 
1192 # for the HTML output. The underlying search engine uses javascript 
1193 # and DHTML and should work on any modern browser. Note that when using 
1194 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 
1195 # (GENERATE_DOCSET) there is already a search function so this one should 
1196 # typically be disabled. For large projects the javascript based search engine 
1197 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1199 SEARCHENGINE           = YES
1201 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 
1202 # implemented using a PHP enabled web server instead of at the web client 
1203 # using Javascript. Doxygen will generate the search PHP script and index 
1204 # file to put on the web server. The advantage of the server 
1205 # based approach is that it scales better to large projects and allows 
1206 # full text search. The disadvantages are that it is more difficult to setup 
1207 # and does not have live searching capabilities.
1209 SERVER_BASED_SEARCH    = NO
1211 #---------------------------------------------------------------------------
1212 # configuration options related to the LaTeX output
1213 #---------------------------------------------------------------------------
1215 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
1216 # generate Latex output.
1218 GENERATE_LATEX         = NO
1220 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
1221 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1222 # put in front of it. If left blank `latex' will be used as the default path.
1224 LATEX_OUTPUT           = latex
1226 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
1227 # invoked. If left blank `latex' will be used as the default command name. 
1228 # Note that when enabling USE_PDFLATEX this option is only used for 
1229 # generating bitmaps for formulas in the HTML output, but not in the 
1230 # Makefile that is written to the output directory.
1232 LATEX_CMD_NAME         = latex
1234 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
1235 # generate index for LaTeX. If left blank `makeindex' will be used as the 
1236 # default command name.
1238 MAKEINDEX_CMD_NAME     = makeindex
1240 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
1241 # LaTeX documents. This may be useful for small projects and may help to 
1242 # save some trees in general.
1244 COMPACT_LATEX          = NO
1246 # The PAPER_TYPE tag can be used to set the paper type that is used 
1247 # by the printer. Possible values are: a4, letter, legal and 
1248 # executive. If left blank a4wide will be used.
1250 PAPER_TYPE             = a4
1252 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
1253 # packages that should be included in the LaTeX output.
1255 EXTRA_PACKAGES         = 
1257 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
1258 # the generated latex document. The header should contain everything until 
1259 # the first chapter. If it is left blank doxygen will generate a 
1260 # standard header. Notice: only use this tag if you know what you are doing!
1262 LATEX_HEADER           = 
1264 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for 
1265 # the generated latex document. The footer should contain everything after 
1266 # the last chapter. If it is left blank doxygen will generate a 
1267 # standard footer. Notice: only use this tag if you know what you are doing!
1269 LATEX_FOOTER           = 
1271 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
1272 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
1273 # contain links (just like the HTML output) instead of page references 
1274 # This makes the output suitable for online browsing using a pdf viewer.
1276 PDF_HYPERLINKS         = YES
1278 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
1279 # plain latex in the generated Makefile. Set this option to YES to get a 
1280 # higher quality PDF documentation.
1282 USE_PDFLATEX           = YES
1284 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
1285 # command to the generated LaTeX files. This will instruct LaTeX to keep 
1286 # running if errors occur, instead of asking the user for help. 
1287 # This option is also used when generating formulas in HTML.
1289 LATEX_BATCHMODE        = NO
1291 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
1292 # include the index chapters (such as File Index, Compound Index, etc.) 
1293 # in the output.
1295 LATEX_HIDE_INDICES     = NO
1297 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 
1298 # source code with syntax highlighting in the LaTeX output. 
1299 # Note that which sources are shown also depends on other settings 
1300 # such as SOURCE_BROWSER.
1302 LATEX_SOURCE_CODE      = NO
1304 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 
1305 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See 
1306 # http://en.wikipedia.org/wiki/BibTeX for more info.
1308 LATEX_BIB_STYLE        = plain
1310 #---------------------------------------------------------------------------
1311 # configuration options related to the RTF output
1312 #---------------------------------------------------------------------------
1314 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
1315 # The RTF output is optimized for Word 97 and may not look very pretty with 
1316 # other RTF readers or editors.
1318 GENERATE_RTF           = NO
1320 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
1321 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1322 # put in front of it. If left blank `rtf' will be used as the default path.
1324 RTF_OUTPUT             = rtf
1326 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
1327 # RTF documents. This may be useful for small projects and may help to 
1328 # save some trees in general.
1330 COMPACT_RTF            = NO
1332 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
1333 # will contain hyperlink fields. The RTF file will 
1334 # contain links (just like the HTML output) instead of page references. 
1335 # This makes the output suitable for online browsing using WORD or other 
1336 # programs which support those fields. 
1337 # Note: wordpad (write) and others do not support links.
1339 RTF_HYPERLINKS         = NO
1341 # Load style sheet definitions from file. Syntax is similar to doxygen's 
1342 # config file, i.e. a series of assignments. You only have to provide 
1343 # replacements, missing definitions are set to their default value.
1345 RTF_STYLESHEET_FILE    = 
1347 # Set optional variables used in the generation of an rtf document. 
1348 # Syntax is similar to doxygen's config file.
1350 RTF_EXTENSIONS_FILE    = 
1352 #---------------------------------------------------------------------------
1353 # configuration options related to the man page output
1354 #---------------------------------------------------------------------------
1356 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
1357 # generate man pages
1359 GENERATE_MAN           = NO
1361 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
1362 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1363 # put in front of it. If left blank `man' will be used as the default path.
1365 MAN_OUTPUT             = man
1367 # The MAN_EXTENSION tag determines the extension that is added to 
1368 # the generated man pages (default is the subroutine's section .3)
1370 MAN_EXTENSION          = .3
1372 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
1373 # then it will generate one additional man file for each entity 
1374 # documented in the real man page(s). These additional files 
1375 # only source the real man page, but without them the man command 
1376 # would be unable to find the correct page. The default is NO.
1378 MAN_LINKS              = NO
1380 #---------------------------------------------------------------------------
1381 # configuration options related to the XML output
1382 #---------------------------------------------------------------------------
1384 # If the GENERATE_XML tag is set to YES Doxygen will 
1385 # generate an XML file that captures the structure of 
1386 # the code including all documentation.
1388 GENERATE_XML           = NO
1390 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
1391 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1392 # put in front of it. If left blank `xml' will be used as the default path.
1394 XML_OUTPUT             = xml
1396 # The XML_SCHEMA tag can be used to specify an XML schema, 
1397 # which can be used by a validating XML parser to check the 
1398 # syntax of the XML files.
1400 XML_SCHEMA             = 
1402 # The XML_DTD tag can be used to specify an XML DTD, 
1403 # which can be used by a validating XML parser to check the 
1404 # syntax of the XML files.
1406 XML_DTD                = 
1408 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
1409 # dump the program listings (including syntax highlighting 
1410 # and cross-referencing information) to the XML output. Note that 
1411 # enabling this will significantly increase the size of the XML output.
1413 XML_PROGRAMLISTING     = YES
1415 #---------------------------------------------------------------------------
1416 # configuration options for the AutoGen Definitions output
1417 #---------------------------------------------------------------------------
1419 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
1420 # generate an AutoGen Definitions (see autogen.sf.net) file 
1421 # that captures the structure of the code including all 
1422 # documentation. Note that this feature is still experimental 
1423 # and incomplete at the moment.
1425 GENERATE_AUTOGEN_DEF   = NO
1427 #---------------------------------------------------------------------------
1428 # configuration options related to the Perl module output
1429 #---------------------------------------------------------------------------
1431 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
1432 # generate a Perl module file that captures the structure of 
1433 # the code including all documentation. Note that this 
1434 # feature is still experimental and incomplete at the 
1435 # moment.
1437 GENERATE_PERLMOD       = NO
1439 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1440 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
1441 # to generate PDF and DVI output from the Perl module output.
1443 PERLMOD_LATEX          = NO
1445 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1446 # nicely formatted so it can be parsed by a human reader.  This is useful 
1447 # if you want to understand what is going on.  On the other hand, if this 
1448 # tag is set to NO the size of the Perl module output will be much smaller 
1449 # and Perl will parse it just the same.
1451 PERLMOD_PRETTY         = YES
1453 # The names of the make variables in the generated doxyrules.make file 
1454 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1455 # This is useful so different doxyrules.make files included by the same 
1456 # Makefile don't overwrite each other's variables.
1458 PERLMOD_MAKEVAR_PREFIX = 
1460 #---------------------------------------------------------------------------
1461 # Configuration options related to the preprocessor
1462 #---------------------------------------------------------------------------
1464 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1465 # evaluate all C-preprocessor directives found in the sources and include 
1466 # files.
1468 ENABLE_PREPROCESSING   = YES
1470 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1471 # names in the source code. If set to NO (the default) only conditional 
1472 # compilation will be performed. Macro expansion can be done in a controlled 
1473 # way by setting EXPAND_ONLY_PREDEF to YES.
1475 MACRO_EXPANSION        = NO
1477 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1478 # then the macro expansion is limited to the macros specified with the 
1479 # PREDEFINED and EXPAND_AS_DEFINED tags.
1481 EXPAND_ONLY_PREDEF     = YES
1483 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1484 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1486 SEARCH_INCLUDES        = YES
1488 # The INCLUDE_PATH tag can be used to specify one or more directories that 
1489 # contain include files that are not input files but should be processed by 
1490 # the preprocessor.
1492 INCLUDE_PATH           = 
1494 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1495 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1496 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1497 # be used.
1499 INCLUDE_FILE_PATTERNS  = 
1501 # The PREDEFINED tag can be used to specify one or more macro names that 
1502 # are defined before the preprocessor is started (similar to the -D option of 
1503 # gcc). The argument of the tag is a list of macros of the form: name 
1504 # or name=definition (no spaces). If the definition and the = are 
1505 # omitted =1 is assumed. To prevent a macro definition from being 
1506 # undefined via #undef or recursively expanded use the := operator 
1507 # instead of the = operator.
1509 PREDEFINED             = SCHAR_MIN=(-128) \
1510                          SCHAR_MAX=127 \
1511                          UCHAR_MAX=0xff \
1512                          SHRT_MAX=32767 \
1513                          SHRT_MIN=(-32768) \
1514                          USHRT_MAX=0xffff \
1515                          INT_MAX=2147483647 \
1516                          INT_MIN=(-2147483647-1) \
1517                          UINT_MAX=0xffffffff \
1518                          _DOXYGEN_
1520 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1521 # this tag can be used to specify a list of macro names that should be expanded. 
1522 # The macro definition that is found in the sources will be used. 
1523 # Use the PREDEFINED tag if you want to use a different macro definition that 
1524 # overrules the definition found in the source code.
1526 EXPAND_AS_DEFINED      = 
1528 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1529 # doxygen's preprocessor will remove all references to function-like macros 
1530 # that are alone on a line, have an all uppercase name, and do not end with a 
1531 # semicolon, because these will confuse the parser if not removed.
1533 SKIP_FUNCTION_MACROS   = YES
1535 #---------------------------------------------------------------------------
1536 # Configuration::additions related to external references
1537 #---------------------------------------------------------------------------
1539 # The TAGFILES option can be used to specify one or more tagfiles. 
1540 # Optionally an initial location of the external documentation 
1541 # can be added for each tagfile. The format of a tag file without 
1542 # this location is as follows: 
1543 #   TAGFILES = file1 file2 ... 
1544 # Adding location for the tag files is done as follows: 
1545 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1546 # where "loc1" and "loc2" can be relative or absolute paths or 
1547 # URLs. If a location is present for each tag, the installdox tool 
1548 # does not have to be run to correct the links. 
1549 # Note that each tag file must have a unique name 
1550 # (where the name does NOT include the path) 
1551 # If a tag file is not located in the directory in which doxygen 
1552 # is run, you must also specify the path to the tagfile here.
1554 TAGFILES               = 
1556 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1557 # a tag file that is based on the input files it reads.
1559 GENERATE_TAGFILE       = 
1561 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1562 # in the class index. If set to NO only the inherited external classes 
1563 # will be listed.
1565 ALLEXTERNALS           = NO
1567 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1568 # in the modules index. If set to NO, only the current project's groups will 
1569 # be listed.
1571 EXTERNAL_GROUPS        = YES
1573 # The PERL_PATH should be the absolute path and name of the perl script 
1574 # interpreter (i.e. the result of `which perl').
1576 PERL_PATH              = /usr/bin/perl
1578 #---------------------------------------------------------------------------
1579 # Configuration options related to the dot tool
1580 #---------------------------------------------------------------------------
1582 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1583 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1584 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
1585 # this option also works with HAVE_DOT disabled, but it is recommended to 
1586 # install and use dot, since it yields more powerful graphs.
1588 CLASS_DIAGRAMS         = YES
1590 # You can define message sequence charts within doxygen comments using the \msc 
1591 # command. Doxygen will then run the mscgen tool (see 
1592 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
1593 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 
1594 # the mscgen tool resides. If left empty the tool is assumed to be found in the 
1595 # default search path.
1597 MSCGEN_PATH            = 
1599 # If set to YES, the inheritance and collaboration graphs will hide 
1600 # inheritance and usage relations if the target is undocumented 
1601 # or is not a class.
1603 HIDE_UNDOC_RELATIONS   = YES
1605 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1606 # available from the path. This tool is part of Graphviz, a graph visualization 
1607 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1608 # have no effect if this option is set to NO (the default)
1610 HAVE_DOT               = NO
1612 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 
1613 # allowed to run in parallel. When set to 0 (the default) doxygen will 
1614 # base this on the number of processors available in the system. You can set it 
1615 # explicitly to a value larger than 0 to get control over the balance 
1616 # between CPU load and processing speed.
1618 DOT_NUM_THREADS        = 0
1620 # By default doxygen will use the Helvetica font for all dot files that 
1621 # doxygen generates. When you want a differently looking font you can specify 
1622 # the font name using DOT_FONTNAME. You need to make sure dot is able to find 
1623 # the font, which can be done by putting it in a standard location or by setting 
1624 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the 
1625 # directory containing the font.
1627 DOT_FONTNAME           = Helvetica
1629 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
1630 # The default size is 10pt.
1632 DOT_FONTSIZE           = 10
1634 # By default doxygen will tell dot to use the Helvetica font. 
1635 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to 
1636 # set the path where dot can find it.
1638 DOT_FONTPATH           = 
1640 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1641 # will generate a graph for each documented class showing the direct and 
1642 # indirect inheritance relations. Setting this tag to YES will force the 
1643 # CLASS_DIAGRAMS tag to NO.
1645 CLASS_GRAPH            = YES
1647 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1648 # will generate a graph for each documented class showing the direct and 
1649 # indirect implementation dependencies (inheritance, containment, and 
1650 # class references variables) of the class with other documented classes.
1652 COLLABORATION_GRAPH    = YES
1654 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1655 # will generate a graph for groups, showing the direct groups dependencies
1657 GROUP_GRAPHS           = YES
1659 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1660 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1661 # Language.
1663 UML_LOOK               = NO
1665 # If set to YES, the inheritance and collaboration graphs will show the 
1666 # relations between templates and their instances.
1668 TEMPLATE_RELATIONS     = NO
1670 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1671 # tags are set to YES then doxygen will generate a graph for each documented 
1672 # file showing the direct and indirect include dependencies of the file with 
1673 # other documented files.
1675 INCLUDE_GRAPH          = YES
1677 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1678 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1679 # documented header file showing the documented files that directly or 
1680 # indirectly include this file.
1682 INCLUDED_BY_GRAPH      = YES
1684 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 
1685 # doxygen will generate a call dependency graph for every global function 
1686 # or class method. Note that enabling this option will significantly increase 
1687 # the time of a run. So in most cases it will be better to enable call graphs 
1688 # for selected functions only using the \callgraph command.
1690 CALL_GRAPH             = NO
1692 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
1693 # doxygen will generate a caller dependency graph for every global function 
1694 # or class method. Note that enabling this option will significantly increase 
1695 # the time of a run. So in most cases it will be better to enable caller 
1696 # graphs for selected functions only using the \callergraph command.
1698 CALLER_GRAPH           = NO
1700 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1701 # will generate a graphical hierarchy of all classes instead of a textual one.
1703 GRAPHICAL_HIERARCHY    = YES
1705 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1706 # then doxygen will show the dependencies a directory has on other directories 
1707 # in a graphical way. The dependency relations are determined by the #include 
1708 # relations between the files in the directories.
1710 DIRECTORY_GRAPH        = YES
1712 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1713 # generated by dot. Possible values are svg, png, jpg, or gif. 
1714 # If left blank png will be used. If you choose svg you need to set 
1715 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files 
1716 # visible in IE 9+ (other browsers do not have this requirement).
1718 DOT_IMAGE_FORMAT       = png
1720 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 
1721 # enable generation of interactive SVG images that allow zooming and panning. 
1722 # Note that this requires a modern browser other than Internet Explorer. 
1723 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you 
1724 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files 
1725 # visible. Older versions of IE do not have SVG support.
1727 INTERACTIVE_SVG        = NO
1729 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1730 # found. If left blank, it is assumed the dot tool can be found in the path.
1732 DOT_PATH               = 
1734 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1735 # contain dot files that are included in the documentation (see the 
1736 # \dotfile command).
1738 DOTFILE_DIRS           = 
1740 # The MSCFILE_DIRS tag can be used to specify one or more directories that 
1741 # contain msc files that are included in the documentation (see the 
1742 # \mscfile command).
1744 MSCFILE_DIRS           = 
1746 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1747 # nodes that will be shown in the graph. If the number of nodes in a graph 
1748 # becomes larger than this value, doxygen will truncate the graph, which is 
1749 # visualized by representing a node as a red box. Note that doxygen if the 
1750 # number of direct children of the root node in a graph is already larger than 
1751 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
1752 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1754 DOT_GRAPH_MAX_NODES    = 50
1756 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1757 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
1758 # from the root by following a path via at most 3 edges will be shown. Nodes 
1759 # that lay further from the root node will be omitted. Note that setting this 
1760 # option to 1 or 2 may greatly reduce the computation time needed for large 
1761 # code bases. Also note that the size of a graph can be further restricted by 
1762 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1764 MAX_DOT_GRAPH_DEPTH    = 0
1766 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1767 # background. This is disabled by default, because dot on Windows does not 
1768 # seem to support this out of the box. Warning: Depending on the platform used, 
1769 # enabling this option may lead to badly anti-aliased labels on the edges of 
1770 # a graph (i.e. they become hard to read).
1772 DOT_TRANSPARENT        = NO
1774 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1775 # files in one run (i.e. multiple -o and -T options on the command line). This 
1776 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1777 # support this, this feature is disabled by default.
1779 DOT_MULTI_TARGETS      = NO
1781 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1782 # generate a legend page explaining the meaning of the various boxes and 
1783 # arrows in the dot generated graphs.
1785 GENERATE_LEGEND        = YES
1787 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1788 # remove the intermediate dot files that are used to generate 
1789 # the various graphs.
1791 DOT_CLEANUP            = YES