blob: eec59c41ac9511d03e902fc0e8ff3b618e66d4c7 [file] [log] [blame]
Jose Fonseca375457b2004-09-09 22:23:24 +00001# Doxyfile 1.3.8
Jose Fonseca91096252003-09-17 17:07:24 +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#---------------------------------------------------------------------------
Jose Fonseca375457b2004-09-09 22:23:24 +000014# Project related configuration options
Jose Fonseca91096252003-09-17 17:07:24 +000015#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME = Mesa
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
Jerome Glisse515f4952007-02-16 23:22:04 +010026PROJECT_NUMBER = 6.5
Jose Fonseca91096252003-09-17 17:07:24 +000027
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33OUTPUT_DIRECTORY =
34
Jose Fonseca375457b2004-09-09 22:23:24 +000035# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36# 4096 sub-directories (in 2 levels) under the output directory of each output
37# format and will distribute the generated files over these directories.
38# Enabling this option can be useful when feeding doxygen a huge amount of source
39# files, where putting all generated files in the same directory would otherwise
40# cause performance problems for the file system.
41
42CREATE_SUBDIRS = NO
43
Jose Fonseca91096252003-09-17 17:07:24 +000044# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45# documentation generated by doxygen is written. Doxygen will use this
46# information to generate all constant output in the proper language.
47# The default language is English, other supported languages are:
Jose Fonseca375457b2004-09-09 22:23:24 +000048# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52# Swedish, and Ukrainian.
Jose Fonseca91096252003-09-17 17:07:24 +000053
54OUTPUT_LANGUAGE = English
55
Jose Fonseca375457b2004-09-09 22:23:24 +000056# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57# include brief member descriptions after the members that are listed in
58# the file and class documentation (similar to JavaDoc).
59# Set to NO to disable this.
60
61BRIEF_MEMBER_DESC = YES
62
63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64# the brief description of a member or function before the detailed description.
65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66# brief descriptions will be completely suppressed.
67
68REPEAT_BRIEF = YES
69
70# This tag implements a quasi-intelligent brief description abbreviator
71# that is used to form the text in various listings. Each string
72# in this list, if found as the leading text of the brief description, will be
73# stripped from the text and the result after processing the whole list, is used
74# as the annotated text. Otherwise, the brief description is used as-is. If left
75# blank, the following values are used ("$name" is automatically replaced with the
76# name of the entity): "The $name class" "The $name widget" "The $name file"
77# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
78
79ABBREVIATE_BRIEF =
80
81# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82# Doxygen will generate a detailed section even if there is only a brief
83# description.
84
85ALWAYS_DETAILED_SEC = NO
86
87# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88# members of a class in the documentation of that class as if those members were
89# ordinary class members. Constructors, destructors and assignment operators of
90# the base classes will not be shown.
91
92INLINE_INHERITED_MEMB = NO
93
94# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
95# path before files name in the file list and in the header files. If set
96# to NO the shortest path that makes the file name unique will be used.
97
98FULL_PATH_NAMES = NO
99
100# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101# can be used to strip a user-defined part of the path. Stripping is
102# only done if one of the specified strings matches the left-hand part of
103# the path. The tag can be used to show relative paths in the file list.
104# If left blank the directory from which doxygen is run is used as the
105# path to strip.
106
107STRIP_FROM_PATH =
108
109# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
110# the path mentioned in the documentation of a class, which tells
111# the reader which header file to include in order to use a class.
112# If left blank only the name of the header file containing the class
113# definition is used. Otherwise one should specify the include paths that
114# are normally passed to the compiler using the -I flag.
115
116STRIP_FROM_INC_PATH =
117
118# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
119# (but less readable) file names. This can be useful is your file systems
120# doesn't support long names like on DOS, Mac, or CD-ROM.
121
122SHORT_NAMES = NO
123
124# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
125# will interpret the first line (until the first dot) of a JavaDoc-style
126# comment as the brief description. If set to NO, the JavaDoc
127# comments will behave just like the Qt-style comments (thus requiring an
128# explicit @brief command for a brief description.
129
130JAVADOC_AUTOBRIEF = YES
131
132# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
133# treat a multi-line C++ special comment block (i.e. a block of //! or ///
134# comments) as a brief description. This used to be the default behaviour.
135# The new default is to treat a multi-line C++ comment block as a detailed
136# description. Set this tag to YES if you prefer the old behaviour instead.
137
138MULTILINE_CPP_IS_BRIEF = NO
139
Jose Fonseca375457b2004-09-09 22:23:24 +0000140# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
141# member inherits the documentation from any documented member that it
142# re-implements.
143
144INHERIT_DOCS = YES
145
146# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
147# tag is set to YES, then doxygen will reuse the documentation of the first
148# member in the group (if any) for the other members of the group. By default
149# all members of a group must be documented explicitly.
150
151DISTRIBUTE_GROUP_DOC = NO
152
153# The TAB_SIZE tag can be used to set the number of spaces in a tab.
154# Doxygen uses this value to replace tabs by spaces in code fragments.
155
156TAB_SIZE = 8
157
158# This tag can be used to specify a number of aliases that acts
159# as commands in the documentation. An alias has the form "name=value".
160# For example adding "sideeffect=\par Side Effects:\n" will allow you to
161# put the command \sideeffect (or @sideeffect) in the documentation, which
162# will result in a user-defined paragraph with heading "Side Effects:".
163# You can put \n's in the value part of an alias to insert newlines.
164
165ALIASES =
166
167# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
168# only. Doxygen will then generate output that is more tailored for C.
169# For instance, some of the names that are used will be different. The list
170# of all members will be omitted, etc.
171
172OPTIMIZE_OUTPUT_FOR_C = YES
173
174# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
175# only. Doxygen will then generate output that is more tailored for Java.
176# For instance, namespaces will be presented as packages, qualified scopes
177# will look different, etc.
178
179OPTIMIZE_OUTPUT_JAVA = NO
180
181# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
182# the same type (for instance a group of public functions) to be put as a
183# subgroup of that type (e.g. under the Public Functions section). Set it to
184# NO to prevent subgrouping. Alternatively, this can be done per class using
185# the \nosubgrouping command.
186
187SUBGROUPING = YES
188
189#---------------------------------------------------------------------------
190# Build related configuration options
191#---------------------------------------------------------------------------
192
Jose Fonseca91096252003-09-17 17:07:24 +0000193# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
194# documentation are documented, even if no documentation was available.
195# Private class members and static file members will be hidden unless
196# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
197
198EXTRACT_ALL = YES
199
200# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
201# will be included in the documentation.
202
203EXTRACT_PRIVATE = NO
204
205# If the EXTRACT_STATIC tag is set to YES all static members of a file
206# will be included in the documentation.
207
208EXTRACT_STATIC = YES
209
210# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
211# defined locally in source files will be included in the documentation.
212# If set to NO only classes defined in header files are included.
213
214EXTRACT_LOCAL_CLASSES = YES
215
Jose Fonseca375457b2004-09-09 22:23:24 +0000216# This flag is only useful for Objective-C code. When set to YES local
217# methods, which are defined in the implementation section but not in
218# the interface are included in the documentation.
219# If set to NO (the default) only methods in the interface are included.
220
221EXTRACT_LOCAL_METHODS = NO
222
Jose Fonseca91096252003-09-17 17:07:24 +0000223# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
224# undocumented members of documented classes, files or namespaces.
225# If set to NO (the default) these members will be included in the
226# various overviews, but no documentation section is generated.
227# This option has no effect if EXTRACT_ALL is enabled.
228
229HIDE_UNDOC_MEMBERS = NO
230
231# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
232# undocumented classes that are normally visible in the class hierarchy.
233# If set to NO (the default) these classes will be included in the various
234# overviews. This option has no effect if EXTRACT_ALL is enabled.
235
236HIDE_UNDOC_CLASSES = NO
237
238# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
239# friend (class|struct|union) declarations.
240# If set to NO (the default) these declarations will be included in the
241# documentation.
242
243HIDE_FRIEND_COMPOUNDS = NO
244
245# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
246# documentation blocks found inside the body of a function.
247# If set to NO (the default) these blocks will be appended to the
248# function's detailed documentation block.
249
250HIDE_IN_BODY_DOCS = NO
251
Jose Fonseca91096252003-09-17 17:07:24 +0000252# The INTERNAL_DOCS tag determines if documentation
253# that is typed after a \internal command is included. If the tag is set
254# to NO (the default) then the documentation will be excluded.
255# Set it to YES to include the internal documentation.
256
257INTERNAL_DOCS = NO
258
259# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
260# file names in lower-case letters. If set to YES upper-case letters are also
261# allowed. This is useful if you have classes or files whose names only differ
262# in case and if your file system supports case sensitive file names. Windows
Jose Fonseca375457b2004-09-09 22:23:24 +0000263# and Mac users are advised to set this option to NO.
Jose Fonseca91096252003-09-17 17:07:24 +0000264
265CASE_SENSE_NAMES = YES
266
Jose Fonseca91096252003-09-17 17:07:24 +0000267# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
268# will show members with their full class and namespace scopes in the
269# documentation. If set to YES the scope will be hidden.
270
271HIDE_SCOPE_NAMES = NO
272
273# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
274# will put a list of the files that are included by a file in the documentation
275# of that file.
276
277SHOW_INCLUDE_FILES = YES
278
Jose Fonseca91096252003-09-17 17:07:24 +0000279# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
280# is inserted in the documentation for inline members.
281
282INLINE_INFO = YES
283
284# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
285# will sort the (detailed) documentation of file and class members
286# alphabetically by member name. If set to NO the members will appear in
287# declaration order.
288
289SORT_MEMBER_DOCS = YES
290
Jose Fonseca375457b2004-09-09 22:23:24 +0000291# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
292# brief documentation of file, namespace and class members alphabetically
293# by member name. If set to NO (the default) the members will appear in
294# declaration order.
Jose Fonseca91096252003-09-17 17:07:24 +0000295
Jose Fonseca375457b2004-09-09 22:23:24 +0000296SORT_BRIEF_DOCS = NO
Jose Fonseca91096252003-09-17 17:07:24 +0000297
Jose Fonseca375457b2004-09-09 22:23:24 +0000298# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
299# sorted by fully-qualified names, including namespaces. If set to
300# NO (the default), the class list will be sorted only by class name,
301# not including the namespace part.
302# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
303# Note: This option applies only to the class list, not to the
304# alphabetical list.
Jose Fonseca91096252003-09-17 17:07:24 +0000305
Jose Fonseca375457b2004-09-09 22:23:24 +0000306SORT_BY_SCOPE_NAME = NO
Jose Fonseca91096252003-09-17 17:07:24 +0000307
308# The GENERATE_TODOLIST tag can be used to enable (YES) or
309# disable (NO) the todo list. This list is created by putting \todo
310# commands in the documentation.
311
312GENERATE_TODOLIST = YES
313
314# The GENERATE_TESTLIST tag can be used to enable (YES) or
315# disable (NO) the test list. This list is created by putting \test
316# commands in the documentation.
317
318GENERATE_TESTLIST = YES
319
320# The GENERATE_BUGLIST tag can be used to enable (YES) or
321# disable (NO) the bug list. This list is created by putting \bug
322# commands in the documentation.
323
324GENERATE_BUGLIST = YES
325
326# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
327# disable (NO) the deprecated list. This list is created by putting
328# \deprecated commands in the documentation.
329
330GENERATE_DEPRECATEDLIST= YES
331
Jose Fonseca91096252003-09-17 17:07:24 +0000332# The ENABLED_SECTIONS tag can be used to enable conditional
333# documentation sections, marked by \if sectionname ... \endif.
334
335ENABLED_SECTIONS =
336
337# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
338# the initial value of a variable or define consists of for it to appear in
339# the documentation. If the initializer consists of more lines than specified
340# here it will be hidden. Use a value of 0 to hide initializers completely.
341# The appearance of the initializer of individual variables and defines in the
342# documentation can be controlled using \showinitializer or \hideinitializer
343# command in the documentation regardless of this setting.
344
345MAX_INITIALIZER_LINES = 30
346
Jose Fonseca91096252003-09-17 17:07:24 +0000347# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
348# at the bottom of the documentation of classes and structs. If set to YES the
349# list will mention the files that were used to generate the documentation.
350
351SHOW_USED_FILES = YES
352
353#---------------------------------------------------------------------------
354# configuration options related to warning and progress messages
355#---------------------------------------------------------------------------
356
357# The QUIET tag can be used to turn on/off the messages that are generated
358# by doxygen. Possible values are YES and NO. If left blank NO is used.
359
360QUIET = NO
361
362# The WARNINGS tag can be used to turn on/off the warning messages that are
363# generated by doxygen. Possible values are YES and NO. If left blank
364# NO is used.
365
366WARNINGS = YES
367
368# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
369# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
370# automatically be disabled.
371
372WARN_IF_UNDOCUMENTED = YES
373
374# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
375# potential errors in the documentation, such as not documenting some
376# parameters in a documented function, or documenting parameters that
377# don't exist or using markup commands wrongly.
378
379WARN_IF_DOC_ERROR = YES
380
381# The WARN_FORMAT tag determines the format of the warning messages that
382# doxygen can produce. The string should contain the $file, $line, and $text
383# tags, which will be replaced by the file and line number from which the
384# warning originated and the warning text.
385
386WARN_FORMAT = "$file:$line: $text"
387
388# The WARN_LOGFILE tag can be used to specify a file to which warning
389# and error messages should be written. If left blank the output is written
390# to stderr.
391
392WARN_LOGFILE =
393
394#---------------------------------------------------------------------------
395# configuration options related to the input files
396#---------------------------------------------------------------------------
397
398# The INPUT tag can be used to specify the files and/or directories that contain
399# documented source files. You may enter file names like "myfile.cpp" or
400# directories like "/usr/src/myproject". Separate the files or directories
401# with spaces.
402
403INPUT =
404
405# If the value of the INPUT tag contains directories, you can use the
406# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
407# and *.h) to filter out the source-files in the directories. If left
408# blank the following patterns are tested:
409# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
Jose Fonseca375457b2004-09-09 22:23:24 +0000410# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
Jose Fonseca91096252003-09-17 17:07:24 +0000411
412FILE_PATTERNS =
413
414# The RECURSIVE tag can be used to turn specify whether or not subdirectories
415# should be searched for input files as well. Possible values are YES and NO.
416# If left blank NO is used.
417
418RECURSIVE = NO
419
420# The EXCLUDE tag can be used to specify files and/or directories that should
421# excluded from the INPUT source files. This way you can easily exclude a
422# subdirectory from a directory tree whose root is specified with the INPUT tag.
423
424EXCLUDE =
425
426# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
427# that are symbolic links (a Unix filesystem feature) are excluded from the input.
428
429EXCLUDE_SYMLINKS = NO
430
431# If the value of the INPUT tag contains directories, you can use the
432# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
433# certain files from those directories.
434
435EXCLUDE_PATTERNS =
436
437# The EXAMPLE_PATH tag can be used to specify one or more files or
438# directories that contain example code fragments that are included (see
439# the \include command).
440
441EXAMPLE_PATH =
442
443# If the value of the EXAMPLE_PATH tag contains directories, you can use the
444# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
445# and *.h) to filter out the source-files in the directories. If left
446# blank all files are included.
447
448EXAMPLE_PATTERNS =
449
450# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
451# searched for input files to be used with the \include or \dontinclude
452# commands irrespective of the value of the RECURSIVE tag.
453# Possible values are YES and NO. If left blank NO is used.
454
455EXAMPLE_RECURSIVE = NO
456
457# The IMAGE_PATH tag can be used to specify one or more files or
458# directories that contain image that are included in the documentation (see
459# the \image command).
460
461IMAGE_PATH =
462
463# The INPUT_FILTER tag can be used to specify a program that doxygen should
464# invoke to filter for each input file. Doxygen will invoke the filter program
465# by executing (via popen()) the command <filter> <input-file>, where <filter>
466# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
467# input file. Doxygen will then use the output that the filter program writes
Jose Fonseca375457b2004-09-09 22:23:24 +0000468# to standard output. If FILTER_PATTERNS is specified, this tag will be
469# ignored.
Jose Fonseca91096252003-09-17 17:07:24 +0000470
471INPUT_FILTER =
472
Jose Fonseca375457b2004-09-09 22:23:24 +0000473# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
474# basis. Doxygen will compare the file name with each pattern and apply the
475# filter if there is a match. The filters are a list of the form:
476# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
477# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
478# is applied to all files.
479
480FILTER_PATTERNS =
481
Jose Fonseca91096252003-09-17 17:07:24 +0000482# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
483# INPUT_FILTER) will be used to filter the input files when producing source
484# files to browse (i.e. when SOURCE_BROWSER is set to YES).
485
486FILTER_SOURCE_FILES = NO
487
488#---------------------------------------------------------------------------
489# configuration options related to source browsing
490#---------------------------------------------------------------------------
491
492# If the SOURCE_BROWSER tag is set to YES then a list of source files will
Jose Fonseca375457b2004-09-09 22:23:24 +0000493# be generated. Documented entities will be cross-referenced with these sources.
494# Note: To get rid of all source code in the generated output, make sure also
495# VERBATIM_HEADERS is set to NO.
Jose Fonseca91096252003-09-17 17:07:24 +0000496
497SOURCE_BROWSER = NO
498
499# Setting the INLINE_SOURCES tag to YES will include the body
500# of functions and classes directly in the documentation.
501
502INLINE_SOURCES = NO
503
504# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
505# doxygen to hide any special comment blocks from generated source code
506# fragments. Normal C and C++ comments will always remain visible.
507
508STRIP_CODE_COMMENTS = YES
509
510# If the REFERENCED_BY_RELATION tag is set to YES (the default)
511# then for each documented function all documented
512# functions referencing it will be listed.
513
514REFERENCED_BY_RELATION = YES
515
516# If the REFERENCES_RELATION tag is set to YES (the default)
517# then for each documented function all documented entities
518# called/used by that function will be listed.
519
520REFERENCES_RELATION = YES
521
522# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
523# will generate a verbatim copy of the header file for each class for
524# which an include is specified. Set to NO to disable this.
525
526VERBATIM_HEADERS = NO
527
528#---------------------------------------------------------------------------
529# configuration options related to the alphabetical class index
530#---------------------------------------------------------------------------
531
532# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
533# of all compounds will be generated. Enable this if the project
534# contains a lot of classes, structs, unions or interfaces.
535
536ALPHABETICAL_INDEX = NO
537
538# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
539# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
540# in which this list will be split (can be a number in the range [1..20])
541
542COLS_IN_ALPHA_INDEX = 5
543
544# In case all classes in a project start with a common prefix, all
545# classes will be put under the same header in the alphabetical index.
546# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
547# should be ignored while generating the index headers.
548
549IGNORE_PREFIX =
550
551#---------------------------------------------------------------------------
552# configuration options related to the HTML output
553#---------------------------------------------------------------------------
554
555# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
556# generate HTML output.
557
558GENERATE_HTML = YES
559
560# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
561# If a relative path is entered the value of OUTPUT_DIRECTORY will be
562# put in front of it. If left blank `html' will be used as the default path.
563
564HTML_OUTPUT = html
565
566# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
567# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
568# doxygen will generate files with .html extension.
569
570HTML_FILE_EXTENSION = .html
571
572# The HTML_HEADER tag can be used to specify a personal HTML header for
573# each generated HTML page. If it is left blank doxygen will generate a
574# standard header.
575
576HTML_HEADER = header.html
577
578# The HTML_FOOTER tag can be used to specify a personal HTML footer for
579# each generated HTML page. If it is left blank doxygen will generate a
580# standard footer.
581
582HTML_FOOTER =
583
584# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
585# style sheet that is used by each HTML page. It can be used to
586# fine-tune the look of the HTML output. If the tag is left blank doxygen
Jose Fonseca375457b2004-09-09 22:23:24 +0000587# will generate a default style sheet. Note that doxygen will try to copy
588# the style sheet file to the HTML output directory, so don't put your own
589# stylesheet in the HTML output directory as well, or it will be erased!
Jose Fonseca91096252003-09-17 17:07:24 +0000590
591HTML_STYLESHEET =
592
Jose Fonseca91096252003-09-17 17:07:24 +0000593# If the GENERATE_HTMLHELP tag is set to YES, additional index files
594# will be generated that can be used as input for tools like the
595# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
596# of the generated HTML documentation.
597
598GENERATE_HTMLHELP = NO
599
600# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
601# be used to specify the file name of the resulting .chm file. You
602# can add a path in front of the file if the result should not be
Jose Fonseca375457b2004-09-09 22:23:24 +0000603# written to the html output directory.
Jose Fonseca91096252003-09-17 17:07:24 +0000604
605CHM_FILE =
606
607# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
608# be used to specify the location (absolute path including file name) of
609# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
610# the HTML help compiler on the generated index.hhp.
611
612HHC_LOCATION =
613
614# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
615# controls if a separate .chi index file is generated (YES) or that
616# it should be included in the master .chm file (NO).
617
618GENERATE_CHI = NO
619
620# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
621# controls whether a binary table of contents is generated (YES) or a
622# normal table of contents (NO) in the .chm file.
623
624BINARY_TOC = NO
625
626# The TOC_EXPAND flag can be set to YES to add extra items for group members
627# to the contents of the HTML help documentation and to the tree view.
628
629TOC_EXPAND = NO
630
631# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
632# top of each HTML page. The value NO (the default) enables the index and
633# the value YES disables it.
634
635DISABLE_INDEX = NO
636
637# This tag can be used to set the number of enum values (range [1..20])
638# that doxygen will group on one line in the generated HTML documentation.
639
640ENUM_VALUES_PER_LINE = 4
641
642# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
643# generated containing a tree-like index structure (just like the one that
644# is generated for HTML Help). For this to work a browser that supports
645# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
646# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
647# probably better off using the HTML help feature.
648
649GENERATE_TREEVIEW = NO
650
651# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
652# used to set the initial width (in pixels) of the frame in which the tree
653# is shown.
654
655TREEVIEW_WIDTH = 250
656
657#---------------------------------------------------------------------------
658# configuration options related to the LaTeX output
659#---------------------------------------------------------------------------
660
661# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
662# generate Latex output.
663
664GENERATE_LATEX = NO
665
666# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
667# If a relative path is entered the value of OUTPUT_DIRECTORY will be
668# put in front of it. If left blank `latex' will be used as the default path.
669
670LATEX_OUTPUT = latex
671
672# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
673# invoked. If left blank `latex' will be used as the default command name.
674
675LATEX_CMD_NAME = latex
676
677# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
678# generate index for LaTeX. If left blank `makeindex' will be used as the
679# default command name.
680
681MAKEINDEX_CMD_NAME = makeindex
682
683# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
684# LaTeX documents. This may be useful for small projects and may help to
685# save some trees in general.
686
687COMPACT_LATEX = NO
688
689# The PAPER_TYPE tag can be used to set the paper type that is used
690# by the printer. Possible values are: a4, a4wide, letter, legal and
691# executive. If left blank a4wide will be used.
692
693PAPER_TYPE = a4wide
694
695# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
696# packages that should be included in the LaTeX output.
697
698EXTRA_PACKAGES =
699
700# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
701# the generated latex document. The header should contain everything until
702# the first chapter. If it is left blank doxygen will generate a
703# standard header. Notice: only use this tag if you know what you are doing!
704
705LATEX_HEADER =
706
707# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
708# is prepared for conversion to pdf (using ps2pdf). The pdf file will
709# contain links (just like the HTML output) instead of page references
710# This makes the output suitable for online browsing using a pdf viewer.
711
712PDF_HYPERLINKS = NO
713
714# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
715# plain latex in the generated Makefile. Set this option to YES to get a
716# higher quality PDF documentation.
717
718USE_PDFLATEX = NO
719
720# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
721# command to the generated LaTeX files. This will instruct LaTeX to keep
722# running if errors occur, instead of asking the user for help.
723# This option is also used when generating formulas in HTML.
724
725LATEX_BATCHMODE = NO
726
727# If LATEX_HIDE_INDICES is set to YES then doxygen will not
728# include the index chapters (such as File Index, Compound Index, etc.)
729# in the output.
730
731LATEX_HIDE_INDICES = NO
732
733#---------------------------------------------------------------------------
734# configuration options related to the RTF output
735#---------------------------------------------------------------------------
736
737# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
Jose Fonseca375457b2004-09-09 22:23:24 +0000738# The RTF output is optimized for Word 97 and may not look very pretty with
Jose Fonseca91096252003-09-17 17:07:24 +0000739# other RTF readers or editors.
740
741GENERATE_RTF = NO
742
743# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
744# If a relative path is entered the value of OUTPUT_DIRECTORY will be
745# put in front of it. If left blank `rtf' will be used as the default path.
746
747RTF_OUTPUT = rtf
748
749# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
750# RTF documents. This may be useful for small projects and may help to
751# save some trees in general.
752
753COMPACT_RTF = NO
754
755# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
756# will contain hyperlink fields. The RTF file will
757# contain links (just like the HTML output) instead of page references.
758# This makes the output suitable for online browsing using WORD or other
759# programs which support those fields.
760# Note: wordpad (write) and others do not support links.
761
762RTF_HYPERLINKS = NO
763
764# Load stylesheet definitions from file. Syntax is similar to doxygen's
Jose Fonseca375457b2004-09-09 22:23:24 +0000765# config file, i.e. a series of assignments. You only have to provide
Jose Fonseca91096252003-09-17 17:07:24 +0000766# replacements, missing definitions are set to their default value.
767
768RTF_STYLESHEET_FILE =
769
770# Set optional variables used in the generation of an rtf document.
771# Syntax is similar to doxygen's config file.
772
773RTF_EXTENSIONS_FILE =
774
775#---------------------------------------------------------------------------
776# configuration options related to the man page output
777#---------------------------------------------------------------------------
778
779# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
780# generate man pages
781
782GENERATE_MAN = NO
783
784# The MAN_OUTPUT tag is used to specify where the man pages 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 `man' will be used as the default path.
787
788MAN_OUTPUT = man
789
790# The MAN_EXTENSION tag determines the extension that is added to
791# the generated man pages (default is the subroutine's section .3)
792
793MAN_EXTENSION = .3
794
795# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
796# then it will generate one additional man file for each entity
797# documented in the real man page(s). These additional files
798# only source the real man page, but without them the man command
799# would be unable to find the correct page. The default is NO.
800
801MAN_LINKS = NO
802
803#---------------------------------------------------------------------------
804# configuration options related to the XML output
805#---------------------------------------------------------------------------
806
807# If the GENERATE_XML tag is set to YES Doxygen will
808# generate an XML file that captures the structure of
Jose Fonseca375457b2004-09-09 22:23:24 +0000809# the code including all documentation.
Jose Fonseca91096252003-09-17 17:07:24 +0000810
811GENERATE_XML = NO
812
813# The XML_OUTPUT tag is used to specify where the XML pages will be put.
814# If a relative path is entered the value of OUTPUT_DIRECTORY will be
815# put in front of it. If left blank `xml' will be used as the default path.
816
817XML_OUTPUT = xml
818
Jose Fonseca375457b2004-09-09 22:23:24 +0000819# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
820# dump the program listings (including syntax highlighting
821# and cross-referencing information) to the XML output. Note that
822# enabling this will significantly increase the size of the XML output.
823
824XML_PROGRAMLISTING = YES
825
Jose Fonseca91096252003-09-17 17:07:24 +0000826#---------------------------------------------------------------------------
827# configuration options for the AutoGen Definitions output
828#---------------------------------------------------------------------------
829
830# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
831# generate an AutoGen Definitions (see autogen.sf.net) file
832# that captures the structure of the code including all
833# documentation. Note that this feature is still experimental
834# and incomplete at the moment.
835
836GENERATE_AUTOGEN_DEF = NO
837
838#---------------------------------------------------------------------------
839# configuration options related to the Perl module output
840#---------------------------------------------------------------------------
841
842# If the GENERATE_PERLMOD tag is set to YES Doxygen will
843# generate a Perl module file that captures the structure of
844# the code including all documentation. Note that this
845# feature is still experimental and incomplete at the
846# moment.
847
848GENERATE_PERLMOD = NO
849
850# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
851# the necessary Makefile rules, Perl scripts and LaTeX code to be able
852# to generate PDF and DVI output from the Perl module output.
853
854PERLMOD_LATEX = NO
855
856# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
857# nicely formatted so it can be parsed by a human reader. This is useful
858# if you want to understand what is going on. On the other hand, if this
859# tag is set to NO the size of the Perl module output will be much smaller
860# and Perl will parse it just the same.
861
862PERLMOD_PRETTY = YES
863
864# The names of the make variables in the generated doxyrules.make file
865# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
866# This is useful so different doxyrules.make files included by the same
867# Makefile don't overwrite each other's variables.
868
869PERLMOD_MAKEVAR_PREFIX =
870
871#---------------------------------------------------------------------------
872# Configuration options related to the preprocessor
873#---------------------------------------------------------------------------
874
875# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
876# evaluate all C-preprocessor directives found in the sources and include
877# files.
878
879ENABLE_PREPROCESSING = YES
880
881# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
882# names in the source code. If set to NO (the default) only conditional
883# compilation will be performed. Macro expansion can be done in a controlled
884# way by setting EXPAND_ONLY_PREDEF to YES.
885
886MACRO_EXPANSION = NO
887
888# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
889# then the macro expansion is limited to the macros specified with the
890# PREDEFINED and EXPAND_AS_PREDEFINED tags.
891
892EXPAND_ONLY_PREDEF = NO
893
894# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
895# in the INCLUDE_PATH (see below) will be search if a #include is found.
896
897SEARCH_INCLUDES = YES
898
899# The INCLUDE_PATH tag can be used to specify one or more directories that
900# contain include files that are not input files but should be processed by
901# the preprocessor.
902
903INCLUDE_PATH = ../include
904
905# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
906# patterns (like *.h and *.hpp) to filter out the header-files in the
907# directories. If left blank, the patterns specified with FILE_PATTERNS will
908# be used.
909
910INCLUDE_FILE_PATTERNS =
911
912# The PREDEFINED tag can be used to specify one or more macro names that
913# are defined before the preprocessor is started (similar to the -D option of
914# gcc). The argument of the tag is a list of macros of the form: name
915# or name=definition (no spaces). If the definition and the = are
916# omitted =1 is assumed.
917
918PREDEFINED =
919
920# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
921# this tag can be used to specify a list of macro names that should be expanded.
922# The macro definition that is found in the sources will be used.
923# Use the PREDEFINED tag if you want to use a different macro definition.
924
925EXPAND_AS_DEFINED =
926
927# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
928# doxygen's preprocessor will remove all function-like macros that are alone
929# on a line, have an all uppercase name, and do not end with a semicolon. Such
930# function macros are typically used for boiler-plate code, and will confuse the
931# parser if not removed.
932
933SKIP_FUNCTION_MACROS = YES
934
935#---------------------------------------------------------------------------
Jose Fonseca375457b2004-09-09 22:23:24 +0000936# Configuration::additions related to external references
Jose Fonseca91096252003-09-17 17:07:24 +0000937#---------------------------------------------------------------------------
938
939# The TAGFILES option can be used to specify one or more tagfiles.
940# Optionally an initial location of the external documentation
941# can be added for each tagfile. The format of a tag file without
942# this location is as follows:
943# TAGFILES = file1 file2 ...
944# Adding location for the tag files is done as follows:
945# TAGFILES = file1=loc1 "file2 = loc2" ...
946# where "loc1" and "loc2" can be relative or absolute paths or
947# URLs. If a location is present for each tag, the installdox tool
948# does not have to be run to correct the links.
949# Note that each tag file must have a unique name
950# (where the name does NOT include the path)
951# If a tag file is not located in the directory in which doxygen
952# is run, you must also specify the path to the tagfile here.
953
954TAGFILES =
955
956# When a file name is specified after GENERATE_TAGFILE, doxygen will create
957# a tag file that is based on the input files it reads.
958
959GENERATE_TAGFILE =
960
961# If the ALLEXTERNALS tag is set to YES all external classes will be listed
962# in the class index. If set to NO only the inherited external classes
963# will be listed.
964
965ALLEXTERNALS = NO
966
967# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
968# in the modules index. If set to NO, only the current project's groups will
969# be listed.
970
971EXTERNAL_GROUPS = NO
972
973# The PERL_PATH should be the absolute path and name of the perl script
974# interpreter (i.e. the result of `which perl').
975
976PERL_PATH = /usr/bin/perl
977
978#---------------------------------------------------------------------------
979# Configuration options related to the dot tool
980#---------------------------------------------------------------------------
981
982# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
983# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
984# super classes. Setting the tag to NO turns the diagrams off. Note that this
Jose Fonseca375457b2004-09-09 22:23:24 +0000985# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
Jose Fonseca91096252003-09-17 17:07:24 +0000986# recommended to install and use dot, since it yields more powerful graphs.
987
988CLASS_DIAGRAMS = YES
989
990# If set to YES, the inheritance and collaboration graphs will hide
991# inheritance and usage relations if the target is undocumented
992# or is not a class.
993
994HIDE_UNDOC_RELATIONS = YES
995
996# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
997# available from the path. This tool is part of Graphviz, a graph visualization
998# toolkit from AT&T and Lucent Bell Labs. The other options in this section
999# have no effect if this option is set to NO (the default)
1000
1001HAVE_DOT = NO
1002
1003# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1004# will generate a graph for each documented class showing the direct and
1005# indirect inheritance relations. Setting this tag to YES will force the
1006# the CLASS_DIAGRAMS tag to NO.
1007
1008CLASS_GRAPH = YES
1009
1010# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1011# will generate a graph for each documented class showing the direct and
1012# indirect implementation dependencies (inheritance, containment, and
1013# class references variables) of the class with other documented classes.
1014
1015COLLABORATION_GRAPH = YES
1016
1017# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
Jose Fonseca375457b2004-09-09 22:23:24 +00001018# collaboration diagrams in a style similar to the OMG's Unified Modeling
Jose Fonseca91096252003-09-17 17:07:24 +00001019# Language.
1020
1021UML_LOOK = NO
1022
1023# If set to YES, the inheritance and collaboration graphs will show the
1024# relations between templates and their instances.
1025
1026TEMPLATE_RELATIONS = NO
1027
1028# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1029# tags are set to YES then doxygen will generate a graph for each documented
1030# file showing the direct and indirect include dependencies of the file with
1031# other documented files.
1032
1033INCLUDE_GRAPH = YES
1034
1035# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1036# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1037# documented header file showing the documented files that directly or
1038# indirectly include this file.
1039
1040INCLUDED_BY_GRAPH = YES
1041
1042# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1043# generate a call dependency graph for every global function or class method.
1044# Note that enabling this option will significantly increase the time of a run.
1045# So in most cases it will be better to enable call graphs for selected
1046# functions only using the \callgraph command.
1047
1048CALL_GRAPH = NO
1049
1050# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1051# will graphical hierarchy of all classes instead of a textual one.
1052
1053GRAPHICAL_HIERARCHY = YES
1054
1055# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1056# generated by dot. Possible values are png, jpg, or gif
1057# If left blank png will be used.
1058
1059DOT_IMAGE_FORMAT = png
1060
1061# The tag DOT_PATH can be used to specify the path where the dot tool can be
1062# found. If left blank, it is assumed the dot tool can be found on the path.
1063
1064DOT_PATH =
1065
1066# The DOTFILE_DIRS tag can be used to specify one or more directories that
1067# contain dot files that are included in the documentation (see the
1068# \dotfile command).
1069
1070DOTFILE_DIRS =
1071
Jose Fonseca91096252003-09-17 17:07:24 +00001072# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1073# graphs generated by dot. A depth value of 3 means that only nodes reachable
1074# from the root by following a path via at most 3 edges will be shown. Nodes that
1075# lay further from the root node will be omitted. Note that setting this option to
1076# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1077# note that a graph may be further truncated if the graph's image dimensions are
1078# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1079# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1080
1081MAX_DOT_GRAPH_DEPTH = 0
1082
1083# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1084# generate a legend page explaining the meaning of the various boxes and
1085# arrows in the dot generated graphs.
1086
1087GENERATE_LEGEND = YES
1088
1089# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1090# remove the intermediate dot files that are used to generate
1091# the various graphs.
1092
1093DOT_CLEANUP = YES
1094
1095#---------------------------------------------------------------------------
Jose Fonseca375457b2004-09-09 22:23:24 +00001096# Configuration::additions related to the search engine
Jose Fonseca91096252003-09-17 17:07:24 +00001097#---------------------------------------------------------------------------
1098
1099# The SEARCHENGINE tag specifies whether or not a search engine should be
1100# used. If set to NO the values of all tags below this one will be ignored.
1101
1102SEARCHENGINE = NO