source: git/dox/Doxyfile.in @ daf33c

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