source: git/dox/Doxyfile.in @ b3ec2d

spielwiese
Last change on this file since b3ec2d was b3ec2d, checked in by Martin Lee <martinlee84@…>, 10 years ago
chg: ignore preprocessor statements and use first sentence as brief description
  • Property mode set to 100644
File size: 99.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           = Singular
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         =
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           =
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)
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
180JAVADOC_AUTOBRIEF      = YES
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
224# For example adding
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
302AUTOLINK_SUPPORT       = YES
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   = NO
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 = NO
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       = YES
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  = NO
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            =
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                  = $(abs_top_srcdir)/omalloc/ \
758                         $(abs_top_srcdir)/resources/ \
759                         $(abs_top_srcdir)/factory/ \
760                         $(abs_top_srcdir)/kernel/ \
761                         $(abs_top_srcdir)/libpolys/ \
762                         $(abs_top_srcdir)/Singular/ \
763                         $(abs_top_srcdir)/templates/ \
764                         $(abs_top_srcdir)/main.dox
765
766# This tag can be used to specify the character encoding of the source files
767# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
768# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
769# documentation (see: http://www.gnu.org/software/libiconv) for the list of
770# possible encodings.
771# The default value is: UTF-8.
772
773INPUT_ENCODING         = UTF-8
774
775# If the value of the INPUT tag contains directories, you can use the
776# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
777# *.h) to filter out the source-files in the directories. If left blank the
778# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
779# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
780# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
781# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
782# *.qsf, *.as and *.js.
783
784FILE_PATTERNS          = *.h \
785                         *.cc \
786                         *.c \
787                         *.cpp \
788                         *.cxx \
789                         *.dox
790
791# The RECURSIVE tag can be used to specify whether or not subdirectories should
792# be searched for input files as well.
793# The default value is: NO.
794
795RECURSIVE              = YES
796
797# The EXCLUDE tag can be used to specify files and/or directories that should be
798# excluded from the INPUT source files. This way you can easily exclude a
799# subdirectory from a directory tree whose root is specified with the INPUT tag.
800#
801# Note that relative paths are relative to the directory from which doxygen is
802# run.
803
804EXCLUDE                = $(abs_top_srcdir)/factory/examples \
805                         $(abs_top_srcdir)/kernel/old \
806                         $(abs_top_srcdir)/omalloc/Misc
807
808# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
809# directories that are symbolic links (a Unix file system feature) are excluded
810# from the input.
811# The default value is: NO.
812
813EXCLUDE_SYMLINKS       = YES
814
815# If the value of the INPUT tag contains directories, you can use the
816# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
817# certain files from those directories.
818#
819# Note that the wildcards are matched against the file with absolute path, so to
820# exclude all test directories for example use the pattern */test/*
821
822EXCLUDE_PATTERNS       = */test.cc
823
824# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
825# (namespaces, classes, functions, etc.) that should be excluded from the
826# output. The symbol name can be a fully qualified name, a word, or if the
827# wildcard * is used, a substring. Examples: ANamespace, AClass,
828# AClass::ANamespace, ANamespace::*Test
829#
830# Note that the wildcards are matched against the file with absolute path, so to
831# exclude all test directories use the pattern */test/*
832
833EXCLUDE_SYMBOLS        =
834
835# The EXAMPLE_PATH tag can be used to specify one or more files or directories
836# that contain example code fragments that are included (see the \include
837# command).
838
839EXAMPLE_PATH           = $(abs_top_srcdir)
840
841# If the value of the EXAMPLE_PATH tag contains directories, you can use the
842# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
843# *.h) to filter out the source-files in the directories. If left blank all
844# files are included.
845
846EXAMPLE_PATTERNS       =
847
848# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
849# searched for input files to be used with the \include or \dontinclude commands
850# irrespective of the value of the RECURSIVE tag.
851# The default value is: NO.
852
853EXAMPLE_RECURSIVE      = NO
854
855# The IMAGE_PATH tag can be used to specify one or more files or directories
856# that contain images that are to be included in the documentation (see the
857# \image command).
858
859IMAGE_PATH             = $(abs_top_srcdir)
860
861# The INPUT_FILTER tag can be used to specify a program that doxygen should
862# invoke to filter for each input file. Doxygen will invoke the filter program
863# by executing (via popen()) the command:
864#
865# <filter> <input-file>
866#
867# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
868# name of an input file. Doxygen will then use the output that the filter
869# program writes to standard output. If FILTER_PATTERNS is specified, this tag
870# will be ignored.
871#
872# Note that the filter must not add or remove lines; it is applied before the
873# code is scanned, but not when the output code is generated. If lines are added
874# or removed, the anchors will not be placed correctly.
875
876INPUT_FILTER           =
877
878# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
879# basis. Doxygen will compare the file name with each pattern and apply the
880# filter if there is a match. The filters are a list of the form: pattern=filter
881# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
882# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
883# patterns match the file name, INPUT_FILTER is applied.
884
885FILTER_PATTERNS        =
886
887# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
888# INPUT_FILTER ) will also be used to filter the input files that are used for
889# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
890# The default value is: NO.
891
892FILTER_SOURCE_FILES    = NO
893
894# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
895# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
896# it is also possible to disable source filtering for a specific pattern using
897# *.ext= (so without naming a filter).
898# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
899
900FILTER_SOURCE_PATTERNS =
901
902# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
903# is part of the input, its contents will be placed on the main page
904# (index.html). This can be useful if you have a project on for instance GitHub
905# and want to reuse the introduction page also for the doxygen output.
906
907USE_MDFILE_AS_MAINPAGE =
908
909#---------------------------------------------------------------------------
910# Configuration options related to source browsing
911#---------------------------------------------------------------------------
912
913# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
914# generated. Documented entities will be cross-referenced with these sources.
915#
916# Note: To get rid of all source code in the generated output, make sure that
917# also VERBATIM_HEADERS is set to NO.
918# The default value is: NO.
919
920SOURCE_BROWSER         = YES
921
922# Setting the INLINE_SOURCES tag to YES will include the body of functions,
923# classes and enums directly into the documentation.
924# The default value is: NO.
925
926INLINE_SOURCES         = YES
927
928# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
929# special comment blocks from generated source code fragments. Normal C, C++ and
930# Fortran comments will always remain visible.
931# The default value is: YES.
932
933STRIP_CODE_COMMENTS    = NO
934
935# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
936# function all documented functions referencing it will be listed.
937# The default value is: NO.
938
939REFERENCED_BY_RELATION = NO
940
941# If the REFERENCES_RELATION tag is set to YES then for each documented function
942# all documented entities called/used by that function will be listed.
943# The default value is: NO.
944
945REFERENCES_RELATION    = NO
946
947# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
948# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
949# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
950# link to the documentation.
951# The default value is: YES.
952
953REFERENCES_LINK_SOURCE = NO
954
955# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
956# source code will show a tooltip with additional information such as prototype,
957# brief description and links to the definition and documentation. Since this
958# will make the HTML file larger and loading of large files a bit slower, you
959# can opt to disable this feature.
960# The default value is: YES.
961# This tag requires that the tag SOURCE_BROWSER is set to YES.
962
963SOURCE_TOOLTIPS        = YES
964
965# If the USE_HTAGS tag is set to YES then the references to source code will
966# point to the HTML generated by the htags(1) tool instead of doxygen built-in
967# source browser. The htags tool is part of GNU's global source tagging system
968# (see http://www.gnu.org/software/global/global.html). You will need version
969# 4.8.6 or higher.
970#
971# To use it do the following:
972# - Install the latest version of global
973# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
974# - Make sure the INPUT points to the root of the source tree
975# - Run doxygen as normal
976#
977# Doxygen will invoke htags (and that will in turn invoke gtags), so these
978# tools must be available from the command line (i.e. in the search path).
979#
980# The result: instead of the source browser generated by doxygen, the links to
981# source code will now point to the output of htags.
982# The default value is: NO.
983# This tag requires that the tag SOURCE_BROWSER is set to YES.
984
985USE_HTAGS              = NO
986
987# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
988# verbatim copy of the header file for each class for which an include is
989# specified. Set to NO to disable this.
990# See also: Section \class.
991# The default value is: YES.
992
993VERBATIM_HEADERS       = YES
994
995#---------------------------------------------------------------------------
996# Configuration options related to the alphabetical class index
997#---------------------------------------------------------------------------
998
999# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1000# compounds will be generated. Enable this if the project contains a lot of
1001# classes, structs, unions or interfaces.
1002# The default value is: YES.
1003
1004ALPHABETICAL_INDEX     = YES
1005
1006# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1007# which the alphabetical index list will be split.
1008# Minimum value: 1, maximum value: 20, default value: 5.
1009# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1010
1011COLS_IN_ALPHA_INDEX    = 5
1012
1013# In case all classes in a project start with a common prefix, all classes will
1014# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1015# can be used to specify a prefix (or a list of prefixes) that should be ignored
1016# while generating the index headers.
1017# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1018
1019IGNORE_PREFIX          =
1020
1021#---------------------------------------------------------------------------
1022# Configuration options related to the HTML output
1023#---------------------------------------------------------------------------
1024
1025# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1026# The default value is: YES.
1027
1028GENERATE_HTML          = YES
1029
1030# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1031# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1032# it.
1033# The default directory is: html.
1034# This tag requires that the tag GENERATE_HTML is set to YES.
1035
1036HTML_OUTPUT            = html
1037
1038# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1039# generated HTML page (for example: .htm, .php, .asp).
1040# The default value is: .html.
1041# This tag requires that the tag GENERATE_HTML is set to YES.
1042
1043HTML_FILE_EXTENSION    = .html
1044
1045# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1046# each generated HTML page. If the tag is left blank doxygen will generate a
1047# standard header.
1048#
1049# To get valid HTML the header file that includes any scripts and style sheets
1050# that doxygen needs, which is dependent on the configuration options used (e.g.
1051# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1052# default header using
1053# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1054# YourConfigFile
1055# and then modify the file new_header.html. See also section "Doxygen usage"
1056# for information on how to generate the default header that doxygen normally
1057# uses.
1058# Note: The header is subject to change so you typically have to regenerate the
1059# default header when upgrading to a newer version of doxygen. For a description
1060# of the possible markers and block names see the documentation.
1061# This tag requires that the tag GENERATE_HTML is set to YES.
1062
1063HTML_HEADER            =
1064
1065# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1066# generated HTML page. If the tag is left blank doxygen will generate a standard
1067# footer. See HTML_HEADER for more information on how to generate a default
1068# footer and what special commands can be used inside the footer. See also
1069# section "Doxygen usage" for information on how to generate the default footer
1070# that doxygen normally uses.
1071# This tag requires that the tag GENERATE_HTML is set to YES.
1072
1073HTML_FOOTER            =
1074
1075# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1076# sheet that is used by each HTML page. It can be used to fine-tune the look of
1077# the HTML output. If left blank doxygen will generate a default style sheet.
1078# See also section "Doxygen usage" for information on how to generate the style
1079# sheet that doxygen normally uses.
1080# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1081# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1082# obsolete.
1083# This tag requires that the tag GENERATE_HTML is set to YES.
1084
1085HTML_STYLESHEET        =
1086
1087# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1088# defined cascading style sheet that is included after the standard style sheets
1089# created by doxygen. Using this option one can overrule certain style aspects.
1090# This is preferred over using HTML_STYLESHEET since it does not replace the
1091# standard style sheet and is therefor more robust against future updates.
1092# Doxygen will copy the style sheet file to the output directory. For an example
1093# see the documentation.
1094# This tag requires that the tag GENERATE_HTML is set to YES.
1095
1096HTML_EXTRA_STYLESHEET  =
1097
1098# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1099# other source files which should be copied to the HTML output directory. Note
1100# that these files will be copied to the base HTML output directory. Use the
1101# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1102# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1103# files will be copied as-is; there are no commands or markers available.
1104# This tag requires that the tag GENERATE_HTML is set to YES.
1105
1106HTML_EXTRA_FILES       =
1107
1108# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1109# will adjust the colors in the stylesheet and background images according to
1110# this color. Hue is specified as an angle on a colorwheel, see
1111# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1112# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1113# purple, and 360 is red again.
1114# Minimum value: 0, maximum value: 359, default value: 220.
1115# This tag requires that the tag GENERATE_HTML is set to YES.
1116
1117HTML_COLORSTYLE_HUE    = 220
1118
1119# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1120# in the HTML output. For a value of 0 the output will use grayscales only. A
1121# value of 255 will produce the most vivid colors.
1122# Minimum value: 0, maximum value: 255, default value: 100.
1123# This tag requires that the tag GENERATE_HTML is set to YES.
1124
1125HTML_COLORSTYLE_SAT    = 100
1126
1127# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1128# luminance component of the colors in the HTML output. Values below 100
1129# gradually make the output lighter, whereas values above 100 make the output
1130# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1131# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1132# change the gamma.
1133# Minimum value: 40, maximum value: 240, default value: 80.
1134# This tag requires that the tag GENERATE_HTML is set to YES.
1135
1136HTML_COLORSTYLE_GAMMA  = 80
1137
1138# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1139# page will contain the date and time when the page was generated. Setting this
1140# to NO can help when comparing the output of multiple runs.
1141# The default value is: YES.
1142# This tag requires that the tag GENERATE_HTML is set to YES.
1143
1144HTML_TIMESTAMP         = NO
1145
1146# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1147# documentation will contain sections that can be hidden and shown after the
1148# page has loaded.
1149# The default value is: NO.
1150# This tag requires that the tag GENERATE_HTML is set to YES.
1151
1152HTML_DYNAMIC_SECTIONS  = NO
1153
1154# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1155# shown in the various tree structured indices initially; the user can expand
1156# and collapse entries dynamically later on. Doxygen will expand the tree to
1157# such a level that at most the specified number of entries are visible (unless
1158# a fully collapsed tree already exceeds this amount). So setting the number of
1159# entries 1 will produce a full collapsed tree by default. 0 is a special value
1160# representing an infinite number of entries and will result in a full expanded
1161# tree by default.
1162# Minimum value: 0, maximum value: 9999, default value: 100.
1163# This tag requires that the tag GENERATE_HTML is set to YES.
1164
1165HTML_INDEX_NUM_ENTRIES = 100
1166
1167# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1168# generated that can be used as input for Apple's Xcode 3 integrated development
1169# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1170# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1171# Makefile in the HTML output directory. Running make will produce the docset in
1172# that directory and running make install will install the docset in
1173# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1174# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1175# for more information.
1176# The default value is: NO.
1177# This tag requires that the tag GENERATE_HTML is set to YES.
1178
1179GENERATE_DOCSET        = NO
1180
1181# This tag determines the name of the docset feed. A documentation feed provides
1182# an umbrella under which multiple documentation sets from a single provider
1183# (such as a company or product suite) can be grouped.
1184# The default value is: Doxygen generated docs.
1185# This tag requires that the tag GENERATE_DOCSET is set to YES.
1186
1187DOCSET_FEEDNAME        = "Doxygen generated docs"
1188
1189# This tag specifies a string that should uniquely identify the documentation
1190# set bundle. This should be a reverse domain-name style string, e.g.
1191# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1192# The default value is: org.doxygen.Project.
1193# This tag requires that the tag GENERATE_DOCSET is set to YES.
1194
1195DOCSET_BUNDLE_ID       = org.doxygen.Project
1196
1197# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1198# the documentation publisher. This should be a reverse domain-name style
1199# string, e.g. com.mycompany.MyDocSet.documentation.
1200# The default value is: org.doxygen.Publisher.
1201# This tag requires that the tag GENERATE_DOCSET is set to YES.
1202
1203DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1204
1205# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1206# The default value is: Publisher.
1207# This tag requires that the tag GENERATE_DOCSET is set to YES.
1208
1209DOCSET_PUBLISHER_NAME  = Publisher
1210
1211# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1212# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1213# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1214# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1215# Windows.
1216#
1217# The HTML Help Workshop contains a compiler that can convert all HTML output
1218# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1219# files are now used as the Windows 98 help format, and will replace the old
1220# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1221# HTML files also contain an index, a table of contents, and you can search for
1222# words in the documentation. The HTML workshop also contains a viewer for
1223# compressed HTML files.
1224# The default value is: NO.
1225# This tag requires that the tag GENERATE_HTML is set to YES.
1226
1227GENERATE_HTMLHELP      = NO
1228
1229# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1230# file. You can add a path in front of the file if the result should not be
1231# written to the html output directory.
1232# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1233
1234CHM_FILE               =
1235
1236# The HHC_LOCATION tag can be used to specify the location (absolute path
1237# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1238# doxygen will try to run the HTML help compiler on the generated index.hhp.
1239# The file has to be specified with full path.
1240# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1241
1242HHC_LOCATION           =
1243
1244# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1245# YES) or that it should be included in the master .chm file ( NO).
1246# The default value is: NO.
1247# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1248
1249GENERATE_CHI           = NO
1250
1251# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1252# and project file content.
1253# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1254
1255CHM_INDEX_ENCODING     =
1256
1257# The BINARY_TOC flag controls whether a binary table of contents is generated (
1258# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1259# enables the Previous and Next buttons.
1260# The default value is: NO.
1261# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1262
1263BINARY_TOC             = NO
1264
1265# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1266# the table of contents of the HTML help documentation and to the tree view.
1267# The default value is: NO.
1268# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1269
1270TOC_EXPAND             = NO
1271
1272# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1273# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1274# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1275# (.qch) of the generated HTML documentation.
1276# The default value is: NO.
1277# This tag requires that the tag GENERATE_HTML is set to YES.
1278
1279GENERATE_QHP           = NO
1280
1281# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1282# the file name of the resulting .qch file. The path specified is relative to
1283# the HTML output folder.
1284# This tag requires that the tag GENERATE_QHP is set to YES.
1285
1286QCH_FILE               =
1287
1288# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1289# Project output. For more information please see Qt Help Project / Namespace
1290# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1291# The default value is: org.doxygen.Project.
1292# This tag requires that the tag GENERATE_QHP is set to YES.
1293
1294QHP_NAMESPACE          = org.doxygen.Project
1295
1296# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1297# Help Project output. For more information please see Qt Help Project / Virtual
1298# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1299# folders).
1300# The default value is: doc.
1301# This tag requires that the tag GENERATE_QHP is set to YES.
1302
1303QHP_VIRTUAL_FOLDER     = doc
1304
1305# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1306# filter to add. For more information please see Qt Help Project / Custom
1307# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1308# filters).
1309# This tag requires that the tag GENERATE_QHP is set to YES.
1310
1311QHP_CUST_FILTER_NAME   =
1312
1313# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1314# custom filter to add. For more information please see Qt Help Project / Custom
1315# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1316# filters).
1317# This tag requires that the tag GENERATE_QHP is set to YES.
1318
1319QHP_CUST_FILTER_ATTRS  =
1320
1321# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1322# project's filter section matches. Qt Help Project / Filter Attributes (see:
1323# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1324# This tag requires that the tag GENERATE_QHP is set to YES.
1325
1326QHP_SECT_FILTER_ATTRS  =
1327
1328# The QHG_LOCATION tag can be used to specify the location of Qt's
1329# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1330# generated .qhp file.
1331# This tag requires that the tag GENERATE_QHP is set to YES.
1332
1333QHG_LOCATION           =
1334
1335# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1336# generated, together with the HTML files, they form an Eclipse help plugin. To
1337# install this plugin and make it available under the help contents menu in
1338# Eclipse, the contents of the directory containing the HTML and XML files needs
1339# to be copied into the plugins directory of eclipse. The name of the directory
1340# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1341# After copying Eclipse needs to be restarted before the help appears.
1342# The default value is: NO.
1343# This tag requires that the tag GENERATE_HTML is set to YES.
1344
1345GENERATE_ECLIPSEHELP   = NO
1346
1347# A unique identifier for the Eclipse help plugin. When installing the plugin
1348# the directory name containing the HTML and XML files should also have this
1349# name. Each documentation set should have its own identifier.
1350# The default value is: org.doxygen.Project.
1351# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1352
1353ECLIPSE_DOC_ID         = org.doxygen.Project
1354
1355# If you want full control over the layout of the generated HTML pages it might
1356# be necessary to disable the index and replace it with your own. The
1357# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1358# of each HTML page. A value of NO enables the index and the value YES disables
1359# it. Since the tabs in the index contain the same information as the navigation
1360# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1361# The default value is: NO.
1362# This tag requires that the tag GENERATE_HTML is set to YES.
1363
1364DISABLE_INDEX          = NO
1365
1366# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1367# structure should be generated to display hierarchical information. If the tag
1368# value is set to YES, a side panel will be generated containing a tree-like
1369# index structure (just like the one that is generated for HTML Help). For this
1370# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1371# (i.e. any modern browser). Windows users are probably better off using the
1372# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1373# further fine-tune the look of the index. As an example, the default style
1374# sheet generated by doxygen has an example that shows how to put an image at
1375# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1376# the same information as the tab index, you could consider setting
1377# DISABLE_INDEX to YES when enabling this option.
1378# The default value is: NO.
1379# This tag requires that the tag GENERATE_HTML is set to YES.
1380
1381GENERATE_TREEVIEW      = NO
1382
1383# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1384# doxygen will group on one line in the generated HTML documentation.
1385#
1386# Note that a value of 0 will completely suppress the enum values from appearing
1387# in the overview section.
1388# Minimum value: 0, maximum value: 20, default value: 4.
1389# This tag requires that the tag GENERATE_HTML is set to YES.
1390
1391ENUM_VALUES_PER_LINE   = 4
1392
1393# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1394# to set the initial width (in pixels) of the frame in which the tree is shown.
1395# Minimum value: 0, maximum value: 1500, default value: 250.
1396# This tag requires that the tag GENERATE_HTML is set to YES.
1397
1398TREEVIEW_WIDTH         = 250
1399
1400# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1401# external symbols imported via tag files in a separate window.
1402# The default value is: NO.
1403# This tag requires that the tag GENERATE_HTML is set to YES.
1404
1405EXT_LINKS_IN_WINDOW    = NO
1406
1407# Use this tag to change the font size of LaTeX formulas included as images in
1408# the HTML documentation. When you change the font size after a successful
1409# doxygen run you need to manually remove any form_*.png images from the HTML
1410# output directory to force them to be regenerated.
1411# Minimum value: 8, maximum value: 50, default value: 10.
1412# This tag requires that the tag GENERATE_HTML is set to YES.
1413
1414FORMULA_FONTSIZE       = 10
1415
1416# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1417# generated for formulas are transparent PNGs. Transparent PNGs are not
1418# supported properly for IE 6.0, but are supported on all modern browsers.
1419#
1420# Note that when changing this option you need to delete any form_*.png files in
1421# the HTML output directory before the changes have effect.
1422# The default value is: YES.
1423# This tag requires that the tag GENERATE_HTML is set to YES.
1424
1425FORMULA_TRANSPARENT    = YES
1426
1427# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1428# http://www.mathjax.org) which uses client side Javascript for the rendering
1429# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1430# installed or if you want to formulas look prettier in the HTML output. When
1431# enabled you may also need to install MathJax separately and configure the path
1432# to it using the MATHJAX_RELPATH option.
1433# The default value is: NO.
1434# This tag requires that the tag GENERATE_HTML is set to YES.
1435
1436USE_MATHJAX            = NO
1437
1438# When MathJax is enabled you can set the default output format to be used for
1439# the MathJax output. See the MathJax site (see:
1440# http://docs.mathjax.org/en/latest/output.html) for more details.
1441# Possible values are: HTML-CSS (which is slower, but has the best
1442# compatibility), NativeMML (i.e. MathML) and SVG.
1443# The default value is: HTML-CSS.
1444# This tag requires that the tag USE_MATHJAX is set to YES.
1445
1446MATHJAX_FORMAT         = HTML-CSS
1447
1448# When MathJax is enabled you need to specify the location relative to the HTML
1449# output directory using the MATHJAX_RELPATH option. The destination directory
1450# should contain the MathJax.js script. For instance, if the mathjax directory
1451# is located at the same level as the HTML output directory, then
1452# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1453# Content Delivery Network so you can quickly see the result without installing
1454# MathJax. However, it is strongly recommended to install a local copy of
1455# MathJax from http://www.mathjax.org before deployment.
1456# The default value is: http://cdn.mathjax.org/mathjax/latest.
1457# This tag requires that the tag USE_MATHJAX is set to YES.
1458
1459MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1460
1461# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1462# extension names that should be enabled during MathJax rendering. For example
1463# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1464# This tag requires that the tag USE_MATHJAX is set to YES.
1465
1466MATHJAX_EXTENSIONS     =
1467
1468# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1469# of code that will be used on startup of the MathJax code. See the MathJax site
1470# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1471# example see the documentation.
1472# This tag requires that the tag USE_MATHJAX is set to YES.
1473
1474MATHJAX_CODEFILE       =
1475
1476# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1477# the HTML output. The underlying search engine uses javascript and DHTML and
1478# should work on any modern browser. Note that when using HTML help
1479# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1480# there is already a search function so this one should typically be disabled.
1481# For large projects the javascript based search engine can be slow, then
1482# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1483# search using the keyboard; to jump to the search box use <access key> + S
1484# (what the <access key> is depends on the OS and browser, but it is typically
1485# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1486# key> to jump into the search results window, the results can be navigated
1487# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1488# the search. The filter options can be selected when the cursor is inside the
1489# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1490# to select a filter and <Enter> or <escape> to activate or cancel the filter
1491# option.
1492# The default value is: YES.
1493# This tag requires that the tag GENERATE_HTML is set to YES.
1494
1495SEARCHENGINE           = YES
1496
1497# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1498# implemented using a web server instead of a web client using Javascript. There
1499# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1500# setting. When disabled, doxygen will generate a PHP script for searching and
1501# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1502# and searching needs to be provided by external tools. See the section
1503# "External Indexing and Searching" for details.
1504# The default value is: NO.
1505# This tag requires that the tag SEARCHENGINE is set to YES.
1506
1507SERVER_BASED_SEARCH    = NO
1508
1509# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1510# script for searching. Instead the search results are written to an XML file
1511# which needs to be processed by an external indexer. Doxygen will invoke an
1512# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1513# search results.
1514#
1515# Doxygen ships with an example indexer ( doxyindexer) and search engine
1516# (doxysearch.cgi) which are based on the open source search engine library
1517# Xapian (see: http://xapian.org/).
1518#
1519# See the section "External Indexing and Searching" for details.
1520# The default value is: NO.
1521# This tag requires that the tag SEARCHENGINE is set to YES.
1522
1523EXTERNAL_SEARCH        = NO
1524
1525# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1526# which will return the search results when EXTERNAL_SEARCH is enabled.
1527#
1528# Doxygen ships with an example indexer ( doxyindexer) and search engine
1529# (doxysearch.cgi) which are based on the open source search engine library
1530# Xapian (see: http://xapian.org/). See the section "External Indexing and
1531# Searching" for details.
1532# This tag requires that the tag SEARCHENGINE is set to YES.
1533
1534SEARCHENGINE_URL       =
1535
1536# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1537# search data is written to a file for indexing by an external tool. With the
1538# SEARCHDATA_FILE tag the name of this file can be specified.
1539# The default file is: searchdata.xml.
1540# This tag requires that the tag SEARCHENGINE is set to YES.
1541
1542SEARCHDATA_FILE        = searchdata.xml
1543
1544# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1545# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1546# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1547# projects and redirect the results back to the right project.
1548# This tag requires that the tag SEARCHENGINE is set to YES.
1549
1550EXTERNAL_SEARCH_ID     =
1551
1552# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1553# projects other than the one defined by this configuration file, but that are
1554# all added to the same external search index. Each project needs to have a
1555# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1556# to a relative location where the documentation can be found. The format is:
1557# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1558# This tag requires that the tag SEARCHENGINE is set to YES.
1559
1560EXTRA_SEARCH_MAPPINGS  =
1561
1562#---------------------------------------------------------------------------
1563# Configuration options related to the LaTeX output
1564#---------------------------------------------------------------------------
1565
1566# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1567# The default value is: YES.
1568
1569GENERATE_LATEX         = NO
1570
1571# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1572# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1573# it.
1574# The default directory is: latex.
1575# This tag requires that the tag GENERATE_LATEX is set to YES.
1576
1577LATEX_OUTPUT           = latex
1578
1579# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1580# invoked.
1581#
1582# Note that when enabling USE_PDFLATEX this option is only used for generating
1583# bitmaps for formulas in the HTML output, but not in the Makefile that is
1584# written to the output directory.
1585# The default file is: latex.
1586# This tag requires that the tag GENERATE_LATEX is set to YES.
1587
1588LATEX_CMD_NAME         = latex
1589
1590# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1591# index for LaTeX.
1592# The default file is: makeindex.
1593# This tag requires that the tag GENERATE_LATEX is set to YES.
1594
1595MAKEINDEX_CMD_NAME     = makeindex
1596
1597# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1598# documents. This may be useful for small projects and may help to save some
1599# trees in general.
1600# The default value is: NO.
1601# This tag requires that the tag GENERATE_LATEX is set to YES.
1602
1603COMPACT_LATEX          = NO
1604
1605# The PAPER_TYPE tag can be used to set the paper type that is used by the
1606# printer.
1607# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1608# 14 inches) and executive (7.25 x 10.5 inches).
1609# The default value is: a4.
1610# This tag requires that the tag GENERATE_LATEX is set to YES.
1611
1612PAPER_TYPE             = a4
1613
1614# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1615# that should be included in the LaTeX output. To get the times font for
1616# instance you can specify
1617# EXTRA_PACKAGES=times
1618# If left blank no extra packages will be included.
1619# This tag requires that the tag GENERATE_LATEX is set to YES.
1620
1621EXTRA_PACKAGES         =
1622
1623# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1624# generated LaTeX document. The header should contain everything until the first
1625# chapter. If it is left blank doxygen will generate a standard header. See
1626# section "Doxygen usage" for information on how to let doxygen write the
1627# default header to a separate file.
1628#
1629# Note: Only use a user-defined header if you know what you are doing! The
1630# following commands have a special meaning inside the header: $title,
1631# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1632# replace them by respectively the title of the page, the current date and time,
1633# only the current date, the version number of doxygen, the project name (see
1634# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1635# This tag requires that the tag GENERATE_LATEX is set to YES.
1636
1637LATEX_HEADER           =
1638
1639# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1640# generated LaTeX document. The footer should contain everything after the last
1641# chapter. If it is left blank doxygen will generate a standard footer.
1642#
1643# Note: Only use a user-defined footer if you know what you are doing!
1644# This tag requires that the tag GENERATE_LATEX is set to YES.
1645
1646LATEX_FOOTER           =
1647
1648# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1649# other source files which should be copied to the LATEX_OUTPUT output
1650# directory. Note that the files will be copied as-is; there are no commands or
1651# markers available.
1652# This tag requires that the tag GENERATE_LATEX is set to YES.
1653
1654LATEX_EXTRA_FILES      =
1655
1656# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1657# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1658# contain links (just like the HTML output) instead of page references. This
1659# makes the output suitable for online browsing using a PDF viewer.
1660# The default value is: YES.
1661# This tag requires that the tag GENERATE_LATEX is set to YES.
1662
1663PDF_HYPERLINKS         = YES
1664
1665# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1666# the PDF file directly from the LaTeX files. Set this option to YES to get a
1667# higher quality PDF documentation.
1668# The default value is: YES.
1669# This tag requires that the tag GENERATE_LATEX is set to YES.
1670
1671USE_PDFLATEX           = YES
1672
1673# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1674# command to the generated LaTeX files. This will instruct LaTeX to keep running
1675# if errors occur, instead of asking the user for help. This option is also used
1676# when generating formulas in HTML.
1677# The default value is: NO.
1678# This tag requires that the tag GENERATE_LATEX is set to YES.
1679
1680LATEX_BATCHMODE        = YES
1681
1682# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1683# index chapters (such as File Index, Compound Index, etc.) in the output.
1684# The default value is: NO.
1685# This tag requires that the tag GENERATE_LATEX is set to YES.
1686
1687LATEX_HIDE_INDICES     = NO
1688
1689# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1690# code with syntax highlighting in the LaTeX output.
1691#
1692# Note that which sources are shown also depends on other settings such as
1693# SOURCE_BROWSER.
1694# The default value is: NO.
1695# This tag requires that the tag GENERATE_LATEX is set to YES.
1696
1697LATEX_SOURCE_CODE      = NO
1698
1699# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1700# bibliography, e.g. plainnat, or ieeetr. See
1701# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1702# The default value is: plain.
1703# This tag requires that the tag GENERATE_LATEX is set to YES.
1704
1705LATEX_BIB_STYLE        = plain
1706
1707#---------------------------------------------------------------------------
1708# Configuration options related to the RTF output
1709#---------------------------------------------------------------------------
1710
1711# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1712# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1713# readers/editors.
1714# The default value is: NO.
1715
1716GENERATE_RTF           = NO
1717
1718# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1719# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1720# it.
1721# The default directory is: rtf.
1722# This tag requires that the tag GENERATE_RTF is set to YES.
1723
1724RTF_OUTPUT             = rtf
1725
1726# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1727# documents. This may be useful for small projects and may help to save some
1728# trees in general.
1729# The default value is: NO.
1730# This tag requires that the tag GENERATE_RTF is set to YES.
1731
1732COMPACT_RTF            = YES
1733
1734# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1735# contain hyperlink fields. The RTF file will contain links (just like the HTML
1736# output) instead of page references. This makes the output suitable for online
1737# browsing using Word or some other Word compatible readers that support those
1738# fields.
1739#
1740# Note: WordPad (write) and others do not support links.
1741# The default value is: NO.
1742# This tag requires that the tag GENERATE_RTF is set to YES.
1743
1744RTF_HYPERLINKS         = YES
1745
1746# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1747# file, i.e. a series of assignments. You only have to provide replacements,
1748# missing definitions are set to their default value.
1749#
1750# See also section "Doxygen usage" for information on how to generate the
1751# default style sheet that doxygen normally uses.
1752# This tag requires that the tag GENERATE_RTF is set to YES.
1753
1754RTF_STYLESHEET_FILE    =
1755
1756# Set optional variables used in the generation of an RTF document. Syntax is
1757# similar to doxygen's config file. A template extensions file can be generated
1758# using doxygen -e rtf extensionFile.
1759# This tag requires that the tag GENERATE_RTF is set to YES.
1760
1761RTF_EXTENSIONS_FILE    =
1762
1763#---------------------------------------------------------------------------
1764# Configuration options related to the man page output
1765#---------------------------------------------------------------------------
1766
1767# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1768# classes and files.
1769# The default value is: NO.
1770
1771GENERATE_MAN           = NO
1772
1773# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1774# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1775# it. A directory man3 will be created inside the directory specified by
1776# MAN_OUTPUT.
1777# The default directory is: man.
1778# This tag requires that the tag GENERATE_MAN is set to YES.
1779
1780MAN_OUTPUT             = man
1781
1782# The MAN_EXTENSION tag determines the extension that is added to the generated
1783# man pages. In case the manual section does not start with a number, the number
1784# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1785# optional.
1786# The default value is: .3.
1787# This tag requires that the tag GENERATE_MAN is set to YES.
1788
1789MAN_EXTENSION          = .3
1790
1791# The MAN_SUBDIR tag determines the name of the directory created within
1792# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1793# MAN_EXTENSION with the initial . removed.
1794# This tag requires that the tag GENERATE_MAN is set to YES.
1795
1796MAN_SUBDIR             =
1797
1798# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1799# will generate one additional man file for each entity documented in the real
1800# man page(s). These additional files only source the real man page, but without
1801# them the man command would be unable to find the correct page.
1802# The default value is: NO.
1803# This tag requires that the tag GENERATE_MAN is set to YES.
1804
1805MAN_LINKS              = YES
1806
1807#---------------------------------------------------------------------------
1808# Configuration options related to the XML output
1809#---------------------------------------------------------------------------
1810
1811# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1812# captures the structure of the code including all documentation.
1813# The default value is: NO.
1814
1815GENERATE_XML           = NO
1816
1817# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1818# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1819# it.
1820# The default directory is: xml.
1821# This tag requires that the tag GENERATE_XML is set to YES.
1822
1823XML_OUTPUT             = xml
1824
1825# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1826# listings (including syntax highlighting and cross-referencing information) to
1827# the XML output. Note that enabling this will significantly increase the size
1828# of the XML output.
1829# The default value is: YES.
1830# This tag requires that the tag GENERATE_XML is set to YES.
1831
1832XML_PROGRAMLISTING     = YES
1833
1834#---------------------------------------------------------------------------
1835# Configuration options related to the DOCBOOK output
1836#---------------------------------------------------------------------------
1837
1838# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1839# that can be used to generate PDF.
1840# The default value is: NO.
1841
1842GENERATE_DOCBOOK       = NO
1843
1844# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1845# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1846# front of it.
1847# The default directory is: docbook.
1848# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1849
1850DOCBOOK_OUTPUT         = docbook
1851
1852#---------------------------------------------------------------------------
1853# Configuration options for the AutoGen Definitions output
1854#---------------------------------------------------------------------------
1855
1856# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1857# Definitions (see http://autogen.sf.net) file that captures the structure of
1858# the code including all documentation. Note that this feature is still
1859# experimental and incomplete at the moment.
1860# The default value is: NO.
1861
1862GENERATE_AUTOGEN_DEF   = NO
1863
1864#---------------------------------------------------------------------------
1865# Configuration options related to the Perl module output
1866#---------------------------------------------------------------------------
1867
1868# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1869# file that captures the structure of the code including all documentation.
1870#
1871# Note that this feature is still experimental and incomplete at the moment.
1872# The default value is: NO.
1873
1874GENERATE_PERLMOD       = NO
1875
1876# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1877# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1878# output from the Perl module output.
1879# The default value is: NO.
1880# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1881
1882PERLMOD_LATEX          = NO
1883
1884# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1885# formatted so it can be parsed by a human reader. This is useful if you want to
1886# understand what is going on. On the other hand, if this tag is set to NO the
1887# size of the Perl module output will be much smaller and Perl will parse it
1888# just the same.
1889# The default value is: YES.
1890# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1891
1892PERLMOD_PRETTY         = YES
1893
1894# The names of the make variables in the generated doxyrules.make file are
1895# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1896# so different doxyrules.make files included by the same Makefile don't
1897# overwrite each other's variables.
1898# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1899
1900PERLMOD_MAKEVAR_PREFIX =
1901
1902#---------------------------------------------------------------------------
1903# Configuration options related to the preprocessor
1904#---------------------------------------------------------------------------
1905
1906# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1907# C-preprocessor directives found in the sources and include files.
1908# The default value is: YES.
1909
1910ENABLE_PREPROCESSING   = NO
1911
1912# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1913# in the source code. If set to NO only conditional compilation will be
1914# performed. Macro expansion can be done in a controlled way by setting
1915# EXPAND_ONLY_PREDEF to YES.
1916# The default value is: NO.
1917# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1918
1919MACRO_EXPANSION        = NO
1920
1921# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1922# the macro expansion is limited to the macros specified with the PREDEFINED and
1923# EXPAND_AS_DEFINED tags.
1924# The default value is: NO.
1925# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1926
1927EXPAND_ONLY_PREDEF     = NO
1928
1929# If the SEARCH_INCLUDES tag is set to YES the includes files in the
1930# INCLUDE_PATH will be searched if a #include is found.
1931# The default value is: YES.
1932# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1933
1934SEARCH_INCLUDES        = NO
1935
1936# The INCLUDE_PATH tag can be used to specify one or more directories that
1937# contain include files that are not input files but should be processed by the
1938# preprocessor.
1939# This tag requires that the tag SEARCH_INCLUDES is set to YES.
1940
1941INCLUDE_PATH           = $(abs_top_builddir)/ \
1942                         $(abs_top_builddir)/factory \
1943                         $(abs_top_builddir)/libpolys
1944
1945# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1946# patterns (like *.h and *.hpp) to filter out the header-files in the
1947# directories. If left blank, the patterns specified with FILE_PATTERNS will be
1948# used.
1949# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1950
1951INCLUDE_FILE_PATTERNS  =
1952
1953# The PREDEFINED tag can be used to specify one or more macro names that are
1954# defined before the preprocessor is started (similar to the -D option of e.g.
1955# gcc). The argument of the tag is a list of macros of the form: name or
1956# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1957# is assumed. To prevent a macro definition from being undefined via #undef or
1958# recursively expanded use the := operator instead of the = operator.
1959# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1960
1961PREDEFINED             =
1962
1963# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1964# tag can be used to specify a list of macro names that should be expanded. The
1965# macro definition that is found in the sources will be used. Use the PREDEFINED
1966# tag if you want to use a different macro definition that overrules the
1967# definition found in the source code.
1968# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1969
1970EXPAND_AS_DEFINED      = SINGULAR_DOXYGEN
1971
1972# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1973# remove all references to function-like macros that are alone on a line, have
1974# an all uppercase name, and do not end with a semicolon. Such function macros
1975# are typically used for boiler-plate code, and will confuse the parser if not
1976# removed.
1977# The default value is: YES.
1978# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1979
1980SKIP_FUNCTION_MACROS   = NO
1981
1982#---------------------------------------------------------------------------
1983# Configuration options related to external references
1984#---------------------------------------------------------------------------
1985
1986# The TAGFILES tag can be used to specify one or more tag files. For each tag
1987# file the location of the external documentation should be added. The format of
1988# a tag file without this location is as follows:
1989# TAGFILES = file1 file2 ...
1990# Adding location for the tag files is done as follows:
1991# TAGFILES = file1=loc1 "file2 = loc2" ...
1992# where loc1 and loc2 can be relative or absolute paths or URLs. See the
1993# section "Linking to external documentation" for more information about the use
1994# of tag files.
1995# Note: Each tag file must have a unique name (where the name does NOT include
1996# the path). If a tag file is not located in the directory in which doxygen is
1997# run, you must also specify the path to the tagfile here.
1998
1999TAGFILES               =
2000
2001# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2002# tag file that is based on the input files it reads. See section "Linking to
2003# external documentation" for more information about the usage of tag files.
2004
2005GENERATE_TAGFILE       = tags
2006
2007# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2008# class index. If set to NO only the inherited external classes will be listed.
2009# The default value is: NO.
2010
2011ALLEXTERNALS           = NO
2012
2013# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2014# the modules index. If set to NO, only the current project's groups will be
2015# listed.
2016# The default value is: YES.
2017
2018EXTERNAL_GROUPS        = YES
2019
2020# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2021# the related pages index. If set to NO, only the current project's pages will
2022# be listed.
2023# The default value is: YES.
2024
2025EXTERNAL_PAGES         = YES
2026
2027# The PERL_PATH should be the absolute path and name of the perl script
2028# interpreter (i.e. the result of 'which perl').
2029# The default file (with absolute path) is: /usr/bin/perl.
2030
2031PERL_PATH              = /usr/bin/perl
2032
2033#---------------------------------------------------------------------------
2034# Configuration options related to the dot tool
2035#---------------------------------------------------------------------------
2036
2037# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2038# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2039# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2040# disabled, but it is recommended to install and use dot, since it yields more
2041# powerful graphs.
2042# The default value is: YES.
2043
2044CLASS_DIAGRAMS         = YES
2045
2046# You can define message sequence charts within doxygen comments using the \msc
2047# command. Doxygen will then run the mscgen tool (see:
2048# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2049# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2050# the mscgen tool resides. If left empty the tool is assumed to be found in the
2051# default search path.
2052
2053MSCGEN_PATH            =
2054
2055# You can include diagrams made with dia in doxygen documentation. Doxygen will
2056# then run dia to produce the diagram and insert it in the documentation. The
2057# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2058# If left empty dia is assumed to be found in the default search path.
2059
2060DIA_PATH               =
2061
2062# If set to YES, the inheritance and collaboration graphs will hide inheritance
2063# and usage relations if the target is undocumented or is not a class.
2064# The default value is: YES.
2065
2066HIDE_UNDOC_RELATIONS   = YES
2067
2068# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2069# available from the path. This tool is part of Graphviz (see:
2070# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2071# Bell Labs. The other options in this section have no effect if this option is
2072# set to NO
2073# The default value is: NO.
2074
2075HAVE_DOT               = YES
2076
2077# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2078# to run in parallel. When set to 0 doxygen will base this on the number of
2079# processors available in the system. You can set it explicitly to a value
2080# larger than 0 to get control over the balance between CPU load and processing
2081# speed.
2082# Minimum value: 0, maximum value: 32, default value: 0.
2083# This tag requires that the tag HAVE_DOT is set to YES.
2084
2085DOT_NUM_THREADS        = 0
2086
2087# When you want a differently looking font n the dot files that doxygen
2088# generates you can specify the font name using DOT_FONTNAME. You need to make
2089# sure dot is able to find the font, which can be done by putting it in a
2090# standard location or by setting the DOTFONTPATH environment variable or by
2091# setting DOT_FONTPATH to the directory containing the font.
2092# The default value is: Helvetica.
2093# This tag requires that the tag HAVE_DOT is set to YES.
2094
2095DOT_FONTNAME           = Helvetica
2096
2097# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2098# dot graphs.
2099# Minimum value: 4, maximum value: 24, default value: 10.
2100# This tag requires that the tag HAVE_DOT is set to YES.
2101
2102DOT_FONTSIZE           = 10
2103
2104# By default doxygen will tell dot to use the default font as specified with
2105# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2106# the path where dot can find it using this tag.
2107# This tag requires that the tag HAVE_DOT is set to YES.
2108
2109DOT_FONTPATH           =
2110
2111# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2112# each documented class showing the direct and indirect inheritance relations.
2113# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2114# The default value is: YES.
2115# This tag requires that the tag HAVE_DOT is set to YES.
2116
2117CLASS_GRAPH            = NO
2118
2119# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2120# graph for each documented class showing the direct and indirect implementation
2121# dependencies (inheritance, containment, and class references variables) of the
2122# class with other documented classes.
2123# The default value is: YES.
2124# This tag requires that the tag HAVE_DOT is set to YES.
2125
2126COLLABORATION_GRAPH    = NO
2127
2128# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2129# groups, showing the direct groups dependencies.
2130# The default value is: YES.
2131# This tag requires that the tag HAVE_DOT is set to YES.
2132
2133GROUP_GRAPHS           = NO
2134
2135# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2136# collaboration diagrams in a style similar to the OMG's Unified Modeling
2137# Language.
2138# The default value is: NO.
2139# This tag requires that the tag HAVE_DOT is set to YES.
2140
2141UML_LOOK               = NO
2142
2143# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2144# class node. If there are many fields or methods and many nodes the graph may
2145# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2146# number of items for each type to make the size more manageable. Set this to 0
2147# for no limit. Note that the threshold may be exceeded by 50% before the limit
2148# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2149# but if the number exceeds 15, the total amount of fields shown is limited to
2150# 10.
2151# Minimum value: 0, maximum value: 100, default value: 10.
2152# This tag requires that the tag HAVE_DOT is set to YES.
2153
2154UML_LIMIT_NUM_FIELDS   = 10
2155
2156# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2157# collaboration graphs will show the relations between templates and their
2158# instances.
2159# The default value is: NO.
2160# This tag requires that the tag HAVE_DOT is set to YES.
2161
2162TEMPLATE_RELATIONS     = NO
2163
2164# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2165# YES then doxygen will generate a graph for each documented file showing the
2166# direct and indirect include dependencies of the file with other documented
2167# files.
2168# The default value is: YES.
2169# This tag requires that the tag HAVE_DOT is set to YES.
2170
2171INCLUDE_GRAPH          = NO
2172
2173# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2174# set to YES then doxygen will generate a graph for each documented file showing
2175# the direct and indirect include dependencies of the file with other documented
2176# files.
2177# The default value is: YES.
2178# This tag requires that the tag HAVE_DOT is set to YES.
2179
2180INCLUDED_BY_GRAPH      = NO
2181
2182# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2183# dependency graph for every global function or class method.
2184#
2185# Note that enabling this option will significantly increase the time of a run.
2186# So in most cases it will be better to enable call graphs for selected
2187# functions only using the \callgraph command.
2188# The default value is: NO.
2189# This tag requires that the tag HAVE_DOT is set to YES.
2190
2191CALL_GRAPH             = NO
2192
2193# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2194# dependency graph for every global function or class method.
2195#
2196# Note that enabling this option will significantly increase the time of a run.
2197# So in most cases it will be better to enable caller graphs for selected
2198# functions only using the \callergraph command.
2199# The default value is: NO.
2200# This tag requires that the tag HAVE_DOT is set to YES.
2201
2202CALLER_GRAPH           = NO
2203
2204# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2205# hierarchy of all classes instead of a textual one.
2206# The default value is: YES.
2207# This tag requires that the tag HAVE_DOT is set to YES.
2208
2209GRAPHICAL_HIERARCHY    = NO
2210
2211# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2212# dependencies a directory has on other directories in a graphical way. The
2213# dependency relations are determined by the #include relations between the
2214# files in the directories.
2215# The default value is: YES.
2216# This tag requires that the tag HAVE_DOT is set to YES.
2217
2218DIRECTORY_GRAPH        = YES
2219
2220# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2221# generated by dot.
2222# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2223# to make the SVG files visible in IE 9+ (other browsers do not have this
2224# requirement).
2225# Possible values are: png, jpg, gif and svg.
2226# The default value is: png.
2227# This tag requires that the tag HAVE_DOT is set to YES.
2228
2229DOT_IMAGE_FORMAT       = png
2230
2231# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2232# enable generation of interactive SVG images that allow zooming and panning.
2233#
2234# Note that this requires a modern browser other than Internet Explorer. Tested
2235# and working are Firefox, Chrome, Safari, and Opera.
2236# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2237# the SVG files visible. Older versions of IE do not have SVG support.
2238# The default value is: NO.
2239# This tag requires that the tag HAVE_DOT is set to YES.
2240
2241INTERACTIVE_SVG        = NO
2242
2243# The DOT_PATH tag can be used to specify the path where the dot tool can be
2244# found. If left blank, it is assumed the dot tool can be found in the path.
2245# This tag requires that the tag HAVE_DOT is set to YES.
2246
2247DOT_PATH               =
2248
2249# The DOTFILE_DIRS tag can be used to specify one or more directories that
2250# contain dot files that are included in the documentation (see the \dotfile
2251# command).
2252# This tag requires that the tag HAVE_DOT is set to YES.
2253
2254DOTFILE_DIRS           = $(abs_top_srcdir)
2255
2256# The MSCFILE_DIRS tag can be used to specify one or more directories that
2257# contain msc files that are included in the documentation (see the \mscfile
2258# command).
2259
2260MSCFILE_DIRS           =
2261
2262# The DIAFILE_DIRS tag can be used to specify one or more directories that
2263# contain dia files that are included in the documentation (see the \diafile
2264# command).
2265
2266DIAFILE_DIRS           =
2267
2268# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2269# that will be shown in the graph. If the number of nodes in a graph becomes
2270# larger than this value, doxygen will truncate the graph, which is visualized
2271# by representing a node as a red box. Note that doxygen if the number of direct
2272# children of the root node in a graph is already larger than
2273# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2274# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2275# Minimum value: 0, maximum value: 10000, default value: 50.
2276# This tag requires that the tag HAVE_DOT is set to YES.
2277
2278DOT_GRAPH_MAX_NODES    = 30
2279
2280# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2281# generated by dot. A depth value of 3 means that only nodes reachable from the
2282# root by following a path via at most 3 edges will be shown. Nodes that lay
2283# further from the root node will be omitted. Note that setting this option to 1
2284# or 2 may greatly reduce the computation time needed for large code bases. Also
2285# note that the size of a graph can be further restricted by
2286# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2287# Minimum value: 0, maximum value: 1000, default value: 0.
2288# This tag requires that the tag HAVE_DOT is set to YES.
2289
2290MAX_DOT_GRAPH_DEPTH    = 2
2291
2292# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2293# background. This is disabled by default, because dot on Windows does not seem
2294# to support this out of the box.
2295#
2296# Warning: Depending on the platform used, enabling this option may lead to
2297# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2298# read).
2299# The default value is: NO.
2300# This tag requires that the tag HAVE_DOT is set to YES.
2301
2302DOT_TRANSPARENT        = NO
2303
2304# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2305# files in one run (i.e. multiple -o and -T options on the command line). This
2306# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2307# this, this feature is disabled by default.
2308# The default value is: NO.
2309# This tag requires that the tag HAVE_DOT is set to YES.
2310
2311DOT_MULTI_TARGETS      = YES
2312
2313# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2314# explaining the meaning of the various boxes and arrows in the dot generated
2315# graphs.
2316# The default value is: YES.
2317# This tag requires that the tag HAVE_DOT is set to YES.
2318
2319GENERATE_LEGEND        = NO
2320
2321# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2322# files that are used to generate the various graphs.
2323# The default value is: YES.
2324# This tag requires that the tag HAVE_DOT is set to YES.
2325
2326DOT_CLEANUP            = YES
Note: See TracBrowser for help on using the repository browser.