source: 3DVCSoftware/branches/HTM-DEV-2.0-dev3-LG/doc/Doxyfile @ 753

Last change on this file since 753 was 537, checked in by tech, 11 years ago

Update to HM 11.0.

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