Blame doxygen.conf

Packit fcad23
# Doxyfile 1.2.11
Packit fcad23
Packit fcad23
# This file describes the settings to be used by the documentation system
Packit fcad23
# doxygen (www.doxygen.org) for a project
Packit fcad23
#
Packit fcad23
# All text after a hash (#) is considered a comment and will be ignored
Packit fcad23
# The format is:
Packit fcad23
#       TAG = value [value, ...]
Packit fcad23
# For lists items can also be appended using:
Packit fcad23
#       TAG += value [value, ...]
Packit fcad23
# Values that contain spaces should be placed between quotes (" ")
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# General configuration options
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
Packit fcad23
# by quotes) that should identify the project.
Packit fcad23
Packit fcad23
PROJECT_NAME           = net-snmp
Packit fcad23
Packit fcad23
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
Packit fcad23
# This could be handy for archiving the generated documentation or 
Packit fcad23
# if some version control system is used.
Packit fcad23
Packit fcad23
PROJECT_NUMBER         = $(VERSION)
Packit fcad23
Packit fcad23
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
Packit fcad23
# base path where the generated documentation will be put. 
Packit fcad23
# If a relative path is entered, it will be relative to the location 
Packit fcad23
# where doxygen was started. If left blank the current directory will be used.
Packit fcad23
Packit fcad23
OUTPUT_DIRECTORY       = docs
Packit fcad23
Packit fcad23
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
Packit fcad23
# documentation generated by doxygen is written. Doxygen will use this 
Packit fcad23
# information to generate all constant output in the proper language. 
Packit fcad23
# The default language is English, other supported languages are: 
Packit fcad23
# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, 
Packit fcad23
# German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, 
Packit fcad23
# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
Packit fcad23
Packit fcad23
OUTPUT_LANGUAGE        = English
Packit fcad23
Packit fcad23
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
Packit fcad23
# documentation are documented, even if no documentation was available. 
Packit fcad23
# Private class members and static file members will be hidden unless 
Packit fcad23
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
Packit fcad23
Packit fcad23
EXTRACT_ALL            = NO
Packit fcad23
Packit fcad23
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
Packit fcad23
# will be included in the documentation.
Packit fcad23
Packit fcad23
EXTRACT_PRIVATE        = NO
Packit fcad23
Packit fcad23
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
Packit fcad23
# will be included in the documentation.
Packit fcad23
Packit fcad23
EXTRACT_STATIC         = NO
Packit fcad23
Packit fcad23
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
Packit fcad23
# undocumented members of documented classes, files or namespaces. 
Packit fcad23
# If set to NO (the default) these members will be included in the 
Packit fcad23
# various overviews, but no documentation section is generated. 
Packit fcad23
# This option has no effect if EXTRACT_ALL is enabled.
Packit fcad23
Packit fcad23
HIDE_UNDOC_MEMBERS     = NO
Packit fcad23
Packit fcad23
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
Packit fcad23
# undocumented classes that are normally visible in the class hierarchy. 
Packit fcad23
# If set to NO (the default) these class will be included in the various 
Packit fcad23
# overviews. This option has no effect if EXTRACT_ALL is enabled.
Packit fcad23
Packit fcad23
HIDE_UNDOC_CLASSES     = NO
Packit fcad23
Packit fcad23
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
Packit fcad23
# include brief member descriptions after the members that are listed in 
Packit fcad23
# the file and class documentation (similar to JavaDoc). 
Packit fcad23
# Set to NO to disable this.
Packit fcad23
Packit fcad23
BRIEF_MEMBER_DESC      = YES
Packit fcad23
Packit fcad23
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
Packit fcad23
# the brief description of a member or function before the detailed description. 
Packit fcad23
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
Packit fcad23
# brief descriptions will be completely suppressed.
Packit fcad23
Packit fcad23
REPEAT_BRIEF           = YES
Packit fcad23
Packit fcad23
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
Packit fcad23
# Doxygen will generate a detailed section even if there is only a brief 
Packit fcad23
# description.
Packit fcad23
Packit fcad23
ALWAYS_DETAILED_SEC    = YES
Packit fcad23
Packit fcad23
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
Packit fcad23
# path before files name in the file list and in the header files. If set 
Packit fcad23
# to NO the shortest path that makes the file name unique will be used.
Packit fcad23
Packit fcad23
FULL_PATH_NAMES        = NO
Packit fcad23
Packit fcad23
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
Packit fcad23
# can be used to strip a user defined part of the path. Stripping is 
Packit fcad23
# only done if one of the specified strings matches the left-hand part of 
Packit fcad23
# the path. It is allowed to use relative paths in the argument list.
Packit fcad23
Packit fcad23
STRIP_FROM_PATH        = 
Packit fcad23
Packit fcad23
# The INTERNAL_DOCS tag determines if documentation 
Packit fcad23
# that is typed after a \internal command is included. If the tag is set 
Packit fcad23
# to NO (the default) then the documentation will be excluded. 
Packit fcad23
# Set it to YES to include the internal documentation.
Packit fcad23
Packit fcad23
INTERNAL_DOCS          = NO
Packit fcad23
Packit fcad23
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
Packit fcad23
# generate a class diagram (in Html and LaTeX) for classes with base or 
Packit fcad23
# super classes. Setting the tag to NO turns the diagrams off.
Packit fcad23
Packit fcad23
CLASS_DIAGRAMS         = YES
Packit fcad23
Packit fcad23
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
Packit fcad23
# be generated. Documented entities will be cross-referenced with these sources.
Packit fcad23
Packit fcad23
SOURCE_BROWSER         = YES
Packit fcad23
Packit fcad23
# Setting the INLINE_SOURCES tag to YES will include the body 
Packit fcad23
# of functions and classes directly in the documentation.
Packit fcad23
Packit fcad23
INLINE_SOURCES         = NO
Packit fcad23
Packit fcad23
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
Packit fcad23
# doxygen to hide any special comment blocks from generated source code 
Packit fcad23
# fragments. Normal C and C++ comments will always remain visible.
Packit fcad23
Packit fcad23
STRIP_CODE_COMMENTS    = YES
Packit fcad23
Packit fcad23
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
Packit fcad23
# file names in lower case letters. If set to YES upper case letters are also 
Packit fcad23
# allowed. This is useful if you have classes or files whose names only differ 
Packit fcad23
# in case and if your file system supports case sensitive file names. Windows 
Packit fcad23
# users are adviced to set this option to NO.
Packit fcad23
Packit fcad23
CASE_SENSE_NAMES       = YES
Packit fcad23
Packit fcad23
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
Packit fcad23
# (but less readable) file names. This can be useful is your file systems 
Packit fcad23
# doesn't support long names like on DOS, Mac, or CD-ROM.
Packit fcad23
Packit fcad23
SHORT_NAMES            = NO
Packit fcad23
Packit fcad23
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
Packit fcad23
# will show members with their full class and namespace scopes in the 
Packit fcad23
# documentation. If set to YES the scope will be hidden.
Packit fcad23
Packit fcad23
HIDE_SCOPE_NAMES       = NO
Packit fcad23
Packit fcad23
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
Packit fcad23
# will generate a verbatim copy of the header file for each class for 
Packit fcad23
# which an include is specified. Set to NO to disable this.
Packit fcad23
Packit fcad23
VERBATIM_HEADERS       = YES
Packit fcad23
Packit fcad23
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
Packit fcad23
# will put list of the files that are included by a file in the documentation 
Packit fcad23
# of that file.
Packit fcad23
Packit fcad23
SHOW_INCLUDE_FILES     = YES
Packit fcad23
Packit fcad23
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
Packit fcad23
# will interpret the first line (until the first dot) of a JavaDoc-style 
Packit fcad23
# comment as the brief description. If set to NO, the JavaDoc 
Packit fcad23
# comments  will behave just like the Qt-style comments (thus requiring an 
Packit fcad23
# explict @brief command for a brief description.
Packit fcad23
Packit fcad23
JAVADOC_AUTOBRIEF      = YES
Packit fcad23
Packit fcad23
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
Packit fcad23
# member inherits the documentation from any documented member that it 
Packit fcad23
# reimplements.
Packit fcad23
Packit fcad23
INHERIT_DOCS           = YES
Packit fcad23
Packit fcad23
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
Packit fcad23
# is inserted in the documentation for inline members.
Packit fcad23
Packit fcad23
INLINE_INFO            = YES
Packit fcad23
Packit fcad23
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
Packit fcad23
# will sort the (detailed) documentation of file and class members 
Packit fcad23
# alphabetically by member name. If set to NO the members will appear in 
Packit fcad23
# declaration order.
Packit fcad23
Packit fcad23
SORT_MEMBER_DOCS       = YES
Packit fcad23
Packit fcad23
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
Packit fcad23
# tag is set to YES, then doxygen will reuse the documentation of the first 
Packit fcad23
# member in the group (if any) for the other members of the group. By default 
Packit fcad23
# all members of a group must be documented explicitly.
Packit fcad23
Packit fcad23
DISTRIBUTE_GROUP_DOC   = NO
Packit fcad23
Packit fcad23
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
Packit fcad23
# Doxygen uses this value to replace tabs by spaces in code fragments.
Packit fcad23
Packit fcad23
TAB_SIZE               = 8
Packit fcad23
Packit fcad23
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
Packit fcad23
# disable (NO) the todo list. This list is created by putting \todo 
Packit fcad23
# commands in the documentation.
Packit fcad23
Packit fcad23
GENERATE_TODOLIST      = YES
Packit fcad23
Packit fcad23
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
Packit fcad23
# disable (NO) the test list. This list is created by putting \test 
Packit fcad23
# commands in the documentation.
Packit fcad23
Packit fcad23
GENERATE_TESTLIST      = YES
Packit fcad23
Packit fcad23
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
Packit fcad23
# disable (NO) the bug list. This list is created by putting \bug 
Packit fcad23
# commands in the documentation.
Packit fcad23
Packit fcad23
GENERATE_BUGLIST       = YES
Packit fcad23
Packit fcad23
# This tag can be used to specify a number of aliases that acts 
Packit fcad23
# as commands in the documentation. An alias has the form "name=value". 
Packit fcad23
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
Packit fcad23
# put the command \sideeffect (or @sideeffect) in the documentation, which 
Packit fcad23
# will result in a user defined paragraph with heading "Side Effects:". 
Packit fcad23
# You can put \n's in the value part of an alias to insert newlines.
Packit fcad23
Packit fcad23
ALIASES                = 
Packit fcad23
Packit fcad23
# The ENABLED_SECTIONS tag can be used to enable conditional 
Packit fcad23
# documentation sections, marked by \if sectionname ... \endif.
Packit fcad23
Packit fcad23
ENABLED_SECTIONS       = 
Packit fcad23
Packit fcad23
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
Packit fcad23
# the initial value of a variable or define consist of for it to appear in 
Packit fcad23
# the documentation. If the initializer consists of more lines than specified 
Packit fcad23
# here it will be hidden. Use a value of 0 to hide initializers completely. 
Packit fcad23
# The appearance of the initializer of individual variables and defines in the 
Packit fcad23
# documentation can be controlled using \showinitializer or \hideinitializer 
Packit fcad23
# command in the documentation regardless of this setting.
Packit fcad23
Packit fcad23
MAX_INITIALIZER_LINES  = 30
Packit fcad23
Packit fcad23
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
Packit fcad23
# only. Doxygen will then generate output that is more tailored for C. 
Packit fcad23
# For instance some of the names that are used will be different. The list 
Packit fcad23
# of all members will be omitted, etc.
Packit fcad23
Packit fcad23
OPTIMIZE_OUTPUT_FOR_C  = YES
Packit fcad23
Packit fcad23
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
Packit fcad23
# at the bottom of the documentation of classes and structs. If set to YES the 
Packit fcad23
# list will mention the files that were used to generate the documentation.
Packit fcad23
Packit fcad23
SHOW_USED_FILES        = YES
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# configuration options related to warning and progress messages
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# The QUIET tag can be used to turn on/off the messages that are generated 
Packit fcad23
# by doxygen. Possible values are YES and NO. If left blank NO is used.
Packit fcad23
Packit fcad23
QUIET                  = YES
Packit fcad23
Packit fcad23
# The WARNINGS tag can be used to turn on/off the warning messages that are 
Packit fcad23
# generated by doxygen. Possible values are YES and NO. If left blank 
Packit fcad23
# NO is used.
Packit fcad23
Packit fcad23
WARNINGS               = YES
Packit fcad23
Packit fcad23
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
Packit fcad23
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
Packit fcad23
# automatically be disabled.
Packit fcad23
Packit fcad23
WARN_IF_UNDOCUMENTED   = NO
Packit fcad23
Packit fcad23
# The WARN_FORMAT tag determines the format of the warning messages that 
Packit fcad23
# doxygen can produce. The string should contain the $file, $line, and $text 
Packit fcad23
# tags, which will be replaced by the file and line number from which the 
Packit fcad23
# warning originated and the warning text.
Packit fcad23
Packit fcad23
WARN_FORMAT            = 
Packit fcad23
Packit fcad23
# The WARN_LOGFILE tag can be used to specify a file to which warning 
Packit fcad23
# and error messages should be written. If left blank the output is written 
Packit fcad23
# to stderr.
Packit fcad23
Packit fcad23
WARN_LOGFILE           = 
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# configuration options related to the input files
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# The INPUT tag can be used to specify the files and/or directories that contain 
Packit fcad23
# documented source files. You may enter file names like "myfile.cpp" or 
Packit fcad23
# directories like "/usr/src/myproject". Separate the files or directories 
Packit fcad23
# with spaces.
Packit fcad23
Packit fcad23
INPUT                  = $(srcdir) $(srcdir)/agent $(srcdir)/snmplib $(srcdir)/agent/helpers $(srcdir)/agent/mibgroup/examples $(srcdir)/include/net-snmp $(srcdir)/include/net-snmp/library $(srcdir)/include/net-snmp/agent
Packit fcad23
Packit fcad23
# If the value of the INPUT tag contains directories, you can use the 
Packit fcad23
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
Packit fcad23
# and *.h) to filter out the source-files in the directories. If left 
Packit fcad23
# blank all files are included.
Packit fcad23
Packit fcad23
FILE_PATTERNS          = *.c *.h
Packit fcad23
Packit fcad23
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
Packit fcad23
# should be searched for input files as well. Possible values are YES and NO. 
Packit fcad23
# If left blank NO is used.
Packit fcad23
Packit fcad23
RECURSIVE              = NO
Packit fcad23
Packit fcad23
# The EXCLUDE tag can be used to specify files and/or directories that should 
Packit fcad23
# excluded from the INPUT source files. This way you can easily exclude a 
Packit fcad23
# subdirectory from a directory tree whose root is specified with the INPUT tag.
Packit fcad23
Packit fcad23
EXCLUDE                = 
Packit fcad23
Packit fcad23
# If the value of the INPUT tag contains directories, you can use the 
Packit fcad23
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
Packit fcad23
# certain files from those directories.
Packit fcad23
Packit fcad23
EXCLUDE_PATTERNS       = 
Packit fcad23
Packit fcad23
# The EXAMPLE_PATH tag can be used to specify one or more files or 
Packit fcad23
# directories that contain example code fragments that are included (see 
Packit fcad23
# the \include command).
Packit fcad23
Packit fcad23
EXAMPLE_PATH           = $(srcdir)/agent/mibgroup/examples
Packit fcad23
Packit fcad23
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
Packit fcad23
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
Packit fcad23
# and *.h) to filter out the source-files in the directories. If left 
Packit fcad23
# blank all files are included.
Packit fcad23
Packit fcad23
EXAMPLE_PATTERNS       = 
Packit fcad23
Packit fcad23
# The IMAGE_PATH tag can be used to specify one or more files or 
Packit fcad23
# directories that contain image that are included in the documentation (see 
Packit fcad23
# the \image command).
Packit fcad23
Packit fcad23
IMAGE_PATH             = 
Packit fcad23
Packit fcad23
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
Packit fcad23
# invoke to filter for each input file. Doxygen will invoke the filter program 
Packit fcad23
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
Packit fcad23
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
Packit fcad23
# input file. Doxygen will then use the output that the filter program writes 
Packit fcad23
# to standard output.
Packit fcad23
Packit fcad23
INPUT_FILTER           = 
Packit fcad23
Packit fcad23
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
Packit fcad23
# INPUT_FILTER) will be used to filter the input files when producing source 
Packit fcad23
# files to browse.
Packit fcad23
Packit fcad23
FILTER_SOURCE_FILES    = NO
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# configuration options related to the alphabetical class index
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
Packit fcad23
# of all compounds will be generated. Enable this if the project 
Packit fcad23
# contains a lot of classes, structs, unions or interfaces.
Packit fcad23
Packit fcad23
ALPHABETICAL_INDEX     = NO
Packit fcad23
Packit fcad23
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
Packit fcad23
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
Packit fcad23
# in which this list will be split (can be a number in the range [1..20])
Packit fcad23
Packit fcad23
COLS_IN_ALPHA_INDEX    = 5
Packit fcad23
Packit fcad23
# In case all classes in a project start with a common prefix, all 
Packit fcad23
# classes will be put under the same header in the alphabetical index. 
Packit fcad23
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
Packit fcad23
# should be ignored while generating the index headers.
Packit fcad23
Packit fcad23
IGNORE_PREFIX          = 
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# configuration options related to the HTML output
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
Packit fcad23
# generate HTML output.
Packit fcad23
Packit fcad23
GENERATE_HTML          = YES
Packit fcad23
Packit fcad23
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
Packit fcad23
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
Packit fcad23
# put in front of it. If left blank `html' will be used as the default path.
Packit fcad23
Packit fcad23
HTML_OUTPUT            = 
Packit fcad23
Packit fcad23
# The HTML_HEADER tag can be used to specify a personal HTML header for 
Packit fcad23
# each generated HTML page. If it is left blank doxygen will generate a 
Packit fcad23
# standard header.
Packit fcad23
Packit fcad23
HTML_HEADER            = 
Packit fcad23
Packit fcad23
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
Packit fcad23
# each generated HTML page. If it is left blank doxygen will generate a 
Packit fcad23
# standard footer.
Packit fcad23
Packit fcad23
HTML_FOOTER            = 
Packit fcad23
Packit fcad23
# The HTML_STYLESHEET tag can be used to specify a user defined cascading 
Packit fcad23
# style sheet that is used by each HTML page. It can be used to 
Packit fcad23
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
Packit fcad23
# will generate a default style sheet
Packit fcad23
Packit fcad23
HTML_STYLESHEET        = 
Packit fcad23
Packit fcad23
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
Packit fcad23
# files or namespaces will be aligned in HTML using tables. If set to 
Packit fcad23
# NO a bullet list will be used.
Packit fcad23
Packit fcad23
HTML_ALIGN_MEMBERS     = YES
Packit fcad23
Packit fcad23
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
Packit fcad23
# will be generated that can be used as input for tools like the 
Packit fcad23
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
Packit fcad23
# of the generated HTML documentation.
Packit fcad23
Packit fcad23
GENERATE_HTMLHELP      = NO
Packit fcad23
Packit fcad23
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
Packit fcad23
# controls if a separate .chi index file is generated (YES) or that 
Packit fcad23
# it should be included in the master .chm file (NO).
Packit fcad23
Packit fcad23
GENERATE_CHI           = NO
Packit fcad23
Packit fcad23
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
Packit fcad23
# controls whether a binary table of contents is generated (YES) or a 
Packit fcad23
# normal table of contents (NO) in the .chm file.
Packit fcad23
Packit fcad23
BINARY_TOC             = NO
Packit fcad23
Packit fcad23
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
Packit fcad23
# to the contents of the Html help documentation and to the tree view.
Packit fcad23
Packit fcad23
TOC_EXPAND             = NO
Packit fcad23
Packit fcad23
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
Packit fcad23
# top of each HTML page. The value NO (the default) enables the index and 
Packit fcad23
# the value YES disables it.
Packit fcad23
Packit fcad23
DISABLE_INDEX          = NO
Packit fcad23
Packit fcad23
# This tag can be used to set the number of enum values (range [1..20]) 
Packit fcad23
# that doxygen will group on one line in the generated HTML documentation.
Packit fcad23
Packit fcad23
ENUM_VALUES_PER_LINE   = 4
Packit fcad23
Packit fcad23
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
Packit fcad23
# generated containing a tree-like index structure (just like the one that 
Packit fcad23
# is generated for HTML Help). For this to work a browser that supports 
Packit fcad23
# JavaScript and frames is required (for instance Netscape 4.0+ 
Packit fcad23
# or Internet explorer 4.0+).
Packit fcad23
Packit fcad23
GENERATE_TREEVIEW      = NO
Packit fcad23
Packit fcad23
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
Packit fcad23
# used to set the initial width (in pixels) of the frame in which the tree 
Packit fcad23
# is shown.
Packit fcad23
Packit fcad23
TREEVIEW_WIDTH         = 250
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# configuration options related to the LaTeX output
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
Packit fcad23
# generate Latex output.
Packit fcad23
Packit fcad23
GENERATE_LATEX         = YES
Packit fcad23
Packit fcad23
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
Packit fcad23
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
Packit fcad23
# put in front of it. If left blank `latex' will be used as the default path.
Packit fcad23
Packit fcad23
LATEX_OUTPUT           = 
Packit fcad23
Packit fcad23
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
Packit fcad23
# LaTeX documents. This may be useful for small projects and may help to 
Packit fcad23
# save some trees in general.
Packit fcad23
Packit fcad23
COMPACT_LATEX          = NO
Packit fcad23
Packit fcad23
# The PAPER_TYPE tag can be used to set the paper type that is used 
Packit fcad23
# by the printer. Possible values are: a4, a4wide, letter, legal and 
Packit fcad23
# executive. If left blank a4wide will be used.
Packit fcad23
Packit fcad23
PAPER_TYPE             = a4wide
Packit fcad23
Packit fcad23
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
Packit fcad23
# packages that should be included in the LaTeX output.
Packit fcad23
Packit fcad23
EXTRA_PACKAGES         = 
Packit fcad23
Packit fcad23
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
Packit fcad23
# the generated latex document. The header should contain everything until 
Packit fcad23
# the first chapter. If it is left blank doxygen will generate a 
Packit fcad23
# standard header. Notice: only use this tag if you know what you are doing!
Packit fcad23
Packit fcad23
LATEX_HEADER           = 
Packit fcad23
Packit fcad23
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
Packit fcad23
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
Packit fcad23
# contain links (just like the HTML output) instead of page references 
Packit fcad23
# This makes the output suitable for online browsing using a pdf viewer.
Packit fcad23
Packit fcad23
PDF_HYPERLINKS         = NO
Packit fcad23
Packit fcad23
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
Packit fcad23
# plain latex in the generated Makefile. Set this option to YES to get a 
Packit fcad23
# higher quality PDF documentation.
Packit fcad23
Packit fcad23
USE_PDFLATEX           = NO
Packit fcad23
Packit fcad23
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
Packit fcad23
# command to the generated LaTeX files. This will instruct LaTeX to keep 
Packit fcad23
# running if errors occur, instead of asking the user for help. 
Packit fcad23
# This option is also used when generating formulas in HTML.
Packit fcad23
Packit fcad23
LATEX_BATCHMODE        = NO
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# configuration options related to the RTF output
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
Packit fcad23
# The RTF output is optimised for Word 97 and may not look very pretty with 
Packit fcad23
# other RTF readers or editors.
Packit fcad23
Packit fcad23
GENERATE_RTF           = NO
Packit fcad23
Packit fcad23
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
Packit fcad23
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
Packit fcad23
# put in front of it. If left blank `rtf' will be used as the default path.
Packit fcad23
Packit fcad23
RTF_OUTPUT             = 
Packit fcad23
Packit fcad23
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
Packit fcad23
# RTF documents. This may be useful for small projects and may help to 
Packit fcad23
# save some trees in general.
Packit fcad23
Packit fcad23
COMPACT_RTF            = NO
Packit fcad23
Packit fcad23
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
Packit fcad23
# will contain hyperlink fields. The RTF file will 
Packit fcad23
# contain links (just like the HTML output) instead of page references. 
Packit fcad23
# This makes the output suitable for online browsing using WORD or other 
Packit fcad23
# programs which support those fields. 
Packit fcad23
# Note: wordpad (write) and others do not support links.
Packit fcad23
Packit fcad23
RTF_HYPERLINKS         = NO
Packit fcad23
Packit fcad23
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
Packit fcad23
# config file, i.e. a series of assigments. You only have to provide 
Packit fcad23
# replacements, missing definitions are set to their default value.
Packit fcad23
Packit fcad23
RTF_STYLESHEET_FILE    = 
Packit fcad23
Packit fcad23
# Set optional variables used in the generation of an rtf document. 
Packit fcad23
# Syntax is similar to doxygen's config file.
Packit fcad23
Packit fcad23
RTF_EXTENSIONS_FILE    = 
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# configuration options related to the man page output
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
Packit fcad23
# generate man pages
Packit fcad23
Packit fcad23
GENERATE_MAN           = NO
Packit fcad23
Packit fcad23
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
Packit fcad23
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
Packit fcad23
# put in front of it. If left blank `man' will be used as the default path.
Packit fcad23
Packit fcad23
MAN_OUTPUT             = 
Packit fcad23
Packit fcad23
# The MAN_EXTENSION tag determines the extension that is added to 
Packit fcad23
# the generated man pages (default is the subroutine's section .3)
Packit fcad23
Packit fcad23
MAN_EXTENSION          = 
Packit fcad23
Packit fcad23
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
Packit fcad23
# then it will generate one additional man file for each entity
Packit fcad23
# documented in the real man page(s). These additional files
Packit fcad23
# only source the real man page, but without them the man command
Packit fcad23
# would be unable to find the correct page. The default is NO.
Packit fcad23
Packit fcad23
MAN_LINKS              = NO
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# configuration options related to the XML output
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# If the GENERATE_XML tag is set to YES Doxygen will 
Packit fcad23
# generate an XML file that captures the structure of 
Packit fcad23
# the code including all documentation. Note that this 
Packit fcad23
# feature is still experimental and incomplete at the 
Packit fcad23
# moment.
Packit fcad23
Packit fcad23
GENERATE_XML           = NO
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# Configuration options related to the preprocessor   
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
Packit fcad23
# evaluate all C-preprocessor directives found in the sources and include 
Packit fcad23
# files.
Packit fcad23
Packit fcad23
ENABLE_PREPROCESSING   = YES
Packit fcad23
Packit fcad23
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
Packit fcad23
# names in the source code. If set to NO (the default) only conditional 
Packit fcad23
# compilation will be performed. Macro expansion can be done in a controlled 
Packit fcad23
# way by setting EXPAND_ONLY_PREDEF to YES.
Packit fcad23
Packit fcad23
MACRO_EXPANSION        = NO
Packit fcad23
Packit fcad23
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
Packit fcad23
# then the macro expansion is limited to the macros specified with the 
Packit fcad23
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
Packit fcad23
Packit fcad23
EXPAND_ONLY_PREDEF     = NO
Packit fcad23
Packit fcad23
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
Packit fcad23
# in the INCLUDE_PATH (see below) will be search if a #include is found.
Packit fcad23
Packit fcad23
SEARCH_INCLUDES        = YES
Packit fcad23
Packit fcad23
# The INCLUDE_PATH tag can be used to specify one or more directories that 
Packit fcad23
# contain include files that are not input files but should be processed by 
Packit fcad23
# the preprocessor.
Packit fcad23
Packit fcad23
INCLUDE_PATH           = 
Packit fcad23
Packit fcad23
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
Packit fcad23
# patterns (like *.h and *.hpp) to filter out the header-files in the 
Packit fcad23
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
Packit fcad23
# be used.
Packit fcad23
Packit fcad23
INCLUDE_FILE_PATTERNS  = 
Packit fcad23
Packit fcad23
# The PREDEFINED tag can be used to specify one or more macro names that 
Packit fcad23
# are defined before the preprocessor is started (similar to the -D option of 
Packit fcad23
# gcc). The argument of the tag is a list of macros of the form: name 
Packit fcad23
# or name=definition (no spaces). If the definition and the = are 
Packit fcad23
# omitted =1 is assumed.
Packit fcad23
Packit fcad23
PREDEFINED             = HAVE_STDARG_H
Packit fcad23
Packit fcad23
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
Packit fcad23
# this tag can be used to specify a list of macro names that should be expanded. 
Packit fcad23
# The macro definition that is found in the sources will be used. 
Packit fcad23
# Use the PREDEFINED tag if you want to use a different macro definition.
Packit fcad23
Packit fcad23
EXPAND_AS_DEFINED      = 
Packit fcad23
Packit fcad23
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
Packit fcad23
# doxygen's preprocessor will remove all function-like macros that are alone 
Packit fcad23
# on a line and do not end with a semicolon. Such function macros are typically 
Packit fcad23
# used for boiler-plate code, and will confuse the parser if not removed.
Packit fcad23
Packit fcad23
SKIP_FUNCTION_MACROS   = YES
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# Configuration::addtions related to external references   
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# The TAGFILES tag can be used to specify one or more tagfiles.
Packit fcad23
Packit fcad23
TAGFILES               = 
Packit fcad23
Packit fcad23
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
Packit fcad23
# a tag file that is based on the input files it reads.
Packit fcad23
Packit fcad23
GENERATE_TAGFILE       = 
Packit fcad23
Packit fcad23
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
Packit fcad23
# in the class index. If set to NO only the inherited external classes 
Packit fcad23
# will be listed.
Packit fcad23
Packit fcad23
ALLEXTERNALS           = NO
Packit fcad23
Packit fcad23
# The PERL_PATH should be the absolute path and name of the perl script 
Packit fcad23
# interpreter (i.e. the result of `which perl').
Packit fcad23
Packit fcad23
PERL_PATH              = 
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# Configuration options related to the dot tool   
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
Packit fcad23
# available from the path. This tool is part of Graphviz, a graph visualization 
Packit fcad23
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
Packit fcad23
# have no effect if this option is set to NO (the default)
Packit fcad23
Packit fcad23
HAVE_DOT               = NO
Packit fcad23
Packit fcad23
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
Packit fcad23
# will generate a graph for each documented class showing the direct and 
Packit fcad23
# indirect inheritance relations. Setting this tag to YES will force the 
Packit fcad23
# the CLASS_DIAGRAMS tag to NO.
Packit fcad23
Packit fcad23
CLASS_GRAPH            = YES
Packit fcad23
Packit fcad23
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
Packit fcad23
# will generate a graph for each documented class showing the direct and 
Packit fcad23
# indirect implementation dependencies (inheritance, containment, and 
Packit fcad23
# class references variables) of the class with other documented classes.
Packit fcad23
Packit fcad23
COLLABORATION_GRAPH    = YES
Packit fcad23
Packit fcad23
# If set to YES, the inheritance and collaboration graphs will show the 
Packit fcad23
# relations between templates and their instances.
Packit fcad23
Packit fcad23
TEMPLATE_RELATIONS     = YES
Packit fcad23
Packit fcad23
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
Packit fcad23
# tags are set to YES then doxygen will generate a graph for each documented 
Packit fcad23
# file showing the direct and indirect include dependencies of the file with 
Packit fcad23
# other documented files.
Packit fcad23
Packit fcad23
INCLUDE_GRAPH          = YES
Packit fcad23
Packit fcad23
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
Packit fcad23
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
Packit fcad23
# documented header file showing the documented files that directly or 
Packit fcad23
# indirectly include this file.
Packit fcad23
Packit fcad23
INCLUDED_BY_GRAPH      = YES
Packit fcad23
Packit fcad23
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
Packit fcad23
# will graphical hierarchy of all classes instead of a textual one.
Packit fcad23
Packit fcad23
GRAPHICAL_HIERARCHY    = YES
Packit fcad23
Packit fcad23
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
Packit fcad23
# found. If left blank, it is assumed the dot tool can be found on the path.
Packit fcad23
Packit fcad23
DOT_PATH               = 
Packit fcad23
Packit fcad23
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
Packit fcad23
# contain dot files that are included in the documentation (see the 
Packit fcad23
# \dotfile command).
Packit fcad23
Packit fcad23
DOTFILE_DIRS           = 
Packit fcad23
Packit fcad23
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
Packit fcad23
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
Packit fcad23
# this value, doxygen will try to truncate the graph, so that it fits within 
Packit fcad23
# the specified constraint. Beware that most browsers cannot cope with very 
Packit fcad23
# large images.
Packit fcad23
Packit fcad23
MAX_DOT_GRAPH_WIDTH    = 1024
Packit fcad23
Packit fcad23
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
Packit fcad23
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
Packit fcad23
# this value, doxygen will try to truncate the graph, so that it fits within 
Packit fcad23
# the specified constraint. Beware that most browsers cannot cope with very 
Packit fcad23
# large images.
Packit fcad23
Packit fcad23
MAX_DOT_GRAPH_HEIGHT   = 1024
Packit fcad23
Packit fcad23
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
Packit fcad23
# generate a legend page explaining the meaning of the various boxes and 
Packit fcad23
# arrows in the dot generated graphs.
Packit fcad23
Packit fcad23
GENERATE_LEGEND        = YES
Packit fcad23
Packit fcad23
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
Packit fcad23
# remove the intermedate dot files that are used to generate 
Packit fcad23
# the various graphs.
Packit fcad23
Packit fcad23
DOT_CLEANUP            = YES
Packit fcad23
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
# Configuration::addtions related to the search engine   
Packit fcad23
#---------------------------------------------------------------------------
Packit fcad23
Packit fcad23
# The SEARCHENGINE tag specifies whether or not a search engine should be 
Packit fcad23
# used. If set to NO the values of all tags below this one will be ignored.
Packit fcad23
Packit fcad23
SEARCHENGINE           = NO
Packit fcad23
Packit fcad23
# The CGI_NAME tag should be the name of the CGI script that 
Packit fcad23
# starts the search engine (doxysearch) with the correct parameters. 
Packit fcad23
# A script with this name will be generated by doxygen.
Packit fcad23
Packit fcad23
CGI_NAME               = 
Packit fcad23
Packit fcad23
# The CGI_URL tag should be the absolute URL to the directory where the 
Packit fcad23
# cgi binaries are located. See the documentation of your http daemon for 
Packit fcad23
# details.
Packit fcad23
Packit fcad23
CGI_URL                = 
Packit fcad23
Packit fcad23
# The DOC_URL tag should be the absolute URL to the directory where the 
Packit fcad23
# documentation is located. If left blank the absolute path to the 
Packit fcad23
# documentation, with file:// prepended to it, will be used.
Packit fcad23
Packit fcad23
DOC_URL                = 
Packit fcad23
Packit fcad23
# The DOC_ABSPATH tag should be the absolute path to the directory where the 
Packit fcad23
# documentation is located. If left blank the directory on the local machine 
Packit fcad23
# will be used.
Packit fcad23
Packit fcad23
DOC_ABSPATH            = 
Packit fcad23
Packit fcad23
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
Packit fcad23
# is installed.
Packit fcad23
Packit fcad23
BIN_ABSPATH            = 
Packit fcad23
Packit fcad23
# The EXT_DOC_PATHS tag can be used to specify one or more paths to 
Packit fcad23
# documentation generated for other projects. This allows doxysearch to search 
Packit fcad23
# the documentation for these projects as well.
Packit fcad23
Packit fcad23
EXT_DOC_PATHS          =