source:git/dox/Doxyfile.in

spielwiese
Last change on this file was 182ac7, checked in by Hans Schoenemann <hannes@…>, 2 years ago
moved kutil.cc -> kstd2.cc: ind2, ind_fact_2, removed VANIDEAL RING2TOM
• Property mode set to 100644
File size: 101.3 KB
Line
1# Doxyfile 1.8.7
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 double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the config file
21# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
26
27DOXYFILE_ENCODING      = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
34
35PROJECT_NAME           =
36
37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
40
41PROJECT_NUMBER         =$(git_version) 42 43# Using the PROJECT_BRIEF tag one can provide an optional one line description 44# for a project that appears at the top of each page and should give viewer a 45# quick idea about the purpose of the project. Keep the description short. 46 47PROJECT_BRIEF = 48 49# With the PROJECT_LOGO tag one can specify an logo or icon that is included in 50# the documentation. The maximum height of the logo should not exceed 55 pixels 51# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo 52# to the output directory. 53 54PROJECT_LOGO =$(abs_top_srcdir)/dox/logo.png
55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
60
61OUTPUT_DIRECTORY       =
62
63# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64# directories (in 2 levels) under the output directory of each output format and
65# will distribute the generated files over these directories. Enabling this
66# option can be useful when feeding doxygen a huge amount of source files, where
67# putting all generated files in the same directory would otherwise causes
68# performance problems for the file system.
69# The default value is: NO.
70
71CREATE_SUBDIRS         = NO
72
73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74# characters to appear in the names of generated files. If set to NO, non-ASCII
75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76# U+3044.
77# The default value is: NO.
78
79ALLOW_UNICODE_NAMES    = NO
80
81# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82# documentation generated by doxygen is written. Doxygen will use this
83# information to generate all constant output in the proper language.
84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91# Ukrainian and Vietnamese.
92# The default value is: English.
93
94OUTPUT_LANGUAGE        = English
95
96# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
97# descriptions after the members that are listed in the file and class
98# documentation (similar to Javadoc). Set to NO to disable this.
99# The default value is: YES.
100
101BRIEF_MEMBER_DESC      = YES
102
103# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
104# description of a member or function before the detailed description
105#
106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107# brief descriptions will be completely suppressed.
108# The default value is: YES.
109
110REPEAT_BRIEF           = YES
111
112# This tag implements a quasi-intelligent brief description abbreviator that is
113# used to form the text in various listings. Each string in this list, if found
114# as the leading text of the brief description, will be stripped from the text
115# and the result, after processing the whole list, is used as the annotated
116# text. Otherwise, the brief description is used as-is. If left blank, the
117# following values are used ($name is automatically replaced with the name of 118# the entity):The$name class, The $name widget, The$name file, is, provides,
119# specifies, contains, represents, a, an and the.
120
121ABBREVIATE_BRIEF       =
122
123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124# doxygen will generate a detailed section even if there is only a brief
125# description.
126# The default value is: NO.
127
128ALWAYS_DETAILED_SEC    = NO
129
130# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131# inherited members of a class in the documentation of that class as if those
132# members were ordinary class members. Constructors, destructors and assignment
133# operators of the base classes will not be shown.
134# The default value is: NO.
135
136INLINE_INHERITED_MEMB  = NO
137
138# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
139# before files name in the file list and in the header files. If set to NO the
140# shortest path that makes the file name unique will be used
141# The default value is: YES.
142
143FULL_PATH_NAMES        = YES
144
145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146# Stripping is only done if one of the specified strings matches the left-hand
147# part of the path. The tag can be used to show relative paths in the file list.
148# If left blank the directory from which doxygen is run is used as the path to
149# strip.
150#
151# Note that you can specify absolute paths here, but also relative paths, which
152# will be relative from the directory where doxygen is started.
153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
155STRIP_FROM_PATH        = $(abs_top_srcdir)$(abs_top_builddir)
156
157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158# path mentioned in the documentation of a class, which tells the reader which
159# header file to include in order to use a class. If left blank only the name of
160# the header file containing the class definition is used. Otherwise one should
161# specify the list of include paths that are normally passed to the compiler
162# using the -I flag.
163
164STRIP_FROM_INC_PATH    =
165
166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167# less readable) file names. This can be useful is your file systems doesn't
168# support long names like on DOS, Mac, or CD-ROM.
169# The default value is: NO.
170
171SHORT_NAMES            = NO
172
173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174# first line (until the first dot) of a Javadoc-style comment as the brief
175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176# style comments (thus requiring an explicit @brief command for a brief
177# description.)
178# The default value is: NO.
179
181
182# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183# line (until the first dot) of a Qt-style comment as the brief description. If
184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185# requiring an explicit \brief command for a brief description.)
186# The default value is: NO.
187
188QT_AUTOBRIEF           = YES
189
190# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192# a brief description. This used to be the default behavior. The new default is
193# to treat a multi-line C++ comment block as a detailed description. Set this
194# tag to YES if you prefer the old behavior instead.
195#
196# Note that setting this tag to YES also means that rational rose comments are
197# not recognized any more.
198# The default value is: NO.
199
200MULTILINE_CPP_IS_BRIEF = YES
201
202# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203# documentation from any documented member that it re-implements.
204# The default value is: YES.
205
206INHERIT_DOCS           = YES
207
208# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209# new page for each member. If set to NO, the documentation of a member will be
210# part of the file/class/namespace that contains it.
211# The default value is: NO.
212
213SEPARATE_MEMBER_PAGES  = NO
214
215# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216# uses this value to replace tabs by spaces in code fragments.
217# Minimum value: 1, maximum value: 16, default value: 4.
218
219TAB_SIZE               = 8
220
221# This tag can be used to specify a number of aliases that act as commands in
222# the documentation. An alias has the form:
223# name=value
225# "sideeffect=@par Side Effects:\n"
226# will allow you to put the command \sideeffect (or @sideeffect) in the
227# documentation, which will result in a user-defined paragraph with heading
228# "Side Effects:". You can put \n's in the value part of an alias to insert
229# newlines.
230
231ALIASES                =
232
233# This tag can be used to specify a number of word-keyword mappings (TCL only).
234# A mapping has the form "name=value". For example adding "class=itcl::class"
235# will allow you to use the command class in the itcl::class meaning.
236
237TCL_SUBST              =
238
239# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240# only. Doxygen will then generate output that is more tailored for C. For
241# instance, some of the names that are used will be different. The list of all
242# members will be omitted, etc.
243# The default value is: NO.
244
245OPTIMIZE_OUTPUT_FOR_C  = YES
246
247# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248# Python sources only. Doxygen will then generate output that is more tailored
249# for that language. For instance, namespaces will be presented as packages,
250# qualified scopes will look different, etc.
251# The default value is: NO.
252
253OPTIMIZE_OUTPUT_JAVA   = NO
254
255# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256# sources. Doxygen will then generate output that is tailored for Fortran.
257# The default value is: NO.
258
259OPTIMIZE_FOR_FORTRAN   = NO
260
261# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262# sources. Doxygen will then generate output that is tailored for VHDL.
263# The default value is: NO.
264
265OPTIMIZE_OUTPUT_VHDL   = NO
266
267# Doxygen selects the parser to use depending on the extension of the files it
268# parses. With this tag you can assign which parser to use for a given
269# extension. Doxygen has a built-in mapping, but you can override or extend it
270# using this tag. The format is ext=language, where ext is a file extension, and
271# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274# Fortran. In the later case the parser tries to guess whether the code is fixed
275# or free formatted code, this is the default for Fortran type files), VHDL. For
276# instance to make doxygen treat .inc files as Fortran files (default is PHP),
277# and .f files as C (default is Fortran), use: inc=Fortran f=C.
278#
279# Note For files without extension you can use no_extension as a placeholder.
280#
281# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282# the files are not read by doxygen.
283
284EXTENSION_MAPPING      =
285
286# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287# according to the Markdown format, which allows for more readable
288# documentation. See http://daringfireball.net/projects/markdown/ for details.
289# The output of markdown processing is further processed by doxygen, so you can
290# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291# case of backward compatibilities issues.
292# The default value is: YES.
293
294MARKDOWN_SUPPORT       = YES
295
296# When enabled doxygen tries to link words that correspond to documented
297# classes, or namespaces to their corresponding documentation. Such a link can
298# be prevented in individual cases by by putting a % sign in front of the word
299# or globally by setting AUTOLINK_SUPPORT to NO.
300# The default value is: YES.
301
303
304# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305# to include (a tag file for) the STL sources as input, then you should set this
306# tag to YES in order to let doxygen match functions declarations and
307# definitions whose arguments contain STL classes (e.g. func(std::string);
308# versus func(std::string) {}). This also make the inheritance and collaboration
309# diagrams that involve STL classes more complete and accurate.
310# The default value is: NO.
311
312BUILTIN_STL_SUPPORT    = YES
313
314# If you use Microsoft's C++/CLI language, you should set this option to YES to
315# enable parsing support.
316# The default value is: NO.
317
318CPP_CLI_SUPPORT        = NO
319
320# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322# will parse them like normal C++ but will assume all classes use public instead
323# of private inheritance when no explicit protection keyword is present.
324# The default value is: NO.
325
326SIP_SUPPORT            = NO
327
328# For Microsoft's IDL there are propget and propput attributes to indicate
329# getter and setter methods for a property. Setting this option to YES will make
330# doxygen to replace the get and set methods by a property in the documentation.
331# This will only work if the methods are indeed getting or setting a simple
332# type. If this is not the case, or you want to show the methods anyway, you
333# should set this option to NO.
334# The default value is: YES.
335
336IDL_PROPERTY_SUPPORT   = NO
337
338# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
339# tag is set to YES, then doxygen will reuse the documentation of the first
340# member in the group (if any) for the other members of the group. By default
341# all members of a group must be documented explicitly.
342# The default value is: NO.
343
344DISTRIBUTE_GROUP_DOC   = YES
345
346# Set the SUBGROUPING tag to YES to allow class member groups of the same type
347# (for instance a group of public functions) to be put as a subgroup of that
348# type (e.g. under the Public Functions section). Set it to NO to prevent
349# subgrouping. Alternatively, this can be done per class using the
350# \nosubgrouping command.
351# The default value is: YES.
352
353SUBGROUPING            = YES
354
355# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356# are shown inside the group in which they are included (e.g. using \ingroup)
357# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
358# and RTF).
359#
360# Note that this feature does not work in combination with
361# SEPARATE_MEMBER_PAGES.
362# The default value is: NO.
363
364INLINE_GROUPED_CLASSES = YES
365
366# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
367# with only public data fields or simple typedef fields will be shown inline in
368# the documentation of the scope in which they are defined (i.e. file,
369# namespace, or group documentation), provided this scope is documented. If set
370# to NO, structs, classes, and unions are shown on a separate page (for HTML and
371# Man pages) or section (for LaTeX and RTF).
372# The default value is: NO.
373
374INLINE_SIMPLE_STRUCTS  = YES
375
376# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
377# enum is documented as struct, union, or enum with the name of the typedef. So
378# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379# with name TypeT. When disabled the typedef will appear as a member of a file,
380# namespace, or class. And the struct will be named TypeS. This can typically be
381# useful for C code in case the coding convention dictates that all compound
382# types are typedef'ed and only the typedef is referenced, never the tag name.
383# The default value is: NO.
384
385TYPEDEF_HIDES_STRUCT   = YES
386
387# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
388# cache is used to resolve symbols given their name and scope. Since this can be
389# an expensive process and often the same symbol appears multiple times in the
390# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
391# doxygen will become slower. If the cache is too large, memory is wasted. The
392# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
393# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394# symbols. At the end of a run doxygen will report the cache usage and suggest
395# the optimal cache size from a speed point of view.
396# Minimum value: 0, maximum value: 9, default value: 0.
397
398LOOKUP_CACHE_SIZE      = 0
399
400#---------------------------------------------------------------------------
401# Build related configuration options
402#---------------------------------------------------------------------------
403
404# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
405# documentation are documented, even if no documentation was available. Private
406# class members and static file members will be hidden unless the
407# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
408# Note: This will also disable the warnings about undocumented members that are
409# normally produced when WARNINGS is set to YES.
410# The default value is: NO.
411
412EXTRACT_ALL            = YES
413
414# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
415# be included in the documentation.
416# The default value is: NO.
417
418EXTRACT_PRIVATE        = YES
419
420# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
421# scope will be included in the documentation.
422# The default value is: NO.
423
424EXTRACT_PACKAGE        = YES
425
426# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
427# included in the documentation.
428# The default value is: NO.
429
430EXTRACT_STATIC         = YES
431
432# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
433# locally in source files will be included in the documentation. If set to NO
434# only classes defined in header files are included. Does not have any effect
435# for Java sources.
436# The default value is: YES.
437
438EXTRACT_LOCAL_CLASSES  = YES
439
440# This flag is only useful for Objective-C code. When set to YES local methods,
441# which are defined in the implementation section but not in the interface are
442# included in the documentation. If set to NO only methods in the interface are
443# included.
444# The default value is: NO.
445
446EXTRACT_LOCAL_METHODS  = YES
447
448# If this flag is set to YES, the members of anonymous namespaces will be
449# extracted and appear in the documentation as a namespace called
450# 'anonymous_namespace{file}', where file will be replaced with the base name of
451# the file that contains the anonymous namespace. By default anonymous namespace
452# are hidden.
453# The default value is: NO.
454
455EXTRACT_ANON_NSPACES   = NO
456
457# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
458# undocumented members inside documented classes or files. If set to NO these
459# members will be included in the various overviews, but no documentation
460# section is generated. This option has no effect if EXTRACT_ALL is enabled.
461# The default value is: NO.
462
463HIDE_UNDOC_MEMBERS     = NO
464
465# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466# undocumented classes that are normally visible in the class hierarchy. If set
467# to NO these classes will be included in the various overviews. This option has
468# no effect if EXTRACT_ALL is enabled.
469# The default value is: NO.
470
471HIDE_UNDOC_CLASSES     = NO
472
473# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
474# (class|struct|union) declarations. If set to NO these declarations will be
475# included in the documentation.
476# The default value is: NO.
477
478HIDE_FRIEND_COMPOUNDS  = NO
479
480# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
481# documentation blocks found inside the body of a function. If set to NO these
482# blocks will be appended to the function's detailed documentation block.
483# The default value is: NO.
484
485HIDE_IN_BODY_DOCS      = NO
486
487# The INTERNAL_DOCS tag determines if documentation that is typed after a
488# \internal command is included. If the tag is set to NO then the documentation
489# will be excluded. Set it to YES to include the internal documentation.
490# The default value is: NO.
491
492INTERNAL_DOCS          = YES
493
494# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
495# names in lower-case letters. If set to YES upper-case letters are also
496# allowed. This is useful if you have classes or files whose names only differ
497# in case and if your file system supports case sensitive file names. Windows
498# and Mac users are advised to set this option to NO.
499# The default value is: system dependent.
500
501CASE_SENSE_NAMES       = YES
502
503# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
504# their full class and namespace scopes in the documentation. If set to YES the
505# scope will be hidden.
506# The default value is: NO.
507
508HIDE_SCOPE_NAMES       = NO
509
510# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
511# the files that are included by a file in the documentation of that file.
512# The default value is: YES.
513
514SHOW_INCLUDE_FILES     = YES
515
516# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
517# grouped member an include statement to the documentation, telling the reader
518# which file to include in order to use the member.
519# The default value is: NO.
520
521SHOW_GROUPED_MEMB_INC  = YES
522
523# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
524# files with double quotes in the documentation rather than with sharp brackets.
525# The default value is: NO.
526
527FORCE_LOCAL_INCLUDES   = NO
528
529# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
530# documentation for inline members.
531# The default value is: YES.
532
533INLINE_INFO            = YES
534
535# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
536# (detailed) documentation of file and class members alphabetically by member
537# name. If set to NO the members will appear in declaration order.
538# The default value is: YES.
539
540SORT_MEMBER_DOCS       = YES
541
542# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
543# descriptions of file, namespace and class members alphabetically by member
544# name. If set to NO the members will appear in declaration order. Note that
545# this will also influence the order of the classes in the class list.
546# The default value is: NO.
547
548SORT_BRIEF_DOCS        = NO
549
550# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
551# (brief and detailed) documentation of class members so that constructors and
552# destructors are listed first. If set to NO the constructors will appear in the
553# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
554# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
555# member documentation.
556# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
557# detailed member documentation.
558# The default value is: NO.
559
560SORT_MEMBERS_CTORS_1ST = NO
561
562# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
563# of group names into alphabetical order. If set to NO the group names will
564# appear in their defined order.
565# The default value is: NO.
566
567SORT_GROUP_NAMES       = NO
568
569# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
570# fully-qualified names, including namespaces. If set to NO, the class list will
571# be sorted only by class name, not including the namespace part.
572# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
573# Note: This option applies only to the class list, not to the alphabetical
574# list.
575# The default value is: NO.
576
577SORT_BY_SCOPE_NAME     = NO
578
579# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
580# type resolution of all parameters of a function it will reject a match between
581# the prototype and the implementation of a member function even if there is
582# only one candidate or it is obvious which candidate to choose by doing a
583# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
584# accept a match between prototype and implementation in such cases.
585# The default value is: NO.
586
587STRICT_PROTO_MATCHING  = NO
588
589# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
590# todo list. This list is created by putting \todo commands in the
591# documentation.
592# The default value is: YES.
593
594GENERATE_TODOLIST      = NO
595
596# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
597# test list. This list is created by putting \test commands in the
598# documentation.
599# The default value is: YES.
600
601GENERATE_TESTLIST      = NO
602
603# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
604# list. This list is created by putting \bug commands in the documentation.
605# The default value is: YES.
606
607GENERATE_BUGLIST       = NO
608
609# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
610# the deprecated list. This list is created by putting \deprecated commands in
611# the documentation.
612# The default value is: YES.
613
614GENERATE_DEPRECATEDLIST= NO
615
616# The ENABLED_SECTIONS tag can be used to enable conditional documentation
617# sections, marked by \if <section_label> ... \endif and \cond <section_label>
618# ... \endcond blocks.
619
620ENABLED_SECTIONS       =
621
622# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
623# initial value of a variable or macro / define can have for it to appear in the
624# documentation. If the initializer consists of more lines than specified here
625# it will be hidden. Use a value of 0 to hide initializers completely. The
626# appearance of the value of individual variables and macros / defines can be
627# controlled using \showinitializer or \hideinitializer command in the
628# documentation regardless of this setting.
629# Minimum value: 0, maximum value: 10000, default value: 30.
630
631MAX_INITIALIZER_LINES  = 30
632
633# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
634# the bottom of the documentation of classes and structs. If set to YES the list
635# will mention the files that were used to generate the documentation.
636# The default value is: YES.
637
638SHOW_USED_FILES        = YES
639
640# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
641# will remove the Files entry from the Quick Index and from the Folder Tree View
642# (if specified).
643# The default value is: YES.
644
645SHOW_FILES             = YES
646
647# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
648# page. This will remove the Namespaces entry from the Quick Index and from the
649# Folder Tree View (if specified).
650# The default value is: YES.
651
652SHOW_NAMESPACES        = NO
653
654# The FILE_VERSION_FILTER tag can be used to specify a program or script that
655# doxygen should invoke to get the current version for each file (typically from
656# the version control system). Doxygen will invoke the program by executing (via
657# popen()) the command command input-file, where command is the value of the
658# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
659# by doxygen. Whatever the program writes to standard output is used as the file
660# version. For an example see the documentation.
661
662FILE_VERSION_FILTER    =
663
664# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
665# by doxygen. The layout file controls the global structure of the generated
666# output files in an output format independent way. To create the layout file
667# that represents doxygen's defaults, run doxygen with the -l option. You can
668# optionally specify a file name after the option, if omitted DoxygenLayout.xml
669# will be used as the name of the layout file.
670#
671# Note that if you run doxygen from a directory containing a file called
672# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
673# tag is left empty.
674
675LAYOUT_FILE            = $(abs_top_srcdir)/dox/DoxygenLayout.xml 676 677# The CITE_BIB_FILES tag can be used to specify one or more bib files containing 678# the reference definitions. This must be a list of .bib files. The .bib 679# extension is automatically appended if omitted. This requires the bibtex tool 680# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 681# For LaTeX the style of the bibliography can be controlled using 682# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 683# search path. Do not use file names with spaces, bibtex cannot handle them. See 684# also \cite for info how to create references. 685 686CITE_BIB_FILES = 687 688#--------------------------------------------------------------------------- 689# Configuration options related to warning and progress messages 690#--------------------------------------------------------------------------- 691 692# The QUIET tag can be used to turn on/off the messages that are generated to 693# standard output by doxygen. If QUIET is set to YES this implies that the 694# messages are off. 695# The default value is: NO. 696 697QUIET = NO 698 699# The WARNINGS tag can be used to turn on/off the warning messages that are 700# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES 701# this implies that the warnings are on. 702# 703# Tip: Turn warnings on while writing the documentation. 704# The default value is: YES. 705 706WARNINGS = YES 707 708# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate 709# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 710# will automatically be disabled. 711# The default value is: YES. 712 713WARN_IF_UNDOCUMENTED = NO 714 715# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 716# potential errors in the documentation, such as not documenting some parameters 717# in a documented function, or documenting parameters that don't exist or using 718# markup commands wrongly. 719# The default value is: YES. 720 721WARN_IF_DOC_ERROR = YES 722 723# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 724# are documented, but have no documentation for their parameters or return 725# value. If set to NO doxygen will only warn about wrong or incomplete parameter 726# documentation, but not about the absence of documentation. 727# The default value is: NO. 728 729WARN_NO_PARAMDOC = NO 730 731# The WARN_FORMAT tag determines the format of the warning messages that doxygen 732# can produce. The string should contain the$file, $line, and$text tags, which
733# will be replaced by the file and line number from which the warning originated
734# and the warning text. Optionally the format may contain $version, which will 735# be replaced by the version of the file (if it could be obtained via 736# FILE_VERSION_FILTER) 737# The default value is:$file:$line:$text.
738
739WARN_FORMAT            = "$file:$line: $text" 740 741# The WARN_LOGFILE tag can be used to specify a file to which warning and error 742# messages should be written. If left blank the output is written to standard 743# error (stderr). 744 745WARN_LOGFILE = html_dox.log 746 747#--------------------------------------------------------------------------- 748# Configuration options related to the input files 749#--------------------------------------------------------------------------- 750 751# The INPUT tag is used to specify the files and/or directories that contain 752# documented source files. You may enter file names like myfile.cpp or 753# directories like /usr/src/myproject. Separate the files or directories with 754# spaces. 755# Note: If this tag is empty the current directory is searched. 756 757INPUT = \ 758$(abs_top_srcdir)/README.md \
759                         $(abs_top_srcdir)/main.dox \ 760$(abs_top_srcdir)/doc/ \
761                         $(abs_top_srcdir)/omalloc/ \ 762$(abs_top_srcdir)/resources/ \
763                         $(abs_top_srcdir)/kernel/ \ 764$(abs_top_srcdir)/libpolys/ \
765                         $(abs_top_srcdir)/Singular/ \ 766$(abs_top_srcdir)/templates/ \
767                         $(abs_top_srcdir)/factory/ 768 769# This tag can be used to specify the character encoding of the source files 770# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 771# libiconv (or the iconv built into libc) for the transcoding. See the libiconv 772# documentation (see: http://www.gnu.org/software/libiconv) for the list of 773# possible encodings. 774# The default value is: UTF-8. 775 776INPUT_ENCODING = UTF-8 777 778# If the value of the INPUT tag contains directories, you can use the 779# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 780# *.h) to filter out the source-files in the directories. If left blank the 781# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 782# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 783# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 784# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 785# *.qsf, *.as and *.js. 786 787FILE_PATTERNS = *.h \ 788 *.cc \ 789 *.c \ 790 *.cpp \ 791 *.cxx \ 792 *.dox \ 793 *.md 794 795# The RECURSIVE tag can be used to specify whether or not subdirectories should 796# be searched for input files as well. 797# The default value is: NO. 798 799RECURSIVE = YES 800 801# The EXCLUDE tag can be used to specify files and/or directories that should be 802# excluded from the INPUT source files. This way you can easily exclude a 803# subdirectory from a directory tree whose root is specified with the INPUT tag. 804# 805# Note that relative paths are relative to the directory from which doxygen is 806# run. 807 808EXCLUDE =$(abs_top_srcdir)/factory/examples \
809                         $(abs_top_srcdir)/kernel/old \ 810$(abs_top_srcdir)/omalloc/Misc
811
812# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
813# directories that are symbolic links (a Unix file system feature) are excluded
814# from the input.
815# The default value is: NO.
816
818
819# If the value of the INPUT tag contains directories, you can use the
820# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
821# certain files from those directories.
822#
823# Note that the wildcards are matched against the file with absolute path, so to
824# exclude all test directories for example use the pattern */test/*
825
826EXCLUDE_PATTERNS       = \
827*/test.cc \
828*[Cc]onfig.h \
829
830# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
831# (namespaces, classes, functions, etc.) that should be excluded from the
832# output. The symbol name can be a fully qualified name, a word, or if the
833# wildcard * is used, a substring. Examples: ANamespace, AClass,
834# AClass::ANamespace, ANamespace::*Test
835#
836# Note that the wildcards are matched against the file with absolute path, so to
837# exclude all test directories use the pattern */test/*
838
839EXCLUDE_SYMBOLS        =
840
841# The EXAMPLE_PATH tag can be used to specify one or more files or directories
842# that contain example code fragments that are included (see the \include
843# command).
844
845EXAMPLE_PATH           = $(abs_top_srcdir) 846 847# If the value of the EXAMPLE_PATH tag contains directories, you can use the 848# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 849# *.h) to filter out the source-files in the directories. If left blank all 850# files are included. 851 852EXAMPLE_PATTERNS = 853 854# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 855# searched for input files to be used with the \include or \dontinclude commands 856# irrespective of the value of the RECURSIVE tag. 857# The default value is: NO. 858 859EXAMPLE_RECURSIVE = NO 860 861# The IMAGE_PATH tag can be used to specify one or more files or directories 862# that contain images that are to be included in the documentation (see the 863# \image command). 864 865IMAGE_PATH =$(abs_top_srcdir)
866
867# The INPUT_FILTER tag can be used to specify a program that doxygen should
868# invoke to filter for each input file. Doxygen will invoke the filter program
869# by executing (via popen()) the command:
870#
871# <filter> <input-file>
872#
873# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
874# name of an input file. Doxygen will then use the output that the filter
875# program writes to standard output. If FILTER_PATTERNS is specified, this tag
876# will be ignored.
877#
878# Note that the filter must not add or remove lines; it is applied before the
879# code is scanned, but not when the output code is generated. If lines are added
880# or removed, the anchors will not be placed correctly.
881
882INPUT_FILTER           =
883
884# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
885# basis. Doxygen will compare the file name with each pattern and apply the
886# filter if there is a match. The filters are a list of the form: pattern=filter
887# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
888# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
889# patterns match the file name, INPUT_FILTER is applied.
890
891FILTER_PATTERNS        =
892
893# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
894# INPUT_FILTER ) will also be used to filter the input files that are used for
895# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
896# The default value is: NO.
897
898FILTER_SOURCE_FILES    = NO
899
900# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
901# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
902# it is also possible to disable source filtering for a specific pattern using
903# *.ext= (so without naming a filter).
904# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
905
906FILTER_SOURCE_PATTERNS =
907
908# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
909# is part of the input, its contents will be placed on the main page
910# (index.html). This can be useful if you have a project on for instance GitHub
911# and want to reuse the introduction page also for the doxygen output.
912
913USE_MDFILE_AS_MAINPAGE =
914
915#---------------------------------------------------------------------------
916# Configuration options related to source browsing
917#---------------------------------------------------------------------------
918
919# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
920# generated. Documented entities will be cross-referenced with these sources.
921#
922# Note: To get rid of all source code in the generated output, make sure that
923# also VERBATIM_HEADERS is set to NO.
924# The default value is: NO.
925
926SOURCE_BROWSER         = YES
927
928# Setting the INLINE_SOURCES tag to YES will include the body of functions,
929# classes and enums directly into the documentation.
930# The default value is: NO.
931
932INLINE_SOURCES         = YES
933
934# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
935# special comment blocks from generated source code fragments. Normal C, C++ and
936# Fortran comments will always remain visible.
937# The default value is: YES.
938
940
941# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
942# function all documented functions referencing it will be listed.
943# The default value is: NO.
944
945REFERENCED_BY_RELATION = NO
946
947# If the REFERENCES_RELATION tag is set to YES then for each documented function
948# all documented entities called/used by that function will be listed.
949# The default value is: NO.
950
951REFERENCES_RELATION    = NO
952
953# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
954# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
955# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
957# The default value is: YES.
958
960
961# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
962# source code will show a tooltip with additional information such as prototype,
963# brief description and links to the definition and documentation. Since this
964# will make the HTML file larger and loading of large files a bit slower, you
965# can opt to disable this feature.
966# The default value is: YES.
967# This tag requires that the tag SOURCE_BROWSER is set to YES.
968
969SOURCE_TOOLTIPS        = YES
970
971# If the USE_HTAGS tag is set to YES then the references to source code will
972# point to the HTML generated by the htags(1) tool instead of doxygen built-in
973# source browser. The htags tool is part of GNU's global source tagging system
974# (see http://www.gnu.org/software/global/global.html). You will need version
975# 4.8.6 or higher.
976#
977# To use it do the following:
979# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
980# - Make sure the INPUT points to the root of the source tree
981# - Run doxygen as normal
982#
983# Doxygen will invoke htags (and that will in turn invoke gtags), so these
984# tools must be available from the command line (i.e. in the search path).
985#
986# The result: instead of the source browser generated by doxygen, the links to
987# source code will now point to the output of htags.
988# The default value is: NO.
989# This tag requires that the tag SOURCE_BROWSER is set to YES.
990
991USE_HTAGS              = NO
992
993# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
994# verbatim copy of the header file for each class for which an include is
995# specified. Set to NO to disable this.
997# The default value is: YES.
998
1000
1001#---------------------------------------------------------------------------
1002# Configuration options related to the alphabetical class index
1003#---------------------------------------------------------------------------
1004
1005# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1006# compounds will be generated. Enable this if the project contains a lot of
1007# classes, structs, unions or interfaces.
1008# The default value is: YES.
1009
1010ALPHABETICAL_INDEX     = YES
1011
1012# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1013# which the alphabetical index list will be split.
1014# Minimum value: 1, maximum value: 20, default value: 5.
1015# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1016
1017COLS_IN_ALPHA_INDEX    = 5
1018
1019# In case all classes in a project start with a common prefix, all classes will
1020# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1021# can be used to specify a prefix (or a list of prefixes) that should be ignored
1022# while generating the index headers.
1023# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1024
1025IGNORE_PREFIX          =
1026
1027#---------------------------------------------------------------------------
1028# Configuration options related to the HTML output
1029#---------------------------------------------------------------------------
1030
1031# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1032# The default value is: YES.
1033
1034GENERATE_HTML          = YES
1035
1036# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1037# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1038# it.
1039# The default directory is: html.
1040# This tag requires that the tag GENERATE_HTML is set to YES.
1041
1042HTML_OUTPUT            = html
1043
1044# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1045# generated HTML page (for example: .htm, .php, .asp).
1046# The default value is: .html.
1047# This tag requires that the tag GENERATE_HTML is set to YES.
1048
1049HTML_FILE_EXTENSION    = .html
1050
1051# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1052# each generated HTML page. If the tag is left blank doxygen will generate a
1054#
1055# To get valid HTML the header file that includes any scripts and style sheets
1056# that doxygen needs, which is dependent on the configuration options used (e.g.
1057# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1059# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1060# YourConfigFile
1062# for information on how to generate the default header that doxygen normally
1063# uses.
1064# Note: The header is subject to change so you typically have to regenerate the
1066# of the possible markers and block names see the documentation.
1067# This tag requires that the tag GENERATE_HTML is set to YES.
1068
1069HTML_HEADER            = $(abs_top_srcdir)/dox/header.html 1070 1071# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1072# generated HTML page. If the tag is left blank doxygen will generate a standard 1073# footer. See HTML_HEADER for more information on how to generate a default 1074# footer and what special commands can be used inside the footer. See also 1075# section "Doxygen usage" for information on how to generate the default footer 1076# that doxygen normally uses. 1077# This tag requires that the tag GENERATE_HTML is set to YES. 1078 1079HTML_FOOTER =$(abs_top_srcdir)/dox/footer.html
1080
1081# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1082# sheet that is used by each HTML page. It can be used to fine-tune the look of
1083# the HTML output. If left blank doxygen will generate a default style sheet.
1084# See also section "Doxygen usage" for information on how to generate the style
1085# sheet that doxygen normally uses.
1086# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1087# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1088# obsolete.
1089# This tag requires that the tag GENERATE_HTML is set to YES.
1090
1091HTML_STYLESHEET        =
1092
1093# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1094# defined cascading style sheet that is included after the standard style sheets
1095# created by doxygen. Using this option one can overrule certain style aspects.
1096# This is preferred over using HTML_STYLESHEET since it does not replace the
1097# standard style sheet and is therefor more robust against future updates.
1098# Doxygen will copy the style sheet file to the output directory. For an example
1099# see the documentation.
1100# This tag requires that the tag GENERATE_HTML is set to YES.
1101
1102HTML_EXTRA_STYLESHEET  = $(abs_top_srcdir)/dox/stylesheet.css 1103 1104# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1105# other source files which should be copied to the HTML output directory. Note 1106# that these files will be copied to the base HTML output directory. Use the 1107#$relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1108# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1109# files will be copied as-is; there are no commands or markers available.
1110# This tag requires that the tag GENERATE_HTML is set to YES.
1111
1112HTML_EXTRA_FILES       =
1113
1114# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1115# will adjust the colors in the stylesheet and background images according to
1116# this color. Hue is specified as an angle on a colorwheel, see
1118# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1119# purple, and 360 is red again.
1120# Minimum value: 0, maximum value: 359, default value: 220.
1121# This tag requires that the tag GENERATE_HTML is set to YES.
1122
1123HTML_COLORSTYLE_HUE    = 200
1124
1125# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1126# in the HTML output. For a value of 0 the output will use grayscales only. A
1127# value of 255 will produce the most vivid colors.
1128# Minimum value: 0, maximum value: 255, default value: 100.
1129# This tag requires that the tag GENERATE_HTML is set to YES.
1130
1131HTML_COLORSTYLE_SAT    = 0
1132
1133# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1134# luminance component of the colors in the HTML output. Values below 100
1135# gradually make the output lighter, whereas values above 100 make the output
1136# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1137# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1138# change the gamma.
1139# Minimum value: 40, maximum value: 240, default value: 80.
1140# This tag requires that the tag GENERATE_HTML is set to YES.
1141
1142HTML_COLORSTYLE_GAMMA  = 190
1143
1144# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1145# page will contain the date and time when the page was generated. Setting this
1146# to NO can help when comparing the output of multiple runs.
1147# The default value is: YES.
1148# This tag requires that the tag GENERATE_HTML is set to YES.
1149
1150HTML_TIMESTAMP         = YES
1151
1152# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1153# documentation will contain sections that can be hidden and shown after the
1155# The default value is: NO.
1156# This tag requires that the tag GENERATE_HTML is set to YES.
1157
1158HTML_DYNAMIC_SECTIONS  = YES
1159
1160# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1161# shown in the various tree structured indices initially; the user can expand
1162# and collapse entries dynamically later on. Doxygen will expand the tree to
1163# such a level that at most the specified number of entries are visible (unless
1164# a fully collapsed tree already exceeds this amount). So setting the number of
1165# entries 1 will produce a full collapsed tree by default. 0 is a special value
1166# representing an infinite number of entries and will result in a full expanded
1167# tree by default.
1168# Minimum value: 0, maximum value: 9999, default value: 100.
1169# This tag requires that the tag GENERATE_HTML is set to YES.
1170
1171HTML_INDEX_NUM_ENTRIES = 100
1172
1173# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1174# generated that can be used as input for Apple's Xcode 3 integrated development
1175# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1176# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1177# Makefile in the HTML output directory. Running make will produce the docset in
1178# that directory and running make install will install the docset in
1179# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1180# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1182# The default value is: NO.
1183# This tag requires that the tag GENERATE_HTML is set to YES.
1184
1185GENERATE_DOCSET        = NO
1186
1187# This tag determines the name of the docset feed. A documentation feed provides
1188# an umbrella under which multiple documentation sets from a single provider
1189# (such as a company or product suite) can be grouped.
1190# The default value is: Doxygen generated docs.
1191# This tag requires that the tag GENERATE_DOCSET is set to YES.
1192
1193DOCSET_FEEDNAME        = "Doxygen generated docs"
1194
1195# This tag specifies a string that should uniquely identify the documentation
1196# set bundle. This should be a reverse domain-name style string, e.g.
1197# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1198# The default value is: org.doxygen.Project.
1199# This tag requires that the tag GENERATE_DOCSET is set to YES.
1200
1201DOCSET_BUNDLE_ID       = org.doxygen.Project
1202
1203# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1204# the documentation publisher. This should be a reverse domain-name style
1205# string, e.g. com.mycompany.MyDocSet.documentation.
1206# The default value is: org.doxygen.Publisher.
1207# This tag requires that the tag GENERATE_DOCSET is set to YES.
1208
1209DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1210
1211# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1212# The default value is: Publisher.
1213# This tag requires that the tag GENERATE_DOCSET is set to YES.
1214
1215DOCSET_PUBLISHER_NAME  = Publisher
1216
1217# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1218# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1219# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1221# Windows.
1222#
1223# The HTML Help Workshop contains a compiler that can convert all HTML output
1224# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1225# files are now used as the Windows 98 help format, and will replace the old
1226# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1228# words in the documentation. The HTML workshop also contains a viewer for
1229# compressed HTML files.
1230# The default value is: NO.
1231# This tag requires that the tag GENERATE_HTML is set to YES.
1232
1233GENERATE_HTMLHELP      = NO
1234
1235# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1236# file. You can add a path in front of the file if the result should not be
1237# written to the html output directory.
1238# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1239
1240CHM_FILE               =
1241
1242# The HHC_LOCATION tag can be used to specify the location (absolute path
1243# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1244# doxygen will try to run the HTML help compiler on the generated index.hhp.
1245# The file has to be specified with full path.
1246# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1247
1248HHC_LOCATION           =
1249
1250# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1251# YES) or that it should be included in the master .chm file ( NO).
1252# The default value is: NO.
1253# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1254
1255GENERATE_CHI           = NO
1256
1257# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1258# and project file content.
1259# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1260
1261CHM_INDEX_ENCODING     =
1262
1265# enables the Previous and Next buttons.
1266# The default value is: NO.
1267# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1268
1269BINARY_TOC             = NO
1270
1271# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1273# The default value is: NO.
1274# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1275
1276TOC_EXPAND             = NO
1277
1278# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1279# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1280# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1281# (.qch) of the generated HTML documentation.
1282# The default value is: NO.
1283# This tag requires that the tag GENERATE_HTML is set to YES.
1284
1285GENERATE_QHP           = NO
1286
1287# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1288# the file name of the resulting .qch file. The path specified is relative to
1289# the HTML output folder.
1290# This tag requires that the tag GENERATE_QHP is set to YES.
1291
1292QCH_FILE               =
1293
1294# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1296# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1297# The default value is: org.doxygen.Project.
1298# This tag requires that the tag GENERATE_QHP is set to YES.
1299
1300QHP_NAMESPACE          = org.doxygen.Project
1301
1302# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1304# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1305# folders).
1306# The default value is: doc.
1307# This tag requires that the tag GENERATE_QHP is set to YES.
1308
1309QHP_VIRTUAL_FOLDER     = doc
1310
1311# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1313# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1314# filters).
1315# This tag requires that the tag GENERATE_QHP is set to YES.
1316
1317QHP_CUST_FILTER_NAME   =
1318
1319# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1321# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1322# filters).
1323# This tag requires that the tag GENERATE_QHP is set to YES.
1324
1325QHP_CUST_FILTER_ATTRS  =
1326
1327# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1328# project's filter section matches. Qt Help Project / Filter Attributes (see:
1329# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1330# This tag requires that the tag GENERATE_QHP is set to YES.
1331
1332QHP_SECT_FILTER_ATTRS  =
1333
1334# The QHG_LOCATION tag can be used to specify the location of Qt's
1335# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1336# generated .qhp file.
1337# This tag requires that the tag GENERATE_QHP is set to YES.
1338
1339QHG_LOCATION           =
1340
1341# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1342# generated, together with the HTML files, they form an Eclipse help plugin. To
1343# install this plugin and make it available under the help contents menu in
1344# Eclipse, the contents of the directory containing the HTML and XML files needs
1345# to be copied into the plugins directory of eclipse. The name of the directory
1346# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1347# After copying Eclipse needs to be restarted before the help appears.
1348# The default value is: NO.
1349# This tag requires that the tag GENERATE_HTML is set to YES.
1350
1351GENERATE_ECLIPSEHELP   = NO
1352
1353# A unique identifier for the Eclipse help plugin. When installing the plugin
1354# the directory name containing the HTML and XML files should also have this
1355# name. Each documentation set should have its own identifier.
1356# The default value is: org.doxygen.Project.
1357# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1358
1359ECLIPSE_DOC_ID         = org.doxygen.Project
1360
1361# If you want full control over the layout of the generated HTML pages it might
1362# be necessary to disable the index and replace it with your own. The
1363# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1364# of each HTML page. A value of NO enables the index and the value YES disables
1365# it. Since the tabs in the index contain the same information as the navigation
1366# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1367# The default value is: NO.
1368# This tag requires that the tag GENERATE_HTML is set to YES.
1369
1370DISABLE_INDEX          = NO
1371
1372# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1373# structure should be generated to display hierarchical information. If the tag
1374# value is set to YES, a side panel will be generated containing a tree-like
1375# index structure (just like the one that is generated for HTML Help). For this
1376# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1377# (i.e. any modern browser). Windows users are probably better off using the
1378# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1379# further fine-tune the look of the index. As an example, the default style
1380# sheet generated by doxygen has an example that shows how to put an image at
1381# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1382# the same information as the tab index, you could consider setting
1383# DISABLE_INDEX to YES when enabling this option.
1384# The default value is: NO.
1385# This tag requires that the tag GENERATE_HTML is set to YES.
1386
1387GENERATE_TREEVIEW      = NO
1388
1389# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1390# doxygen will group on one line in the generated HTML documentation.
1391#
1392# Note that a value of 0 will completely suppress the enum values from appearing
1393# in the overview section.
1394# Minimum value: 0, maximum value: 20, default value: 4.
1395# This tag requires that the tag GENERATE_HTML is set to YES.
1396
1397ENUM_VALUES_PER_LINE   = 4
1398
1399# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1400# to set the initial width (in pixels) of the frame in which the tree is shown.
1401# Minimum value: 0, maximum value: 1500, default value: 250.
1402# This tag requires that the tag GENERATE_HTML is set to YES.
1403
1404TREEVIEW_WIDTH         = 250
1405
1406# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1407# external symbols imported via tag files in a separate window.
1408# The default value is: NO.
1409# This tag requires that the tag GENERATE_HTML is set to YES.
1410
1412
1413# Use this tag to change the font size of LaTeX formulas included as images in
1414# the HTML documentation. When you change the font size after a successful
1415# doxygen run you need to manually remove any form_*.png images from the HTML
1416# output directory to force them to be regenerated.
1417# Minimum value: 8, maximum value: 50, default value: 10.
1418# This tag requires that the tag GENERATE_HTML is set to YES.
1419
1420FORMULA_FONTSIZE       = 10
1421
1422# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1423# generated for formulas are transparent PNGs. Transparent PNGs are not
1424# supported properly for IE 6.0, but are supported on all modern browsers.
1425#
1426# Note that when changing this option you need to delete any form_*.png files in
1427# the HTML output directory before the changes have effect.
1428# The default value is: YES.
1429# This tag requires that the tag GENERATE_HTML is set to YES.
1430
1431FORMULA_TRANSPARENT    = YES
1432
1433# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1434# http://www.mathjax.org) which uses client side Javascript for the rendering
1435# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1436# installed or if you want to formulas look prettier in the HTML output. When
1437# enabled you may also need to install MathJax separately and configure the path
1438# to it using the MATHJAX_RELPATH option.
1439# The default value is: NO.
1440# This tag requires that the tag GENERATE_HTML is set to YES.
1441
1442USE_MATHJAX            = NO
1443
1444# When MathJax is enabled you can set the default output format to be used for
1445# the MathJax output. See the MathJax site (see:
1446# http://docs.mathjax.org/en/latest/output.html) for more details.
1447# Possible values are: HTML-CSS (which is slower, but has the best
1448# compatibility), NativeMML (i.e. MathML) and SVG.
1449# The default value is: HTML-CSS.
1450# This tag requires that the tag USE_MATHJAX is set to YES.
1451
1452MATHJAX_FORMAT         = HTML-CSS
1453
1454# When MathJax is enabled you need to specify the location relative to the HTML
1455# output directory using the MATHJAX_RELPATH option. The destination directory
1456# should contain the MathJax.js script. For instance, if the mathjax directory
1457# is located at the same level as the HTML output directory, then
1458# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1459# Content Delivery Network so you can quickly see the result without installing
1460# MathJax. However, it is strongly recommended to install a local copy of
1461# MathJax from http://www.mathjax.org before deployment.
1462# The default value is: http://cdn.mathjax.org/mathjax/latest.
1463# This tag requires that the tag USE_MATHJAX is set to YES.
1464
1465MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1466
1467# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1468# extension names that should be enabled during MathJax rendering. For example
1469# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1470# This tag requires that the tag USE_MATHJAX is set to YES.
1471
1472MATHJAX_EXTENSIONS     =
1473
1474# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1475# of code that will be used on startup of the MathJax code. See the MathJax site
1476# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1477# example see the documentation.
1478# This tag requires that the tag USE_MATHJAX is set to YES.
1479
1480MATHJAX_CODEFILE       =
1481
1482# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1483# the HTML output. The underlying search engine uses javascript and DHTML and
1484# should work on any modern browser. Note that when using HTML help
1485# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1486# there is already a search function so this one should typically be disabled.
1487# For large projects the javascript based search engine can be slow, then
1488# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1489# search using the keyboard; to jump to the search box use <access key> + S
1490# (what the <access key> is depends on the OS and browser, but it is typically
1491# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1492# key> to jump into the search results window, the results can be navigated
1493# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1494# the search. The filter options can be selected when the cursor is inside the
1495# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1496# to select a filter and <Enter> or <escape> to activate or cancel the filter
1497# option.
1498# The default value is: YES.
1499# This tag requires that the tag GENERATE_HTML is set to YES.
1500
1501SEARCHENGINE           = YES
1502
1503# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1504# implemented using a web server instead of a web client using Javascript. There
1505# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1506# setting. When disabled, doxygen will generate a PHP script for searching and
1507# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1508# and searching needs to be provided by external tools. See the section
1509# "External Indexing and Searching" for details.
1510# The default value is: NO.
1511# This tag requires that the tag SEARCHENGINE is set to YES.
1512
1513SERVER_BASED_SEARCH    = NO
1514
1515# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1516# script for searching. Instead the search results are written to an XML file
1517# which needs to be processed by an external indexer. Doxygen will invoke an
1518# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1519# search results.
1520#
1521# Doxygen ships with an example indexer ( doxyindexer) and search engine
1522# (doxysearch.cgi) which are based on the open source search engine library
1523# Xapian (see: http://xapian.org/).
1524#
1525# See the section "External Indexing and Searching" for details.
1526# The default value is: NO.
1527# This tag requires that the tag SEARCHENGINE is set to YES.
1528
1529EXTERNAL_SEARCH        = NO
1530
1531# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1532# which will return the search results when EXTERNAL_SEARCH is enabled.
1533#
1534# Doxygen ships with an example indexer ( doxyindexer) and search engine
1535# (doxysearch.cgi) which are based on the open source search engine library
1536# Xapian (see: http://xapian.org/). See the section "External Indexing and
1537# Searching" for details.
1538# This tag requires that the tag SEARCHENGINE is set to YES.
1539
1540SEARCHENGINE_URL       =
1541
1542# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1543# search data is written to a file for indexing by an external tool. With the
1544# SEARCHDATA_FILE tag the name of this file can be specified.
1545# The default file is: searchdata.xml.
1546# This tag requires that the tag SEARCHENGINE is set to YES.
1547
1548SEARCHDATA_FILE        = searchdata.xml
1549
1550# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1551# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1552# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1553# projects and redirect the results back to the right project.
1554# This tag requires that the tag SEARCHENGINE is set to YES.
1555
1556EXTERNAL_SEARCH_ID     =
1557
1558# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1559# projects other than the one defined by this configuration file, but that are
1560# all added to the same external search index. Each project needs to have a
1561# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1562# to a relative location where the documentation can be found. The format is:
1563# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1564# This tag requires that the tag SEARCHENGINE is set to YES.
1565
1566EXTRA_SEARCH_MAPPINGS  =
1567
1568#---------------------------------------------------------------------------
1569# Configuration options related to the LaTeX output
1570#---------------------------------------------------------------------------
1571
1572# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1573# The default value is: YES.
1574
1575GENERATE_LATEX         = NO
1576
1577# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1578# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1579# it.
1580# The default directory is: latex.
1581# This tag requires that the tag GENERATE_LATEX is set to YES.
1582
1583LATEX_OUTPUT           = latex
1584
1585# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1586# invoked.
1587#
1588# Note that when enabling USE_PDFLATEX this option is only used for generating
1589# bitmaps for formulas in the HTML output, but not in the Makefile that is
1590# written to the output directory.
1591# The default file is: latex.
1592# This tag requires that the tag GENERATE_LATEX is set to YES.
1593
1594LATEX_CMD_NAME         = latex
1595
1596# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1597# index for LaTeX.
1598# The default file is: makeindex.
1599# This tag requires that the tag GENERATE_LATEX is set to YES.
1600
1601MAKEINDEX_CMD_NAME     = makeindex
1602
1603# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1604# documents. This may be useful for small projects and may help to save some
1605# trees in general.
1606# The default value is: NO.
1607# This tag requires that the tag GENERATE_LATEX is set to YES.
1608
1609COMPACT_LATEX          = NO
1610
1611# The PAPER_TYPE tag can be used to set the paper type that is used by the
1612# printer.
1613# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1614# 14 inches) and executive (7.25 x 10.5 inches).
1615# The default value is: a4.
1616# This tag requires that the tag GENERATE_LATEX is set to YES.
1617
1618PAPER_TYPE             = a4
1619
1620# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1621# that should be included in the LaTeX output. To get the times font for
1622# instance you can specify
1623# EXTRA_PACKAGES=times
1624# If left blank no extra packages will be included.
1625# This tag requires that the tag GENERATE_LATEX is set to YES.
1626
1627EXTRA_PACKAGES         =
1628
1629# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1630# generated LaTeX document. The header should contain everything until the first
1631# chapter. If it is left blank doxygen will generate a standard header. See
1632# section "Doxygen usage" for information on how to let doxygen write the
1633# default header to a separate file.
1634#
1635# Note: Only use a user-defined header if you know what you are doing! The
1636# following commands have a special meaning inside the header: $title, 1637#$datetime, $date,$doxygenversion, $projectname,$projectnumber,
1638# $projectbrief,$projectlogo. Doxygen will replace $title with the empty string, 1639# for the replacement values of the other commands the user is referred to 1640# HTML_HEADER. 1641# This tag requires that the tag GENERATE_LATEX is set to YES. 1642 1643LATEX_HEADER = 1644 1645# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1646# generated LaTeX document. The footer should contain everything after the last 1647# chapter. If it is left blank doxygen will generate a standard footer. See 1648# LATEX_HEADER for more information on how to generate a default footer and what 1649# special commands can be used inside the footer. 1650# 1651# Note: Only use a user-defined footer if you know what you are doing! 1652# This tag requires that the tag GENERATE_LATEX is set to YES. 1653 1654LATEX_FOOTER = 1655 1656# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1657# other source files which should be copied to the LATEX_OUTPUT output 1658# directory. Note that the files will be copied as-is; there are no commands or 1659# markers available. 1660# This tag requires that the tag GENERATE_LATEX is set to YES. 1661 1662LATEX_EXTRA_FILES = 1663 1664# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1665# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1666# contain links (just like the HTML output) instead of page references. This 1667# makes the output suitable for online browsing using a PDF viewer. 1668# The default value is: YES. 1669# This tag requires that the tag GENERATE_LATEX is set to YES. 1670 1671PDF_HYPERLINKS = YES 1672 1673# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1674# the PDF file directly from the LaTeX files. Set this option to YES to get a 1675# higher quality PDF documentation. 1676# The default value is: YES. 1677# This tag requires that the tag GENERATE_LATEX is set to YES. 1678 1679USE_PDFLATEX = YES 1680 1681# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1682# command to the generated LaTeX files. This will instruct LaTeX to keep running 1683# if errors occur, instead of asking the user for help. This option is also used 1684# when generating formulas in HTML. 1685# The default value is: NO. 1686# This tag requires that the tag GENERATE_LATEX is set to YES. 1687 1688LATEX_BATCHMODE = YES 1689 1690# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1691# index chapters (such as File Index, Compound Index, etc.) in the output. 1692# The default value is: NO. 1693# This tag requires that the tag GENERATE_LATEX is set to YES. 1694 1695LATEX_HIDE_INDICES = NO 1696 1697# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1698# code with syntax highlighting in the LaTeX output. 1699# 1700# Note that which sources are shown also depends on other settings such as 1701# SOURCE_BROWSER. 1702# The default value is: NO. 1703# This tag requires that the tag GENERATE_LATEX is set to YES. 1704 1705LATEX_SOURCE_CODE = NO 1706 1707# The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1708# bibliography, e.g. plainnat, or ieeetr. See 1709# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1710# The default value is: plain. 1711# This tag requires that the tag GENERATE_LATEX is set to YES. 1712 1713LATEX_BIB_STYLE = plain 1714 1715#--------------------------------------------------------------------------- 1716# Configuration options related to the RTF output 1717#--------------------------------------------------------------------------- 1718 1719# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The 1720# RTF output is optimized for Word 97 and may not look too pretty with other RTF 1721# readers/editors. 1722# The default value is: NO. 1723 1724GENERATE_RTF = NO 1725 1726# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1727# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1728# it. 1729# The default directory is: rtf. 1730# This tag requires that the tag GENERATE_RTF is set to YES. 1731 1732RTF_OUTPUT = rtf 1733 1734# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF 1735# documents. This may be useful for small projects and may help to save some 1736# trees in general. 1737# The default value is: NO. 1738# This tag requires that the tag GENERATE_RTF is set to YES. 1739 1740COMPACT_RTF = YES 1741 1742# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1743# contain hyperlink fields. The RTF file will contain links (just like the HTML 1744# output) instead of page references. This makes the output suitable for online 1745# browsing using Word or some other Word compatible readers that support those 1746# fields. 1747# 1748# Note: WordPad (write) and others do not support links. 1749# The default value is: NO. 1750# This tag requires that the tag GENERATE_RTF is set to YES. 1751 1752RTF_HYPERLINKS = YES 1753 1754# Load stylesheet definitions from file. Syntax is similar to doxygen's config 1755# file, i.e. a series of assignments. You only have to provide replacements, 1756# missing definitions are set to their default value. 1757# 1758# See also section "Doxygen usage" for information on how to generate the 1759# default style sheet that doxygen normally uses. 1760# This tag requires that the tag GENERATE_RTF is set to YES. 1761 1762RTF_STYLESHEET_FILE = 1763 1764# Set optional variables used in the generation of an RTF document. Syntax is 1765# similar to doxygen's config file. A template extensions file can be generated 1766# using doxygen -e rtf extensionFile. 1767# This tag requires that the tag GENERATE_RTF is set to YES. 1768 1769RTF_EXTENSIONS_FILE = 1770 1771#--------------------------------------------------------------------------- 1772# Configuration options related to the man page output 1773#--------------------------------------------------------------------------- 1774 1775# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for 1776# classes and files. 1777# The default value is: NO. 1778 1779GENERATE_MAN = NO 1780 1781# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1782# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1783# it. A directory man3 will be created inside the directory specified by 1784# MAN_OUTPUT. 1785# The default directory is: man. 1786# This tag requires that the tag GENERATE_MAN is set to YES. 1787 1788MAN_OUTPUT = man 1789 1790# The MAN_EXTENSION tag determines the extension that is added to the generated 1791# man pages. In case the manual section does not start with a number, the number 1792# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1793# optional. 1794# The default value is: .3. 1795# This tag requires that the tag GENERATE_MAN is set to YES. 1796 1797MAN_EXTENSION = .3 1798 1799# The MAN_SUBDIR tag determines the name of the directory created within 1800# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1801# MAN_EXTENSION with the initial . removed. 1802# This tag requires that the tag GENERATE_MAN is set to YES. 1803 1804MAN_SUBDIR = 1805 1806# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1807# will generate one additional man file for each entity documented in the real 1808# man page(s). These additional files only source the real man page, but without 1809# them the man command would be unable to find the correct page. 1810# The default value is: NO. 1811# This tag requires that the tag GENERATE_MAN is set to YES. 1812 1813MAN_LINKS = YES 1814 1815#--------------------------------------------------------------------------- 1816# Configuration options related to the XML output 1817#--------------------------------------------------------------------------- 1818 1819# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that 1820# captures the structure of the code including all documentation. 1821# The default value is: NO. 1822 1823GENERATE_XML = NO 1824 1825# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1826# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1827# it. 1828# The default directory is: xml. 1829# This tag requires that the tag GENERATE_XML is set to YES. 1830 1831XML_OUTPUT = xml 1832 1833# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program 1834# listings (including syntax highlighting and cross-referencing information) to 1835# the XML output. Note that enabling this will significantly increase the size 1836# of the XML output. 1837# The default value is: YES. 1838# This tag requires that the tag GENERATE_XML is set to YES. 1839 1840XML_PROGRAMLISTING = YES 1841 1842#--------------------------------------------------------------------------- 1843# Configuration options related to the DOCBOOK output 1844#--------------------------------------------------------------------------- 1845 1846# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files 1847# that can be used to generate PDF. 1848# The default value is: NO. 1849 1850GENERATE_DOCBOOK = NO 1851 1852# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1853# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1854# front of it. 1855# The default directory is: docbook. 1856# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1857 1858DOCBOOK_OUTPUT = docbook 1859 1860# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the 1861# program listings (including syntax highlighting and cross-referencing 1862# information) to the DOCBOOK output. Note that enabling this will significantly 1863# increase the size of the DOCBOOK output. 1864# The default value is: NO. 1865# This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1866 1867DOCBOOK_PROGRAMLISTING = NO 1868 1869#--------------------------------------------------------------------------- 1870# Configuration options for the AutoGen Definitions output 1871#--------------------------------------------------------------------------- 1872 1873# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen 1874# Definitions (see http://autogen.sf.net) file that captures the structure of 1875# the code including all documentation. Note that this feature is still 1876# experimental and incomplete at the moment. 1877# The default value is: NO. 1878 1879GENERATE_AUTOGEN_DEF = NO 1880 1881#--------------------------------------------------------------------------- 1882# Configuration options related to the Perl module output 1883#--------------------------------------------------------------------------- 1884 1885# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module 1886# file that captures the structure of the code including all documentation. 1887# 1888# Note that this feature is still experimental and incomplete at the moment. 1889# The default value is: NO. 1890 1891GENERATE_PERLMOD = NO 1892 1893# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary 1894# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 1895# output from the Perl module output. 1896# The default value is: NO. 1897# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1898 1899PERLMOD_LATEX = NO 1900 1901# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely 1902# formatted so it can be parsed by a human reader. This is useful if you want to 1903# understand what is going on. On the other hand, if this tag is set to NO the 1904# size of the Perl module output will be much smaller and Perl will parse it 1905# just the same. 1906# The default value is: YES. 1907# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1908 1909PERLMOD_PRETTY = YES 1910 1911# The names of the make variables in the generated doxyrules.make file are 1912# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 1913# so different doxyrules.make files included by the same Makefile don't 1914# overwrite each other's variables. 1915# This tag requires that the tag GENERATE_PERLMOD is set to YES. 1916 1917PERLMOD_MAKEVAR_PREFIX = 1918 1919#--------------------------------------------------------------------------- 1920# Configuration options related to the preprocessor 1921#--------------------------------------------------------------------------- 1922 1923# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all 1924# C-preprocessor directives found in the sources and include files. 1925# The default value is: YES. 1926 1927ENABLE_PREPROCESSING = YES 1928 1929# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names 1930# in the source code. If set to NO only conditional compilation will be 1931# performed. Macro expansion can be done in a controlled way by setting 1932# EXPAND_ONLY_PREDEF to YES. 1933# The default value is: NO. 1934# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1935 1936MACRO_EXPANSION = NO 1937 1938# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 1939# the macro expansion is limited to the macros specified with the PREDEFINED and 1940# EXPAND_AS_DEFINED tags. 1941# The default value is: NO. 1942# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1943 1944EXPAND_ONLY_PREDEF = NO 1945 1946# If the SEARCH_INCLUDES tag is set to YES the includes files in the 1947# INCLUDE_PATH will be searched if a #include is found. 1948# The default value is: YES. 1949# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1950 1951SEARCH_INCLUDES = YES 1952 1953# The INCLUDE_PATH tag can be used to specify one or more directories that 1954# contain include files that are not input files but should be processed by the 1955# preprocessor. 1956# This tag requires that the tag SEARCH_INCLUDES is set to YES. 1957 1958INCLUDE_PATH = \ 1959$(abs_top_builddir)/ \
1960                         $(abs_top_builddir)/factory \ 1961$(abs_top_builddir)/libpolys \
1962                         $(abs_top_srcdir)/ \ 1963$(abs_top_srcdir)/factory \
1964                         $(abs_top_srcdir)/libpolys 1965 1966# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1967# patterns (like *.h and *.hpp) to filter out the header-files in the 1968# directories. If left blank, the patterns specified with FILE_PATTERNS will be 1969# used. 1970# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1971 1972INCLUDE_FILE_PATTERNS = *.h *.inc 1973 1974# The PREDEFINED tag can be used to specify one or more macro names that are 1975# defined before the preprocessor is started (similar to the -D option of e.g. 1976# gcc). The argument of the tag is a list of macros of the form: name or 1977# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 1978# is assumed. To prevent a macro definition from being undefined via #undef or 1979# recursively expanded use the := operator instead of the = operator. 1980# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1981 1982PREDEFINED = \ 1983"SIZEOF_LONG=8" \ 1984"HAVE_GFANLIB=1" \ 1985"HAVE_RINGS=1" \ 1986"HAVE_MORE_FIELDS_IMPLEMENTED=1" \ 1987"__FLINT_RELEASE=20400" \ 1988"__GMP_BITS_PER_MP_LIMB=100" \ 1989__cplusplus \ 1990GENTABLE \ 1991HAVE_ATEXIT \ 1992HAVE_BIGINTM \ 1993HAVE_CDD_SETOPER_H \ 1994HAVE_DBM \ 1995HAVE_DL \ 1996HAVE_DLD \ 1997HAVE_DYN_RL \ 1998HAVE_DYNAMIC_LOADING \ 1999HAVE_EIGENVAL \ 2000HAVE_ELF_SYSTEM \ 2001HAVE_EXPLICIT_CONSTR \ 2002HAVE_EXTENDED_SYSTEM \ 2003HAVE_F4 \ 2004HAVE_F5 \ 2005HAVE_F5C \ 2006HAVE_FEREAD \ 2007HAVE_FLINT \ 2008HAVE_GENERIC_ADD \ 2009HAVE_GMS \ 2010HAVE_IOSTREAM \ 2011HAVE_LENGTH_DIFF \ 2012HAVE_LIBPARSER \ 2013HAVE_LM_BIN \ 2014HAVE_MATHICGB \ 2015HAVE_NAMESPACES \ 2016HAVE_NEWTON \ 2017HAVE_NTL \ 2018HAVE_OM_ASSUME \ 2019HAVE_OMALLOC \ 2020HAVE_PCV \ 2021HAVE_PLURAL \ 2022HAVE_POLYEXTENSIONS \ 2023HAVE_POLYMAKE \ 2024HAVE_PSEUDO_BUCKETS \ 2025HAVE_PYTHON \ 2026HAVE_RATGRING \ 2027HAVE_SBRK \ 2028HAVE_SDB \ 2029HAVE_SHEAFCOH_TRICKS \ 2030HAVE_SHIFTBBA \ 2031HAVE_SPECTRUM \ 2032HAVE_SUMMATOR \ 2033HAVE_SVD \ 2034HAVE_TAIL_BIN \ 2035HAVE_TAIL_RING \ 2036HAVE_WALK \ 2037HAVE_ZERODIVISORS \ 2038IPARITH \ 2039IPASSIGN \ 2040IPCONV \ 2041OLD_RES \ 2042OMALLOC_USES_SYSTEM_MALLOC \ 2043PLURAL_INTERNAL_DECLARATIONS \ 2044SEMIC_PRINT \ 2045SI_COUNTEDREF_AUTOLOAD \ 2046SINGULAR 2047 2048 2049# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2050# tag can be used to specify a list of macro names that should be expanded. The 2051# macro definition that is found in the sources will be used. Use the PREDEFINED 2052# tag if you want to use a different macro definition that overrules the 2053# definition found in the source code. 2054# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2055 2056EXPAND_AS_DEFINED = SINGULAR_DOXYGEN 2057 2058# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2059# remove all references to function-like macros that are alone on a line, have 2060# an all uppercase name, and do not end with a semicolon. Such function macros 2061# are typically used for boiler-plate code, and will confuse the parser if not 2062# removed. 2063# The default value is: YES. 2064# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2065 2066SKIP_FUNCTION_MACROS = NO 2067 2068#--------------------------------------------------------------------------- 2069# Configuration options related to external references 2070#--------------------------------------------------------------------------- 2071 2072# The TAGFILES tag can be used to specify one or more tag files. For each tag 2073# file the location of the external documentation should be added. The format of 2074# a tag file without this location is as follows: 2075# TAGFILES = file1 file2 ... 2076# Adding location for the tag files is done as follows: 2077# TAGFILES = file1=loc1 "file2 = loc2" ... 2078# where loc1 and loc2 can be relative or absolute paths or URLs. See the 2079# section "Linking to external documentation" for more information about the use 2080# of tag files. 2081# Note: Each tag file must have a unique name (where the name does NOT include 2082# the path). If a tag file is not located in the directory in which doxygen is 2083# run, you must also specify the path to the tagfile here. 2084 2085TAGFILES = 2086 2087# When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2088# tag file that is based on the input files it reads. See section "Linking to 2089# external documentation" for more information about the usage of tag files. 2090 2091GENERATE_TAGFILE = tags 2092 2093# If the ALLEXTERNALS tag is set to YES all external class will be listed in the 2094# class index. If set to NO only the inherited external classes will be listed. 2095# The default value is: NO. 2096 2097ALLEXTERNALS = NO 2098 2099# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in 2100# the modules index. If set to NO, only the current project's groups will be 2101# listed. 2102# The default value is: YES. 2103 2104EXTERNAL_GROUPS = YES 2105 2106# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in 2107# the related pages index. If set to NO, only the current project's pages will 2108# be listed. 2109# The default value is: YES. 2110 2111EXTERNAL_PAGES = YES 2112 2113# The PERL_PATH should be the absolute path and name of the perl script 2114# interpreter (i.e. the result of 'which perl'). 2115# The default file (with absolute path) is: /usr/bin/perl. 2116 2117PERL_PATH = /usr/bin/perl 2118 2119#--------------------------------------------------------------------------- 2120# Configuration options related to the dot tool 2121#--------------------------------------------------------------------------- 2122 2123# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram 2124# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2125# NO turns the diagrams off. Note that this option also works with HAVE_DOT 2126# disabled, but it is recommended to install and use dot, since it yields more 2127# powerful graphs. 2128# The default value is: YES. 2129 2130CLASS_DIAGRAMS = YES 2131 2132# You can define message sequence charts within doxygen comments using the \msc 2133# command. Doxygen will then run the mscgen tool (see: 2134# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 2135# documentation. The MSCGEN_PATH tag allows you to specify the directory where 2136# the mscgen tool resides. If left empty the tool is assumed to be found in the 2137# default search path. 2138 2139MSCGEN_PATH = 2140 2141# You can include diagrams made with dia in doxygen documentation. Doxygen will 2142# then run dia to produce the diagram and insert it in the documentation. The 2143# DIA_PATH tag allows you to specify the directory where the dia binary resides. 2144# If left empty dia is assumed to be found in the default search path. 2145 2146DIA_PATH = 2147 2148# If set to YES, the inheritance and collaboration graphs will hide inheritance 2149# and usage relations if the target is undocumented or is not a class. 2150# The default value is: YES. 2151 2152HIDE_UNDOC_RELATIONS = YES 2153 2154# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2155# available from the path. This tool is part of Graphviz (see: 2156# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2157# Bell Labs. The other options in this section have no effect if this option is 2158# set to NO 2159# The default value is: NO. 2160 2161HAVE_DOT = YES 2162 2163# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2164# to run in parallel. When set to 0 doxygen will base this on the number of 2165# processors available in the system. You can set it explicitly to a value 2166# larger than 0 to get control over the balance between CPU load and processing 2167# speed. 2168# Minimum value: 0, maximum value: 32, default value: 0. 2169# This tag requires that the tag HAVE_DOT is set to YES. 2170 2171DOT_NUM_THREADS = 0 2172 2173# When you want a differently looking font in the dot files that doxygen 2174# generates you can specify the font name using DOT_FONTNAME. You need to make 2175# sure dot is able to find the font, which can be done by putting it in a 2176# standard location or by setting the DOTFONTPATH environment variable or by 2177# setting DOT_FONTPATH to the directory containing the font. 2178# The default value is: Helvetica. 2179# This tag requires that the tag HAVE_DOT is set to YES. 2180 2181DOT_FONTNAME = Helvetica 2182 2183# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2184# dot graphs. 2185# Minimum value: 4, maximum value: 24, default value: 10. 2186# This tag requires that the tag HAVE_DOT is set to YES. 2187 2188DOT_FONTSIZE = 10 2189 2190# By default doxygen will tell dot to use the default font as specified with 2191# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2192# the path where dot can find it using this tag. 2193# This tag requires that the tag HAVE_DOT is set to YES. 2194 2195DOT_FONTPATH = 2196 2197# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2198# each documented class showing the direct and indirect inheritance relations. 2199# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2200# The default value is: YES. 2201# This tag requires that the tag HAVE_DOT is set to YES. 2202 2203CLASS_GRAPH = NO 2204 2205# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2206# graph for each documented class showing the direct and indirect implementation 2207# dependencies (inheritance, containment, and class references variables) of the 2208# class with other documented classes. 2209# The default value is: YES. 2210# This tag requires that the tag HAVE_DOT is set to YES. 2211 2212COLLABORATION_GRAPH = NO 2213 2214# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2215# groups, showing the direct groups dependencies. 2216# The default value is: YES. 2217# This tag requires that the tag HAVE_DOT is set to YES. 2218 2219GROUP_GRAPHS = YES 2220 2221# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 2222# collaboration diagrams in a style similar to the OMG's Unified Modeling 2223# Language. 2224# The default value is: NO. 2225# This tag requires that the tag HAVE_DOT is set to YES. 2226 2227UML_LOOK = NO 2228 2229# If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2230# class node. If there are many fields or methods and many nodes the graph may 2231# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2232# number of items for each type to make the size more manageable. Set this to 0 2233# for no limit. Note that the threshold may be exceeded by 50% before the limit 2234# is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2235# but if the number exceeds 15, the total amount of fields shown is limited to 2236# 10. 2237# Minimum value: 0, maximum value: 100, default value: 10. 2238# This tag requires that the tag HAVE_DOT is set to YES. 2239 2240UML_LIMIT_NUM_FIELDS = 10 2241 2242# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2243# collaboration graphs will show the relations between templates and their 2244# instances. 2245# The default value is: NO. 2246# This tag requires that the tag HAVE_DOT is set to YES. 2247 2248TEMPLATE_RELATIONS = NO 2249 2250# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2251# YES then doxygen will generate a graph for each documented file showing the 2252# direct and indirect include dependencies of the file with other documented 2253# files. 2254# The default value is: YES. 2255# This tag requires that the tag HAVE_DOT is set to YES. 2256 2257INCLUDE_GRAPH = NO 2258 2259# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2260# set to YES then doxygen will generate a graph for each documented file showing 2261# the direct and indirect include dependencies of the file with other documented 2262# files. 2263# The default value is: YES. 2264# This tag requires that the tag HAVE_DOT is set to YES. 2265 2266INCLUDED_BY_GRAPH = NO 2267 2268# If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2269# dependency graph for every global function or class method. 2270# 2271# Note that enabling this option will significantly increase the time of a run. 2272# So in most cases it will be better to enable call graphs for selected 2273# functions only using the \callgraph command. 2274# The default value is: NO. 2275# This tag requires that the tag HAVE_DOT is set to YES. 2276 2277CALL_GRAPH = NO 2278 2279# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2280# dependency graph for every global function or class method. 2281# 2282# Note that enabling this option will significantly increase the time of a run. 2283# So in most cases it will be better to enable caller graphs for selected 2284# functions only using the \callergraph command. 2285# The default value is: NO. 2286# This tag requires that the tag HAVE_DOT is set to YES. 2287 2288CALLER_GRAPH = NO 2289 2290# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2291# hierarchy of all classes instead of a textual one. 2292# The default value is: YES. 2293# This tag requires that the tag HAVE_DOT is set to YES. 2294 2295GRAPHICAL_HIERARCHY = NO 2296 2297# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2298# dependencies a directory has on other directories in a graphical way. The 2299# dependency relations are determined by the #include relations between the 2300# files in the directories. 2301# The default value is: YES. 2302# This tag requires that the tag HAVE_DOT is set to YES. 2303 2304DIRECTORY_GRAPH = YES 2305 2306# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2307# generated by dot. 2308# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2309# to make the SVG files visible in IE 9+ (other browsers do not have this 2310# requirement). 2311# Possible values are: png, jpg, gif and svg. 2312# The default value is: png. 2313# This tag requires that the tag HAVE_DOT is set to YES. 2314 2315DOT_IMAGE_FORMAT = png 2316 2317# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2318# enable generation of interactive SVG images that allow zooming and panning. 2319# 2320# Note that this requires a modern browser other than Internet Explorer. Tested 2321# and working are Firefox, Chrome, Safari, and Opera. 2322# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2323# the SVG files visible. Older versions of IE do not have SVG support. 2324# The default value is: NO. 2325# This tag requires that the tag HAVE_DOT is set to YES. 2326 2327INTERACTIVE_SVG = YES 2328 2329# The DOT_PATH tag can be used to specify the path where the dot tool can be 2330# found. If left blank, it is assumed the dot tool can be found in the path. 2331# This tag requires that the tag HAVE_DOT is set to YES. 2332 2333DOT_PATH = 2334 2335# The DOTFILE_DIRS tag can be used to specify one or more directories that 2336# contain dot files that are included in the documentation (see the \dotfile 2337# command). 2338# This tag requires that the tag HAVE_DOT is set to YES. 2339 2340DOTFILE_DIRS =$(abs_top_srcdir)
2341
2342# The MSCFILE_DIRS tag can be used to specify one or more directories that
2343# contain msc files that are included in the documentation (see the \mscfile
2344# command).
2345
2346MSCFILE_DIRS           =
2347
2348# The DIAFILE_DIRS tag can be used to specify one or more directories that
2349# contain dia files that are included in the documentation (see the \diafile
2350# command).
2351
2352DIAFILE_DIRS           =
2353
2354# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2355# that will be shown in the graph. If the number of nodes in a graph becomes
2356# larger than this value, doxygen will truncate the graph, which is visualized
2357# by representing a node as a red box. Note that doxygen if the number of direct
2358# children of the root node in a graph is already larger than
2359# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2360# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2361# Minimum value: 0, maximum value: 10000, default value: 50.
2362# This tag requires that the tag HAVE_DOT is set to YES.
2363
2364DOT_GRAPH_MAX_NODES    = 30
2365
2366# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2367# generated by dot. A depth value of 3 means that only nodes reachable from the
2368# root by following a path via at most 3 edges will be shown. Nodes that lay
2369# further from the root node will be omitted. Note that setting this option to 1
2370# or 2 may greatly reduce the computation time needed for large code bases. Also
2371# note that the size of a graph can be further restricted by
2372# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2373# Minimum value: 0, maximum value: 1000, default value: 0.
2374# This tag requires that the tag HAVE_DOT is set to YES.
2375
2376MAX_DOT_GRAPH_DEPTH    = 3
2377
2378# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2379# background. This is disabled by default, because dot on Windows does not seem
2380# to support this out of the box.
2381#
2382# Warning: Depending on the platform used, enabling this option may lead to
2383# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2385# The default value is: NO.
2386# This tag requires that the tag HAVE_DOT is set to YES.
2387
2388DOT_TRANSPARENT        = NO
2389
2390# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2391# files in one run (i.e. multiple -o and -T options on the command line). This
2392# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2393# this, this feature is disabled by default.
2394# The default value is: NO.
2395# This tag requires that the tag HAVE_DOT is set to YES.
2396
2397DOT_MULTI_TARGETS      = YES
2398
2399# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2400# explaining the meaning of the various boxes and arrows in the dot generated
2401# graphs.
2402# The default value is: YES.
2403# This tag requires that the tag HAVE_DOT is set to YES.
2404
2405GENERATE_LEGEND        = NO
2406
2407# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2408# files that are used to generate the various graphs.
2409# The default value is: YES.
2410# This tag requires that the tag HAVE_DOT is set to YES.
2411
2412DOT_CLEANUP            = YES
Note: See TracBrowser for help on using the repository browser.