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