blob: fb2b859b9760c55aaccc4aff011165a4a5c3cc64 [file] [log] [blame]
Chris Lattner3785a662002-01-26 21:16:41 +00001# Doxyfile 1.2.13.1
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
8# TAG = value [value, ...]
9# For lists items can also be appended using:
10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")
12
13#---------------------------------------------------------------------------
14# General configuration options
15#---------------------------------------------------------------------------
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 = LLVM
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
26PROJECT_NUMBER =
27
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 = doxygen
34
35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36# documentation generated by doxygen is written. Doxygen will use this
37# information to generate all constant output in the proper language.
38# The default language is English, other supported languages are:
39# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
40# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
41# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
42
43OUTPUT_LANGUAGE = English
44
45# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
46# documentation are documented, even if no documentation was available.
47# Private class members and static file members will be hidden unless
48# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
49
50EXTRACT_ALL = YES
51
52# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
53# will be included in the documentation.
54
55EXTRACT_PRIVATE = NO
56
57# If the EXTRACT_STATIC tag is set to YES all static members of a file
58# will be included in the documentation.
59
60EXTRACT_STATIC = YES
61
62# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
63# defined locally in source files will be included in the documentation.
64# If set to NO only classes defined in header files are included.
65
66EXTRACT_LOCAL_CLASSES = YES
67
68# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
69# undocumented members of documented classes, files or namespaces.
70# If set to NO (the default) these members will be included in the
71# various overviews, but no documentation section is generated.
72# This option has no effect if EXTRACT_ALL is enabled.
73
74HIDE_UNDOC_MEMBERS = NO
75
76# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
77# undocumented classes that are normally visible in the class hierarchy.
78# If set to NO (the default) these class will be included in the various
79# overviews. This option has no effect if EXTRACT_ALL is enabled.
80
81HIDE_UNDOC_CLASSES = NO
82
83# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
84# include brief member descriptions after the members that are listed in
85# the file and class documentation (similar to JavaDoc).
86# Set to NO to disable this.
87
88BRIEF_MEMBER_DESC = YES
89
90# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
91# the brief description of a member or function before the detailed description.
92# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
93# brief descriptions will be completely suppressed.
94
95REPEAT_BRIEF = YES
96
97# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
98# Doxygen will generate a detailed section even if there is only a brief
99# description.
100
101ALWAYS_DETAILED_SEC = NO
102
103# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
104# members of a class in the documentation of that class as if those members were
105# ordinary class members. Constructors, destructors and assignment operators of
106# the base classes will not be shown.
107
108INLINE_INHERITED_MEMB = NO
109
110# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
111# path before files name in the file list and in the header files. If set
112# to NO the shortest path that makes the file name unique will be used.
113
114FULL_PATH_NAMES = YES
115
116# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
117# can be used to strip a user defined part of the path. Stripping is
118# only done if one of the specified strings matches the left-hand part of
119# the path. It is allowed to use relative paths in the argument list.
120
121STRIP_FROM_PATH = /home/vadve/lattner/cvs/
122
123
124# The INTERNAL_DOCS tag determines if documentation
125# that is typed after a \internal command is included. If the tag is set
126# to NO (the default) then the documentation will be excluded.
127# Set it to YES to include the internal documentation.
128
129INTERNAL_DOCS = NO
130
131# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
132# doxygen to hide any special comment blocks from generated source code
133# fragments. Normal C and C++ comments will always remain visible.
134
Chris Lattner846f5352002-08-22 22:44:22 +0000135STRIP_CODE_COMMENTS = NO
Chris Lattner3785a662002-01-26 21:16:41 +0000136
137# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
138# file names in lower case letters. If set to YES upper case letters are also
139# allowed. This is useful if you have classes or files whose names only differ
140# in case and if your file system supports case sensitive file names. Windows
141# users are adviced to set this option to NO.
142
143CASE_SENSE_NAMES = YES
144
145# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
146# (but less readable) file names. This can be useful is your file systems
147# doesn't support long names like on DOS, Mac, or CD-ROM.
148
149SHORT_NAMES = NO
150
151# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
152# will show members with their full class and namespace scopes in the
153# documentation. If set to YES the scope will be hidden.
154
155HIDE_SCOPE_NAMES = NO
156
157# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
158# will generate a verbatim copy of the header file for each class for
159# which an include is specified. Set to NO to disable this.
160
161VERBATIM_HEADERS = YES
162
163# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
164# will put list of the files that are included by a file in the documentation
165# of that file.
166
167SHOW_INCLUDE_FILES = YES
168
169# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
170# will interpret the first line (until the first dot) of a JavaDoc-style
171# comment as the brief description. If set to NO, the JavaDoc
172# comments will behave just like the Qt-style comments (thus requiring an
173# explict @brief command for a brief description.
174
175JAVADOC_AUTOBRIEF = NO
176
177# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
178# member inherits the documentation from any documented member that it
179# reimplements.
180
181INHERIT_DOCS = YES
182
183# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
184# is inserted in the documentation for inline members.
185
186INLINE_INFO = YES
187
188# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
189# will sort the (detailed) documentation of file and class members
190# alphabetically by member name. If set to NO the members will appear in
191# declaration order.
192
193SORT_MEMBER_DOCS = YES
194
195# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
196# tag is set to YES, then doxygen will reuse the documentation of the first
197# member in the group (if any) for the other members of the group. By default
198# all members of a group must be documented explicitly.
199
200DISTRIBUTE_GROUP_DOC = NO
201
202# The TAB_SIZE tag can be used to set the number of spaces in a tab.
203# Doxygen uses this value to replace tabs by spaces in code fragments.
204
205TAB_SIZE = 8
206
207# The GENERATE_TODOLIST tag can be used to enable (YES) or
208# disable (NO) the todo list. This list is created by putting \todo
209# commands in the documentation.
210
211GENERATE_TODOLIST = YES
212
213# The GENERATE_TESTLIST tag can be used to enable (YES) or
214# disable (NO) the test list. This list is created by putting \test
215# commands in the documentation.
216
217GENERATE_TESTLIST = YES
218
219# The GENERATE_BUGLIST tag can be used to enable (YES) or
220# disable (NO) the bug list. This list is created by putting \bug
221# commands in the documentation.
222
223GENERATE_BUGLIST = YES
224
225# This tag can be used to specify a number of aliases that acts
226# as commands in the documentation. An alias has the form "name=value".
227# For example adding "sideeffect=\par Side Effects:\n" will allow you to
228# put the command \sideeffect (or @sideeffect) in the documentation, which
229# will result in a user defined paragraph with heading "Side Effects:".
230# You can put \n's in the value part of an alias to insert newlines.
231
232ALIASES =
233
234# The ENABLED_SECTIONS tag can be used to enable conditional
235# documentation sections, marked by \if sectionname ... \endif.
236
237ENABLED_SECTIONS =
238
239# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
240# the initial value of a variable or define consist of for it to appear in
241# the documentation. If the initializer consists of more lines than specified
242# here it will be hidden. Use a value of 0 to hide initializers completely.
243# The appearance of the initializer of individual variables and defines in the
244# documentation can be controlled using \showinitializer or \hideinitializer
245# command in the documentation regardless of this setting.
246
247MAX_INITIALIZER_LINES = 30
248
249# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
250# only. Doxygen will then generate output that is more tailored for C.
251# For instance some of the names that are used will be different. The list
252# of all members will be omitted, etc.
253
254OPTIMIZE_OUTPUT_FOR_C = NO
255
256# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
257# at the bottom of the documentation of classes and structs. If set to YES the
258# list will mention the files that were used to generate the documentation.
259
260SHOW_USED_FILES = YES
261
262#---------------------------------------------------------------------------
263# configuration options related to warning and progress messages
264#---------------------------------------------------------------------------
265
266# The QUIET tag can be used to turn on/off the messages that are generated
267# by doxygen. Possible values are YES and NO. If left blank NO is used.
268
269QUIET = NO
270
271# The WARNINGS tag can be used to turn on/off the warning messages that are
272# generated by doxygen. Possible values are YES and NO. If left blank
273# NO is used.
274
275WARNINGS = NO
276
277# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
278# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
279# automatically be disabled.
280
281WARN_IF_UNDOCUMENTED = NO
282
283# The WARN_FORMAT tag determines the format of the warning messages that
284# doxygen can produce. The string should contain the $file, $line, and $text
285# tags, which will be replaced by the file and line number from which the
286# warning originated and the warning text.
287
288WARN_FORMAT =
289
290# The WARN_LOGFILE tag can be used to specify a file to which warning
291# and error messages should be written. If left blank the output is written
292# to stderr.
293
294WARN_LOGFILE =
295
296#---------------------------------------------------------------------------
297# configuration options related to the input files
298#---------------------------------------------------------------------------
299
300# The INPUT tag can be used to specify the files and/or directories that contain
301# documented source files. You may enter file names like "myfile.cpp" or
302# directories like "/usr/src/myproject". Separate the files or directories
303# with spaces.
304
305INPUT = ..
306
307# If the value of the INPUT tag contains directories, you can use the
308# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
309# and *.h) to filter out the source-files in the directories. If left
310# blank the following patterns are tested:
311# *.c *.cc *.cxx *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
312# *.h++ *.idl
313
314FILE_PATTERNS =
315
316# The RECURSIVE tag can be used to turn specify whether or not subdirectories
317# should be searched for input files as well. Possible values are YES and NO.
318# If left blank NO is used.
319
320RECURSIVE = YES
321
322# The EXCLUDE tag can be used to specify files and/or directories that should
323# excluded from the INPUT source files. This way you can easily exclude a
324# subdirectory from a directory tree whose root is specified with the INPUT tag.
325
Chris Lattner47fe3372002-07-25 15:05:28 +0000326EXCLUDE = ../test ../include/boost
Chris Lattner3785a662002-01-26 21:16:41 +0000327
328# If the value of the INPUT tag contains directories, you can use the
329# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
330# certain files from those directories.
331
332EXCLUDE_PATTERNS =
333
334# The EXAMPLE_PATH tag can be used to specify one or more files or
335# directories that contain example code fragments that are included (see
336# the \include command).
337
338EXAMPLE_PATH =
339
340# If the value of the EXAMPLE_PATH tag contains directories, you can use the
341# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
342# and *.h) to filter out the source-files in the directories. If left
343# blank all files are included.
344
345EXAMPLE_PATTERNS =
346
347# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
348# searched for input files to be used with the \include or \dontinclude
349# commands irrespective of the value of the RECURSIVE tag.
350# Possible values are YES and NO. If left blank NO is used.
351
352EXAMPLE_RECURSIVE = NO
353
354# The IMAGE_PATH tag can be used to specify one or more files or
355# directories that contain image that are included in the documentation (see
356# the \image command).
357
358IMAGE_PATH =
359
360# The INPUT_FILTER tag can be used to specify a program that doxygen should
361# invoke to filter for each input file. Doxygen will invoke the filter program
362# by executing (via popen()) the command <filter> <input-file>, where <filter>
363# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
364# input file. Doxygen will then use the output that the filter program writes
365# to standard output.
366
367INPUT_FILTER =
368
369# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
370# INPUT_FILTER) will be used to filter the input files when producing source
371# files to browse.
372
373FILTER_SOURCE_FILES = NO
374
375#---------------------------------------------------------------------------
376# configuration options related to source browsing
377#---------------------------------------------------------------------------
378
379# If the SOURCE_BROWSER tag is set to YES then a list of source files will
380# be generated. Documented entities will be cross-referenced with these sources.
381
382SOURCE_BROWSER = YES
383
384# Setting the INLINE_SOURCES tag to YES will include the body
385# of functions and classes directly in the documentation.
386
387INLINE_SOURCES = NO
388
389# If the REFERENCED_BY_RELATION tag is set to YES (the default)
390# then for each documented function all documented
391# functions referencing it will be listed.
392
393REFERENCED_BY_RELATION = YES
394
395# If the REFERENCES_RELATION tag is set to YES (the default)
396# then for each documented function all documented entities
397# called/used by that function will be listed.
398
399REFERENCES_RELATION = YES
400
401#---------------------------------------------------------------------------
402# configuration options related to the alphabetical class index
403#---------------------------------------------------------------------------
404
405# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
406# of all compounds will be generated. Enable this if the project
407# contains a lot of classes, structs, unions or interfaces.
408
409ALPHABETICAL_INDEX = YES
410
411# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
412# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
413# in which this list will be split (can be a number in the range [1..20])
414
415COLS_IN_ALPHA_INDEX = 5
416
417# In case all classes in a project start with a common prefix, all
418# classes will be put under the same header in the alphabetical index.
419# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
420# should be ignored while generating the index headers.
421
422IGNORE_PREFIX =
423
424#---------------------------------------------------------------------------
425# configuration options related to the HTML output
426#---------------------------------------------------------------------------
427
428# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
429# generate HTML output.
430
431GENERATE_HTML = YES
432
433# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
434# If a relative path is entered the value of OUTPUT_DIRECTORY will be
435# put in front of it. If left blank `html' will be used as the default path.
436
437HTML_OUTPUT = .
438
439# The HTML_HEADER tag can be used to specify a personal HTML header for
440# each generated HTML page. If it is left blank doxygen will generate a
441# standard header.
442
443HTML_HEADER =
444
445# The HTML_FOOTER tag can be used to specify a personal HTML footer for
446# each generated HTML page. If it is left blank doxygen will generate a
447# standard footer.
448
449HTML_FOOTER =
450
451# The HTML_STYLESHEET tag can be used to specify a user defined cascading
452# style sheet that is used by each HTML page. It can be used to
453# fine-tune the look of the HTML output. If the tag is left blank doxygen
454# will generate a default style sheet
455
456HTML_STYLESHEET =
457
458# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
459# files or namespaces will be aligned in HTML using tables. If set to
460# NO a bullet list will be used.
461
462HTML_ALIGN_MEMBERS = YES
463
464# If the GENERATE_HTMLHELP tag is set to YES, additional index files
465# will be generated that can be used as input for tools like the
466# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
467# of the generated HTML documentation.
468
469GENERATE_HTMLHELP = NO
470
471# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
472# controls if a separate .chi index file is generated (YES) or that
473# it should be included in the master .chm file (NO).
474
475GENERATE_CHI = NO
476
477# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
478# controls whether a binary table of contents is generated (YES) or a
479# normal table of contents (NO) in the .chm file.
480
481BINARY_TOC = NO
482
483# The TOC_EXPAND flag can be set to YES to add extra items for group members
484# to the contents of the Html help documentation and to the tree view.
485
486TOC_EXPAND = NO
487
488# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
489# top of each HTML page. The value NO (the default) enables the index and
490# the value YES disables it.
491
492DISABLE_INDEX = NO
493
494# This tag can be used to set the number of enum values (range [1..20])
495# that doxygen will group on one line in the generated HTML documentation.
496
497ENUM_VALUES_PER_LINE = 4
498
499# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
500# generated containing a tree-like index structure (just like the one that
501# is generated for HTML Help). For this to work a browser that supports
502# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
503# or Internet explorer 4.0+). Note that for large projects the tree generation
504# can take a very long time. In such cases it is better to disable this feature.
505# Windows users are probably better off using the HTML help feature.
506
507GENERATE_TREEVIEW = NO
508
509# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
510# used to set the initial width (in pixels) of the frame in which the tree
511# is shown.
512
513TREEVIEW_WIDTH = 250
514
515#---------------------------------------------------------------------------
516# configuration options related to the LaTeX output
517#---------------------------------------------------------------------------
518
519# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
520# generate Latex output.
521
522GENERATE_LATEX = NO
523
524# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
525# If a relative path is entered the value of OUTPUT_DIRECTORY will be
526# put in front of it. If left blank `latex' will be used as the default path.
527
528LATEX_OUTPUT =
529
530# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
531# LaTeX documents. This may be useful for small projects and may help to
532# save some trees in general.
533
534COMPACT_LATEX = NO
535
536# The PAPER_TYPE tag can be used to set the paper type that is used
537# by the printer. Possible values are: a4, a4wide, letter, legal and
538# executive. If left blank a4wide will be used.
539
540PAPER_TYPE = a4wide
541
542# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
543# packages that should be included in the LaTeX output.
544
545EXTRA_PACKAGES =
546
547# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
548# the generated latex document. The header should contain everything until
549# the first chapter. If it is left blank doxygen will generate a
550# standard header. Notice: only use this tag if you know what you are doing!
551
552LATEX_HEADER =
553
554# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
555# is prepared for conversion to pdf (using ps2pdf). The pdf file will
556# contain links (just like the HTML output) instead of page references
557# This makes the output suitable for online browsing using a pdf viewer.
558
559PDF_HYPERLINKS = NO
560
561# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
562# plain latex in the generated Makefile. Set this option to YES to get a
563# higher quality PDF documentation.
564
565USE_PDFLATEX = NO
566
567# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
568# command to the generated LaTeX files. This will instruct LaTeX to keep
569# running if errors occur, instead of asking the user for help.
570# This option is also used when generating formulas in HTML.
571
572LATEX_BATCHMODE = NO
573
574#---------------------------------------------------------------------------
575# configuration options related to the RTF output
576#---------------------------------------------------------------------------
577
578# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
579# The RTF output is optimised for Word 97 and may not look very pretty with
580# other RTF readers or editors.
581
582GENERATE_RTF = NO
583
584# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
585# If a relative path is entered the value of OUTPUT_DIRECTORY will be
586# put in front of it. If left blank `rtf' will be used as the default path.
587
588RTF_OUTPUT =
589
590# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
591# RTF documents. This may be useful for small projects and may help to
592# save some trees in general.
593
594COMPACT_RTF = NO
595
596# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
597# will contain hyperlink fields. The RTF file will
598# contain links (just like the HTML output) instead of page references.
599# This makes the output suitable for online browsing using WORD or other
600# programs which support those fields.
601# Note: wordpad (write) and others do not support links.
602
603RTF_HYPERLINKS = NO
604
605# Load stylesheet definitions from file. Syntax is similar to doxygen's
606# config file, i.e. a series of assigments. You only have to provide
607# replacements, missing definitions are set to their default value.
608
609RTF_STYLESHEET_FILE =
610
611# Set optional variables used in the generation of an rtf document.
612# Syntax is similar to doxygen's config file.
613
614RTF_EXTENSIONS_FILE =
615
616#---------------------------------------------------------------------------
617# configuration options related to the man page output
618#---------------------------------------------------------------------------
619
620# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
621# generate man pages
622
623GENERATE_MAN = NO
624
625# The MAN_OUTPUT tag is used to specify where the man pages will be put.
626# If a relative path is entered the value of OUTPUT_DIRECTORY will be
627# put in front of it. If left blank `man' will be used as the default path.
628
629MAN_OUTPUT =
630
631# The MAN_EXTENSION tag determines the extension that is added to
632# the generated man pages (default is the subroutine's section .3)
633
634MAN_EXTENSION =
635
636# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
637# then it will generate one additional man file for each entity
638# documented in the real man page(s). These additional files
639# only source the real man page, but without them the man command
640# would be unable to find the correct page. The default is NO.
641
642MAN_LINKS = NO
643
644#---------------------------------------------------------------------------
645# configuration options related to the XML output
646#---------------------------------------------------------------------------
647
648# If the GENERATE_XML tag is set to YES Doxygen will
649# generate an XML file that captures the structure of
650# the code including all documentation. Note that this
651# feature is still experimental and incomplete at the
652# moment.
653
654GENERATE_XML = NO
655
656#---------------------------------------------------------------------------
657# configuration options for the AutoGen Definitions output
658#---------------------------------------------------------------------------
659
660# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
661# generate an AutoGen Definitions (see autogen.sf.net) file
662# that captures the structure of the code including all
663# documentation. Note that this feature is still experimental
664# and incomplete at the moment.
665
666GENERATE_AUTOGEN_DEF = NO
667
668#---------------------------------------------------------------------------
669# Configuration options related to the preprocessor
670#---------------------------------------------------------------------------
671
672# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
673# evaluate all C-preprocessor directives found in the sources and include
674# files.
675
676ENABLE_PREPROCESSING = YES
677
678# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
679# names in the source code. If set to NO (the default) only conditional
680# compilation will be performed. Macro expansion can be done in a controlled
681# way by setting EXPAND_ONLY_PREDEF to YES.
682
683MACRO_EXPANSION = NO
684
685# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
686# then the macro expansion is limited to the macros specified with the
687# PREDEFINED and EXPAND_AS_PREDEFINED tags.
688
689EXPAND_ONLY_PREDEF = NO
690
691# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
692# in the INCLUDE_PATH (see below) will be search if a #include is found.
693
694SEARCH_INCLUDES = YES
695
696# The INCLUDE_PATH tag can be used to specify one or more directories that
697# contain include files that are not input files but should be processed by
698# the preprocessor.
699
700INCLUDE_PATH = ../include
701
702# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
703# patterns (like *.h and *.hpp) to filter out the header-files in the
704# directories. If left blank, the patterns specified with FILE_PATTERNS will
705# be used.
706
707INCLUDE_FILE_PATTERNS =
708
709# The PREDEFINED tag can be used to specify one or more macro names that
710# are defined before the preprocessor is started (similar to the -D option of
711# gcc). The argument of the tag is a list of macros of the form: name
712# or name=definition (no spaces). If the definition and the = are
713# omitted =1 is assumed.
714
715PREDEFINED =
716
717# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
718# this tag can be used to specify a list of macro names that should be expanded.
719# The macro definition that is found in the sources will be used.
720# Use the PREDEFINED tag if you want to use a different macro definition.
721
722EXPAND_AS_DEFINED =
723
724# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
725# doxygen's preprocessor will remove all function-like macros that are alone
726# on a line and do not end with a semicolon. Such function macros are typically
727# used for boiler-plate code, and will confuse the parser if not removed.
728
729SKIP_FUNCTION_MACROS = YES
730
731#---------------------------------------------------------------------------
732# Configuration::addtions related to external references
733#---------------------------------------------------------------------------
734
735# The TAGFILES tag can be used to specify one or more tagfiles.
736
737TAGFILES =
738
739# When a file name is specified after GENERATE_TAGFILE, doxygen will create
740# a tag file that is based on the input files it reads.
741
742GENERATE_TAGFILE =
743
744# If the ALLEXTERNALS tag is set to YES all external classes will be listed
745# in the class index. If set to NO only the inherited external classes
746# will be listed.
747
748ALLEXTERNALS = YES
749
750# The PERL_PATH should be the absolute path and name of the perl script
751# interpreter (i.e. the result of `which perl').
752
753PERL_PATH =
754
755#---------------------------------------------------------------------------
756# Configuration options related to the dot tool
757#---------------------------------------------------------------------------
758
759# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
760# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
761# super classes. Setting the tag to NO turns the diagrams off. Note that this
762# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
763# recommended to install and use dot, since it yield more powerful graphs.
764
765CLASS_DIAGRAMS = YES
766
767# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
768# available from the path. This tool is part of Graphviz, a graph visualization
769# toolkit from AT&T and Lucent Bell Labs. The other options in this section
770# have no effect if this option is set to NO (the default)
771
772HAVE_DOT = YES
773
774# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
775# will generate a graph for each documented class showing the direct and
776# indirect inheritance relations. Setting this tag to YES will force the
777# the CLASS_DIAGRAMS tag to NO.
778
779CLASS_GRAPH = YES
780
781# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
782# will generate a graph for each documented class showing the direct and
783# indirect implementation dependencies (inheritance, containment, and
784# class references variables) of the class with other documented classes.
785
786COLLABORATION_GRAPH = YES
787
788# If set to YES, the inheritance and collaboration graphs will show the
789# relations between templates and their instances.
790
791TEMPLATE_RELATIONS = YES
792
793# If set to YES, the inheritance and collaboration graphs will hide
794# inheritance and usage relations if the target is undocumented
795# or is not a class.
796
797HIDE_UNDOC_RELATIONS = NO
798
799# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
800# tags are set to YES then doxygen will generate a graph for each documented
801# file showing the direct and indirect include dependencies of the file with
802# other documented files.
803
804INCLUDE_GRAPH = YES
805
806# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
807# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
808# documented header file showing the documented files that directly or
809# indirectly include this file.
810
811INCLUDED_BY_GRAPH = YES
812
813# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
814# will graphical hierarchy of all classes instead of a textual one.
815
816GRAPHICAL_HIERARCHY = YES
817
818# The tag DOT_PATH can be used to specify the path where the dot tool can be
819# found. If left blank, it is assumed the dot tool can be found on the path.
820
821DOT_PATH = /home/vadve/lattner/bin/
822
823# The DOTFILE_DIRS tag can be used to specify one or more directories that
824# contain dot files that are included in the documentation (see the
825# \dotfile command).
826
827DOTFILE_DIRS =
828
829# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
830# (in pixels) of the graphs generated by dot. If a graph becomes larger than
831# this value, doxygen will try to truncate the graph, so that it fits within
832# the specified constraint. Beware that most browsers cannot cope with very
833# large images.
834
835MAX_DOT_GRAPH_WIDTH = 1024
836
837# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
838# (in pixels) of the graphs generated by dot. If a graph becomes larger than
839# this value, doxygen will try to truncate the graph, so that it fits within
840# the specified constraint. Beware that most browsers cannot cope with very
841# large images.
842
843MAX_DOT_GRAPH_HEIGHT = 1024
844
845# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
846# generate a legend page explaining the meaning of the various boxes and
847# arrows in the dot generated graphs.
848
849GENERATE_LEGEND = YES
850
851# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
852# remove the intermedate dot files that are used to generate
853# the various graphs.
854
855DOT_CLEANUP = YES
856
857#---------------------------------------------------------------------------
858# Configuration::addtions related to the search engine
859#---------------------------------------------------------------------------
860
861# The SEARCHENGINE tag specifies whether or not a search engine should be
862# used. If set to NO the values of all tags below this one will be ignored.
863
864SEARCHENGINE = NO
865
866# The CGI_NAME tag should be the name of the CGI script that
867# starts the search engine (doxysearch) with the correct parameters.
868# A script with this name will be generated by doxygen.
869
870CGI_NAME =
871
872# The CGI_URL tag should be the absolute URL to the directory where the
873# cgi binaries are located. See the documentation of your http daemon for
874# details.
875
876CGI_URL =
877
878# The DOC_URL tag should be the absolute URL to the directory where the
879# documentation is located. If left blank the absolute path to the
880# documentation, with file:// prepended to it, will be used.
881
882DOC_URL =
883
884# The DOC_ABSPATH tag should be the absolute path to the directory where the
885# documentation is located. If left blank the directory on the local machine
886# will be used.
887
888DOC_ABSPATH =
889
890# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
891# is installed.
892
893BIN_ABSPATH =
894
895# The EXT_DOC_PATHS tag can be used to specify one or more paths to
896# documentation generated for other projects. This allows doxysearch to search
897# the documentation for these projects as well.
898
899EXT_DOC_PATHS =