source: trunk/samples/Doxyfile.linux @ 39

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