source: trunk/doc/doxygen.cfg.in @ 2174

Last change on this file since 2174 was 2174, checked in by jylam, 8 years ago
  • Doxygen: generate collaboration diagrams if dot is available
File size: 62.7 KB
Line 
1# Doxyfile 1.5.9
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           = @PACKAGE@
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         = @VERSION@
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       = .
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           = NO
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        = NO
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        =
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      = NO
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               = 8
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  = NO
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            = NO
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        = NO
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         = NO
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  = NO
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       = NO
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     = NO
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       = NO
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_GROUP_NAMES tag is set to YES then doxygen will sort the
409# hierarchy of group names into alphabetical order. If set to NO (the default)
410# the group names will appear in their defined order.
411
412SORT_GROUP_NAMES       = NO
413
414# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
415# sorted by fully-qualified names, including namespaces. If set to
416# NO (the default), the class list will be sorted only by class name,
417# not including the namespace part.
418# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
419# Note: This option applies only to the class list, not to the
420# alphabetical list.
421
422SORT_BY_SCOPE_NAME     = NO
423
424# The GENERATE_TODOLIST tag can be used to enable (YES) or
425# disable (NO) the todo list. This list is created by putting \todo
426# commands in the documentation.
427
428GENERATE_TODOLIST      = YES
429
430# The GENERATE_TESTLIST tag can be used to enable (YES) or
431# disable (NO) the test list. This list is created by putting \test
432# commands in the documentation.
433
434GENERATE_TESTLIST      = YES
435
436# The GENERATE_BUGLIST tag can be used to enable (YES) or
437# disable (NO) the bug list. This list is created by putting \bug
438# commands in the documentation.
439
440GENERATE_BUGLIST       = YES
441
442# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
443# disable (NO) the deprecated list. This list is created by putting
444# \deprecated commands in the documentation.
445
446GENERATE_DEPRECATEDLIST= YES
447
448# The ENABLED_SECTIONS tag can be used to enable conditional
449# documentation sections, marked by \if sectionname ... \endif.
450
451ENABLED_SECTIONS       =
452
453# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
454# the initial value of a variable or define consists of for it to appear in
455# the documentation. If the initializer consists of more lines than specified
456# here it will be hidden. Use a value of 0 to hide initializers completely.
457# The appearance of the initializer of individual variables and defines in the
458# documentation can be controlled using \showinitializer or \hideinitializer
459# command in the documentation regardless of this setting.
460
461MAX_INITIALIZER_LINES  = 30
462
463# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
464# at the bottom of the documentation of classes and structs. If set to YES the
465# list will mention the files that were used to generate the documentation.
466
467SHOW_USED_FILES        = NO
468
469# If the sources in your project are distributed over multiple directories
470# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
471# in the documentation. The default is NO.
472
473SHOW_DIRECTORIES       = NO
474
475# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
476# This will remove the Files entry from the Quick Index and from the
477# Folder Tree View (if specified). The default is YES.
478
479SHOW_FILES             = YES
480
481# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
482# Namespaces page.
483# This will remove the Namespaces entry from the Quick Index
484# and from the Folder Tree View (if specified). The default is YES.
485
486SHOW_NAMESPACES        = YES
487
488# The FILE_VERSION_FILTER tag can be used to specify a program or script that
489# doxygen should invoke to get the current version for each file (typically from
490# the version control system). Doxygen will invoke the program by executing (via
491# popen()) the command <command> <input-file>, where <command> is the value of
492# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
493# provided by doxygen. Whatever the program writes to standard output
494# is used as the file version. See the manual for examples.
495
496FILE_VERSION_FILTER    =
497
498# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
499# doxygen. The layout file controls the global structure of the generated output files
500# in an output format independent way. The create the layout file that represents
501# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
502# file name after the option, if omitted DoxygenLayout.xml will be used as the name
503# of the layout file.
504
505LAYOUT_FILE            =
506
507#---------------------------------------------------------------------------
508# configuration options related to warning and progress messages
509#---------------------------------------------------------------------------
510
511# The QUIET tag can be used to turn on/off the messages that are generated
512# by doxygen. Possible values are YES and NO. If left blank NO is used.
513
514QUIET                  = NO
515
516# The WARNINGS tag can be used to turn on/off the warning messages that are
517# generated by doxygen. Possible values are YES and NO. If left blank
518# NO is used.
519
520WARNINGS               = YES
521
522# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
523# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
524# automatically be disabled.
525
526WARN_IF_UNDOCUMENTED   = YES
527
528# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
529# potential errors in the documentation, such as not documenting some
530# parameters in a documented function, or documenting parameters that
531# don't exist or using markup commands wrongly.
532
533WARN_IF_DOC_ERROR      = YES
534
535# This WARN_NO_PARAMDOC option can be abled to get warnings for
536# functions that are documented, but have no documentation for their parameters
537# or return value. If set to NO (the default) doxygen will only warn about
538# wrong or incomplete parameter documentation, but not about the absence of
539# documentation.
540
541WARN_NO_PARAMDOC       = NO
542
543# The WARN_FORMAT tag determines the format of the warning messages that
544# doxygen can produce. The string should contain the $file, $line, and $text
545# tags, which will be replaced by the file and line number from which the
546# warning originated and the warning text. Optionally the format may contain
547# $version, which will be replaced by the version of the file (if it could
548# be obtained via FILE_VERSION_FILTER)
549
550WARN_FORMAT            = "$file:$line: $text  "
551
552# The WARN_LOGFILE tag can be used to specify a file to which warning
553# and error messages should be written. If left blank the output is written
554# to stderr.
555
556WARN_LOGFILE           =
557
558#---------------------------------------------------------------------------
559# configuration options related to the input files
560#---------------------------------------------------------------------------
561
562# The INPUT tag can be used to specify the files and/or directories that contain
563# documented source files. You may enter file names like "myfile.cpp" or
564# directories like "/usr/src/myproject". Separate the files or directories
565# with spaces.
566
567INPUT                  = @top_srcdir@ \
568                         @top_srcdir@/doc \
569                         @top_srcdir@/src \
570                         @top_srcdir@/src/application \
571                         @top_srcdir@/src/core \
572                         @top_srcdir@/src/data \
573                         @top_srcdir@/src/debug \
574                         @top_srcdir@/src/easymesh \
575                         @top_srcdir@/src/gpu \
576                         @top_srcdir@/src/image \
577                         @top_srcdir@/src/input \
578                         @top_srcdir@/src/lol \
579                         @top_srcdir@/src/ath \
580                         @top_srcdir@/src/mesh \
581                         @top_srcdir@/src/platform \
582                         @top_srcdir@/src/thread
583
584
585# This tag can be used to specify the character encoding of the source files
586# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
587# also the default input encoding. Doxygen uses libiconv (or the iconv built
588# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
589# the list of possible encodings.
590
591INPUT_ENCODING         = UTF-8
592
593# If the value of the INPUT tag contains directories, you can use the
594# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
595# and *.h) to filter out the source-files in the directories. If left
596# blank the following patterns are tested:
597# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
598# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
599
600FILE_PATTERNS          = *.dox \
601                         *.cpp \
602                         *.h   \
603                         AUTHORS \
604                         NEWS \
605                         README \
606                         THANKS
607
608# The RECURSIVE tag can be used to turn specify whether or not subdirectories
609# should be searched for input files as well. Possible values are YES and NO.
610# If left blank NO is used.
611
612RECURSIVE              = NO
613
614# The EXCLUDE tag can be used to specify files and/or directories that should
615# excluded from the INPUT source files. This way you can easily exclude a
616# subdirectory from a directory tree whose root is specified with the INPUT tag.
617
618EXCLUDE                =
619
620# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
621# directories that are symbolic links (a Unix filesystem feature) are excluded
622# from the input.
623
624EXCLUDE_SYMLINKS       = NO
625
626# If the value of the INPUT tag contains directories, you can use the
627# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
628# certain files from those directories. Note that the wildcards are matched
629# against the file with absolute path, so to exclude all test directories
630# for example use the pattern */test/*
631
632EXCLUDE_PATTERNS       =
633
634# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
635# (namespaces, classes, functions, etc.) that should be excluded from the
636# output. The symbol name can be a fully qualified name, a word, or if the
637# wildcard * is used, a substring. Examples: ANamespace, AClass,
638# AClass::ANamespace, ANamespace::*Test
639
640EXCLUDE_SYMBOLS        =
641
642# The EXAMPLE_PATH tag can be used to specify one or more files or
643# directories that contain example code fragments that are included (see
644# the \include command).
645
646EXAMPLE_PATH           =
647
648# If the value of the EXAMPLE_PATH tag contains directories, you can use the
649# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
650# and *.h) to filter out the source-files in the directories. If left
651# blank all files are included.
652
653EXAMPLE_PATTERNS       =
654
655# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
656# searched for input files to be used with the \include or \dontinclude
657# commands irrespective of the value of the RECURSIVE tag.
658# Possible values are YES and NO. If left blank NO is used.
659
660EXAMPLE_RECURSIVE      = NO
661
662# The IMAGE_PATH tag can be used to specify one or more files or
663# directories that contain image that are included in the documentation (see
664# the \image command).
665
666IMAGE_PATH             =
667
668# The INPUT_FILTER tag can be used to specify a program that doxygen should
669# invoke to filter for each input file. Doxygen will invoke the filter program
670# by executing (via popen()) the command <filter> <input-file>, where <filter>
671# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
672# input file. Doxygen will then use the output that the filter program writes
673# to standard output.
674# If FILTER_PATTERNS is specified, this tag will be
675# ignored.
676
677INPUT_FILTER           =
678
679# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
680# basis.
681# Doxygen will compare the file name with each pattern and apply the
682# filter if there is a match.
683# The filters are a list of the form:
684# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
685# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
686# is applied to all files.
687
688FILTER_PATTERNS        =
689
690# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
691# INPUT_FILTER) will be used to filter the input files when producing source
692# files to browse (i.e. when SOURCE_BROWSER is set to YES).
693
694FILTER_SOURCE_FILES    = NO
695
696#---------------------------------------------------------------------------
697# configuration options related to source browsing
698#---------------------------------------------------------------------------
699
700# If the SOURCE_BROWSER tag is set to YES then a list of source files will
701# be generated. Documented entities will be cross-referenced with these sources.
702# Note: To get rid of all source code in the generated output, make sure also
703# VERBATIM_HEADERS is set to NO.
704
705SOURCE_BROWSER         = NO
706
707# Setting the INLINE_SOURCES tag to YES will include the body
708# of functions and classes directly in the documentation.
709
710INLINE_SOURCES         = NO
711
712# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
713# doxygen to hide any special comment blocks from generated source code
714# fragments. Normal C and C++ comments will always remain visible.
715
716STRIP_CODE_COMMENTS    = YES
717
718# If the REFERENCED_BY_RELATION tag is set to YES
719# then for each documented function all documented
720# functions referencing it will be listed.
721
722REFERENCED_BY_RELATION = YES
723
724# If the REFERENCES_RELATION tag is set to YES
725# then for each documented function all documented entities
726# called/used by that function will be listed.
727
728REFERENCES_RELATION    = YES
729
730# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
731# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
732# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
733# link to the source code.
734# Otherwise they will link to the documentation.
735
736REFERENCES_LINK_SOURCE = YES
737
738# If the USE_HTAGS tag is set to YES then the references to source code
739# will point to the HTML generated by the htags(1) tool instead of doxygen
740# built-in source browser. The htags tool is part of GNU's global source
741# tagging system (see http://www.gnu.org/software/global/global.html). You
742# will need version 4.8.6 or higher.
743
744USE_HTAGS              = NO
745
746# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
747# will generate a verbatim copy of the header file for each class for
748# which an include is specified. Set to NO to disable this.
749
750VERBATIM_HEADERS       = NO
751
752#---------------------------------------------------------------------------
753# configuration options related to the alphabetical class index
754#---------------------------------------------------------------------------
755
756# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
757# of all compounds will be generated. Enable this if the project
758# contains a lot of classes, structs, unions or interfaces.
759
760ALPHABETICAL_INDEX     = NO
761
762# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
763# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
764# in which this list will be split (can be a number in the range [1..20])
765
766COLS_IN_ALPHA_INDEX    = 5
767
768# In case all classes in a project start with a common prefix, all
769# classes will be put under the same header in the alphabetical index.
770# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
771# should be ignored while generating the index headers.
772
773IGNORE_PREFIX          =
774
775#---------------------------------------------------------------------------
776# configuration options related to the HTML output
777#---------------------------------------------------------------------------
778
779# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
780# generate HTML output.
781
782GENERATE_HTML          = YES
783
784# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
785# If a relative path is entered the value of OUTPUT_DIRECTORY will be
786# put in front of it. If left blank `html' will be used as the default path.
787
788HTML_OUTPUT            = html
789
790# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
791# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
792# doxygen will generate files with .html extension.
793
794HTML_FILE_EXTENSION    = .html
795
796# The HTML_HEADER tag can be used to specify a personal HTML header for
797# each generated HTML page. If it is left blank doxygen will generate a
798# standard header.
799
800HTML_HEADER            = @srcdir@/header.html
801
802# The HTML_FOOTER tag can be used to specify a personal HTML footer for
803# each generated HTML page. If it is left blank doxygen will generate a
804# standard footer.
805
806HTML_FOOTER            = @srcdir@/footer.html
807
808# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
809# style sheet that is used by each HTML page. It can be used to
810# fine-tune the look of the HTML output. If the tag is left blank doxygen
811# will generate a default style sheet. Note that doxygen will try to copy
812# the style sheet file to the HTML output directory, so don't put your own
813# stylesheet in the HTML output directory as well, or it will be erased!
814
815HTML_STYLESHEET        = doxygen.css
816
817# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
818# files or namespaces will be aligned in HTML using tables. If set to
819# NO a bullet list will be used.
820
821HTML_ALIGN_MEMBERS     = YES
822
823# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
824# documentation will contain sections that can be hidden and shown after the
825# page has loaded. For this to work a browser that supports
826# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
827# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
828
829HTML_DYNAMIC_SECTIONS  = NO
830
831# If the GENERATE_DOCSET tag is set to YES, additional index files
832# will be generated that can be used as input for Apple's Xcode 3
833# integrated development environment, introduced with OSX 10.5 (Leopard).
834# To create a documentation set, doxygen will generate a Makefile in the
835# HTML output directory. Running make will produce the docset in that
836# directory and running "make install" will install the docset in
837# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
838# it at startup.
839# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
840
841GENERATE_DOCSET        = NO
842
843# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
844# feed. A documentation feed provides an umbrella under which multiple
845# documentation sets from a single provider (such as a company or product suite)
846# can be grouped.
847
848DOCSET_FEEDNAME        = "Doxygen generated docs"
849
850# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
851# should uniquely identify the documentation set bundle. This should be a
852# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
853# will append .docset to the name.
854
855DOCSET_BUNDLE_ID       = org.doxygen.Project
856
857# If the GENERATE_HTMLHELP tag is set to YES, additional index files
858# will be generated that can be used as input for tools like the
859# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
860# of the generated HTML documentation.
861
862GENERATE_HTMLHELP      = NO
863
864# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
865# be used to specify the file name of the resulting .chm file. You
866# can add a path in front of the file if the result should not be
867# written to the html output directory.
868
869CHM_FILE               =
870
871# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
872# be used to specify the location (absolute path including file name) of
873# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
874# the HTML help compiler on the generated index.hhp.
875
876HHC_LOCATION           =
877
878# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
879# controls if a separate .chi index file is generated (YES) or that
880# it should be included in the master .chm file (NO).
881
882GENERATE_CHI           = NO
883
884# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
885# is used to encode HtmlHelp index (hhk), content (hhc) and project file
886# content.
887
888CHM_INDEX_ENCODING     =
889
890# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
891# controls whether a binary table of contents is generated (YES) or a
892# normal table of contents (NO) in the .chm file.
893
894BINARY_TOC             = NO
895
896# The TOC_EXPAND flag can be set to YES to add extra items for group members
897# to the contents of the HTML help documentation and to the tree view.
898
899TOC_EXPAND             = NO
900
901# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
902# are set, an additional index file will be generated that can be used as input for
903# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
904# HTML documentation.
905
906GENERATE_QHP           = NO
907
908# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
909# be used to specify the file name of the resulting .qch file.
910# The path specified is relative to the HTML output folder.
911
912QCH_FILE               =
913
914# The QHP_NAMESPACE tag specifies the namespace to use when generating
915# Qt Help Project output. For more information please see
916# http://doc.trolltech.com/qthelpproject.html#namespace
917
918QHP_NAMESPACE          =
919
920# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
921# Qt Help Project output. For more information please see
922# http://doc.trolltech.com/qthelpproject.html#virtual-folders
923
924QHP_VIRTUAL_FOLDER     = doc
925
926# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
927# For more information please see
928# http://doc.trolltech.com/qthelpproject.html#custom-filters
929
930QHP_CUST_FILTER_NAME   =
931
932# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
933# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
934
935QHP_CUST_FILTER_ATTRS  =
936
937# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
938# filter section matches.
939# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
940
941QHP_SECT_FILTER_ATTRS  =
942
943# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
944# be used to specify the location of Qt's qhelpgenerator.
945# If non-empty doxygen will try to run qhelpgenerator on the generated
946# .qhp file.
947
948QHG_LOCATION           =
949
950# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
951# top of each HTML page. The value NO (the default) enables the index and
952# the value YES disables it.
953
954DISABLE_INDEX          = YES
955
956# This tag can be used to set the number of enum values (range [1..20])
957# that doxygen will group on one line in the generated HTML documentation.
958
959ENUM_VALUES_PER_LINE   = 1
960
961# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
962# structure should be generated to display hierarchical information.
963# If the tag value is set to FRAME, a side panel will be generated
964# containing a tree-like index structure (just like the one that
965# is generated for HTML Help). For this to work a browser that supports
966# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
967# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
968# probably better off using the HTML help feature. Other possible values
969# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
970# and Class Hierarchy pages using a tree view instead of an ordered list;
971# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
972# disables this behavior completely. For backwards compatibility with previous
973# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
974# respectively.
975
976GENERATE_TREEVIEW      = NO
977
978# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
979# used to set the initial width (in pixels) of the frame in which the tree
980# is shown.
981
982TREEVIEW_WIDTH         = 250
983
984# Use this tag to change the font size of Latex formulas included
985# as images in the HTML documentation. The default is 10. Note that
986# when you change the font size after a successful doxygen run you need
987# to manually remove any form_*.png images from the HTML output directory
988# to force them to be regenerated.
989
990FORMULA_FONTSIZE       = 10
991
992#---------------------------------------------------------------------------
993# configuration options related to the LaTeX output
994#---------------------------------------------------------------------------
995
996# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
997# generate Latex output.
998
999GENERATE_LATEX         = YES
1000
1001# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1002# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1003# put in front of it. If left blank `latex' will be used as the default path.
1004
1005LATEX_OUTPUT           = latex
1006
1007# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1008# invoked. If left blank `latex' will be used as the default command name.
1009
1010LATEX_CMD_NAME         = latex
1011
1012# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1013# generate index for LaTeX. If left blank `makeindex' will be used as the
1014# default command name.
1015
1016MAKEINDEX_CMD_NAME     = makeindex
1017
1018# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1019# LaTeX documents. This may be useful for small projects and may help to
1020# save some trees in general.
1021
1022COMPACT_LATEX          = YES
1023
1024# The PAPER_TYPE tag can be used to set the paper type that is used
1025# by the printer. Possible values are: a4, a4wide, letter, legal and
1026# executive. If left blank a4wide will be used.
1027
1028PAPER_TYPE             = a4wide
1029
1030# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1031# packages that should be included in the LaTeX output.
1032
1033EXTRA_PACKAGES         =
1034
1035# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1036# the generated latex document. The header should contain everything until
1037# the first chapter. If it is left blank doxygen will generate a
1038# standard header. Notice: only use this tag if you know what you are doing!
1039
1040LATEX_HEADER           =
1041
1042# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1043# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1044# contain links (just like the HTML output) instead of page references
1045# This makes the output suitable for online browsing using a pdf viewer.
1046
1047PDF_HYPERLINKS         = YES
1048
1049# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1050# plain latex in the generated Makefile. Set this option to YES to get a
1051# higher quality PDF documentation.
1052
1053USE_PDFLATEX           = YES
1054
1055# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1056# command to the generated LaTeX files. This will instruct LaTeX to keep
1057# running if errors occur, instead of asking the user for help.
1058# This option is also used when generating formulas in HTML.
1059
1060LATEX_BATCHMODE        = YES
1061
1062# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1063# include the index chapters (such as File Index, Compound Index, etc.)
1064# in the output.
1065
1066LATEX_HIDE_INDICES     = YES
1067
1068# 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.
1069
1070LATEX_SOURCE_CODE      = NO
1071
1072#---------------------------------------------------------------------------
1073# configuration options related to the RTF output
1074#---------------------------------------------------------------------------
1075
1076# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1077# The RTF output is optimized for Word 97 and may not look very pretty with
1078# other RTF readers or editors.
1079
1080GENERATE_RTF           = NO
1081
1082# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1083# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1084# put in front of it. If left blank `rtf' will be used as the default path.
1085
1086RTF_OUTPUT             = rtf
1087
1088# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1089# RTF documents. This may be useful for small projects and may help to
1090# save some trees in general.
1091
1092COMPACT_RTF            = NO
1093
1094# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1095# will contain hyperlink fields. The RTF file will
1096# contain links (just like the HTML output) instead of page references.
1097# This makes the output suitable for online browsing using WORD or other
1098# programs which support those fields.
1099# Note: wordpad (write) and others do not support links.
1100
1101RTF_HYPERLINKS         = NO
1102
1103# Load stylesheet definitions from file. Syntax is similar to doxygen's
1104# config file, i.e. a series of assignments. You only have to provide
1105# replacements, missing definitions are set to their default value.
1106
1107RTF_STYLESHEET_FILE    =
1108
1109# Set optional variables used in the generation of an rtf document.
1110# Syntax is similar to doxygen's config file.
1111
1112RTF_EXTENSIONS_FILE    =
1113
1114#---------------------------------------------------------------------------
1115# configuration options related to the man page output
1116#---------------------------------------------------------------------------
1117
1118# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1119# generate man pages
1120
1121GENERATE_MAN           = YES
1122
1123# The MAN_OUTPUT tag is used to specify where the man 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 `man' will be used as the default path.
1126
1127MAN_OUTPUT             = man
1128
1129# The MAN_EXTENSION tag determines the extension that is added to
1130# the generated man pages (default is the subroutine's section .3)
1131
1132MAN_EXTENSION          = .3lol
1133
1134# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1135# then it will generate one additional man file for each entity
1136# documented in the real man page(s). These additional files
1137# only source the real man page, but without them the man command
1138# would be unable to find the correct page. The default is NO.
1139
1140MAN_LINKS              = YES
1141
1142#---------------------------------------------------------------------------
1143# configuration options related to the XML output
1144#---------------------------------------------------------------------------
1145
1146# If the GENERATE_XML tag is set to YES Doxygen will
1147# generate an XML file that captures the structure of
1148# the code including all documentation.
1149
1150GENERATE_XML           = NO
1151
1152# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1153# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1154# put in front of it. If left blank `xml' will be used as the default path.
1155
1156XML_OUTPUT             = xml
1157
1158# The XML_SCHEMA tag can be used to specify an XML schema,
1159# which can be used by a validating XML parser to check the
1160# syntax of the XML files.
1161
1162XML_SCHEMA             =
1163
1164# The XML_DTD tag can be used to specify an XML DTD,
1165# which can be used by a validating XML parser to check the
1166# syntax of the XML files.
1167
1168XML_DTD                =
1169
1170# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1171# dump the program listings (including syntax highlighting
1172# and cross-referencing information) to the XML output. Note that
1173# enabling this will significantly increase the size of the XML output.
1174
1175XML_PROGRAMLISTING     = YES
1176
1177#---------------------------------------------------------------------------
1178# configuration options for the AutoGen Definitions output
1179#---------------------------------------------------------------------------
1180
1181# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1182# generate an AutoGen Definitions (see autogen.sf.net) file
1183# that captures the structure of the code including all
1184# documentation. Note that this feature is still experimental
1185# and incomplete at the moment.
1186
1187GENERATE_AUTOGEN_DEF   = NO
1188
1189#---------------------------------------------------------------------------
1190# configuration options related to the Perl module output
1191#---------------------------------------------------------------------------
1192
1193# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1194# generate a Perl module file that captures the structure of
1195# the code including all documentation. Note that this
1196# feature is still experimental and incomplete at the
1197# moment.
1198
1199GENERATE_PERLMOD       = NO
1200
1201# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1202# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1203# to generate PDF and DVI output from the Perl module output.
1204
1205PERLMOD_LATEX          = NO
1206
1207# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1208# nicely formatted so it can be parsed by a human reader.
1209# This is useful
1210# if you want to understand what is going on.
1211# On the other hand, if this
1212# tag is set to NO the size of the Perl module output will be much smaller
1213# and Perl will parse it just the same.
1214
1215PERLMOD_PRETTY         = YES
1216
1217# The names of the make variables in the generated doxyrules.make file
1218# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1219# This is useful so different doxyrules.make files included by the same
1220# Makefile don't overwrite each other's variables.
1221
1222PERLMOD_MAKEVAR_PREFIX =
1223
1224#---------------------------------------------------------------------------
1225# Configuration options related to the preprocessor
1226#---------------------------------------------------------------------------
1227
1228# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1229# evaluate all C-preprocessor directives found in the sources and include
1230# files.
1231
1232ENABLE_PREPROCESSING   = YES
1233
1234# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1235# names in the source code. If set to NO (the default) only conditional
1236# compilation will be performed. Macro expansion can be done in a controlled
1237# way by setting EXPAND_ONLY_PREDEF to YES.
1238
1239MACRO_EXPANSION        = YES
1240
1241# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1242# then the macro expansion is limited to the macros specified with the
1243# PREDEFINED and EXPAND_AS_DEFINED tags.
1244
1245EXPAND_ONLY_PREDEF     = YES
1246
1247# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1248# in the INCLUDE_PATH (see below) will be search if a #include is found.
1249
1250SEARCH_INCLUDES        = YES
1251
1252# The INCLUDE_PATH tag can be used to specify one or more directories that
1253# contain include files that are not input files but should be processed by
1254# the preprocessor.
1255
1256INCLUDE_PATH           =
1257
1258# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1259# patterns (like *.h and *.hpp) to filter out the header-files in the
1260# directories. If left blank, the patterns specified with FILE_PATTERNS will
1261# be used.
1262
1263INCLUDE_FILE_PATTERNS  =
1264
1265# The PREDEFINED tag can be used to specify one or more macro names that
1266# are defined before the preprocessor is started (similar to the -D option of
1267# gcc). The argument of the tag is a list of macros of the form: name
1268# or name=definition (no spaces). If the definition and the = are
1269# omitted =1 is assumed. To prevent a macro definition from being
1270# undefined via #undef or recursively expanded use the := operator
1271# instead of the = operator.
1272
1273PREDEFINED             = _DOXYGEN_SKIP_ME __extern=
1274
1275# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1276# this tag can be used to specify a list of macro names that should be expanded.
1277# The macro definition that is found in the sources will be used.
1278# Use the PREDEFINED tag if you want to use a different macro definition.
1279
1280EXPAND_AS_DEFINED      = __extern \
1281                         __class
1282
1283# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1284# doxygen's preprocessor will remove all function-like macros that are alone
1285# on a line, have an all uppercase name, and do not end with a semicolon. Such
1286# function macros are typically used for boiler-plate code, and will confuse
1287# the parser if not removed.
1288
1289SKIP_FUNCTION_MACROS   = YES
1290
1291#---------------------------------------------------------------------------
1292# Configuration::additions related to external references
1293#---------------------------------------------------------------------------
1294
1295# The TAGFILES option can be used to specify one or more tagfiles.
1296# Optionally an initial location of the external documentation
1297# can be added for each tagfile. The format of a tag file without
1298# this location is as follows:
1299#
1300# TAGFILES = file1 file2 ...
1301# Adding location for the tag files is done as follows:
1302#
1303# TAGFILES = file1=loc1 "file2 = loc2" ...
1304# where "loc1" and "loc2" can be relative or absolute paths or
1305# URLs. If a location is present for each tag, the installdox tool
1306# does not have to be run to correct the links.
1307# Note that each tag file must have a unique name
1308# (where the name does NOT include the path)
1309# If a tag file is not located in the directory in which doxygen
1310# is run, you must also specify the path to the tagfile here.
1311
1312TAGFILES               =
1313
1314# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1315# a tag file that is based on the input files it reads.
1316
1317GENERATE_TAGFILE       =
1318
1319# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1320# in the class index. If set to NO only the inherited external classes
1321# will be listed.
1322
1323ALLEXTERNALS           = NO
1324
1325# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1326# in the modules index. If set to NO, only the current project's groups will
1327# be listed.
1328
1329EXTERNAL_GROUPS        = YES
1330
1331# The PERL_PATH should be the absolute path and name of the perl script
1332# interpreter (i.e. the result of `which perl').
1333
1334PERL_PATH              = /usr/bin/perl
1335
1336#---------------------------------------------------------------------------
1337# Configuration options related to the dot tool
1338#---------------------------------------------------------------------------
1339
1340# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1341# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1342# or super classes. Setting the tag to NO turns the diagrams off. Note that
1343# this option is superseded by the HAVE_DOT option below. This is only a
1344# fallback. It is recommended to install and use dot, since it yields more
1345# powerful graphs.
1346
1347CLASS_DIAGRAMS         = YES
1348
1349# You can define message sequence charts within doxygen comments using the \msc
1350# command. Doxygen will then run the mscgen tool (see
1351# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1352# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1353# the mscgen tool resides. If left empty the tool is assumed to be found in the
1354# default search path.
1355
1356MSCGEN_PATH            =
1357
1358# If set to YES, the inheritance and collaboration graphs will hide
1359# inheritance and usage relations if the target is undocumented
1360# or is not a class.
1361
1362HIDE_UNDOC_RELATIONS   = NO
1363
1364# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1365# available from the path. This tool is part of Graphviz, a graph visualization
1366# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1367# have no effect if this option is set to NO (the default)
1368
1369HAVE_DOT               = @USE_DOT@
1370
1371# By default doxygen will write a font called FreeSans.ttf to the output
1372# directory and reference it in all dot files that doxygen generates. This
1373# font does not include all possible unicode characters however, so when you need
1374# these (or just want a differently looking font) you can specify the font name
1375# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1376# which can be done by putting it in a standard location or by setting the
1377# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1378# containing the font.
1379
1380DOT_FONTNAME           = FreeSans
1381
1382# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1383# The default size is 10pt.
1384
1385DOT_FONTSIZE           = 10
1386
1387# By default doxygen will tell dot to use the output directory to look for the
1388# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1389# different font using DOT_FONTNAME you can set the path where dot
1390# can find it using this tag.
1391
1392DOT_FONTPATH           =
1393
1394# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1395# will generate a graph for each documented class showing the direct and
1396# indirect inheritance relations. Setting this tag to YES will force the
1397# the CLASS_DIAGRAMS tag to NO.
1398
1399CLASS_GRAPH            = YES
1400
1401# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1402# will generate a graph for each documented class showing the direct and
1403# indirect implementation dependencies (inheritance, containment, and
1404# class references variables) of the class with other documented classes.
1405
1406COLLABORATION_GRAPH    = YES
1407
1408# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1409# will generate a graph for groups, showing the direct groups dependencies
1410
1411GROUP_GRAPHS           = YES
1412
1413# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1414# collaboration diagrams in a style similar to the OMG's Unified Modeling
1415# Language.
1416
1417UML_LOOK               = NO
1418
1419# If set to YES, the inheritance and collaboration graphs will show the
1420# relations between templates and their instances.
1421
1422TEMPLATE_RELATIONS     = YES
1423
1424# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1425# tags are set to YES then doxygen will generate a graph for each documented
1426# file showing the direct and indirect include dependencies of the file with
1427# other documented files.
1428
1429INCLUDE_GRAPH          = YES
1430
1431# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1432# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1433# documented header file showing the documented files that directly or
1434# indirectly include this file.
1435
1436INCLUDED_BY_GRAPH      = YES
1437
1438# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1439# doxygen will generate a call dependency graph for every global function
1440# or class method. Note that enabling this option will significantly increase
1441# the time of a run. So in most cases it will be better to enable call graphs
1442# for selected functions only using the \callgraph command.
1443
1444CALL_GRAPH             = NO
1445
1446# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1447# doxygen will generate a caller dependency graph for every global function
1448# or class method. Note that enabling this option will significantly increase
1449# the time of a run. So in most cases it will be better to enable caller
1450# graphs for selected functions only using the \callergraph command.
1451
1452CALLER_GRAPH           = NO
1453
1454# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1455# will graphical hierarchy of all classes instead of a textual one.
1456
1457GRAPHICAL_HIERARCHY    = YES
1458
1459# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1460# then doxygen will show the dependencies a directory has on other directories
1461# in a graphical way. The dependency relations are determined by the #include
1462# relations between the files in the directories.
1463
1464DIRECTORY_GRAPH        = YES
1465
1466# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1467# generated by dot. Possible values are png, jpg, or gif
1468# If left blank png will be used.
1469
1470DOT_IMAGE_FORMAT       = png
1471
1472# The tag DOT_PATH can be used to specify the path where the dot tool can be
1473# found. If left blank, it is assumed the dot tool can be found in the path.
1474
1475DOT_PATH               = @DOT@
1476
1477# The DOTFILE_DIRS tag can be used to specify one or more directories that
1478# contain dot files that are included in the documentation (see the
1479# \dotfile command).
1480
1481DOTFILE_DIRS           = .
1482
1483# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1484# nodes that will be shown in the graph. If the number of nodes in a graph
1485# becomes larger than this value, doxygen will truncate the graph, which is
1486# visualized by representing a node as a red box. Note that doxygen if the
1487# number of direct children of the root node in a graph is already larger than
1488# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1489# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1490
1491DOT_GRAPH_MAX_NODES    = 50
1492
1493# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1494# graphs generated by dot. A depth value of 3 means that only nodes reachable
1495# from the root by following a path via at most 3 edges will be shown. Nodes
1496# that lay further from the root node will be omitted. Note that setting this
1497# option to 1 or 2 may greatly reduce the computation time needed for large
1498# code bases. Also note that the size of a graph can be further restricted by
1499# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1500
1501MAX_DOT_GRAPH_DEPTH    = 0
1502
1503# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1504# background. This is disabled by default, because dot on Windows does not
1505# seem to support this out of the box. Warning: Depending on the platform used,
1506# enabling this option may lead to badly anti-aliased labels on the edges of
1507# a graph (i.e. they become hard to read).
1508
1509DOT_TRANSPARENT        = NO
1510
1511# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1512# files in one run (i.e. multiple -o and -T options on the command line). This
1513# makes dot run faster, but since only newer versions of dot (>1.8.10)
1514# support this, this feature is disabled by default.
1515
1516DOT_MULTI_TARGETS      = NO
1517
1518# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1519# generate a legend page explaining the meaning of the various boxes and
1520# arrows in the dot generated graphs.
1521
1522GENERATE_LEGEND        = YES
1523
1524# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1525# remove the intermediate dot files that are used to generate
1526# the various graphs.
1527
1528DOT_CLEANUP            = YES
1529
1530#---------------------------------------------------------------------------
1531# Options related to the search engine
1532#---------------------------------------------------------------------------
1533
1534# The SEARCHENGINE tag specifies whether or not a search engine should be
1535# used. If set to NO the values of all tags below this one will be ignored.
1536
1537SEARCHENGINE           = NO
Note: See TracBrowser for help on using the repository browser.