~drizzle-trunk/drizzle/development

# Doxyfile 1.5.6

# This file describes the settings to be used by the documentation system

# doxygen (www.doxygen.org) for a project

#

# All text after a hash (#) is considered a comment and will be ignored

# The format is:

#       TAG = value [value, ...]

# For lists items can also be appended using:

#       TAG += value [value, ...]

# Values that contain spaces should be placed between quotes (" ")

#---------------------------------------------------------------------------

# Project related configuration options

#---------------------------------------------------------------------------

# This tag specifies the encoding used for all characters in the config file 

# that follow. The default is UTF-8 which is also the encoding used for all 

# text before the first occurrence of this tag. Doxygen uses libiconv (or the 

# iconv built into libc) for the transcoding. See 

# http://www.gnu.org/software/libiconv for the list of possible encodings.

DOXYFILE_ENCODING      = UTF-8

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 

# by quotes) that should identify the project.

PROJECT_NAME           = 

# The PROJECT_NUMBER tag can be used to enter a project or revision number. 

# This could be handy for archiving the generated documentation or 

# if some version control system is used.

PROJECT_NUMBER         = 

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 

# base path where the generated documentation will be put. 

# If a relative path is entered, it will be relative to the location 

# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY       = docs/api

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 

# 4096 sub-directories (in 2 levels) under the output directory of each output 

# format and will distribute the generated files over these directories. 

# Enabling this option can be useful when feeding doxygen a huge amount of 

# source files, where putting all generated files in the same directory would 

# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

# The OUTPUT_LANGUAGE tag is used to specify the language in which all 

# documentation generated by doxygen is written. Doxygen will use this 

# information to generate all constant output in the proper language. 

# The default language is English, other supported languages are: 

# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 

# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 

# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 

# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 

# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 

# and Ukrainian.

OUTPUT_LANGUAGE        = English

# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 

# include brief member descriptions after the members that are listed in 

# the file and class documentation (similar to JavaDoc). 

# Set to NO to disable this.

BRIEF_MEMBER_DESC      = YES

# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 

# the brief description of a member or function before the detailed description. 

# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 

# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

# This tag implements a quasi-intelligent brief description abbreviator 

# that is used to form the text in various listings. Each string 

# in this list, if found as the leading text of the brief description, will be 

# stripped from the text and the result after processing the whole list, is 

# used as the annotated text. Otherwise, the brief description is used as-is. 

# If left blank, the following values are used ("$name" is automatically 

# replaced with the name of the entity): "The $name class" "The $name widget" 

# "The $name file" "is" "provides" "specifies" "contains" 

# "represents" "a" "an" "the"

ABBREVIATE_BRIEF       = 

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 

# Doxygen will generate a detailed section even if there is only a brief 

# description.

ALWAYS_DETAILED_SEC    = YES

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 

# inherited members of a class in the documentation of that class as if those 

# members were ordinary class members. Constructors, destructors and assignment 

# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 

# path before files name in the file list and in the header files. If set 

# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 

# can be used to strip a user-defined part of the path. Stripping is 

# only done if one of the specified strings matches the left-hand part of 

# the path. The tag can be used to show relative paths in the file list. 

# If left blank the directory from which doxygen is run is used as the 

# path to strip.

STRIP_FROM_PATH        = 

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 

# the path mentioned in the documentation of a class, which tells 

# the reader which header file to include in order to use a class. 

# If left blank only the name of the header file containing the class 

# definition is used. Otherwise one should specify the include paths that 

# are normally passed to the compiler using the -I flag.

STRIP_FROM_INC_PATH    = 

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 

# (but less readable) file names. This can be useful is your file systems 

# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 

# will interpret the first line (until the first dot) of a JavaDoc-style 

# comment as the brief description. If set to NO, the JavaDoc 

# comments will behave just like regular Qt-style comments 

# (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF      = NO

# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 

# interpret the first line (until the first dot) of a Qt-style 

# comment as the brief description. If set to NO, the comments 

# will behave just like regular Qt-style comments (thus requiring 

# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 

# treat a multi-line C++ special comment block (i.e. a block of //! or /// 

# comments) as a brief description. This used to be the default behaviour. 

# The new default is to treat a multi-line C++ comment block as a detailed 

# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 

# member inherits the documentation from any documented member that it 

# re-implements.

INHERIT_DOCS           = YES

# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 

# a new page for each member. If set to NO, the documentation of a member will 

# be part of the file/class/namespace that contains it.

SEPARATE_MEMBER_PAGES  = NO

# The TAB_SIZE tag can be used to set the number of spaces in a tab. 

# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

# This tag can be used to specify a number of aliases that acts 

# as commands in the documentation. An alias has the form "name=value". 

# For example adding "sideeffect=\par Side Effects:\n" will allow you to 

# put the command \sideeffect (or @sideeffect) in the documentation, which 

# will result in a user-defined paragraph with heading "Side Effects:". 

# You can put \n's in the value part of an alias to insert newlines.

ALIASES                = 

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 

# sources only. Doxygen will then generate output that is more tailored for C. 

# For instance, some of the names that are used will be different. The list 

# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = YES

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 

# sources only. Doxygen will then generate output that is more tailored for 

# Java. For instance, namespaces will be presented as packages, qualified 

# scopes will look different, etc.

OPTIMIZE_OUTPUT_JAVA   = NO

# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 

# sources only. Doxygen will then generate output that is more tailored for 

# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 

# sources. Doxygen will then generate output that is tailored for 

# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 

# to include (a tag file for) the STL sources as input, then you should 

# set this tag to YES in order to let doxygen match functions declarations and 

# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 

# func(std::string) {}). This also make the inheritance and collaboration 

# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to

# enable parsing support.

CPP_CLI_SUPPORT        = NO

# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 

# Doxygen will parse them like normal C++ but will assume all classes use public 

# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

# For Microsoft's IDL there are propget and propput attributes to indicate getter 

# and setter methods for a property. Setting this option to YES (the default) 

# will make doxygen to replace the get and set methods by a property in the 

# documentation. This will only work if the methods are indeed getting or 

# setting a simple type. If this is not the case, or you want to show the 

# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 

# tag is set to YES, then doxygen will reuse the documentation of the first 

# member in the group (if any) for the other members of the group. By default 

# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 

# the same type (for instance a group of public functions) to be put as a 

# subgroup of that type (e.g. under the Public Functions section). Set it to 

# NO to prevent subgrouping. Alternatively, this can be done per class using 

# the \nosubgrouping command.

SUBGROUPING            = YES

# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 

# is documented as struct, union, or enum with the name of the typedef. So 

# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 

# with name TypeT. When disabled the typedef will appear as a member of a file, 

# namespace, or class. And the struct will be named TypeS. This can typically 

# be useful for C code in case the coding convention dictates that all compound 

# types are typedef'ed and only the typedef is referenced, never the tag name.

TYPEDEF_HIDES_STRUCT   = YES

#---------------------------------------------------------------------------

# Build related configuration options

#---------------------------------------------------------------------------

# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 

# documentation are documented, even if no documentation was available. 

# Private class members and static file members will be hidden unless 

# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = YES

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 

# will be included in the documentation.

EXTRACT_PRIVATE        = YES

# If the EXTRACT_STATIC tag is set to YES all static members of a file 

# will be included in the documentation.

EXTRACT_STATIC         = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 

# defined locally in source files will be included in the documentation. 

# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

# This flag is only useful for Objective-C code. When set to YES local 

# methods, which are defined in the implementation section but not in 

# the interface are included in the documentation. 

# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

# If this flag is set to YES, the members of anonymous namespaces will be 

# extracted and appear in the documentation as a namespace called 

# 'anonymous_namespace{file}', where file will be replaced with the base 

# name of the file that contains the anonymous namespace. By default 

# anonymous namespace are hidden.

EXTRACT_ANON_NSPACES   = NO

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 

# undocumented members of documented classes, files or namespaces. 

# If set to NO (the default) these members will be included in the 

# various overviews, but no documentation section is generated. 

# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 

# undocumented classes that are normally visible in the class hierarchy. 

# If set to NO (the default) these classes will be included in the various 

# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 

# friend (class|struct|union) declarations. 

# If set to NO (the default) these declarations will be included in the 

# documentation.

HIDE_FRIEND_COMPOUNDS  = NO

# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 

# documentation blocks found inside the body of a function. 

# If set to NO (the default) these blocks will be appended to the 

# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

# The INTERNAL_DOCS tag determines if documentation 

# that is typed after a \internal command is included. If the tag is set 

# to NO (the default) then the documentation will be excluded. 

# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 

# file names in lower-case letters. If set to YES upper-case letters are also 

# allowed. This is useful if you have classes or files whose names only differ 

# in case and if your file system supports case sensitive file names. Windows 

# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = YES

# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 

# will show members with their full class and namespace scopes in the 

# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 

# will put a list of the files that are included by a file in the documentation 

# of that file.

SHOW_INCLUDE_FILES     = YES

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 

# is inserted in the documentation for inline members.

INLINE_INFO            = YES

# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 

# will sort the (detailed) documentation of file and class members 

# alphabetically by member name. If set to NO the members will appear in 

# declaration order.

SORT_MEMBER_DOCS       = NO

# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 

# brief documentation of file, namespace and class members alphabetically 

# by member name. If set to NO (the default) the members will appear in 

# declaration order.

SORT_BRIEF_DOCS        = NO

# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 

# hierarchy of group names into alphabetical order. If set to NO (the default) 

# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 

# sorted by fully-qualified names, including namespaces. If set to 

# NO (the default), the class list will be sorted only by class name, 

# not including the namespace part. 

# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.

# Note: This option applies only to the class list, not to the 

# alphabetical list.

SORT_BY_SCOPE_NAME     = NO

# The GENERATE_TODOLIST tag can be used to enable (YES) or 

# disable (NO) the todo list. This list is created by putting \todo 

# commands in the documentation.

GENERATE_TODOLIST      = YES

# The GENERATE_TESTLIST tag can be used to enable (YES) or 

# disable (NO) the test list. This list is created by putting \test 

# commands in the documentation.

GENERATE_TESTLIST      = YES

# The GENERATE_BUGLIST tag can be used to enable (YES) or 

# disable (NO) the bug list. This list is created by putting \bug 

# commands in the documentation.

GENERATE_BUGLIST       = YES

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 

# disable (NO) the deprecated list. This list is created by putting 

# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

# The ENABLED_SECTIONS tag can be used to enable conditional 

# documentation sections, marked by \if sectionname ... \endif.

ENABLED_SECTIONS       = 

# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 

# the initial value of a variable or define consists of for it to appear in 

# the documentation. If the initializer consists of more lines than specified 

# here it will be hidden. Use a value of 0 to hide initializers completely. 

# The appearance of the initializer of individual variables and defines in the 

# documentation can be controlled using \showinitializer or \hideinitializer 

# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 

# at the bottom of the documentation of classes and structs. If set to YES the 

# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

# If the sources in your project are distributed over multiple directories 

# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 

# in the documentation. The default is NO.

SHOW_DIRECTORIES       = NO

# Set the SHOW_FILES tag to NO to disable the generation of the Files page.

# This will remove the Files entry from the Quick Index and from the 

# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the 

# Namespaces page.  This will remove the Namespaces entry from the Quick Index

# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

# The FILE_VERSION_FILTER tag can be used to specify a program or script that 

# doxygen should invoke to get the current version for each file (typically from 

# the version control system). Doxygen will invoke the program by executing (via 

# popen()) the command <command> <input-file>, where <command> is the value of 

# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 

# provided by doxygen. Whatever the program writes to standard output 

# is used as the file version. See the manual for examples.

FILE_VERSION_FILTER    = 

#---------------------------------------------------------------------------

# configuration options related to warning and progress messages

#---------------------------------------------------------------------------

# The QUIET tag can be used to turn on/off the messages that are generated 

# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = NO

# The WARNINGS tag can be used to turn on/off the warning messages that are 

# generated by doxygen. Possible values are YES and NO. If left blank 

# NO is used.

WARNINGS               = YES

# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 

# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 

# automatically be disabled.

WARN_IF_UNDOCUMENTED   = NO

# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 

# potential errors in the documentation, such as not documenting some 

# parameters in a documented function, or documenting parameters that 

# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

# This WARN_NO_PARAMDOC option can be abled to get warnings for 

# functions that are documented, but have no documentation for their parameters 

# or return value. If set to NO (the default) doxygen will only warn about 

# wrong or incomplete parameter documentation, but not about the absence of 

# documentation.

WARN_NO_PARAMDOC       = NO

# The WARN_FORMAT tag determines the format of the warning messages that 

# doxygen can produce. The string should contain the $file, $line, and $text 

# tags, which will be replaced by the file and line number from which the 

# warning originated and the warning text. Optionally the format may contain 

# $version, which will be replaced by the version of the file (if it could 

# be obtained via FILE_VERSION_FILTER)

WARN_FORMAT            = "$file:$line: $text"

# The WARN_LOGFILE tag can be used to specify a file to which warning 

# and error messages should be written. If left blank the output is written 

# to stderr.

WARN_LOGFILE           = 

#---------------------------------------------------------------------------

# configuration options related to the input files

#---------------------------------------------------------------------------

# The INPUT tag can be used to specify the files and/or directories that contain 

# documented source files. You may enter file names like "myfile.cpp" or 

# directories like "/usr/src/myproject". Separate the files or directories 

# with spaces.

INPUT                  = docs/doxygen.h \

                         libdrizzle/constants.h \

                         libdrizzle/drizzle.h \

                         libdrizzle/drizzle_client.h \

                         libdrizzle/drizzle_server.h \

                         libdrizzle/conn.h \

                         libdrizzle/conn_client.h \

                         libdrizzle/conn_server.h \

                         libdrizzle/handshake_client.h \

                         libdrizzle/handshake_server.h \

                         libdrizzle/command_client.h \

                         libdrizzle/command_server.h \

                         libdrizzle/query.h \

                         libdrizzle/result.h \

                         libdrizzle/result_client.h \

                         libdrizzle/result_server.h \

                         libdrizzle/column.h \

                         libdrizzle/column_client.h \

                         libdrizzle/column_server.h \

                         libdrizzle/row_client.h \

                         libdrizzle/row_server.h \

                         libdrizzle/field_client.h \

                         libdrizzle/field_server.h \

                         examples

# This tag can be used to specify the character encoding of the source files 

# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 

# also the default input encoding. Doxygen uses libiconv (or the iconv built 

# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 

# the list of possible encodings.

INPUT_ENCODING         = UTF-8

# If the value of the INPUT tag contains directories, you can use the 

# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

# and *.h) to filter out the source-files in the directories. If left 

# blank the following patterns are tested: 

# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 

# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90

FILE_PATTERNS          = *.h *.c

# The RECURSIVE tag can be used to turn specify whether or not subdirectories 

# should be searched for input files as well. Possible values are YES and NO. 

# If left blank NO is used.

RECURSIVE              = YES

# The EXCLUDE tag can be used to specify files and/or directories that should 

# excluded from the INPUT source files. This way you can easily exclude a 

# subdirectory from a directory tree whose root is specified with the INPUT tag.

EXCLUDE                = 

# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 

# directories that are symbolic links (a Unix filesystem feature) are excluded 

# from the input.

EXCLUDE_SYMLINKS       = NO

# If the value of the INPUT tag contains directories, you can use the 

# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 

# certain files from those directories. Note that the wildcards are matched 

# against the file with absolute path, so to exclude all test directories 

# for example use the pattern */test/*

EXCLUDE_PATTERNS       = 

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 

# (namespaces, classes, functions, etc.) that should be excluded from the 

# output. The symbol name can be a fully qualified name, a word, or if the 

# wildcard * is used, a substring. Examples: ANamespace, AClass, 

# AClass::ANamespace, ANamespace::*Test

EXCLUDE_SYMBOLS        = 

# The EXAMPLE_PATH tag can be used to specify one or more files or 

# directories that contain example code fragments that are included (see 

# the \include command).

EXAMPLE_PATH           = 

# If the value of the EXAMPLE_PATH tag contains directories, you can use the 

# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

# and *.h) to filter out the source-files in the directories. If left 

# blank all files are included.

EXAMPLE_PATTERNS       = 

# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 

# searched for input files to be used with the \include or \dontinclude 

# commands irrespective of the value of the RECURSIVE tag. 

# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

# The IMAGE_PATH tag can be used to specify one or more files or 

# directories that contain image that are included in the documentation (see 

# the \image command).

IMAGE_PATH             = 

# The INPUT_FILTER tag can be used to specify a program that doxygen should 

# invoke to filter for each input file. Doxygen will invoke the filter program 

# by executing (via popen()) the command <filter> <input-file>, where <filter> 

# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 

# input file. Doxygen will then use the output that the filter program writes 

# to standard output.  If FILTER_PATTERNS is specified, this tag will be 

# ignored.

INPUT_FILTER           = 

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 

# basis.  Doxygen will compare the file name with each pattern and apply the 

# filter if there is a match.  The filters are a list of the form: 

# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 

# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 

# is applied to all files.

FILTER_PATTERNS        = 

# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 

# INPUT_FILTER) will be used to filter the input files when producing source 

# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

#---------------------------------------------------------------------------

# configuration options related to source browsing

#---------------------------------------------------------------------------

# If the SOURCE_BROWSER tag is set to YES then a list of source files will 

# be generated. Documented entities will be cross-referenced with these sources. 

# Note: To get rid of all source code in the generated output, make sure also 

# VERBATIM_HEADERS is set to NO.

SOURCE_BROWSER         = YES

# Setting the INLINE_SOURCES tag to YES will include the body 

# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 

# doxygen to hide any special comment blocks from generated source code 

# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

# If the REFERENCED_BY_RELATION tag is set to YES 

# then for each documented function all documented 

# functions referencing it will be listed.

REFERENCED_BY_RELATION = NO

# If the REFERENCES_RELATION tag is set to YES 

# then for each documented function all documented entities 

# called/used by that function will be listed.

REFERENCES_RELATION    = NO

# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)

# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from

# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will

# link to the source code.  Otherwise they will link to the documentstion.

REFERENCES_LINK_SOURCE = YES

# If the USE_HTAGS tag is set to YES then the references to source code 

# will point to the HTML generated by the htags(1) tool instead of doxygen 

# built-in source browser. The htags tool is part of GNU's global source 

# tagging system (see http://www.gnu.org/software/global/global.html). You 

# will need version 4.8.6 or higher.

USE_HTAGS              = NO

# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 

# will generate a verbatim copy of the header file for each class for 

# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

#---------------------------------------------------------------------------

# configuration options related to the alphabetical class index

#---------------------------------------------------------------------------

# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 

# of all compounds will be generated. Enable this if the project 

# contains a lot of classes, structs, unions or interfaces.

ALPHABETICAL_INDEX     = NO

# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 

# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 

# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

# In case all classes in a project start with a common prefix, all 

# classes will be put under the same header in the alphabetical index. 

# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 

# should be ignored while generating the index headers.

IGNORE_PREFIX          = 

#---------------------------------------------------------------------------

# configuration options related to the HTML output

#---------------------------------------------------------------------------

# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 

# generate HTML output.

GENERATE_HTML          = YES

# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.