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