source: doc/full.cfg @ b4fac43

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since b4fac43 was b4fac43, checked in by Paul Brossier <piem@piem.org>, 7 years ago

doc/: upgrade to latest doxygen

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