An Overlay-based
Virtual Network Substrate
SpoVNet

source: docu/doxygen/Doxyfile.in @ 10700

Last change on this file since 10700 was 10700, checked in by Michael Tänzer, 7 years ago

Merge CMake branch into trunk

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