1
# Copyright (C) 2003, 2005 MySQL AB
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; version 2 of the License.
7
# This program is distributed in the hope that it will be useful,
8
# but WITHOUT ANY WARRANTY; without even the implied warranty of
9
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10
# GNU General Public License for more details.
12
# You should have received a copy of the GNU General Public License
13
# along with this program; if not, write to the Free Software
14
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# This file describes the settings to be used by the documentation system
19
# doxygen (www.doxygen.org) for a project
21
# All text after a hash (#) is considered a comment and will be ignored
23
# TAG = value [value, ...]
24
# For lists items can also be appended using:
25
# TAG += value [value, ...]
26
# Values that contain spaces should be placed between quotes (" ")
28
#---------------------------------------------------------------------------
29
# General configuration options
30
#---------------------------------------------------------------------------
34
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
35
# by quotes) that should identify the project.
37
PROJECT_NAME = "NDB ODBC"
39
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
40
# This could be handy for archiving the generated documentation or
41
# if some version control system is used.
45
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
46
# base path where the generated documentation will be put.
47
# If a relative path is entered, it will be relative to the location
48
# where doxygen was started. If left blank the current directory will be used.
52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53
# documentation generated by doxygen is written. Doxygen will use this
54
# information to generate all constant output in the proper language.
55
# The default language is English, other supported languages are:
56
# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
57
# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
58
# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
60
OUTPUT_LANGUAGE = English
62
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
63
# documentation are documented, even if no documentation was available.
64
# Private class members and static file members will be hidden unless
65
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
69
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
70
# will be included in the documentation.
74
# If the EXTRACT_STATIC tag is set to YES all static members of a file
75
# will be included in the documentation.
79
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
80
# defined locally in source files will be included in the documentation.
81
# If set to NO only classes defined in header files are included.
83
EXTRACT_LOCAL_CLASSES = YES
85
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
86
# undocumented members of documented classes, files or namespaces.
87
# If set to NO (the default) these members will be included in the
88
# various overviews, but no documentation section is generated.
89
# This option has no effect if EXTRACT_ALL is enabled.
91
HIDE_UNDOC_MEMBERS = NO
93
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
94
# undocumented classes that are normally visible in the class hierarchy.
95
# If set to NO (the default) these class will be included in the various
96
# overviews. This option has no effect if EXTRACT_ALL is enabled.
98
HIDE_UNDOC_CLASSES = NO
100
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
101
# include brief member descriptions after the members that are listed in
102
# the file and class documentation (similar to JavaDoc).
103
# Set to NO to disable this.
105
BRIEF_MEMBER_DESC = YES
107
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
108
# the brief description of a member or function before the detailed description.
109
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
110
# brief descriptions will be completely suppressed.
114
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
115
# Doxygen will generate a detailed section even if there is only a brief
118
ALWAYS_DETAILED_SEC = NO
120
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
121
# members of a class in the documentation of that class as if those members were
122
# ordinary class members. Constructors, destructors and assignment operators of
123
# the base classes will not be shown.
125
INLINE_INHERITED_MEMB = NO
127
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
128
# path before files name in the file list and in the header files. If set
129
# to NO the shortest path that makes the file name unique will be used.
131
FULL_PATH_NAMES = YES
133
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
134
# can be used to strip a user defined part of the path. Stripping is
135
# only done if one of the specified strings matches the left-hand part of
136
# the path. It is allowed to use relative paths in the argument list.
140
# The INTERNAL_DOCS tag determines if documentation
141
# that is typed after a \internal command is included. If the tag is set
142
# to NO (the default) then the documentation will be excluded.
143
# Set it to YES to include the internal documentation.
147
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
148
# doxygen to hide any special comment blocks from generated source code
149
# fragments. Normal C and C++ comments will always remain visible.
151
STRIP_CODE_COMMENTS = YES
153
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
154
# file names in lower case letters. If set to YES upper case letters are also
155
# allowed. This is useful if you have classes or files whose names only differ
156
# in case and if your file system supports case sensitive file names. Windows
157
# users are adviced to set this option to NO.
159
CASE_SENSE_NAMES = YES
161
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
162
# (but less readable) file names. This can be useful is your file systems
163
# doesn't support long names like on DOS, Mac, or CD-ROM.
167
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
168
# will show members with their full class and namespace scopes in the
169
# documentation. If set to YES the scope will be hidden.
171
HIDE_SCOPE_NAMES = NO
173
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
174
# will generate a verbatim copy of the header file for each class for
175
# which an include is specified. Set to NO to disable this.
177
VERBATIM_HEADERS = NO
179
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
180
# will put list of the files that are included by a file in the documentation
183
SHOW_INCLUDE_FILES = YES
185
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
186
# will interpret the first line (until the first dot) of a JavaDoc-style
187
# comment as the brief description. If set to NO, the JavaDoc
188
# comments will behave just like the Qt-style comments (thus requiring an
189
# explict @brief command for a brief description.
191
JAVADOC_AUTOBRIEF = NO
193
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
194
# member inherits the documentation from any documented member that it
199
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
200
# is inserted in the documentation for inline members.
204
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
205
# will sort the (detailed) documentation of file and class members
206
# alphabetically by member name. If set to NO the members will appear in
209
SORT_MEMBER_DOCS = YES
211
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
212
# tag is set to YES, then doxygen will reuse the documentation of the first
213
# member in the group (if any) for the other members of the group. By default
214
# all members of a group must be documented explicitly.
216
DISTRIBUTE_GROUP_DOC = NO
218
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
219
# Doxygen uses this value to replace tabs by spaces in code fragments.
223
# The GENERATE_TODOLIST tag can be used to enable (YES) or
224
# disable (NO) the todo list. This list is created by putting \todo
225
# commands in the documentation.
227
GENERATE_TODOLIST = YES
229
# The GENERATE_TESTLIST tag can be used to enable (YES) or
230
# disable (NO) the test list. This list is created by putting \test
231
# commands in the documentation.
233
GENERATE_TESTLIST = YES
235
# The GENERATE_BUGLIST tag can be used to enable (YES) or
236
# disable (NO) the bug list. This list is created by putting \bug
237
# commands in the documentation.
239
GENERATE_BUGLIST = YES
241
# This tag can be used to specify a number of aliases that acts
242
# as commands in the documentation. An alias has the form "name=value".
243
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
244
# put the command \sideeffect (or @sideeffect) in the documentation, which
245
# will result in a user defined paragraph with heading "Side Effects:".
246
# You can put \n's in the value part of an alias to insert newlines.
250
# The ENABLED_SECTIONS tag can be used to enable conditional
251
# documentation sections, marked by \if sectionname ... \endif.
255
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
256
# the initial value of a variable or define consist of for it to appear in
257
# the documentation. If the initializer consists of more lines than specified
258
# here it will be hidden. Use a value of 0 to hide initializers completely.
259
# The appearance of the initializer of individual variables and defines in the
260
# documentation can be controlled using \showinitializer or \hideinitializer
261
# command in the documentation regardless of this setting.
263
MAX_INITIALIZER_LINES = 30
265
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
266
# only. Doxygen will then generate output that is more tailored for C.
267
# For instance some of the names that are used will be different. The list
268
# of all members will be omitted, etc.
270
OPTIMIZE_OUTPUT_FOR_C = NO
272
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
273
# at the bottom of the documentation of classes and structs. If set to YES the
274
# list will mention the files that were used to generate the documentation.
278
#---------------------------------------------------------------------------
279
# configuration options related to warning and progress messages
280
#---------------------------------------------------------------------------
282
# The QUIET tag can be used to turn on/off the messages that are generated
283
# by doxygen. Possible values are YES and NO. If left blank NO is used.
287
# The WARNINGS tag can be used to turn on/off the warning messages that are
288
# generated by doxygen. Possible values are YES and NO. If left blank
293
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
294
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
295
# automatically be disabled.
297
WARN_IF_UNDOCUMENTED = YES
299
# The WARN_FORMAT tag determines the format of the warning messages that
300
# doxygen can produce. The string should contain the $file, $line, and $text
301
# tags, which will be replaced by the file and line number from which the
302
# warning originated and the warning text.
304
WARN_FORMAT = "$file:$line: $text"
306
# The WARN_LOGFILE tag can be used to specify a file to which warning
307
# and error messages should be written. If left blank the output is written
312
#---------------------------------------------------------------------------
313
# configuration options related to the input files
314
#---------------------------------------------------------------------------
316
# The INPUT tag can be used to specify the files and/or directories that contain
317
# documented source files. You may enter file names like "myfile.cpp" or
318
# directories like "/usr/src/myproject". Separate the files or directories
321
INPUT = src/client/odbc
323
# If the value of the INPUT tag contains directories, you can use the
324
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
325
# and *.h) to filter out the source-files in the directories. If left
326
# blank the following patterns are tested:
327
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
332
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
333
# should be searched for input files as well. Possible values are YES and NO.
334
# If left blank NO is used.
338
# The EXCLUDE tag can be used to specify files and/or directories that should
339
# excluded from the INPUT source files. This way you can easily exclude a
340
# subdirectory from a directory tree whose root is specified with the INPUT tag.
344
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
345
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
347
EXCLUDE_SYMLINKS = NO
349
# If the value of the INPUT tag contains directories, you can use the
350
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
351
# certain files from those directories.
355
# The EXAMPLE_PATH tag can be used to specify one or more files or
356
# directories that contain example code fragments that are included (see
357
# the \include command).
361
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
362
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
363
# and *.h) to filter out the source-files in the directories. If left
364
# blank all files are included.
368
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
369
# searched for input files to be used with the \include or \dontinclude
370
# commands irrespective of the value of the RECURSIVE tag.
371
# Possible values are YES and NO. If left blank NO is used.
373
EXAMPLE_RECURSIVE = NO
375
# The IMAGE_PATH tag can be used to specify one or more files or
376
# directories that contain image that are included in the documentation (see
377
# the \image command).
381
# The INPUT_FILTER tag can be used to specify a program that doxygen should
382
# invoke to filter for each input file. Doxygen will invoke the filter program
383
# by executing (via popen()) the command <filter> <input-file>, where <filter>
384
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
385
# input file. Doxygen will then use the output that the filter program writes
386
# to standard output.
390
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
391
# INPUT_FILTER) will be used to filter the input files when producing source
394
FILTER_SOURCE_FILES = NO
396
#---------------------------------------------------------------------------
397
# configuration options related to source browsing
398
#---------------------------------------------------------------------------
400
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
401
# be generated. Documented entities will be cross-referenced with these sources.
405
# Setting the INLINE_SOURCES tag to YES will include the body
406
# of functions and classes directly in the documentation.
410
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
411
# then for each documented function all documented
412
# functions referencing it will be listed.
414
REFERENCED_BY_RELATION = YES
416
# If the REFERENCES_RELATION tag is set to YES (the default)
417
# then for each documented function all documented entities
418
# called/used by that function will be listed.
420
REFERENCES_RELATION = YES
422
#---------------------------------------------------------------------------
423
# configuration options related to the alphabetical class index
424
#---------------------------------------------------------------------------
426
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
427
# of all compounds will be generated. Enable this if the project
428
# contains a lot of classes, structs, unions or interfaces.
430
ALPHABETICAL_INDEX = YES
432
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
433
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
434
# in which this list will be split (can be a number in the range [1..20])
436
COLS_IN_ALPHA_INDEX = 5
438
# In case all classes in a project start with a common prefix, all
439
# classes will be put under the same header in the alphabetical index.
440
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
441
# should be ignored while generating the index headers.
445
#---------------------------------------------------------------------------
446
# configuration options related to the HTML output
447
#---------------------------------------------------------------------------
449
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
450
# generate HTML output.
454
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
455
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
456
# put in front of it. If left blank `html' will be used as the default path.
458
HTML_OUTPUT = ../.doxyout/odbc.html
460
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
461
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
462
# doxygen will generate files with .html extension.
464
HTML_FILE_EXTENSION = .html
466
# The HTML_HEADER tag can be used to specify a personal HTML header for
467
# each generated HTML page. If it is left blank doxygen will generate a
472
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
473
# each generated HTML page. If it is left blank doxygen will generate a
478
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
479
# style sheet that is used by each HTML page. It can be used to
480
# fine-tune the look of the HTML output. If the tag is left blank doxygen
481
# will generate a default style sheet
485
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
486
# files or namespaces will be aligned in HTML using tables. If set to
487
# NO a bullet list will be used.
489
HTML_ALIGN_MEMBERS = NO
491
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
492
# will be generated that can be used as input for tools like the
493
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
494
# of the generated HTML documentation.
496
GENERATE_HTMLHELP = NO
498
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
499
# controls if a separate .chi index file is generated (YES) or that
500
# it should be included in the master .chm file (NO).
504
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
505
# controls whether a binary table of contents is generated (YES) or a
506
# normal table of contents (NO) in the .chm file.
510
# The TOC_EXPAND flag can be set to YES to add extra items for group members
511
# to the contents of the Html help documentation and to the tree view.
515
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
516
# top of each HTML page. The value NO (the default) enables the index and
517
# the value YES disables it.
521
# This tag can be used to set the number of enum values (range [1..20])
522
# that doxygen will group on one line in the generated HTML documentation.
524
ENUM_VALUES_PER_LINE = 4
526
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
527
# generated containing a tree-like index structure (just like the one that
528
# is generated for HTML Help). For this to work a browser that supports
529
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
530
# or Internet explorer 4.0+). Note that for large projects the tree generation
531
# can take a very long time. In such cases it is better to disable this feature.
532
# Windows users are probably better off using the HTML help feature.
534
GENERATE_TREEVIEW = NO
536
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
537
# used to set the initial width (in pixels) of the frame in which the tree
542
#---------------------------------------------------------------------------
543
# configuration options related to the LaTeX output
544
#---------------------------------------------------------------------------
546
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
547
# generate Latex output.
551
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
552
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
553
# put in front of it. If left blank `latex' will be used as the default path.
555
LATEX_OUTPUT = ../.doxyout/odbc.latex
557
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
558
# LaTeX documents. This may be useful for small projects and may help to
559
# save some trees in general.
563
# The PAPER_TYPE tag can be used to set the paper type that is used
564
# by the printer. Possible values are: a4, a4wide, letter, legal and
565
# executive. If left blank a4wide will be used.
569
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
570
# packages that should be included in the LaTeX output.
574
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
575
# the generated latex document. The header should contain everything until
576
# the first chapter. If it is left blank doxygen will generate a
577
# standard header. Notice: only use this tag if you know what you are doing!
581
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
582
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
583
# contain links (just like the HTML output) instead of page references
584
# This makes the output suitable for online browsing using a pdf viewer.
588
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
589
# plain latex in the generated Makefile. Set this option to YES to get a
590
# higher quality PDF documentation.
594
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
595
# command to the generated LaTeX files. This will instruct LaTeX to keep
596
# running if errors occur, instead of asking the user for help.
597
# This option is also used when generating formulas in HTML.
601
#---------------------------------------------------------------------------
602
# configuration options related to the RTF output
603
#---------------------------------------------------------------------------
605
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
606
# The RTF output is optimised for Word 97 and may not look very pretty with
607
# other RTF readers or editors.
611
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
612
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
613
# put in front of it. If left blank `rtf' will be used as the default path.
617
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
618
# RTF documents. This may be useful for small projects and may help to
619
# save some trees in general.
623
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
624
# will contain hyperlink fields. The RTF file will
625
# contain links (just like the HTML output) instead of page references.
626
# This makes the output suitable for online browsing using WORD or other
627
# programs which support those fields.
628
# Note: wordpad (write) and others do not support links.
632
# Load stylesheet definitions from file. Syntax is similar to doxygen's
633
# config file, i.e. a series of assigments. You only have to provide
634
# replacements, missing definitions are set to their default value.
636
RTF_STYLESHEET_FILE =
638
# Set optional variables used in the generation of an rtf document.
639
# Syntax is similar to doxygen's config file.
641
RTF_EXTENSIONS_FILE =
643
#---------------------------------------------------------------------------
644
# configuration options related to the man page output
645
#---------------------------------------------------------------------------
647
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
652
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
653
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
654
# put in front of it. If left blank `man' will be used as the default path.
658
# The MAN_EXTENSION tag determines the extension that is added to
659
# the generated man pages (default is the subroutine's section .3)
663
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
664
# then it will generate one additional man file for each entity
665
# documented in the real man page(s). These additional files
666
# only source the real man page, but without them the man command
667
# would be unable to find the correct page. The default is NO.
671
#---------------------------------------------------------------------------
672
# configuration options related to the XML output
673
#---------------------------------------------------------------------------
675
# If the GENERATE_XML tag is set to YES Doxygen will
676
# generate an XML file that captures the structure of
677
# the code including all documentation. Note that this
678
# feature is still experimental and incomplete at the
683
#---------------------------------------------------------------------------
684
# configuration options for the AutoGen Definitions output
685
#---------------------------------------------------------------------------
687
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
688
# generate an AutoGen Definitions (see autogen.sf.net) file
689
# that captures the structure of the code including all
690
# documentation. Note that this feature is still experimental
691
# and incomplete at the moment.
693
GENERATE_AUTOGEN_DEF = NO
695
#---------------------------------------------------------------------------
696
# Configuration options related to the preprocessor
697
#---------------------------------------------------------------------------
699
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
700
# evaluate all C-preprocessor directives found in the sources and include
703
ENABLE_PREPROCESSING = YES
705
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
706
# names in the source code. If set to NO (the default) only conditional
707
# compilation will be performed. Macro expansion can be done in a controlled
708
# way by setting EXPAND_ONLY_PREDEF to YES.
712
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
713
# then the macro expansion is limited to the macros specified with the
714
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
716
EXPAND_ONLY_PREDEF = NO
718
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
719
# in the INCLUDE_PATH (see below) will be search if a #include is found.
721
SEARCH_INCLUDES = YES
723
# The INCLUDE_PATH tag can be used to specify one or more directories that
724
# contain include files that are not input files but should be processed by
729
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
730
# patterns (like *.h and *.hpp) to filter out the header-files in the
731
# directories. If left blank, the patterns specified with FILE_PATTERNS will
734
INCLUDE_FILE_PATTERNS =
736
# The PREDEFINED tag can be used to specify one or more macro names that
737
# are defined before the preprocessor is started (similar to the -D option of
738
# gcc). The argument of the tag is a list of macros of the form: name
739
# or name=definition (no spaces). If the definition and the = are
740
# omitted =1 is assumed.
744
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
745
# this tag can be used to specify a list of macro names that should be expanded.
746
# The macro definition that is found in the sources will be used.
747
# Use the PREDEFINED tag if you want to use a different macro definition.
751
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
752
# doxygen's preprocessor will remove all function-like macros that are alone
753
# on a line and do not end with a semicolon. Such function macros are typically
754
# used for boiler-plate code, and will confuse the parser if not removed.
756
SKIP_FUNCTION_MACROS = YES
758
#---------------------------------------------------------------------------
759
# Configuration::addtions related to external references
760
#---------------------------------------------------------------------------
762
# The TAGFILES tag can be used to specify one or more tagfiles.
766
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
767
# a tag file that is based on the input files it reads.
771
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
772
# in the class index. If set to NO only the inherited external classes
777
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
778
# in the modules index. If set to NO, only the current project's groups will
781
EXTERNAL_GROUPS = YES
783
# The PERL_PATH should be the absolute path and name of the perl script
784
# interpreter (i.e. the result of `which perl').
786
PERL_PATH = /usr/bin/perl
788
#---------------------------------------------------------------------------
789
# Configuration options related to the dot tool
790
#---------------------------------------------------------------------------
792
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
793
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
794
# super classes. Setting the tag to NO turns the diagrams off. Note that this
795
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
796
# recommended to install and use dot, since it yield more powerful graphs.
800
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
801
# available from the path. This tool is part of Graphviz, a graph visualization
802
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
803
# have no effect if this option is set to NO (the default)
807
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
808
# will generate a graph for each documented class showing the direct and
809
# indirect inheritance relations. Setting this tag to YES will force the
810
# the CLASS_DIAGRAMS tag to NO.
814
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
815
# will generate a graph for each documented class showing the direct and
816
# indirect implementation dependencies (inheritance, containment, and
817
# class references variables) of the class with other documented classes.
819
COLLABORATION_GRAPH = YES
821
# If set to YES, the inheritance and collaboration graphs will show the
822
# relations between templates and their instances.
824
TEMPLATE_RELATIONS = YES
826
# If set to YES, the inheritance and collaboration graphs will hide
827
# inheritance and usage relations if the target is undocumented
830
HIDE_UNDOC_RELATIONS = NO
832
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
833
# tags are set to YES then doxygen will generate a graph for each documented
834
# file showing the direct and indirect include dependencies of the file with
835
# other documented files.
839
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
840
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
841
# documented header file showing the documented files that directly or
842
# indirectly include this file.
844
INCLUDED_BY_GRAPH = YES
846
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
847
# will graphical hierarchy of all classes instead of a textual one.
849
GRAPHICAL_HIERARCHY = YES
851
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
852
# generated by dot. Possible values are gif, jpg, and png
853
# If left blank gif will be used.
855
DOT_IMAGE_FORMAT = gif
857
# The tag DOT_PATH can be used to specify the path where the dot tool can be
858
# found. If left blank, it is assumed the dot tool can be found on the path.
862
# The DOTFILE_DIRS tag can be used to specify one or more directories that
863
# contain dot files that are included in the documentation (see the
868
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
869
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
870
# this value, doxygen will try to truncate the graph, so that it fits within
871
# the specified constraint. Beware that most browsers cannot cope with very
874
MAX_DOT_GRAPH_WIDTH = 1024
876
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
877
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
878
# this value, doxygen will try to truncate the graph, so that it fits within
879
# the specified constraint. Beware that most browsers cannot cope with very
882
MAX_DOT_GRAPH_HEIGHT = 1024
884
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
885
# generate a legend page explaining the meaning of the various boxes and
886
# arrows in the dot generated graphs.
888
GENERATE_LEGEND = YES
890
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
891
# remove the intermedate dot files that are used to generate
892
# the various graphs.
896
#---------------------------------------------------------------------------
897
# Configuration::addtions related to the search engine
898
#---------------------------------------------------------------------------
900
# The SEARCHENGINE tag specifies whether or not a search engine should be
901
# used. If set to NO the values of all tags below this one will be ignored.
905
# The CGI_NAME tag should be the name of the CGI script that
906
# starts the search engine (doxysearch) with the correct parameters.
907
# A script with this name will be generated by doxygen.
909
CGI_NAME = search.cgi
911
# The CGI_URL tag should be the absolute URL to the directory where the
912
# cgi binaries are located. See the documentation of your http daemon for
917
# The DOC_URL tag should be the absolute URL to the directory where the
918
# documentation is located. If left blank the absolute path to the
919
# documentation, with file:// prepended to it, will be used.
923
# The DOC_ABSPATH tag should be the absolute path to the directory where the
924
# documentation is located. If left blank the directory on the local machine
929
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
932
BIN_ABSPATH = /usr/local/bin/
934
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
935
# documentation generated for other projects. This allows doxysearch to search
936
# the documentation for these projects as well.