blob: 6a8ff2e8c9a9e88bffbc3581b0ab33c00b7672d7 [file] [log] [blame]
cristy4a760ec2010-05-08 02:25:19 +00001# Doxyfile 1.6.2-20100208
cristy3ed852e2009-09-05 21:47:34 +00002
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
cristy4a760ec2010-05-08 02:25:19 +000017# 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.
cristy3ed852e2009-09-05 21:47:34 +000022
23DOXYFILE_ENCODING = UTF-8
24
cristy4a760ec2010-05-08 02:25:19 +000025# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
cristy3ed852e2009-09-05 21:47:34 +000026# by quotes) that should identify the project.
27
28PROJECT_NAME = MagickCore
29
cristy4a760ec2010-05-08 02:25:19 +000030# 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
cristy3ed852e2009-09-05 21:47:34 +000032# if some version control system is used.
33
34PROJECT_NUMBER = @PACKAGE_VERSION@
35
cristy4a760ec2010-05-08 02:25:19 +000036# 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
cristy3ed852e2009-09-05 21:47:34 +000039# where doxygen was started. If left blank the current directory will be used.
40
41OUTPUT_DIRECTORY = www/api
42
cristy4a760ec2010-05-08 02:25:19 +000043# 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
cristy3ed852e2009-09-05 21:47:34 +000048# otherwise cause performance problems for the file system.
49
50CREATE_SUBDIRS = NO
51
cristy4a760ec2010-05-08 02:25:19 +000052# 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.
cristy3ed852e2009-09-05 21:47:34 +000062
63OUTPUT_LANGUAGE = English
64
cristy4a760ec2010-05-08 02:25:19 +000065# 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).
cristy3ed852e2009-09-05 21:47:34 +000068# Set to NO to disable this.
69
70BRIEF_MEMBER_DESC = YES
71
cristy4a760ec2010-05-08 02:25:19 +000072# 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
cristy3ed852e2009-09-05 21:47:34 +000075# brief descriptions will be completely suppressed.
76
77REPEAT_BRIEF = YES
78
cristy4a760ec2010-05-08 02:25:19 +000079# 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"
cristy3ed852e2009-09-05 21:47:34 +000087# "represents" "a" "an" "the"
88
cristy4a760ec2010-05-08 02:25:19 +000089ABBREVIATE_BRIEF =
cristy3ed852e2009-09-05 21:47:34 +000090
cristy4a760ec2010-05-08 02:25:19 +000091# 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
cristy3ed852e2009-09-05 21:47:34 +000093# description.
94
95ALWAYS_DETAILED_SEC = NO
96
cristy4a760ec2010-05-08 02:25:19 +000097# 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
cristy3ed852e2009-09-05 21:47:34 +0000100# operators of the base classes will not be shown.
101
102INLINE_INHERITED_MEMB = NO
103
cristy4a760ec2010-05-08 02:25:19 +0000104# 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
cristy3ed852e2009-09-05 21:47:34 +0000106# to NO the shortest path that makes the file name unique will be used.
107
108FULL_PATH_NAMES = NO
109
cristy4a760ec2010-05-08 02:25:19 +0000110# 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
cristy3ed852e2009-09-05 21:47:34 +0000115# path to strip.
116
cristy4a760ec2010-05-08 02:25:19 +0000117STRIP_FROM_PATH =
cristy3ed852e2009-09-05 21:47:34 +0000118
cristy4a760ec2010-05-08 02:25:19 +0000119# 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
cristy3ed852e2009-09-05 21:47:34 +0000124# are normally passed to the compiler using the -I flag.
125
cristy4a760ec2010-05-08 02:25:19 +0000126STRIP_FROM_INC_PATH =
cristy3ed852e2009-09-05 21:47:34 +0000127
cristy4a760ec2010-05-08 02:25:19 +0000128# 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
cristy3ed852e2009-09-05 21:47:34 +0000130# doesn't support long names like on DOS, Mac, or CD-ROM.
131
132SHORT_NAMES = NO
133
cristy4a760ec2010-05-08 02:25:19 +0000134# 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
cristy3ed852e2009-09-05 21:47:34 +0000138# (thus requiring an explicit @brief command for a brief description.)
139
140JAVADOC_AUTOBRIEF = NO
141
cristy4a760ec2010-05-08 02:25:19 +0000142# 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
cristy3ed852e2009-09-05 21:47:34 +0000146# an explicit \brief command for a brief description.)
147
148QT_AUTOBRIEF = NO
149
cristy4a760ec2010-05-08 02:25:19 +0000150# 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
cristy3ed852e2009-09-05 21:47:34 +0000154# description. Set this tag to YES if you prefer the old behaviour instead.
155
156MULTILINE_CPP_IS_BRIEF = YES
157
cristy4a760ec2010-05-08 02:25:19 +0000158# 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
cristy3ed852e2009-09-05 21:47:34 +0000160# re-implements.
161
162INHERIT_DOCS = YES
163
cristy4a760ec2010-05-08 02:25:19 +0000164# 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
cristy3ed852e2009-09-05 21:47:34 +0000166# be part of the file/class/namespace that contains it.
167
168SEPARATE_MEMBER_PAGES = NO
169
cristy4a760ec2010-05-08 02:25:19 +0000170# The TAB_SIZE tag can be used to set the number of spaces in a tab.
cristy3ed852e2009-09-05 21:47:34 +0000171# Doxygen uses this value to replace tabs by spaces in code fragments.
172
173TAB_SIZE = 8
174
cristy4a760ec2010-05-08 02:25:19 +0000175# 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:".
cristy3ed852e2009-09-05 21:47:34 +0000180# You can put \n's in the value part of an alias to insert newlines.
181
cristy4a760ec2010-05-08 02:25:19 +0000182ALIASES =
cristy3ed852e2009-09-05 21:47:34 +0000183
cristy4a760ec2010-05-08 02:25:19 +0000184# 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
cristy3ed852e2009-09-05 21:47:34 +0000187# of all members will be omitted, etc.
188
189OPTIMIZE_OUTPUT_FOR_C = YES
190
cristy4a760ec2010-05-08 02:25:19 +0000191# 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.
cristy3ed852e2009-09-05 21:47:34 +0000195
196OPTIMIZE_OUTPUT_JAVA = NO
197
cristy4a760ec2010-05-08 02:25:19 +0000198# 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
cristy3ed852e2009-09-05 21:47:34 +0000226# 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
cristy4a760ec2010-05-08 02:25:19 +0000235# 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
cristy3ed852e2009-09-05 21:47:34 +0000237# instead of private inheritance when no explicit protection keyword is present.
238
239SIP_SUPPORT = NO
240
cristy4a760ec2010-05-08 02:25:19 +0000241# 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
cristy3ed852e2009-09-05 21:47:34 +0000253# all members of a group must be documented explicitly.
254
255DISTRIBUTE_GROUP_DOC = NO
256
cristy4a760ec2010-05-08 02:25:19 +0000257# 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
cristy3ed852e2009-09-05 21:47:34 +0000261# the \nosubgrouping command.
262
263SUBGROUPING = YES
264
cristy4a760ec2010-05-08 02:25:19 +0000265# 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.
cristy3ed852e2009-09-05 21:47:34 +0000272
273TYPEDEF_HIDES_STRUCT = NO
274
cristy4a760ec2010-05-08 02:25:19 +0000275# 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
cristy3ed852e2009-09-05 21:47:34 +0000291#---------------------------------------------------------------------------
292# Build related configuration options
293#---------------------------------------------------------------------------
294
cristy4a760ec2010-05-08 02:25:19 +0000295# 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
cristy3ed852e2009-09-05 21:47:34 +0000298# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
299
300EXTRACT_ALL = YES
301
cristy4a760ec2010-05-08 02:25:19 +0000302# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
cristy3ed852e2009-09-05 21:47:34 +0000303# will be included in the documentation.
304
305EXTRACT_PRIVATE = NO
306
cristy4a760ec2010-05-08 02:25:19 +0000307# If the EXTRACT_STATIC tag is set to YES all static members of a file
cristy3ed852e2009-09-05 21:47:34 +0000308# will be included in the documentation.
309
310EXTRACT_STATIC = YES
311
cristy4a760ec2010-05-08 02:25:19 +0000312# 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.
cristy3ed852e2009-09-05 21:47:34 +0000314# If set to NO only classes defined in header files are included.
315
316EXTRACT_LOCAL_CLASSES = YES
317
cristy4a760ec2010-05-08 02:25:19 +0000318# 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.
cristy3ed852e2009-09-05 21:47:34 +0000321# If set to NO (the default) only methods in the interface are included.
322
323EXTRACT_LOCAL_METHODS = NO
324
cristy4a760ec2010-05-08 02:25:19 +0000325# 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.
cristy3ed852e2009-09-05 21:47:34 +0000330
331EXTRACT_ANON_NSPACES = NO
332
cristy4a760ec2010-05-08 02:25:19 +0000333# 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.
cristy3ed852e2009-09-05 21:47:34 +0000337# This option has no effect if EXTRACT_ALL is enabled.
338
339HIDE_UNDOC_MEMBERS = NO
340
cristy4a760ec2010-05-08 02:25:19 +0000341# 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
cristy3ed852e2009-09-05 21:47:34 +0000344# overviews. This option has no effect if EXTRACT_ALL is enabled.
345
346HIDE_UNDOC_CLASSES = NO
347
cristy4a760ec2010-05-08 02:25:19 +0000348# 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
cristy3ed852e2009-09-05 21:47:34 +0000351# documentation.
352
353HIDE_FRIEND_COMPOUNDS = NO
354
cristy4a760ec2010-05-08 02:25:19 +0000355# 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
cristy3ed852e2009-09-05 21:47:34 +0000358# function's detailed documentation block.
359
360HIDE_IN_BODY_DOCS = NO
361
cristy4a760ec2010-05-08 02:25:19 +0000362# 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.
cristy3ed852e2009-09-05 21:47:34 +0000365# Set it to YES to include the internal documentation.
366
367INTERNAL_DOCS = NO
368
cristy4a760ec2010-05-08 02:25:19 +0000369# 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
cristy3ed852e2009-09-05 21:47:34 +0000373# and Mac users are advised to set this option to NO.
374
375CASE_SENSE_NAMES = YES
376
cristy4a760ec2010-05-08 02:25:19 +0000377# 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
cristy3ed852e2009-09-05 21:47:34 +0000379# documentation. If set to YES the scope will be hidden.
380
381HIDE_SCOPE_NAMES = NO
382
cristy4a760ec2010-05-08 02:25:19 +0000383# 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
cristy3ed852e2009-09-05 21:47:34 +0000385# of that file.
386
387SHOW_INCLUDE_FILES = YES
388
cristy4a760ec2010-05-08 02:25:19 +0000389# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
390# will list include files with double quotes in the documentation
391# rather than with sharp brackets.
392
393FORCE_LOCAL_INCLUDES = NO
394
395# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
cristy3ed852e2009-09-05 21:47:34 +0000396# is inserted in the documentation for inline members.
397
398INLINE_INFO = YES
399
cristy4a760ec2010-05-08 02:25:19 +0000400# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
401# will sort the (detailed) documentation of file and class members
402# alphabetically by member name. If set to NO the members will appear in
cristy3ed852e2009-09-05 21:47:34 +0000403# declaration order.
404
405SORT_MEMBER_DOCS = YES
406
cristy4a760ec2010-05-08 02:25:19 +0000407# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
408# brief documentation of file, namespace and class members alphabetically
409# by member name. If set to NO (the default) the members will appear in
cristy3ed852e2009-09-05 21:47:34 +0000410# declaration order.
411
412SORT_BRIEF_DOCS = NO
413
cristy4a760ec2010-05-08 02:25:19 +0000414# 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.
415
416SORT_MEMBERS_CTORS_1ST = NO
417
418# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
419# hierarchy of group names into alphabetical order. If set to NO (the default)
420# the group names will appear in their defined order.
421
422SORT_GROUP_NAMES = NO
423
424# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
425# sorted by fully-qualified names, including namespaces. If set to
426# NO (the default), the class list will be sorted only by class name,
427# not including the namespace part.
cristy3ed852e2009-09-05 21:47:34 +0000428# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
cristy4a760ec2010-05-08 02:25:19 +0000429# Note: This option applies only to the class list, not to the
cristy3ed852e2009-09-05 21:47:34 +0000430# alphabetical list.
431
432SORT_BY_SCOPE_NAME = NO
433
cristy4a760ec2010-05-08 02:25:19 +0000434# The GENERATE_TODOLIST tag can be used to enable (YES) or
435# disable (NO) the todo list. This list is created by putting \todo
cristy3ed852e2009-09-05 21:47:34 +0000436# commands in the documentation.
437
438GENERATE_TODOLIST = YES
439
cristy4a760ec2010-05-08 02:25:19 +0000440# The GENERATE_TESTLIST tag can be used to enable (YES) or
441# disable (NO) the test list. This list is created by putting \test
cristy3ed852e2009-09-05 21:47:34 +0000442# commands in the documentation.
443
444GENERATE_TESTLIST = YES
445
cristy4a760ec2010-05-08 02:25:19 +0000446# The GENERATE_BUGLIST tag can be used to enable (YES) or
447# disable (NO) the bug list. This list is created by putting \bug
cristy3ed852e2009-09-05 21:47:34 +0000448# commands in the documentation.
449
450GENERATE_BUGLIST = YES
451
cristy4a760ec2010-05-08 02:25:19 +0000452# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
453# disable (NO) the deprecated list. This list is created by putting
cristy3ed852e2009-09-05 21:47:34 +0000454# \deprecated commands in the documentation.
455
456GENERATE_DEPRECATEDLIST= YES
457
cristy4a760ec2010-05-08 02:25:19 +0000458# The ENABLED_SECTIONS tag can be used to enable conditional
cristy3ed852e2009-09-05 21:47:34 +0000459# documentation sections, marked by \if sectionname ... \endif.
460
cristy4a760ec2010-05-08 02:25:19 +0000461ENABLED_SECTIONS =
cristy3ed852e2009-09-05 21:47:34 +0000462
cristy4a760ec2010-05-08 02:25:19 +0000463# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
464# the initial value of a variable or define consists of for it to appear in
465# the documentation. If the initializer consists of more lines than specified
466# here it will be hidden. Use a value of 0 to hide initializers completely.
467# The appearance of the initializer of individual variables and defines in the
468# documentation can be controlled using \showinitializer or \hideinitializer
cristy3ed852e2009-09-05 21:47:34 +0000469# command in the documentation regardless of this setting.
470
471MAX_INITIALIZER_LINES = 30
472
cristy4a760ec2010-05-08 02:25:19 +0000473# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
474# at the bottom of the documentation of classes and structs. If set to YES the
cristy3ed852e2009-09-05 21:47:34 +0000475# list will mention the files that were used to generate the documentation.
476
477SHOW_USED_FILES = YES
478
cristy4a760ec2010-05-08 02:25:19 +0000479# If the sources in your project are distributed over multiple directories
480# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
cristy3ed852e2009-09-05 21:47:34 +0000481# in the documentation. The default is NO.
482
483SHOW_DIRECTORIES = YES
484
cristy4a760ec2010-05-08 02:25:19 +0000485# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
486# This will remove the Files entry from the Quick Index and from the
487# Folder Tree View (if specified). The default is YES.
488
489SHOW_FILES = YES
490
491# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
492# Namespaces page.
493# This will remove the Namespaces entry from the Quick Index
494# and from the Folder Tree View (if specified). The default is YES.
495
496SHOW_NAMESPACES = YES
497
498# The FILE_VERSION_FILTER tag can be used to specify a program or script that
499# doxygen should invoke to get the current version for each file (typically from
500# the version control system). Doxygen will invoke the program by executing (via
501# popen()) the command <command> <input-file>, where <command> is the value of
502# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
503# provided by doxygen. Whatever the program writes to standard output
cristy3ed852e2009-09-05 21:47:34 +0000504# is used as the file version. See the manual for examples.
505
cristy4a760ec2010-05-08 02:25:19 +0000506FILE_VERSION_FILTER =
507
508# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
509# doxygen. The layout file controls the global structure of the generated output files
510# in an output format independent way. The create the layout file that represents
511# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
512# file name after the option, if omitted DoxygenLayout.xml will be used as the name
513# of the layout file.
514
515LAYOUT_FILE =
cristy3ed852e2009-09-05 21:47:34 +0000516
517#---------------------------------------------------------------------------
518# configuration options related to warning and progress messages
519#---------------------------------------------------------------------------
520
cristy4a760ec2010-05-08 02:25:19 +0000521# The QUIET tag can be used to turn on/off the messages that are generated
cristy3ed852e2009-09-05 21:47:34 +0000522# by doxygen. Possible values are YES and NO. If left blank NO is used.
523
524QUIET = NO
525
cristy4a760ec2010-05-08 02:25:19 +0000526# The WARNINGS tag can be used to turn on/off the warning messages that are
527# generated by doxygen. Possible values are YES and NO. If left blank
cristy3ed852e2009-09-05 21:47:34 +0000528# NO is used.
529
530WARNINGS = YES
531
cristy4a760ec2010-05-08 02:25:19 +0000532# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
533# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
cristy3ed852e2009-09-05 21:47:34 +0000534# automatically be disabled.
535
536WARN_IF_UNDOCUMENTED = YES
537
cristy4a760ec2010-05-08 02:25:19 +0000538# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
539# potential errors in the documentation, such as not documenting some
540# parameters in a documented function, or documenting parameters that
cristy3ed852e2009-09-05 21:47:34 +0000541# don't exist or using markup commands wrongly.
542
543WARN_IF_DOC_ERROR = YES
544
cristy4a760ec2010-05-08 02:25:19 +0000545# This WARN_NO_PARAMDOC option can be abled to get warnings for
546# functions that are documented, but have no documentation for their parameters
547# or return value. If set to NO (the default) doxygen will only warn about
548# wrong or incomplete parameter documentation, but not about the absence of
cristy3ed852e2009-09-05 21:47:34 +0000549# documentation.
550
551WARN_NO_PARAMDOC = NO
552
cristy4a760ec2010-05-08 02:25:19 +0000553# The WARN_FORMAT tag determines the format of the warning messages that
554# doxygen can produce. The string should contain the $file, $line, and $text
555# tags, which will be replaced by the file and line number from which the
556# warning originated and the warning text. Optionally the format may contain
557# $version, which will be replaced by the version of the file (if it could
cristy3ed852e2009-09-05 21:47:34 +0000558# be obtained via FILE_VERSION_FILTER)
559
560WARN_FORMAT = "$file:$line: $text "
561
cristy4a760ec2010-05-08 02:25:19 +0000562# The WARN_LOGFILE tag can be used to specify a file to which warning
563# and error messages should be written. If left blank the output is written
cristy3ed852e2009-09-05 21:47:34 +0000564# to stderr.
565
cristy4a760ec2010-05-08 02:25:19 +0000566WARN_LOGFILE =
cristy3ed852e2009-09-05 21:47:34 +0000567
568#---------------------------------------------------------------------------
569# configuration options related to the input files
570#---------------------------------------------------------------------------
571
cristy4a760ec2010-05-08 02:25:19 +0000572# The INPUT tag can be used to specify the files and/or directories that contain
573# documented source files. You may enter file names like "myfile.cpp" or
574# directories like "/usr/src/myproject". Separate the files or directories
cristy3ed852e2009-09-05 21:47:34 +0000575# with spaces.
576
577INPUT = magick
578
cristy4a760ec2010-05-08 02:25:19 +0000579# This tag can be used to specify the character encoding of the source files
580# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
581# also the default input encoding. Doxygen uses libiconv (or the iconv built
582# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
583# the list of possible encodings.
cristy3ed852e2009-09-05 21:47:34 +0000584
585INPUT_ENCODING = UTF-8
586
cristy4a760ec2010-05-08 02:25:19 +0000587# If the value of the INPUT tag contains directories, you can use the
588# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
589# and *.h) to filter out the source-files in the directories. If left
590# blank the following patterns are tested:
591# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
cristy3ed852e2009-09-05 21:47:34 +0000592# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
593
594FILE_PATTERNS = *.c \
595 *.h
596
cristy4a760ec2010-05-08 02:25:19 +0000597# The RECURSIVE tag can be used to turn specify whether or not subdirectories
598# should be searched for input files as well. Possible values are YES and NO.
cristy3ed852e2009-09-05 21:47:34 +0000599# If left blank NO is used.
600
601RECURSIVE = NO
602
cristy4a760ec2010-05-08 02:25:19 +0000603# The EXCLUDE tag can be used to specify files and/or directories that should
604# excluded from the INPUT source files. This way you can easily exclude a
cristy3ed852e2009-09-05 21:47:34 +0000605# subdirectory from a directory tree whose root is specified with the INPUT tag.
606
cristy4a760ec2010-05-08 02:25:19 +0000607EXCLUDE =
cristy3ed852e2009-09-05 21:47:34 +0000608
cristy4a760ec2010-05-08 02:25:19 +0000609# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
610# directories that are symbolic links (a Unix filesystem feature) are excluded
cristy3ed852e2009-09-05 21:47:34 +0000611# from the input.
612
613EXCLUDE_SYMLINKS = NO
614
cristy4a760ec2010-05-08 02:25:19 +0000615# If the value of the INPUT tag contains directories, you can use the
616# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
617# certain files from those directories. Note that the wildcards are matched
618# against the file with absolute path, so to exclude all test directories
cristy3ed852e2009-09-05 21:47:34 +0000619# for example use the pattern */test/*
620
cristy4a760ec2010-05-08 02:25:19 +0000621EXCLUDE_PATTERNS =
cristy3ed852e2009-09-05 21:47:34 +0000622
cristy4a760ec2010-05-08 02:25:19 +0000623# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
624# (namespaces, classes, functions, etc.) that should be excluded from the
625# output. The symbol name can be a fully qualified name, a word, or if the
626# wildcard * is used, a substring. Examples: ANamespace, AClass,
627# AClass::ANamespace, ANamespace::*Test
cristy3ed852e2009-09-05 21:47:34 +0000628
cristy4a760ec2010-05-08 02:25:19 +0000629EXCLUDE_SYMBOLS =
cristy3ed852e2009-09-05 21:47:34 +0000630
cristy4a760ec2010-05-08 02:25:19 +0000631# The EXAMPLE_PATH tag can be used to specify one or more files or
632# directories that contain example code fragments that are included (see
cristy3ed852e2009-09-05 21:47:34 +0000633# the \include command).
634
635EXAMPLE_PATH = .
636
cristy4a760ec2010-05-08 02:25:19 +0000637# If the value of the EXAMPLE_PATH tag contains directories, you can use the
638# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
639# and *.h) to filter out the source-files in the directories. If left
cristy3ed852e2009-09-05 21:47:34 +0000640# blank all files are included.
641
cristy4a760ec2010-05-08 02:25:19 +0000642EXAMPLE_PATTERNS =
cristy3ed852e2009-09-05 21:47:34 +0000643
cristy4a760ec2010-05-08 02:25:19 +0000644# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
645# searched for input files to be used with the \include or \dontinclude
646# commands irrespective of the value of the RECURSIVE tag.
cristy3ed852e2009-09-05 21:47:34 +0000647# Possible values are YES and NO. If left blank NO is used.
648
649EXAMPLE_RECURSIVE = NO
650
cristy4a760ec2010-05-08 02:25:19 +0000651# The IMAGE_PATH tag can be used to specify one or more files or
652# directories that contain image that are included in the documentation (see
cristy3ed852e2009-09-05 21:47:34 +0000653# the \image command).
654
cristy4a760ec2010-05-08 02:25:19 +0000655IMAGE_PATH =
cristy3ed852e2009-09-05 21:47:34 +0000656
cristy4a760ec2010-05-08 02:25:19 +0000657# The INPUT_FILTER tag can be used to specify a program that doxygen should
658# invoke to filter for each input file. Doxygen will invoke the filter program
659# by executing (via popen()) the command <filter> <input-file>, where <filter>
660# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
661# input file. Doxygen will then use the output that the filter program writes
662# to standard output.
663# If FILTER_PATTERNS is specified, this tag will be
cristy3ed852e2009-09-05 21:47:34 +0000664# ignored.
665
cristy4a760ec2010-05-08 02:25:19 +0000666INPUT_FILTER =
cristy3ed852e2009-09-05 21:47:34 +0000667
cristy4a760ec2010-05-08 02:25:19 +0000668# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
669# basis.
670# Doxygen will compare the file name with each pattern and apply the
671# filter if there is a match.
672# The filters are a list of the form:
673# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
674# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
cristy3ed852e2009-09-05 21:47:34 +0000675# is applied to all files.
676
cristy4a760ec2010-05-08 02:25:19 +0000677FILTER_PATTERNS =
cristy3ed852e2009-09-05 21:47:34 +0000678
cristy4a760ec2010-05-08 02:25:19 +0000679# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
680# INPUT_FILTER) will be used to filter the input files when producing source
cristy3ed852e2009-09-05 21:47:34 +0000681# files to browse (i.e. when SOURCE_BROWSER is set to YES).
682
683FILTER_SOURCE_FILES = NO
684
685#---------------------------------------------------------------------------
686# configuration options related to source browsing
687#---------------------------------------------------------------------------
688
cristy4a760ec2010-05-08 02:25:19 +0000689# If the SOURCE_BROWSER tag is set to YES then a list of source files will
690# be generated. Documented entities will be cross-referenced with these sources.
691# Note: To get rid of all source code in the generated output, make sure also
692# VERBATIM_HEADERS is set to NO.
cristy3ed852e2009-09-05 21:47:34 +0000693
694SOURCE_BROWSER = NO
695
cristy4a760ec2010-05-08 02:25:19 +0000696# Setting the INLINE_SOURCES tag to YES will include the body
cristy3ed852e2009-09-05 21:47:34 +0000697# of functions and classes directly in the documentation.
698
699INLINE_SOURCES = NO
700
cristy4a760ec2010-05-08 02:25:19 +0000701# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
702# doxygen to hide any special comment blocks from generated source code
cristy3ed852e2009-09-05 21:47:34 +0000703# fragments. Normal C and C++ comments will always remain visible.
704
705STRIP_CODE_COMMENTS = YES
706
cristy4a760ec2010-05-08 02:25:19 +0000707# If the REFERENCED_BY_RELATION tag is set to YES
708# then for each documented function all documented
cristy3ed852e2009-09-05 21:47:34 +0000709# functions referencing it will be listed.
710
711REFERENCED_BY_RELATION = YES
712
cristy4a760ec2010-05-08 02:25:19 +0000713# If the REFERENCES_RELATION tag is set to YES
714# then for each documented function all documented entities
cristy3ed852e2009-09-05 21:47:34 +0000715# called/used by that function will be listed.
716
717REFERENCES_RELATION = YES
718
719# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
720# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
721# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
cristy4a760ec2010-05-08 02:25:19 +0000722# link to the source code.
723# Otherwise they will link to the documentation.
cristy3ed852e2009-09-05 21:47:34 +0000724
725REFERENCES_LINK_SOURCE = YES
726
cristy4a760ec2010-05-08 02:25:19 +0000727# If the USE_HTAGS tag is set to YES then the references to source code
728# will point to the HTML generated by the htags(1) tool instead of doxygen
729# built-in source browser. The htags tool is part of GNU's global source
730# tagging system (see http://www.gnu.org/software/global/global.html). You
cristy3ed852e2009-09-05 21:47:34 +0000731# will need version 4.8.6 or higher.
732
733USE_HTAGS = NO
734
cristy4a760ec2010-05-08 02:25:19 +0000735# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
736# will generate a verbatim copy of the header file for each class for
cristy3ed852e2009-09-05 21:47:34 +0000737# which an include is specified. Set to NO to disable this.
738
739VERBATIM_HEADERS = YES
740
741#---------------------------------------------------------------------------
742# configuration options related to the alphabetical class index
743#---------------------------------------------------------------------------
744
cristy4a760ec2010-05-08 02:25:19 +0000745# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
746# of all compounds will be generated. Enable this if the project
cristy3ed852e2009-09-05 21:47:34 +0000747# contains a lot of classes, structs, unions or interfaces.
748
749ALPHABETICAL_INDEX = YES
750
cristy4a760ec2010-05-08 02:25:19 +0000751# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
752# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
cristy3ed852e2009-09-05 21:47:34 +0000753# in which this list will be split (can be a number in the range [1..20])
754
755COLS_IN_ALPHA_INDEX = 8
756
cristy4a760ec2010-05-08 02:25:19 +0000757# In case all classes in a project start with a common prefix, all
758# classes will be put under the same header in the alphabetical index.
759# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
cristy3ed852e2009-09-05 21:47:34 +0000760# should be ignored while generating the index headers.
761
cristy4a760ec2010-05-08 02:25:19 +0000762IGNORE_PREFIX =
cristy3ed852e2009-09-05 21:47:34 +0000763
764#---------------------------------------------------------------------------
765# configuration options related to the HTML output
766#---------------------------------------------------------------------------
767
cristy4a760ec2010-05-08 02:25:19 +0000768# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
cristy3ed852e2009-09-05 21:47:34 +0000769# generate HTML output.
770
771GENERATE_HTML = YES
772
cristy4a760ec2010-05-08 02:25:19 +0000773# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
774# If a relative path is entered the value of OUTPUT_DIRECTORY will be
cristy3ed852e2009-09-05 21:47:34 +0000775# put in front of it. If left blank `html' will be used as the default path.
776
777HTML_OUTPUT = MagickCore
778
cristy4a760ec2010-05-08 02:25:19 +0000779# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
780# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
cristy3ed852e2009-09-05 21:47:34 +0000781# doxygen will generate files with .html extension.
782
783HTML_FILE_EXTENSION = .html
784
cristy4a760ec2010-05-08 02:25:19 +0000785# The HTML_HEADER tag can be used to specify a personal HTML header for
786# each generated HTML page. If it is left blank doxygen will generate a
cristy3ed852e2009-09-05 21:47:34 +0000787# standard header.
788
cristy4a760ec2010-05-08 02:25:19 +0000789HTML_HEADER =
cristy3ed852e2009-09-05 21:47:34 +0000790
cristy4a760ec2010-05-08 02:25:19 +0000791# The HTML_FOOTER tag can be used to specify a personal HTML footer for
792# each generated HTML page. If it is left blank doxygen will generate a
cristy3ed852e2009-09-05 21:47:34 +0000793# standard footer.
794
cristy4a760ec2010-05-08 02:25:19 +0000795HTML_FOOTER =
cristy3ed852e2009-09-05 21:47:34 +0000796
cristy4a760ec2010-05-08 02:25:19 +0000797# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
798# documentation will contain the timesstamp.
799
800HTML_TIMESTAMP = NO
801
802# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
803# style sheet that is used by each HTML page. It can be used to
804# fine-tune the look of the HTML output. If the tag is left blank doxygen
805# will generate a default style sheet. Note that doxygen will try to copy
806# the style sheet file to the HTML output directory, so don't put your own
cristy3ed852e2009-09-05 21:47:34 +0000807# stylesheet in the HTML output directory as well, or it will be erased!
808
cristy4a760ec2010-05-08 02:25:19 +0000809HTML_STYLESHEET =
cristy3ed852e2009-09-05 21:47:34 +0000810
cristy4a760ec2010-05-08 02:25:19 +0000811# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
812# page will contain the date and time when the page was generated. Setting
813# this to NO can help when comparing the output of multiple runs.
814
815HTML_TIMESTAMP = NO
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
cristy3ed852e2009-09-05 21:47:34 +0000819# NO a bullet list will be used.
820
821HTML_ALIGN_MEMBERS = YES
822
cristy4a760ec2010-05-08 02:25:19 +0000823# 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
cristy3ed852e2009-09-05 21:47:34 +0000827# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
828
829HTML_DYNAMIC_SECTIONS = NO
830
cristy4a760ec2010-05-08 02:25:19 +0000831# 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
cristy3ed852e2009-09-05 21:47:34 +0000867# written to the html output directory.
868
cristy4a760ec2010-05-08 02:25:19 +0000869CHM_FILE =
cristy3ed852e2009-09-05 21:47:34 +0000870
cristy4a760ec2010-05-08 02:25:19 +0000871# 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
cristy3ed852e2009-09-05 21:47:34 +0000874# the HTML help compiler on the generated index.hhp.
875
cristy4a760ec2010-05-08 02:25:19 +0000876HHC_LOCATION =
cristy3ed852e2009-09-05 21:47:34 +0000877
cristy4a760ec2010-05-08 02:25:19 +0000878# 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
cristy3ed852e2009-09-05 21:47:34 +0000880# it should be included in the master .chm file (NO).
881
882GENERATE_CHI = NO
883
cristy4a760ec2010-05-08 02:25:19 +0000884# 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
cristy3ed852e2009-09-05 21:47:34 +0000892# normal table of contents (NO) in the .chm file.
893
894BINARY_TOC = NO
895
cristy4a760ec2010-05-08 02:25:19 +0000896# The TOC_EXPAND flag can be set to YES to add extra items for group members
cristy3ed852e2009-09-05 21:47:34 +0000897# to the contents of the HTML help documentation and to the tree view.
898
899TOC_EXPAND = YES
900
cristy4a760ec2010-05-08 02:25:19 +0000901# 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 = org.doxygen.Project
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# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
951# will be generated, which together with the HTML files, form an Eclipse help
952# plugin. To install this plugin and make it available under the help contents
953# menu in Eclipse, the contents of the directory containing the HTML and XML
954# files needs to be copied into the plugins directory of eclipse. The name of
955# the directory within the plugins directory should be the same as
956# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
957
958GENERATE_ECLIPSEHELP = NO
959
960# A unique identifier for the eclipse help plugin. When installing the plugin
961# the directory name containing the HTML and XML files should also have
962# this name.
963
964ECLIPSE_DOC_ID = org.doxygen.Project
965
966# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
967# top of each HTML page. The value NO (the default) enables the index and
cristy3ed852e2009-09-05 21:47:34 +0000968# the value YES disables it.
969
970DISABLE_INDEX = YES
971
cristy4a760ec2010-05-08 02:25:19 +0000972# This tag can be used to set the number of enum values (range [1..20])
cristy3ed852e2009-09-05 21:47:34 +0000973# that doxygen will group on one line in the generated HTML documentation.
974
975ENUM_VALUES_PER_LINE = 4
976
cristy4a760ec2010-05-08 02:25:19 +0000977# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
978# structure should be generated to display hierarchical information.
979# If the tag value is set to YES, a side panel will be generated
980# containing a tree-like index structure (just like the one that
981# is generated for HTML Help). For this to work a browser that supports
982# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
983# Windows users are probably better off using the HTML help feature.
cristy3ed852e2009-09-05 21:47:34 +0000984
985GENERATE_TREEVIEW = YES
986
cristy4a760ec2010-05-08 02:25:19 +0000987# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
988# and Class Hierarchy pages using a tree view instead of an ordered list.
989
990USE_INLINE_TREES = NO
991
992# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
993# used to set the initial width (in pixels) of the frame in which the tree
cristy3ed852e2009-09-05 21:47:34 +0000994# is shown.
995
996TREEVIEW_WIDTH = 250
997
cristy4a760ec2010-05-08 02:25:19 +0000998# Use this tag to change the font size of Latex formulas included
999# as images in the HTML documentation. The default is 10. Note that
1000# when you change the font size after a successful doxygen run you need
1001# to manually remove any form_*.png images from the HTML output directory
1002# to force them to be regenerated.
1003
1004FORMULA_FONTSIZE = 10
1005
1006# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
1007# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
1008# typically be disabled. For large projects the javascript based search engine
1009# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1010
1011SEARCHENGINE = NO
1012
1013# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
1014# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
1015# and does not have live searching capabilities.
1016
1017SERVER_BASED_SEARCH = NO
1018
cristy3ed852e2009-09-05 21:47:34 +00001019#---------------------------------------------------------------------------
1020# configuration options related to the LaTeX output
1021#---------------------------------------------------------------------------
1022
cristy4a760ec2010-05-08 02:25:19 +00001023# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
cristy3ed852e2009-09-05 21:47:34 +00001024# generate Latex output.
1025
1026GENERATE_LATEX = NO
1027
cristy4a760ec2010-05-08 02:25:19 +00001028# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1029# If a relative path is entered the value of OUTPUT_DIRECTORY will be
cristy3ed852e2009-09-05 21:47:34 +00001030# put in front of it. If left blank `latex' will be used as the default path.
1031
1032LATEX_OUTPUT = latex
1033
cristy4a760ec2010-05-08 02:25:19 +00001034# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
cristy3ed852e2009-09-05 21:47:34 +00001035# invoked. If left blank `latex' will be used as the default command name.
cristy4a760ec2010-05-08 02:25:19 +00001036# Note that when enabling USE_PDFLATEX this option is only used for
1037# generating bitmaps for formulas in the HTML output, but not in the
1038# Makefile that is written to the output directory.
cristy3ed852e2009-09-05 21:47:34 +00001039
1040LATEX_CMD_NAME = latex
1041
cristy4a760ec2010-05-08 02:25:19 +00001042# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1043# generate index for LaTeX. If left blank `makeindex' will be used as the
cristy3ed852e2009-09-05 21:47:34 +00001044# default command name.
1045
1046MAKEINDEX_CMD_NAME = makeindex
1047
cristy4a760ec2010-05-08 02:25:19 +00001048# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1049# LaTeX documents. This may be useful for small projects and may help to
cristy3ed852e2009-09-05 21:47:34 +00001050# save some trees in general.
1051
1052COMPACT_LATEX = NO
1053
cristy4a760ec2010-05-08 02:25:19 +00001054# The PAPER_TYPE tag can be used to set the paper type that is used
1055# by the printer. Possible values are: a4, a4wide, letter, legal and
cristy3ed852e2009-09-05 21:47:34 +00001056# executive. If left blank a4wide will be used.
1057
1058PAPER_TYPE = a4wide
1059
cristy4a760ec2010-05-08 02:25:19 +00001060# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
cristy3ed852e2009-09-05 21:47:34 +00001061# packages that should be included in the LaTeX output.
1062
cristy4a760ec2010-05-08 02:25:19 +00001063EXTRA_PACKAGES =
cristy3ed852e2009-09-05 21:47:34 +00001064
cristy4a760ec2010-05-08 02:25:19 +00001065# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1066# the generated latex document. The header should contain everything until
1067# the first chapter. If it is left blank doxygen will generate a
cristy3ed852e2009-09-05 21:47:34 +00001068# standard header. Notice: only use this tag if you know what you are doing!
1069
cristy4a760ec2010-05-08 02:25:19 +00001070LATEX_HEADER =
cristy3ed852e2009-09-05 21:47:34 +00001071
cristy4a760ec2010-05-08 02:25:19 +00001072# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1073# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1074# contain links (just like the HTML output) instead of page references
cristy3ed852e2009-09-05 21:47:34 +00001075# This makes the output suitable for online browsing using a pdf viewer.
1076
1077PDF_HYPERLINKS = NO
1078
cristy4a760ec2010-05-08 02:25:19 +00001079# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1080# plain latex in the generated Makefile. Set this option to YES to get a
cristy3ed852e2009-09-05 21:47:34 +00001081# higher quality PDF documentation.
1082
1083USE_PDFLATEX = NO
1084
cristy4a760ec2010-05-08 02:25:19 +00001085# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1086# command to the generated LaTeX files. This will instruct LaTeX to keep
1087# running if errors occur, instead of asking the user for help.
cristy3ed852e2009-09-05 21:47:34 +00001088# This option is also used when generating formulas in HTML.
1089
1090LATEX_BATCHMODE = NO
1091
cristy4a760ec2010-05-08 02:25:19 +00001092# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1093# include the index chapters (such as File Index, Compound Index, etc.)
cristy3ed852e2009-09-05 21:47:34 +00001094# in the output.
1095
1096LATEX_HIDE_INDICES = NO
1097
cristy4a760ec2010-05-08 02:25:19 +00001098# 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.
1099
1100LATEX_SOURCE_CODE = NO
1101
cristy3ed852e2009-09-05 21:47:34 +00001102#---------------------------------------------------------------------------
1103# configuration options related to the RTF output
1104#---------------------------------------------------------------------------
1105
cristy4a760ec2010-05-08 02:25:19 +00001106# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1107# The RTF output is optimized for Word 97 and may not look very pretty with
cristy3ed852e2009-09-05 21:47:34 +00001108# other RTF readers or editors.
1109
1110GENERATE_RTF = NO
1111
cristy4a760ec2010-05-08 02:25:19 +00001112# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1113# If a relative path is entered the value of OUTPUT_DIRECTORY will be
cristy3ed852e2009-09-05 21:47:34 +00001114# put in front of it. If left blank `rtf' will be used as the default path.
1115
1116RTF_OUTPUT = rtf
1117
cristy4a760ec2010-05-08 02:25:19 +00001118# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1119# RTF documents. This may be useful for small projects and may help to
cristy3ed852e2009-09-05 21:47:34 +00001120# save some trees in general.
1121
1122COMPACT_RTF = NO
1123
cristy4a760ec2010-05-08 02:25:19 +00001124# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1125# will contain hyperlink fields. The RTF file will
1126# contain links (just like the HTML output) instead of page references.
1127# This makes the output suitable for online browsing using WORD or other
1128# programs which support those fields.
cristy3ed852e2009-09-05 21:47:34 +00001129# Note: wordpad (write) and others do not support links.
1130
1131RTF_HYPERLINKS = NO
1132
cristy4a760ec2010-05-08 02:25:19 +00001133# Load stylesheet definitions from file. Syntax is similar to doxygen's
1134# config file, i.e. a series of assignments. You only have to provide
cristy3ed852e2009-09-05 21:47:34 +00001135# replacements, missing definitions are set to their default value.
1136
cristy4a760ec2010-05-08 02:25:19 +00001137RTF_STYLESHEET_FILE =
cristy3ed852e2009-09-05 21:47:34 +00001138
cristy4a760ec2010-05-08 02:25:19 +00001139# Set optional variables used in the generation of an rtf document.
cristy3ed852e2009-09-05 21:47:34 +00001140# Syntax is similar to doxygen's config file.
1141
cristy4a760ec2010-05-08 02:25:19 +00001142RTF_EXTENSIONS_FILE =
cristy3ed852e2009-09-05 21:47:34 +00001143
1144#---------------------------------------------------------------------------
1145# configuration options related to the man page output
1146#---------------------------------------------------------------------------
1147
cristy4a760ec2010-05-08 02:25:19 +00001148# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
cristy3ed852e2009-09-05 21:47:34 +00001149# generate man pages
1150
1151GENERATE_MAN = NO
1152
cristy4a760ec2010-05-08 02:25:19 +00001153# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1154# If a relative path is entered the value of OUTPUT_DIRECTORY will be
cristy3ed852e2009-09-05 21:47:34 +00001155# put in front of it. If left blank `man' will be used as the default path.
1156
1157MAN_OUTPUT = man
1158
cristy4a760ec2010-05-08 02:25:19 +00001159# The MAN_EXTENSION tag determines the extension that is added to
cristy3ed852e2009-09-05 21:47:34 +00001160# the generated man pages (default is the subroutine's section .3)
1161
1162MAN_EXTENSION = .3
1163
cristy4a760ec2010-05-08 02:25:19 +00001164# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1165# then it will generate one additional man file for each entity
1166# documented in the real man page(s). These additional files
1167# only source the real man page, but without them the man command
cristy3ed852e2009-09-05 21:47:34 +00001168# would be unable to find the correct page. The default is NO.
1169
1170MAN_LINKS = NO
1171
1172#---------------------------------------------------------------------------
1173# configuration options related to the XML output
1174#---------------------------------------------------------------------------
1175
cristy4a760ec2010-05-08 02:25:19 +00001176# If the GENERATE_XML tag is set to YES Doxygen will
1177# generate an XML file that captures the structure of
cristy3ed852e2009-09-05 21:47:34 +00001178# the code including all documentation.
1179
1180GENERATE_XML = NO
1181
cristy4a760ec2010-05-08 02:25:19 +00001182# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1183# If a relative path is entered the value of OUTPUT_DIRECTORY will be
cristy3ed852e2009-09-05 21:47:34 +00001184# put in front of it. If left blank `xml' will be used as the default path.
1185
1186XML_OUTPUT = xml
1187
cristy4a760ec2010-05-08 02:25:19 +00001188# The XML_SCHEMA tag can be used to specify an XML schema,
1189# which can be used by a validating XML parser to check the
cristy3ed852e2009-09-05 21:47:34 +00001190# syntax of the XML files.
1191
cristy4a760ec2010-05-08 02:25:19 +00001192XML_SCHEMA =
cristy3ed852e2009-09-05 21:47:34 +00001193
cristy4a760ec2010-05-08 02:25:19 +00001194# The XML_DTD tag can be used to specify an XML DTD,
1195# which can be used by a validating XML parser to check the
cristy3ed852e2009-09-05 21:47:34 +00001196# syntax of the XML files.
1197
cristy4a760ec2010-05-08 02:25:19 +00001198XML_DTD =
cristy3ed852e2009-09-05 21:47:34 +00001199
cristy4a760ec2010-05-08 02:25:19 +00001200# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1201# dump the program listings (including syntax highlighting
1202# and cross-referencing information) to the XML output. Note that
cristy3ed852e2009-09-05 21:47:34 +00001203# enabling this will significantly increase the size of the XML output.
1204
1205XML_PROGRAMLISTING = YES
1206
1207#---------------------------------------------------------------------------
1208# configuration options for the AutoGen Definitions output
1209#---------------------------------------------------------------------------
1210
cristy4a760ec2010-05-08 02:25:19 +00001211# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1212# generate an AutoGen Definitions (see autogen.sf.net) file
1213# that captures the structure of the code including all
1214# documentation. Note that this feature is still experimental
cristy3ed852e2009-09-05 21:47:34 +00001215# and incomplete at the moment.
1216
1217GENERATE_AUTOGEN_DEF = NO
1218
1219#---------------------------------------------------------------------------
1220# configuration options related to the Perl module output
1221#---------------------------------------------------------------------------
1222
cristy4a760ec2010-05-08 02:25:19 +00001223# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1224# generate a Perl module file that captures the structure of
1225# the code including all documentation. Note that this
1226# feature is still experimental and incomplete at the
cristy3ed852e2009-09-05 21:47:34 +00001227# moment.
1228
1229GENERATE_PERLMOD = NO
1230
cristy4a760ec2010-05-08 02:25:19 +00001231# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1232# the necessary Makefile rules, Perl scripts and LaTeX code to be able
cristy3ed852e2009-09-05 21:47:34 +00001233# to generate PDF and DVI output from the Perl module output.
1234
1235PERLMOD_LATEX = NO
1236
cristy4a760ec2010-05-08 02:25:19 +00001237# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1238# nicely formatted so it can be parsed by a human reader.
1239# This is useful
1240# if you want to understand what is going on.
1241# On the other hand, if this
1242# tag is set to NO the size of the Perl module output will be much smaller
cristy3ed852e2009-09-05 21:47:34 +00001243# and Perl will parse it just the same.
1244
1245PERLMOD_PRETTY = YES
1246
cristy4a760ec2010-05-08 02:25:19 +00001247# The names of the make variables in the generated doxyrules.make file
1248# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1249# This is useful so different doxyrules.make files included by the same
cristy3ed852e2009-09-05 21:47:34 +00001250# Makefile don't overwrite each other's variables.
1251
cristy4a760ec2010-05-08 02:25:19 +00001252PERLMOD_MAKEVAR_PREFIX =
cristy3ed852e2009-09-05 21:47:34 +00001253
1254#---------------------------------------------------------------------------
cristy4a760ec2010-05-08 02:25:19 +00001255# Configuration options related to the preprocessor
cristy3ed852e2009-09-05 21:47:34 +00001256#---------------------------------------------------------------------------
1257
cristy4a760ec2010-05-08 02:25:19 +00001258# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1259# evaluate all C-preprocessor directives found in the sources and include
cristy3ed852e2009-09-05 21:47:34 +00001260# files.
1261
1262ENABLE_PREPROCESSING = YES
1263
cristy4a760ec2010-05-08 02:25:19 +00001264# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1265# names in the source code. If set to NO (the default) only conditional
1266# compilation will be performed. Macro expansion can be done in a controlled
cristy3ed852e2009-09-05 21:47:34 +00001267# way by setting EXPAND_ONLY_PREDEF to YES.
1268
1269MACRO_EXPANSION = NO
1270
cristy4a760ec2010-05-08 02:25:19 +00001271# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1272# then the macro expansion is limited to the macros specified with the
cristy3ed852e2009-09-05 21:47:34 +00001273# PREDEFINED and EXPAND_AS_DEFINED tags.
1274
1275EXPAND_ONLY_PREDEF = NO
1276
cristy4a760ec2010-05-08 02:25:19 +00001277# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
cristy3ed852e2009-09-05 21:47:34 +00001278# in the INCLUDE_PATH (see below) will be search if a #include is found.
1279
1280SEARCH_INCLUDES = YES
1281
cristy4a760ec2010-05-08 02:25:19 +00001282# The INCLUDE_PATH tag can be used to specify one or more directories that
1283# contain include files that are not input files but should be processed by
cristy3ed852e2009-09-05 21:47:34 +00001284# the preprocessor.
1285
cristy4a760ec2010-05-08 02:25:19 +00001286INCLUDE_PATH =
cristy3ed852e2009-09-05 21:47:34 +00001287
cristy4a760ec2010-05-08 02:25:19 +00001288# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1289# patterns (like *.h and *.hpp) to filter out the header-files in the
1290# directories. If left blank, the patterns specified with FILE_PATTERNS will
cristy3ed852e2009-09-05 21:47:34 +00001291# be used.
1292
cristy4a760ec2010-05-08 02:25:19 +00001293INCLUDE_FILE_PATTERNS =
cristy3ed852e2009-09-05 21:47:34 +00001294
cristy4a760ec2010-05-08 02:25:19 +00001295# The PREDEFINED tag can be used to specify one or more macro names that
1296# are defined before the preprocessor is started (similar to the -D option of
1297# gcc). The argument of the tag is a list of macros of the form: name
1298# or name=definition (no spaces). If the definition and the = are
1299# omitted =1 is assumed. To prevent a macro definition from being
1300# undefined via #undef or recursively expanded use the := operator
cristy3ed852e2009-09-05 21:47:34 +00001301# instead of the = operator.
1302
cristy4a760ec2010-05-08 02:25:19 +00001303PREDEFINED =
cristy3ed852e2009-09-05 21:47:34 +00001304
cristy4a760ec2010-05-08 02:25:19 +00001305# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1306# this tag can be used to specify a list of macro names that should be expanded.
1307# The macro definition that is found in the sources will be used.
cristy3ed852e2009-09-05 21:47:34 +00001308# Use the PREDEFINED tag if you want to use a different macro definition.
1309
cristy4a760ec2010-05-08 02:25:19 +00001310EXPAND_AS_DEFINED =
cristy3ed852e2009-09-05 21:47:34 +00001311
cristy4a760ec2010-05-08 02:25:19 +00001312# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1313# doxygen's preprocessor will remove all function-like macros that are alone
1314# on a line, have an all uppercase name, and do not end with a semicolon. Such
1315# function macros are typically used for boiler-plate code, and will confuse
cristy3ed852e2009-09-05 21:47:34 +00001316# the parser if not removed.
1317
1318SKIP_FUNCTION_MACROS = YES
1319
1320#---------------------------------------------------------------------------
cristy4a760ec2010-05-08 02:25:19 +00001321# Configuration::additions related to external references
cristy3ed852e2009-09-05 21:47:34 +00001322#---------------------------------------------------------------------------
1323
cristy4a760ec2010-05-08 02:25:19 +00001324# The TAGFILES option can be used to specify one or more tagfiles.
1325# Optionally an initial location of the external documentation
1326# can be added for each tagfile. The format of a tag file without
1327# this location is as follows:
1328#
1329# TAGFILES = file1 file2 ...
1330# Adding location for the tag files is done as follows:
1331#
1332# TAGFILES = file1=loc1 "file2 = loc2" ...
1333# where "loc1" and "loc2" can be relative or absolute paths or
1334# URLs. If a location is present for each tag, the installdox tool
cristy3ed852e2009-09-05 21:47:34 +00001335# does not have to be run to correct the links.
1336# Note that each tag file must have a unique name
1337# (where the name does NOT include the path)
cristy4a760ec2010-05-08 02:25:19 +00001338# If a tag file is not located in the directory in which doxygen
cristy3ed852e2009-09-05 21:47:34 +00001339# is run, you must also specify the path to the tagfile here.
1340
cristy4a760ec2010-05-08 02:25:19 +00001341TAGFILES =
cristy3ed852e2009-09-05 21:47:34 +00001342
cristy4a760ec2010-05-08 02:25:19 +00001343# When a file name is specified after GENERATE_TAGFILE, doxygen will create
cristy3ed852e2009-09-05 21:47:34 +00001344# a tag file that is based on the input files it reads.
1345
cristy4a760ec2010-05-08 02:25:19 +00001346GENERATE_TAGFILE =
cristy3ed852e2009-09-05 21:47:34 +00001347
cristy4a760ec2010-05-08 02:25:19 +00001348# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1349# in the class index. If set to NO only the inherited external classes
cristy3ed852e2009-09-05 21:47:34 +00001350# will be listed.
1351
1352ALLEXTERNALS = NO
1353
cristy4a760ec2010-05-08 02:25:19 +00001354# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1355# in the modules index. If set to NO, only the current project's groups will
cristy3ed852e2009-09-05 21:47:34 +00001356# be listed.
1357
1358EXTERNAL_GROUPS = YES
1359
cristy4a760ec2010-05-08 02:25:19 +00001360# The PERL_PATH should be the absolute path and name of the perl script
cristy3ed852e2009-09-05 21:47:34 +00001361# interpreter (i.e. the result of `which perl').
1362
1363PERL_PATH = /usr/bin/perl
1364
1365#---------------------------------------------------------------------------
cristy4a760ec2010-05-08 02:25:19 +00001366# Configuration options related to the dot tool
cristy3ed852e2009-09-05 21:47:34 +00001367#---------------------------------------------------------------------------
1368
cristy4a760ec2010-05-08 02:25:19 +00001369# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1370# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1371# or super classes. Setting the tag to NO turns the diagrams off. Note that
1372# this option is superseded by the HAVE_DOT option below. This is only a
1373# fallback. It is recommended to install and use dot, since it yields more
cristy3ed852e2009-09-05 21:47:34 +00001374# powerful graphs.
1375
1376CLASS_DIAGRAMS = YES
1377
cristy4a760ec2010-05-08 02:25:19 +00001378# You can define message sequence charts within doxygen comments using the \msc
1379# command. Doxygen will then run the mscgen tool (see
1380# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1381# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1382# the mscgen tool resides. If left empty the tool is assumed to be found in the
1383# default search path.
cristy3ed852e2009-09-05 21:47:34 +00001384
cristy4a760ec2010-05-08 02:25:19 +00001385MSCGEN_PATH =
cristy3ed852e2009-09-05 21:47:34 +00001386
cristy4a760ec2010-05-08 02:25:19 +00001387# If set to YES, the inheritance and collaboration graphs will hide
1388# inheritance and usage relations if the target is undocumented
cristy3ed852e2009-09-05 21:47:34 +00001389# or is not a class.
1390
1391HIDE_UNDOC_RELATIONS = YES
1392
cristy4a760ec2010-05-08 02:25:19 +00001393# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1394# available from the path. This tool is part of Graphviz, a graph visualization
1395# toolkit from AT&T and Lucent Bell Labs. The other options in this section
cristy3ed852e2009-09-05 21:47:34 +00001396# have no effect if this option is set to NO (the default)
1397
1398HAVE_DOT = NO
1399
cristy4a760ec2010-05-08 02:25:19 +00001400# By default doxygen will write a font called FreeSans.ttf to the output
1401# directory and reference it in all dot files that doxygen generates. This
1402# font does not include all possible unicode characters however, so when you need
1403# these (or just want a differently looking font) you can specify the font name
1404# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1405# which can be done by putting it in a standard location or by setting the
1406# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1407# containing the font.
1408
1409DOT_FONTNAME = FreeSans
1410
1411# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1412# The default size is 10pt.
1413
1414DOT_FONTSIZE = 10
1415
1416# By default doxygen will tell dot to use the output directory to look for the
1417# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1418# different font using DOT_FONTNAME you can set the path where dot
1419# can find it using this tag.
1420
1421DOT_FONTPATH =
1422
1423# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1424# will generate a graph for each documented class showing the direct and
1425# indirect inheritance relations. Setting this tag to YES will force the
cristy3ed852e2009-09-05 21:47:34 +00001426# the CLASS_DIAGRAMS tag to NO.
1427
1428CLASS_GRAPH = YES
1429
cristy4a760ec2010-05-08 02:25:19 +00001430# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1431# will generate a graph for each documented class showing the direct and
1432# indirect implementation dependencies (inheritance, containment, and
cristy3ed852e2009-09-05 21:47:34 +00001433# class references variables) of the class with other documented classes.
1434
1435COLLABORATION_GRAPH = YES
1436
cristy4a760ec2010-05-08 02:25:19 +00001437# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
cristy3ed852e2009-09-05 21:47:34 +00001438# will generate a graph for groups, showing the direct groups dependencies
1439
1440GROUP_GRAPHS = YES
1441
cristy4a760ec2010-05-08 02:25:19 +00001442# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1443# collaboration diagrams in a style similar to the OMG's Unified Modeling
cristy3ed852e2009-09-05 21:47:34 +00001444# Language.
1445
1446UML_LOOK = NO
1447
cristy4a760ec2010-05-08 02:25:19 +00001448# If set to YES, the inheritance and collaboration graphs will show the
cristy3ed852e2009-09-05 21:47:34 +00001449# relations between templates and their instances.
1450
1451TEMPLATE_RELATIONS = NO
1452
cristy4a760ec2010-05-08 02:25:19 +00001453# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1454# tags are set to YES then doxygen will generate a graph for each documented
1455# file showing the direct and indirect include dependencies of the file with
cristy3ed852e2009-09-05 21:47:34 +00001456# other documented files.
1457
1458INCLUDE_GRAPH = YES
1459
cristy4a760ec2010-05-08 02:25:19 +00001460# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1461# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1462# documented header file showing the documented files that directly or
cristy3ed852e2009-09-05 21:47:34 +00001463# indirectly include this file.
1464
1465INCLUDED_BY_GRAPH = YES
1466
cristy4a760ec2010-05-08 02:25:19 +00001467# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1468# doxygen will generate a call dependency graph for every global function
1469# or class method. Note that enabling this option will significantly increase
1470# the time of a run. So in most cases it will be better to enable call graphs
1471# for selected functions only using the \callgraph command.
cristy3ed852e2009-09-05 21:47:34 +00001472
1473CALL_GRAPH = NO
1474
cristy4a760ec2010-05-08 02:25:19 +00001475# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1476# doxygen will generate a caller dependency graph for every global function
1477# or class method. Note that enabling this option will significantly increase
1478# the time of a run. So in most cases it will be better to enable caller
1479# graphs for selected functions only using the \callergraph command.
cristy3ed852e2009-09-05 21:47:34 +00001480
1481CALLER_GRAPH = NO
1482
cristy4a760ec2010-05-08 02:25:19 +00001483# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
cristy3ed852e2009-09-05 21:47:34 +00001484# will graphical hierarchy of all classes instead of a textual one.
1485
1486GRAPHICAL_HIERARCHY = YES
1487
cristy4a760ec2010-05-08 02:25:19 +00001488# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1489# then doxygen will show the dependencies a directory has on other directories
cristy3ed852e2009-09-05 21:47:34 +00001490# in a graphical way. The dependency relations are determined by the #include
1491# relations between the files in the directories.
1492
1493DIRECTORY_GRAPH = YES
1494
cristy4a760ec2010-05-08 02:25:19 +00001495# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
cristy3ed852e2009-09-05 21:47:34 +00001496# generated by dot. Possible values are png, jpg, or gif
1497# If left blank png will be used.
1498
1499DOT_IMAGE_FORMAT = png
1500
cristy4a760ec2010-05-08 02:25:19 +00001501# The tag DOT_PATH can be used to specify the path where the dot tool can be
cristy3ed852e2009-09-05 21:47:34 +00001502# found. If left blank, it is assumed the dot tool can be found in the path.
1503
cristy4a760ec2010-05-08 02:25:19 +00001504DOT_PATH =
cristy3ed852e2009-09-05 21:47:34 +00001505
cristy4a760ec2010-05-08 02:25:19 +00001506# The DOTFILE_DIRS tag can be used to specify one or more directories that
1507# contain dot files that are included in the documentation (see the
cristy3ed852e2009-09-05 21:47:34 +00001508# \dotfile command).
1509
cristy4a760ec2010-05-08 02:25:19 +00001510DOTFILE_DIRS =
cristy3ed852e2009-09-05 21:47:34 +00001511
cristy4a760ec2010-05-08 02:25:19 +00001512# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1513# nodes that will be shown in the graph. If the number of nodes in a graph
1514# becomes larger than this value, doxygen will truncate the graph, which is
1515# visualized by representing a node as a red box. Note that doxygen if the
1516# number of direct children of the root node in a graph is already larger than
1517# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
cristy3ed852e2009-09-05 21:47:34 +00001518# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1519
1520DOT_GRAPH_MAX_NODES = 50
1521
cristy4a760ec2010-05-08 02:25:19 +00001522# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1523# graphs generated by dot. A depth value of 3 means that only nodes reachable
1524# from the root by following a path via at most 3 edges will be shown. Nodes
1525# that lay further from the root node will be omitted. Note that setting this
1526# option to 1 or 2 may greatly reduce the computation time needed for large
1527# code bases. Also note that the size of a graph can be further restricted by
cristy3ed852e2009-09-05 21:47:34 +00001528# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1529
1530MAX_DOT_GRAPH_DEPTH = 0
1531
cristy4a760ec2010-05-08 02:25:19 +00001532# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1533# background. This is disabled by default, because dot on Windows does not
1534# seem to support this out of the box. Warning: Depending on the platform used,
1535# enabling this option may lead to badly anti-aliased labels on the edges of
1536# a graph (i.e. they become hard to read).
cristy3ed852e2009-09-05 21:47:34 +00001537
1538DOT_TRANSPARENT = NO
1539
cristy4a760ec2010-05-08 02:25:19 +00001540# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1541# files in one run (i.e. multiple -o and -T options on the command line). This
1542# makes dot run faster, but since only newer versions of dot (>1.8.10)
cristy3ed852e2009-09-05 21:47:34 +00001543# support this, this feature is disabled by default.
1544
1545DOT_MULTI_TARGETS = NO
1546
cristy4a760ec2010-05-08 02:25:19 +00001547# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1548# generate a legend page explaining the meaning of the various boxes and
cristy3ed852e2009-09-05 21:47:34 +00001549# arrows in the dot generated graphs.
1550
1551GENERATE_LEGEND = YES
1552
cristy4a760ec2010-05-08 02:25:19 +00001553# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1554# remove the intermediate dot files that are used to generate
cristy3ed852e2009-09-05 21:47:34 +00001555# the various graphs.
1556
1557DOT_CLEANUP = YES