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