source: git/dox/Doxyfile.latex.short @ 8d1432e

spielwiese
Last change on this file since 8d1432e was 75f460, checked in by Hans Schoenemann <hannes@…>, 9 years ago
format
  • Property mode set to 100644
File size: 62.3 KB
Line 
1# This is the Doxygen (1.5.9) configuration for LATEX without graphics
2# Read Doxygen FAQ in case of LATEX shortage of capacities.
3# Doxyfile 1.5.9
4
5# This file describes the settings to be used by the documentation system
6# doxygen (www.doxygen.org) for a project
7#
8# All text after a hash (#) is considered a comment and will be ignored
9# The format is:
10#       TAG = value [value, ...]
11# For lists items can also be appended using:
12#       TAG += value [value, ...]
13# Values that contain spaces should be placed between quotes (" ")
14
15#---------------------------------------------------------------------------
16# Project related configuration options
17#---------------------------------------------------------------------------
18
19# This tag specifies the encoding used for all characters in the config file
20# that follow. The default is UTF-8 which is also the encoding used for all
21# text before the first occurrence of this tag. Doxygen uses libiconv (or the
22# iconv built into libc) for the transcoding. See
23# http://www.gnu.org/software/libiconv for the list of possible encodings.
24
25DOXYFILE_ENCODING      = UTF-8
26
27# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
28# by quotes) that should identify the project.
29
30PROJECT_NAME           = Singular
31
32# The PROJECT_NUMBER tag can be used to enter a project or revision number.
33# This could be handy for archiving the generated documentation or
34# if some version control system is used.
35
36PROJECT_NUMBER         = $VERSION$
37
38# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
39# base path where the generated documentation will be put.
40# If a relative path is entered, it will be relative to the location
41# where doxygen was started. If left blank the current directory will be used.
42
43OUTPUT_DIRECTORY       =
44
45# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
46# 4096 sub-directories (in 2 levels) under the output directory of each output
47# format and will distribute the generated files over these directories.
48# Enabling this option can be useful when feeding doxygen a huge amount of
49# source files, where putting all generated files in the same directory would
50# otherwise cause performance problems for the file system.
51
52CREATE_SUBDIRS         = YES
53
54# The OUTPUT_LANGUAGE tag is used to specify the language in which all
55# documentation generated by doxygen is written. Doxygen will use this
56# information to generate all constant output in the proper language.
57# The default language is English, other supported languages are:
58# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
59# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
60# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
61# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
62# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
63# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
64
65OUTPUT_LANGUAGE        = English
66
67# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
68# include brief member descriptions after the members that are listed in
69# the file and class documentation (similar to JavaDoc).
70# Set to NO to disable this.
71
72BRIEF_MEMBER_DESC      = YES
73
74# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
75# the brief description of a member or function before the detailed description.
76# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
77# brief descriptions will be completely suppressed.
78
79REPEAT_BRIEF           = YES
80
81# This tag implements a quasi-intelligent brief description abbreviator
82# that is used to form the text in various listings. Each string
83# in this list, if found as the leading text of the brief description, will be
84# stripped from the text and the result after processing the whole list, is
85# used as the annotated text. Otherwise, the brief description is used as-is.
86# If left blank, the following values are used ("$name" is automatically
87# replaced with the name of the entity): "The $name class" "The $name widget"
88# "The $name file" "is" "provides" "specifies" "contains"
89# "represents" "a" "an" "the"
90
91ABBREVIATE_BRIEF       = "The $name class"  "The $name widget"  "The $name file" \
92                         is provides  specifies  contains   represents a an the
93
94# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
95# Doxygen will generate a detailed section even if there is only a brief
96# description.
97
98ALWAYS_DETAILED_SEC    = NO
99
100# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
101# inherited members of a class in the documentation of that class as if those
102# members were ordinary class members. Constructors, destructors and assignment
103# operators of the base classes will not be shown.
104
105INLINE_INHERITED_MEMB  = NO
106
107# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
108# path before files name in the file list and in the header files. If set
109# to NO the shortest path that makes the file name unique will be used.
110
111FULL_PATH_NAMES        = YES
112
113# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
114# can be used to strip a user-defined part of the path. Stripping is
115# only done if one of the specified strings matches the left-hand part of
116# the path. The tag can be used to show relative paths in the file list.
117# If left blank the directory from which doxygen is run is used as the
118# path to strip.
119
120STRIP_FROM_PATH        = ..
121
122# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
123# the path mentioned in the documentation of a class, which tells
124# the reader which header file to include in order to use a class.
125# If left blank only the name of the header file containing the class
126# definition is used. Otherwise one should specify the include paths that
127# are normally passed to the compiler using the -I flag.
128
129STRIP_FROM_INC_PATH    =
130
131# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
132# (but less readable) file names. This can be useful is your file systems
133# doesn't support long names like on DOS, Mac, or CD-ROM.
134
135SHORT_NAMES            = NO
136
137# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
138# will interpret the first line (until the first dot) of a JavaDoc-style
139# comment as the brief description. If set to NO, the JavaDoc
140# comments will behave just like regular Qt-style comments
141# (thus requiring an explicit @brief command for a brief description.)
142
143JAVADOC_AUTOBRIEF      = NO
144
145# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
146# interpret the first line (until the first dot) of a Qt-style
147# comment as the brief description. If set to NO, the comments
148# will behave just like regular Qt-style comments (thus requiring
149# an explicit \brief command for a brief description.)
150
151QT_AUTOBRIEF           = NO
152
153# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
154# treat a multi-line C++ special comment block (i.e. a block of //! or ///
155# comments) as a brief description. This used to be the default behaviour.
156# The new default is to treat a multi-line C++ comment block as a detailed
157# description. Set this tag to YES if you prefer the old behaviour instead.
158
159MULTILINE_CPP_IS_BRIEF = NO
160
161# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
162# member inherits the documentation from any documented member that it
163# re-implements.
164
165INHERIT_DOCS           = YES
166
167# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
168# a new page for each member. If set to NO, the documentation of a member will
169# be part of the file/class/namespace that contains it.
170
171SEPARATE_MEMBER_PAGES  = YES
172
173# The TAB_SIZE tag can be used to set the number of spaces in a tab.
174# Doxygen uses this value to replace tabs by spaces in code fragments.
175
176TAB_SIZE               = 2
177
178# This tag can be used to specify a number of aliases that acts
179# as commands in the documentation. An alias has the form "name=value".
180# For example adding "sideeffect=\par Side Effects:\n" will allow you to
181# put the command \sideeffect (or @sideeffect) in the documentation, which
182# will result in a user-defined paragraph with heading "Side Effects:".
183# You can put \n's in the value part of an alias to insert newlines.
184
185ALIASES                =
186
187# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
188# sources only. Doxygen will then generate output that is more tailored for C.
189# For instance, some of the names that are used will be different. The list
190# of all members will be omitted, etc.
191
192OPTIMIZE_OUTPUT_FOR_C  = YES
193
194# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
195# sources only. Doxygen will then generate output that is more tailored for
196# Java. For instance, namespaces will be presented as packages, qualified
197# scopes will look different, etc.
198
199OPTIMIZE_OUTPUT_JAVA   = NO
200
201# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
202# sources only. Doxygen will then generate output that is more tailored for
203# Fortran.
204
205OPTIMIZE_FOR_FORTRAN   = NO
206
207# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
208# sources. Doxygen will then generate output that is tailored for
209# VHDL.
210
211OPTIMIZE_OUTPUT_VHDL   = NO
212
213# Doxygen selects the parser to use depending on the extension of the files it parses.
214# With this tag you can assign which parser to use for a given extension.
215# Doxygen has a built-in mapping, but you can override or extend it using this tag.
216# The format is ext=language, where ext is a file extension, and language is one of
217# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
218# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
219# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
220# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
221
222EXTENSION_MAPPING      =
223
224# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
225# to include (a tag file for) the STL sources as input, then you should
226# set this tag to YES in order to let doxygen match functions declarations and
227# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
228# func(std::string) {}). This also make the inheritance and collaboration
229# diagrams that involve STL classes more complete and accurate.
230
231BUILTIN_STL_SUPPORT    = YES
232
233# If you use Microsoft's C++/CLI language, you should set this option to YES to
234# enable parsing support.
235
236CPP_CLI_SUPPORT        = NO
237
238# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
239# Doxygen will parse them like normal C++ but will assume all classes use public
240# instead of private inheritance when no explicit protection keyword is present.
241
242SIP_SUPPORT            = NO
243
244# For Microsoft's IDL there are propget and propput attributes to indicate getter
245# and setter methods for a property. Setting this option to YES (the default)
246# will make doxygen to replace the get and set methods by a property in the
247# documentation. This will only work if the methods are indeed getting or
248# setting a simple type. If this is not the case, or you want to show the
249# methods anyway, you should set this option to NO.
250
251IDL_PROPERTY_SUPPORT   = NO
252
253# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
254# tag is set to YES, then doxygen will reuse the documentation of the first
255# member in the group (if any) for the other members of the group. By default
256# all members of a group must be documented explicitly.
257
258DISTRIBUTE_GROUP_DOC   = YES
259
260# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
261# the same type (for instance a group of public functions) to be put as a
262# subgroup of that type (e.g. under the Public Functions section). Set it to
263# NO to prevent subgrouping. Alternatively, this can be done per class using
264# the \nosubgrouping command.
265
266SUBGROUPING            = YES
267
268# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
269# is documented as struct, union, or enum with the name of the typedef. So
270# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
271# with name TypeT. When disabled the typedef will appear as a member of a file,
272# namespace, or class. And the struct will be named TypeS. This can typically
273# be useful for C code in case the coding convention dictates that all compound
274# types are typedef'ed and only the typedef is referenced, never the tag name.
275
276TYPEDEF_HIDES_STRUCT   = NO
277
278# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
279# determine which symbols to keep in memory and which to flush to disk.
280# When the cache is full, less often used symbols will be written to disk.
281# For small to medium size projects (<1000 input files) the default value is
282# probably good enough. For larger projects a too small cache size can cause
283# doxygen to be busy swapping symbols to and from disk most of the time
284# causing a significant performance penality.
285# If the system has enough physical memory increasing the cache will improve the
286# performance by keeping more symbols in memory. Note that the value works on
287# a logarithmic scale so increasing the size by one will rougly double the
288# memory usage. The cache size is given by this formula:
289# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
290# corresponding to a cache size of 2^16 = 65536 symbols
291
292SYMBOL_CACHE_SIZE      = 0
293
294#---------------------------------------------------------------------------
295# Build related configuration options
296#---------------------------------------------------------------------------
297
298# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
299# documentation are documented, even if no documentation was available.
300# Private class members and static file members will be hidden unless
301# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
302
303EXTRACT_ALL            = YES
304
305# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
306# will be included in the documentation.
307
308EXTRACT_PRIVATE        = YES
309
310# If the EXTRACT_STATIC tag is set to YES all static members of a file
311# will be included in the documentation.
312
313EXTRACT_STATIC         = YES
314
315# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
316# defined locally in source files will be included in the documentation.
317# If set to NO only classes defined in header files are included.
318
319EXTRACT_LOCAL_CLASSES  = YES
320
321# This flag is only useful for Objective-C code. When set to YES local
322# methods, which are defined in the implementation section but not in
323# the interface are included in the documentation.
324# If set to NO (the default) only methods in the interface are included.
325
326EXTRACT_LOCAL_METHODS  = YES
327
328# If this flag is set to YES, the members of anonymous namespaces will be
329# extracted and appear in the documentation as a namespace called
330# 'anonymous_namespace{file}', where file will be replaced with the base
331# name of the file that contains the anonymous namespace. By default
332# anonymous namespace are hidden.
333
334EXTRACT_ANON_NSPACES   = YES
335
336# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
337# undocumented members of documented classes, files or namespaces.
338# If set to NO (the default) these members will be included in the
339# various overviews, but no documentation section is generated.
340# This option has no effect if EXTRACT_ALL is enabled.
341
342HIDE_UNDOC_MEMBERS     = NO
343
344# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
345# undocumented classes that are normally visible in the class hierarchy.
346# If set to NO (the default) these classes will be included in the various
347# overviews. This option has no effect if EXTRACT_ALL is enabled.
348
349HIDE_UNDOC_CLASSES     = NO
350
351# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
352# friend (class|struct|union) declarations.
353# If set to NO (the default) these declarations will be included in the
354# documentation.
355
356HIDE_FRIEND_COMPOUNDS  = NO
357
358# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
359# documentation blocks found inside the body of a function.
360# If set to NO (the default) these blocks will be appended to the
361# function's detailed documentation block.
362
363HIDE_IN_BODY_DOCS      = NO
364
365# The INTERNAL_DOCS tag determines if documentation
366# that is typed after a \internal command is included. If the tag is set
367# to NO (the default) then the documentation will be excluded.
368# Set it to YES to include the internal documentation.
369
370INTERNAL_DOCS          = YES
371
372# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
373# file names in lower-case letters. If set to YES upper-case letters are also
374# allowed. This is useful if you have classes or files whose names only differ
375# in case and if your file system supports case sensitive file names. Windows
376# and Mac users are advised to set this option to NO.
377
378CASE_SENSE_NAMES       = YES
379
380# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
381# will show members with their full class and namespace scopes in the
382# documentation. If set to YES the scope will be hidden.
383
384HIDE_SCOPE_NAMES       = NO
385
386# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
387# will put a list of the files that are included by a file in the documentation
388# of that file.
389
390SHOW_INCLUDE_FILES     = YES
391
392# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
393# is inserted in the documentation for inline members.
394
395INLINE_INFO            = YES
396
397# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
398# will sort the (detailed) documentation of file and class members
399# alphabetically by member name. If set to NO the members will appear in
400# declaration order.
401
402SORT_MEMBER_DOCS       = YES
403
404# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
405# brief documentation of file, namespace and class members alphabetically
406# by member name. If set to NO (the default) the members will appear in
407# declaration order.
408
409SORT_BRIEF_DOCS        = NO
410
411# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
412# hierarchy of group names into alphabetical order. If set to NO (the default)
413# the group names will appear in their defined order.
414
415SORT_GROUP_NAMES       = NO
416
417# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
418# sorted by fully-qualified names, including namespaces. If set to
419# NO (the default), the class list will be sorted only by class name,
420# not including the namespace part.
421# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
422# Note: This option applies only to the class list, not to the
423# alphabetical list.
424
425SORT_BY_SCOPE_NAME     = NO
426
427# The GENERATE_TODOLIST tag can be used to enable (YES) or
428# disable (NO) the todo list. This list is created by putting \todo
429# commands in the documentation.
430
431GENERATE_TODOLIST      = YES
432
433# The GENERATE_TESTLIST tag can be used to enable (YES) or
434# disable (NO) the test list. This list is created by putting \test
435# commands in the documentation.
436
437GENERATE_TESTLIST      = YES
438
439# The GENERATE_BUGLIST tag can be used to enable (YES) or
440# disable (NO) the bug list. This list is created by putting \bug
441# commands in the documentation.
442
443GENERATE_BUGLIST       = YES
444
445# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
446# disable (NO) the deprecated list. This list is created by putting
447# \deprecated commands in the documentation.
448
449GENERATE_DEPRECATEDLIST= YES
450
451# The ENABLED_SECTIONS tag can be used to enable conditional
452# documentation sections, marked by \if sectionname ... \endif.
453
454ENABLED_SECTIONS       =
455
456# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
457# the initial value of a variable or define consists of for it to appear in
458# the documentation. If the initializer consists of more lines than specified
459# here it will be hidden. Use a value of 0 to hide initializers completely.
460# The appearance of the initializer of individual variables and defines in the
461# documentation can be controlled using \showinitializer or \hideinitializer
462# command in the documentation regardless of this setting.
463
464MAX_INITIALIZER_LINES  = 40
465
466# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
467# at the bottom of the documentation of classes and structs. If set to YES the
468# list will mention the files that were used to generate the documentation.
469
470SHOW_USED_FILES        = YES
471
472# If the sources in your project are distributed over multiple directories
473# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
474# in the documentation. The default is NO.
475
476SHOW_DIRECTORIES       = YES
477
478# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
479# This will remove the Files entry from the Quick Index and from the
480# Folder Tree View (if specified). The default is YES.
481
482SHOW_FILES             = YES
483
484# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
485# Namespaces page.
486# This will remove the Namespaces entry from the Quick Index
487# and from the Folder Tree View (if specified). The default is YES.
488
489SHOW_NAMESPACES        = YES
490
491# The FILE_VERSION_FILTER tag can be used to specify a program or script that
492# doxygen should invoke to get the current version for each file (typically from
493# the version control system). Doxygen will invoke the program by executing (via
494# popen()) the command <command> <input-file>, where <command> is the value of
495# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
496# provided by doxygen. Whatever the program writes to standard output
497# is used as the file version. See the manual for examples.
498
499FILE_VERSION_FILTER    =
500
501# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
502# doxygen. The layout file controls the global structure of the generated output files
503# in an output format independent way. The create the layout file that represents
504# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
505# file name after the option, if omitted DoxygenLayout.xml will be used as the name
506# of the layout file.
507
508LAYOUT_FILE            =
509
510#---------------------------------------------------------------------------
511# configuration options related to warning and progress messages
512#---------------------------------------------------------------------------
513
514# The QUIET tag can be used to turn on/off the messages that are generated
515# by doxygen. Possible values are YES and NO. If left blank NO is used.
516
517QUIET                  = NO
518
519# The WARNINGS tag can be used to turn on/off the warning messages that are
520# generated by doxygen. Possible values are YES and NO. If left blank
521# NO is used.
522
523WARNINGS               = YES
524
525# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
526# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
527# automatically be disabled.
528
529WARN_IF_UNDOCUMENTED   = NO
530
531# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
532# potential errors in the documentation, such as not documenting some
533# parameters in a documented function, or documenting parameters that
534# don't exist or using markup commands wrongly.
535
536WARN_IF_DOC_ERROR      = YES
537
538# This WARN_NO_PARAMDOC option can be abled to get warnings for
539# functions that are documented, but have no documentation for their parameters
540# or return value. If set to NO (the default) doxygen will only warn about
541# wrong or incomplete parameter documentation, but not about the absence of
542# documentation.
543
544WARN_NO_PARAMDOC       = NO
545
546# The WARN_FORMAT tag determines the format of the warning messages that
547# doxygen can produce. The string should contain the $file, $line, and $text
548# tags, which will be replaced by the file and line number from which the
549# warning originated and the warning text. Optionally the format may contain
550# $version, which will be replaced by the version of the file (if it could
551# be obtained via FILE_VERSION_FILTER)
552
553WARN_FORMAT            = "$file:$line: $text "
554
555# The WARN_LOGFILE tag can be used to specify a file to which warning
556# and error messages should be written. If left blank the output is written
557# to stderr.
558
559WARN_LOGFILE           = dox.latex.log
560
561#---------------------------------------------------------------------------
562# configuration options related to the input files
563#---------------------------------------------------------------------------
564
565# The INPUT tag can be used to specify the files and/or directories that contain
566# documented source files. You may enter file names like "myfile.cpp" or
567# directories like "/usr/src/myproject". Separate the files or directories
568# with spaces.
569
570INPUT                  =    \
571                         ../omalloc  ../svd  ../mpr  ../factory ../libfac  ../IntegerProgramming  ../ntl  ../MP \
572                        ../kernel \
573                        ../Singular
574
575
576# This tag can be used to specify the character encoding of the source files
577# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
578# also the default input encoding. Doxygen uses libiconv (or the iconv built
579# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
580# the list of possible encodings.
581
582INPUT_ENCODING         = UTF-8
583
584# If the value of the INPUT tag contains directories, you can use the
585# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
586# and *.h) to filter out the source-files in the directories. If left
587# blank the following patterns are tested:
588# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
589# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
590
591FILE_PATTERNS          = *.dox \
592                         *.h *.hh *.hxx *.hpp *.h++ *.H *.HH *.H++ \
593                         *.c *.cc *.cxx *.cpp *.c++ *.C *.CC *.C++
594
595# The RECURSIVE tag can be used to turn specify whether or not subdirectories
596# should be searched for input files as well. Possible values are YES and NO.
597# If left blank NO is used.
598
599RECURSIVE              = YES
600
601# The EXCLUDE tag can be used to specify files and/or directories that should
602# excluded from the INPUT source files. This way you can easily exclude a
603# subdirectory from a directory tree whose root is specified with the INPUT tag.
604
605
606EXCLUDE                = ../doc  ../Tst   ../emacs  ../singular_usr     ../Singular/LIB   ../Singular/Examples ../Singular++ \
607                         CVS
608
609# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
610# directories that are symbolic links (a Unix filesystem feature) are excluded
611# from the input.
612
613EXCLUDE_SYMLINKS       = NO
614
615# If the value of the INPUT tag contains directories, you can use the
616# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
617# certain files from those directories. Note that the wildcards are matched
618# against the file with absolute path, so to exclude all test directories
619# for example use the pattern */test/*
620
621EXCLUDE_PATTERNS       =
622
623# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
624# (namespaces, classes, functions, etc.) that should be excluded from the
625# output. The symbol name can be a fully qualified name, a word, or if the
626# wildcard * is used, a substring. Examples: ANamespace, AClass,
627# AClass::ANamespace, ANamespace::*Test
628
629EXCLUDE_SYMBOLS        =
630
631# The EXAMPLE_PATH tag can be used to specify one or more files or
632# directories that contain example code fragments that are included (see
633# the \include command).
634
635EXAMPLE_PATH           =
636
637# If the value of the EXAMPLE_PATH tag contains directories, you can use the
638# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
639# and *.h) to filter out the source-files in the directories. If left
640# blank all files are included.
641
642EXAMPLE_PATTERNS       =
643
644# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
645# searched for input files to be used with the \include or \dontinclude
646# commands irrespective of the value of the RECURSIVE tag.
647# Possible values are YES and NO. If left blank NO is used.
648
649EXAMPLE_RECURSIVE      = NO
650
651# The IMAGE_PATH tag can be used to specify one or more files or
652# directories that contain image that are included in the documentation (see
653# the \image command).
654
655IMAGE_PATH             =
656
657# The INPUT_FILTER tag can be used to specify a program that doxygen should
658# invoke to filter for each input file. Doxygen will invoke the filter program
659# by executing (via popen()) the command <filter> <input-file>, where <filter>
660# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
661# input file. Doxygen will then use the output that the filter program writes
662# to standard output.
663# If FILTER_PATTERNS is specified, this tag will be
664# ignored.
665
666INPUT_FILTER           =
667
668# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
669# basis.
670# Doxygen will compare the file name with each pattern and apply the
671# filter if there is a match.
672# The filters are a list of the form:
673# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
674# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
675# is applied to all files.
676
677FILTER_PATTERNS        =
678
679# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
680# INPUT_FILTER) will be used to filter the input files when producing source
681# files to browse (i.e. when SOURCE_BROWSER is set to YES).
682
683FILTER_SOURCE_FILES    = NO
684
685#---------------------------------------------------------------------------
686# configuration options related to source browsing
687#---------------------------------------------------------------------------
688
689# If the SOURCE_BROWSER tag is set to YES then a list of source files will
690# be generated. Documented entities will be cross-referenced with these sources.
691# Note: To get rid of all source code in the generated output, make sure also
692# VERBATIM_HEADERS is set to NO.
693
694SOURCE_BROWSER         = YES
695
696# Setting the INLINE_SOURCES tag to YES will include the body
697# of functions and classes directly in the documentation.
698
699INLINE_SOURCES         = YES
700
701# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
702# doxygen to hide any special comment blocks from generated source code
703# fragments. Normal C and C++ comments will always remain visible.
704
705STRIP_CODE_COMMENTS    = NO
706
707# If the REFERENCED_BY_RELATION tag is set to YES
708# then for each documented function all documented
709# functions referencing it will be listed.
710
711REFERENCED_BY_RELATION = YES
712
713# If the REFERENCES_RELATION tag is set to YES
714# then for each documented function all documented entities
715# called/used by that function will be listed.
716
717REFERENCES_RELATION    = YES
718
719# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
720# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
721# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
722# link to the source code.
723# Otherwise they will link to the documentation.
724
725REFERENCES_LINK_SOURCE = YES
726
727# If the USE_HTAGS tag is set to YES then the references to source code
728# will point to the HTML generated by the htags(1) tool instead of doxygen
729# built-in source browser. The htags tool is part of GNU's global source
730# tagging system (see http://www.gnu.org/software/global/global.html). You
731# will need version 4.8.6 or higher.
732
733USE_HTAGS              = NO
734
735# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
736# will generate a verbatim copy of the header file for each class for
737# which an include is specified. Set to NO to disable this.
738
739VERBATIM_HEADERS       = YES
740
741#---------------------------------------------------------------------------
742# configuration options related to the alphabetical class index
743#---------------------------------------------------------------------------
744
745# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
746# of all compounds will be generated. Enable this if the project
747# contains a lot of classes, structs, unions or interfaces.
748
749ALPHABETICAL_INDEX     = YES
750
751# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
752# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
753# in which this list will be split (can be a number in the range [1..20])
754
755COLS_IN_ALPHA_INDEX    = 4
756
757# In case all classes in a project start with a common prefix, all
758# classes will be put under the same header in the alphabetical index.
759# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
760# should be ignored while generating the index headers.
761
762IGNORE_PREFIX          = C
763
764#---------------------------------------------------------------------------
765# configuration options related to the HTML output
766#---------------------------------------------------------------------------
767
768# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
769# generate HTML output.
770
771GENERATE_HTML          = NO
772
773# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
774# If a relative path is entered the value of OUTPUT_DIRECTORY will be
775# put in front of it. If left blank `html' will be used as the default path.
776
777HTML_OUTPUT            = html
778
779# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
780# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
781# doxygen will generate files with .html extension.
782
783HTML_FILE_EXTENSION    = .html
784
785# The HTML_HEADER tag can be used to specify a personal HTML header for
786# each generated HTML page. If it is left blank doxygen will generate a
787# standard header.
788
789HTML_HEADER            =
790
791# The HTML_FOOTER tag can be used to specify a personal HTML footer for
792# each generated HTML page. If it is left blank doxygen will generate a
793# standard footer.
794
795HTML_FOOTER            =
796
797# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
798# style sheet that is used by each HTML page. It can be used to
799# fine-tune the look of the HTML output. If the tag is left blank doxygen
800# will generate a default style sheet. Note that doxygen will try to copy
801# the style sheet file to the HTML output directory, so don't put your own
802# stylesheet in the HTML output directory as well, or it will be erased!
803
804HTML_STYLESHEET        =
805
806# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
807# files or namespaces will be aligned in HTML using tables. If set to
808# NO a bullet list will be used.
809
810HTML_ALIGN_MEMBERS     = YES
811
812# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
813# documentation will contain sections that can be hidden and shown after the
814# page has loaded. For this to work a browser that supports
815# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
816# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
817
818HTML_DYNAMIC_SECTIONS  = YES
819
820# If the GENERATE_DOCSET tag is set to YES, additional index files
821# will be generated that can be used as input for Apple's Xcode 3
822# integrated development environment, introduced with OSX 10.5 (Leopard).
823# To create a documentation set, doxygen will generate a Makefile in the
824# HTML output directory. Running make will produce the docset in that
825# directory and running "make install" will install the docset in
826# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
827# it at startup.
828# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
829
830GENERATE_DOCSET        = NO
831
832# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
833# feed. A documentation feed provides an umbrella under which multiple
834# documentation sets from a single provider (such as a company or product suite)
835# can be grouped.
836
837DOCSET_FEEDNAME        = "Doxygen generated docs"
838
839# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
840# should uniquely identify the documentation set bundle. This should be a
841# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
842# will append .docset to the name.
843
844DOCSET_BUNDLE_ID       = org.doxygen.Project
845
846# If the GENERATE_HTMLHELP tag is set to YES, additional index files
847# will be generated that can be used as input for tools like the
848# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
849# of the generated HTML documentation.
850
851GENERATE_HTMLHELP      = NO
852
853# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
854# be used to specify the file name of the resulting .chm file. You
855# can add a path in front of the file if the result should not be
856# written to the html output directory.
857
858CHM_FILE               = Singular.chm
859
860# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
861# be used to specify the location (absolute path including file name) of
862# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
863# the HTML help compiler on the generated index.hhp.
864
865HHC_LOCATION           =
866
867# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
868# controls if a separate .chi index file is generated (YES) or that
869# it should be included in the master .chm file (NO).
870
871GENERATE_CHI           = NO
872
873# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
874# is used to encode HtmlHelp index (hhk), content (hhc) and project file
875# content.
876
877CHM_INDEX_ENCODING     =
878
879# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
880# controls whether a binary table of contents is generated (YES) or a
881# normal table of contents (NO) in the .chm file.
882
883BINARY_TOC             = NO
884
885# The TOC_EXPAND flag can be set to YES to add extra items for group members
886# to the contents of the HTML help documentation and to the tree view.
887
888TOC_EXPAND             = NO
889
890# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
891# are set, an additional index file will be generated that can be used as input for
892# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
893# HTML documentation.
894
895GENERATE_QHP           = NO
896
897# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
898# be used to specify the file name of the resulting .qch file.
899# The path specified is relative to the HTML output folder.
900
901QCH_FILE               =
902
903# The QHP_NAMESPACE tag specifies the namespace to use when generating
904# Qt Help Project output. For more information please see
905# http://doc.trolltech.com/qthelpproject.html#namespace
906
907QHP_NAMESPACE          =
908
909# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
910# Qt Help Project output. For more information please see
911# http://doc.trolltech.com/qthelpproject.html#virtual-folders
912
913QHP_VIRTUAL_FOLDER     = doc
914
915# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
916# For more information please see
917# http://doc.trolltech.com/qthelpproject.html#custom-filters
918
919QHP_CUST_FILTER_NAME   =
920
921# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
922# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
923
924QHP_CUST_FILTER_ATTRS  =
925
926# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
927# filter section matches.
928# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
929
930QHP_SECT_FILTER_ATTRS  =
931
932# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
933# be used to specify the location of Qt's qhelpgenerator.
934# If non-empty doxygen will try to run qhelpgenerator on the generated
935# .qhp file.
936
937QHG_LOCATION           =
938
939# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
940# top of each HTML page. The value NO (the default) enables the index and
941# the value YES disables it.
942
943DISABLE_INDEX          = NO
944
945# This tag can be used to set the number of enum values (range [1..20])
946# that doxygen will group on one line in the generated HTML documentation.
947
948ENUM_VALUES_PER_LINE   = 4
949
950# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
951# structure should be generated to display hierarchical information.
952# If the tag value is set to FRAME, a side panel will be generated
953# containing a tree-like index structure (just like the one that
954# is generated for HTML Help). For this to work a browser that supports
955# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
956# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
957# probably better off using the HTML help feature. Other possible values
958# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
959# and Class Hierarchy pages using a tree view instead of an ordered list;
960# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
961# disables this behavior completely. For backwards compatibility with previous
962# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
963# respectively.
964
965GENERATE_TREEVIEW      = YES
966
967# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
968# used to set the initial width (in pixels) of the frame in which the tree
969# is shown.
970
971TREEVIEW_WIDTH         = 250
972
973# Use this tag to change the font size of Latex formulas included
974# as images in the HTML documentation. The default is 10. Note that
975# when you change the font size after a successful doxygen run you need
976# to manually remove any form_*.png images from the HTML output directory
977# to force them to be regenerated.
978
979FORMULA_FONTSIZE       = 8
980
981#---------------------------------------------------------------------------
982# configuration options related to the LaTeX output
983#---------------------------------------------------------------------------
984
985# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
986# generate Latex output.
987
988GENERATE_LATEX         = YES
989
990# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
991# If a relative path is entered the value of OUTPUT_DIRECTORY will be
992# put in front of it. If left blank `latex' will be used as the default path.
993
994LATEX_OUTPUT           = latex
995
996# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
997# invoked. If left blank `latex' will be used as the default command name.
998
999LATEX_CMD_NAME         = latex
1000
1001# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1002# generate index for LaTeX. If left blank `makeindex' will be used as the
1003# default command name.
1004
1005MAKEINDEX_CMD_NAME     = makeindex
1006
1007# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1008# LaTeX documents. This may be useful for small projects and may help to
1009# save some trees in general.
1010
1011COMPACT_LATEX          = YES
1012
1013# The PAPER_TYPE tag can be used to set the paper type that is used
1014# by the printer. Possible values are: a4, a4wide, letter, legal and
1015# executive. If left blank a4wide will be used.
1016
1017PAPER_TYPE             = a4wide
1018
1019# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1020# packages that should be included in the LaTeX output.
1021
1022EXTRA_PACKAGES         =
1023
1024# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1025# the generated latex document. The header should contain everything until
1026# the first chapter. If it is left blank doxygen will generate a
1027# standard header. Notice: only use this tag if you know what you are doing!
1028
1029LATEX_HEADER           =
1030
1031# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1032# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1033# contain links (just like the HTML output) instead of page references
1034# This makes the output suitable for online browsing using a pdf viewer.
1035
1036PDF_HYPERLINKS         = YES
1037
1038# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1039# plain latex in the generated Makefile. Set this option to YES to get a
1040# higher quality PDF documentation.
1041
1042USE_PDFLATEX           = YES
1043
1044# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1045# command to the generated LaTeX files. This will instruct LaTeX to keep
1046# running if errors occur, instead of asking the user for help.
1047# This option is also used when generating formulas in HTML.
1048
1049LATEX_BATCHMODE        = YES
1050
1051# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1052# include the index chapters (such as File Index, Compound Index, etc.)
1053# in the output.
1054
1055LATEX_HIDE_INDICES     = NO
1056
1057# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1058
1059LATEX_SOURCE_CODE      = NO
1060
1061#---------------------------------------------------------------------------
1062# configuration options related to the RTF output
1063#---------------------------------------------------------------------------
1064
1065# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1066# The RTF output is optimized for Word 97 and may not look very pretty with
1067# other RTF readers or editors.
1068
1069GENERATE_RTF           = NO
1070
1071# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1072# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1073# put in front of it. If left blank `rtf' will be used as the default path.
1074
1075RTF_OUTPUT             = rtf
1076
1077# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1078# RTF documents. This may be useful for small projects and may help to
1079# save some trees in general.
1080
1081COMPACT_RTF            = NO
1082
1083# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1084# will contain hyperlink fields. The RTF file will
1085# contain links (just like the HTML output) instead of page references.
1086# This makes the output suitable for online browsing using WORD or other
1087# programs which support those fields.
1088# Note: wordpad (write) and others do not support links.
1089
1090RTF_HYPERLINKS         = NO
1091
1092# Load stylesheet definitions from file. Syntax is similar to doxygen's
1093# config file, i.e. a series of assignments. You only have to provide
1094# replacements, missing definitions are set to their default value.
1095
1096RTF_STYLESHEET_FILE    =
1097
1098# Set optional variables used in the generation of an rtf document.
1099# Syntax is similar to doxygen's config file.
1100
1101RTF_EXTENSIONS_FILE    =
1102
1103#---------------------------------------------------------------------------
1104# configuration options related to the man page output
1105#---------------------------------------------------------------------------
1106
1107# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1108# generate man pages
1109
1110GENERATE_MAN           = NO
1111
1112# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1113# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1114# put in front of it. If left blank `man' will be used as the default path.
1115
1116MAN_OUTPUT             = man
1117
1118# The MAN_EXTENSION tag determines the extension that is added to
1119# the generated man pages (default is the subroutine's section .3)
1120
1121MAN_EXTENSION          = .3
1122
1123# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1124# then it will generate one additional man file for each entity
1125# documented in the real man page(s). These additional files
1126# only source the real man page, but without them the man command
1127# would be unable to find the correct page. The default is NO.
1128
1129MAN_LINKS              = NO
1130
1131#---------------------------------------------------------------------------
1132# configuration options related to the XML output
1133#---------------------------------------------------------------------------
1134
1135# If the GENERATE_XML tag is set to YES Doxygen will
1136# generate an XML file that captures the structure of
1137# the code including all documentation.
1138
1139GENERATE_XML           = NO
1140
1141# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1142# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1143# put in front of it. If left blank `xml' will be used as the default path.
1144
1145XML_OUTPUT             = xml
1146
1147# The XML_SCHEMA tag can be used to specify an XML schema,
1148# which can be used by a validating XML parser to check the
1149# syntax of the XML files.
1150
1151XML_SCHEMA             =
1152
1153# The XML_DTD tag can be used to specify an XML DTD,
1154# which can be used by a validating XML parser to check the
1155# syntax of the XML files.
1156
1157XML_DTD                =
1158
1159# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1160# dump the program listings (including syntax highlighting
1161# and cross-referencing information) to the XML output. Note that
1162# enabling this will significantly increase the size of the XML output.
1163
1164XML_PROGRAMLISTING     = YES
1165
1166#---------------------------------------------------------------------------
1167# configuration options for the AutoGen Definitions output
1168#---------------------------------------------------------------------------
1169
1170# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1171# generate an AutoGen Definitions (see autogen.sf.net) file
1172# that captures the structure of the code including all
1173# documentation. Note that this feature is still experimental
1174# and incomplete at the moment.
1175
1176GENERATE_AUTOGEN_DEF   = NO
1177
1178#---------------------------------------------------------------------------
1179# configuration options related to the Perl module output
1180#---------------------------------------------------------------------------
1181
1182# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1183# generate a Perl module file that captures the structure of
1184# the code including all documentation. Note that this
1185# feature is still experimental and incomplete at the
1186# moment.
1187
1188GENERATE_PERLMOD       = NO
1189
1190# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1191# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1192# to generate PDF and DVI output from the Perl module output.
1193
1194PERLMOD_LATEX          = NO
1195
1196# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1197# nicely formatted so it can be parsed by a human reader.
1198# This is useful
1199# if you want to understand what is going on.
1200# On the other hand, if this
1201# tag is set to NO the size of the Perl module output will be much smaller
1202# and Perl will parse it just the same.
1203
1204PERLMOD_PRETTY         = YES
1205
1206# The names of the make variables in the generated doxyrules.make file
1207# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1208# This is useful so different doxyrules.make files included by the same
1209# Makefile don't overwrite each other's variables.
1210
1211PERLMOD_MAKEVAR_PREFIX =
1212
1213#---------------------------------------------------------------------------
1214# Configuration options related to the preprocessor
1215#---------------------------------------------------------------------------
1216
1217# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1218# evaluate all C-preprocessor directives found in the sources and include
1219# files.
1220
1221ENABLE_PREPROCESSING   = YES
1222
1223# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1224# names in the source code. If set to NO (the default) only conditional
1225# compilation will be performed. Macro expansion can be done in a controlled
1226# way by setting EXPAND_ONLY_PREDEF to YES.
1227
1228MACRO_EXPANSION        = NO
1229
1230# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1231# then the macro expansion is limited to the macros specified with the
1232# PREDEFINED and EXPAND_AS_DEFINED tags.
1233
1234EXPAND_ONLY_PREDEF     = NO
1235
1236# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1237# in the INCLUDE_PATH (see below) will be search if a #include is found.
1238
1239SEARCH_INCLUDES        = YES
1240
1241# The INCLUDE_PATH tag can be used to specify one or more directories that
1242# contain include files that are not input files but should be processed by
1243# the preprocessor.
1244
1245INCLUDE_PATH           =
1246
1247# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1248# patterns (like *.h and *.hpp) to filter out the header-files in the
1249# directories. If left blank, the patterns specified with FILE_PATTERNS will
1250# be used.
1251
1252INCLUDE_FILE_PATTERNS  =
1253
1254# The PREDEFINED tag can be used to specify one or more macro names that
1255# are defined before the preprocessor is started (similar to the -D option of
1256# gcc). The argument of the tag is a list of macros of the form: name
1257# or name=definition (no spaces). If the definition and the = are
1258# omitted =1 is assumed. To prevent a macro definition from being
1259# undefined via #undef or recursively expanded use the := operator
1260# instead of the = operator.
1261
1262PREDEFINED             = DOXYGEN_PARSE
1263
1264# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1265# this tag can be used to specify a list of macro names that should be expanded.
1266# The macro definition that is found in the sources will be used.
1267# Use the PREDEFINED tag if you want to use a different macro definition.
1268
1269EXPAND_AS_DEFINED      = HAVE_PLURAL HAVE_RINGS
1270
1271# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1272# doxygen's preprocessor will remove all function-like macros that are alone
1273# on a line, have an all uppercase name, and do not end with a semicolon. Such
1274# function macros are typically used for boiler-plate code, and will confuse
1275# the parser if not removed.
1276
1277SKIP_FUNCTION_MACROS   = NO
1278
1279#---------------------------------------------------------------------------
1280# Configuration::additions related to external references
1281#---------------------------------------------------------------------------
1282
1283# The TAGFILES option can be used to specify one or more tagfiles.
1284# Optionally an initial location of the external documentation
1285# can be added for each tagfile. The format of a tag file without
1286# this location is as follows:
1287#
1288# TAGFILES = file1 file2 ...
1289# Adding location for the tag files is done as follows:
1290#
1291# TAGFILES = file1=loc1 "file2 = loc2" ...
1292# where "loc1" and "loc2" can be relative or absolute paths or
1293# URLs. If a location is present for each tag, the installdox tool
1294# does not have to be run to correct the links.
1295# Note that each tag file must have a unique name
1296# (where the name does NOT include the path)
1297# If a tag file is not located in the directory in which doxygen
1298# is run, you must also specify the path to the tagfile here.
1299
1300TAGFILES               =
1301
1302# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1303# a tag file that is based on the input files it reads.
1304
1305GENERATE_TAGFILE       =
1306
1307# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1308# in the class index. If set to NO only the inherited external classes
1309# will be listed.
1310
1311ALLEXTERNALS           = NO
1312
1313# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1314# in the modules index. If set to NO, only the current project's groups will
1315# be listed.
1316
1317EXTERNAL_GROUPS        = YES
1318
1319# The PERL_PATH should be the absolute path and name of the perl script
1320# interpreter (i.e. the result of `which perl').
1321
1322PERL_PATH              = /usr/bin/perl
1323
1324#---------------------------------------------------------------------------
1325# Configuration options related to the dot tool
1326#---------------------------------------------------------------------------
1327
1328# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1329# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1330# or super classes. Setting the tag to NO turns the diagrams off. Note that
1331# this option is superseded by the HAVE_DOT option below. This is only a
1332# fallback. It is recommended to install and use dot, since it yields more
1333# powerful graphs.
1334
1335CLASS_DIAGRAMS         = NO
1336
1337# You can define message sequence charts within doxygen comments using the \msc
1338# command. Doxygen will then run the mscgen tool (see
1339# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1340# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1341# the mscgen tool resides. If left empty the tool is assumed to be found in the
1342# default search path.
1343
1344MSCGEN_PATH            =
1345
1346# If set to YES, the inheritance and collaboration graphs will hide
1347# inheritance and usage relations if the target is undocumented
1348# or is not a class.
1349
1350HIDE_UNDOC_RELATIONS   = NO
1351
1352# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1353# available from the path. This tool is part of Graphviz, a graph visualization
1354# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1355# have no effect if this option is set to NO (the default)
1356
1357HAVE_DOT               = NO
1358
1359# By default doxygen will write a font called FreeSans.ttf to the output
1360# directory and reference it in all dot files that doxygen generates. This
1361# font does not include all possible unicode characters however, so when you need
1362# these (or just want a differently looking font) you can specify the font name
1363# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1364# which can be done by putting it in a standard location or by setting the
1365# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1366# containing the font.
1367
1368DOT_FONTNAME           = FreeSans
1369
1370# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1371# The default size is 10pt.
1372
1373DOT_FONTSIZE           = 8
1374
1375# By default doxygen will tell dot to use the output directory to look for the
1376# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1377# different font using DOT_FONTNAME you can set the path where dot
1378# can find it using this tag.
1379
1380DOT_FONTPATH           =
1381
1382# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1383# will generate a graph for each documented class showing the direct and
1384# indirect inheritance relations. Setting this tag to YES will force the
1385# the CLASS_DIAGRAMS tag to NO.
1386
1387CLASS_GRAPH            = NO
1388
1389# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1390# will generate a graph for each documented class showing the direct and
1391# indirect implementation dependencies (inheritance, containment, and
1392# class references variables) of the class with other documented classes.
1393
1394COLLABORATION_GRAPH    = NO
1395
1396# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1397# will generate a graph for groups, showing the direct groups dependencies
1398
1399GROUP_GRAPHS           = NO
1400
1401# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1402# collaboration diagrams in a style similar to the OMG's Unified Modeling
1403# Language.
1404
1405UML_LOOK               = NO
1406
1407# If set to YES, the inheritance and collaboration graphs will show the
1408# relations between templates and their instances.
1409
1410TEMPLATE_RELATIONS     = NO
1411
1412# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1413# tags are set to YES then doxygen will generate a graph for each documented
1414# file showing the direct and indirect include dependencies of the file with
1415# other documented files.
1416
1417INCLUDE_GRAPH          = NO
1418
1419# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1420# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1421# documented header file showing the documented files that directly or
1422# indirectly include this file.
1423
1424INCLUDED_BY_GRAPH      = NO
1425
1426# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1427# doxygen will generate a call dependency graph for every global function
1428# or class method. Note that enabling this option will significantly increase
1429# the time of a run. So in most cases it will be better to enable call graphs
1430# for selected functions only using the \callgraph command.
1431
1432CALL_GRAPH             = NO
1433
1434# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1435# doxygen will generate a caller dependency graph for every global function
1436# or class method. Note that enabling this option will significantly increase
1437# the time of a run. So in most cases it will be better to enable caller
1438# graphs for selected functions only using the \callergraph command.
1439
1440CALLER_GRAPH           = NO
1441
1442# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1443# will graphical hierarchy of all classes instead of a textual one.
1444
1445GRAPHICAL_HIERARCHY    = NO
1446
1447# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1448# then doxygen will show the dependencies a directory has on other directories
1449# in a graphical way. The dependency relations are determined by the #include
1450# relations between the files in the directories.
1451
1452DIRECTORY_GRAPH        = YES
1453
1454# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1455# generated by dot. Possible values are png, jpg, or gif
1456# If left blank png will be used.
1457
1458DOT_IMAGE_FORMAT       = png
1459
1460# The tag DOT_PATH can be used to specify the path where the dot tool can be
1461# found. If left blank, it is assumed the dot tool can be found in the path.
1462
1463DOT_PATH               =
1464
1465# The DOTFILE_DIRS tag can be used to specify one or more directories that
1466# contain dot files that are included in the documentation (see the
1467# \dotfile command).
1468
1469DOTFILE_DIRS           =
1470
1471# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1472# nodes that will be shown in the graph. If the number of nodes in a graph
1473# becomes larger than this value, doxygen will truncate the graph, which is
1474# visualized by representing a node as a red box. Note that doxygen if the
1475# number of direct children of the root node in a graph is already larger than
1476# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1477# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1478
1479DOT_GRAPH_MAX_NODES    = 70
1480
1481# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1482# graphs generated by dot. A depth value of 3 means that only nodes reachable
1483# from the root by following a path via at most 3 edges will be shown. Nodes
1484# that lay further from the root node will be omitted. Note that setting this
1485# option to 1 or 2 may greatly reduce the computation time needed for large
1486# code bases. Also note that the size of a graph can be further restricted by
1487# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1488
1489MAX_DOT_GRAPH_DEPTH    = 20
1490
1491# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1492# background. This is disabled by default, because dot on Windows does not
1493# seem to support this out of the box. Warning: Depending on the platform used,
1494# enabling this option may lead to badly anti-aliased labels on the edges of
1495# a graph (i.e. they become hard to read).
1496
1497DOT_TRANSPARENT        = YES
1498
1499# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1500# files in one run (i.e. multiple -o and -T options on the command line). This
1501# makes dot run faster, but since only newer versions of dot (>1.8.10)
1502# support this, this feature is disabled by default.
1503
1504DOT_MULTI_TARGETS      = YES
1505
1506# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1507# generate a legend page explaining the meaning of the various boxes and
1508# arrows in the dot generated graphs.
1509
1510GENERATE_LEGEND        = NO
1511
1512# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1513# remove the intermediate dot files that are used to generate
1514# the various graphs.
1515
1516DOT_CLEANUP            = YES
1517
1518#---------------------------------------------------------------------------
1519# Options related to the search engine
1520#---------------------------------------------------------------------------
1521
1522# The SEARCHENGINE tag specifies whether or not a search engine should be
1523# used. If set to NO the values of all tags below this one will be ignored.
1524
1525SEARCHENGINE           = NO
Note: See TracBrowser for help on using the repository browser.