Clean up. Add set polarity prototype.

[bertos.git] / bertos / net / nmeap / Doxyfile

# Doxyfile 1.3.8\r
\r
# This file describes the settings to be used by the documentation system\r
# doxygen (www.doxygen.org) for a project\r
#\r
# All text after a hash (#) is considered a comment and will be ignored\r
# The format is:\r
#       TAG = value [value, ...]\r
# For lists items can also be appended using:\r
#       TAG += value [value, ...]\r
# Values that contain spaces should be placed between quotes (" ")\r
\r
#---------------------------------------------------------------------------\r
# Project related configuration options\r
#---------------------------------------------------------------------------\r
\r
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded \r
# by quotes) that should identify the project.\r
\r
PROJECT_NAME           = NMEAP\r
\r
# The PROJECT_NUMBER tag can be used to enter a project or revision number. \r
# This could be handy for archiving the generated documentation or \r
# if some version control system is used.\r
\r
PROJECT_NUMBER         = 0.1\r
\r
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) \r
# base path where the generated documentation will be put. \r
# If a relative path is entered, it will be relative to the location \r
# where doxygen was started. If left blank the current directory will be used.\r
\r
OUTPUT_DIRECTORY       = doc\r
\r
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create \r
# 4096 sub-directories (in 2 levels) under the output directory of each output \r
# format and will distribute the generated files over these directories. \r
# Enabling this option can be useful when feeding doxygen a huge amount of source \r
# files, where putting all generated files in the same directory would otherwise \r
# cause performance problems for the file system.\r
\r
CREATE_SUBDIRS         = NO\r
\r
# The OUTPUT_LANGUAGE tag is used to specify the language in which all \r
# documentation generated by doxygen is written. Doxygen will use this \r
# information to generate all constant output in the proper language. \r
# The default language is English, other supported languages are: \r
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, \r
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, \r
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, \r
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, \r
# Swedish, and Ukrainian.\r
\r
OUTPUT_LANGUAGE        = English\r
\r
# This tag can be used to specify the encoding used in the generated output. \r
# The encoding is not always determined by the language that is chosen, \r
# but also whether or not the output is meant for Windows or non-Windows users. \r
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES \r
# forces the Windows encoding (this is the default for the Windows binary), \r
# whereas setting the tag to NO uses a Unix-style encoding (the default for \r
# all platforms other than Windows).\r
\r
USE_WINDOWS_ENCODING   = NO\r
\r
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will \r
# include brief member descriptions after the members that are listed in \r
# the file and class documentation (similar to JavaDoc). \r
# Set to NO to disable this.\r
\r
BRIEF_MEMBER_DESC      = YES\r
\r
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend \r
# the brief description of a member or function before the detailed description. \r
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the \r
# brief descriptions will be completely suppressed.\r
\r
REPEAT_BRIEF           = YES\r
\r
# This tag implements a quasi-intelligent brief description abbreviator \r
# that is used to form the text in various listings. Each string \r
# in this list, if found as the leading text of the brief description, will be \r
# stripped from the text and the result after processing the whole list, is used \r
# as the annotated text. Otherwise, the brief description is used as-is. If left \r
# blank, the following values are used ("$name" is automatically replaced with the \r
# name of the entity): "The $name class" "The $name widget" "The $name file" \r
# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"\r
\r
ABBREVIATE_BRIEF       = \r
\r
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then \r
# Doxygen will generate a detailed section even if there is only a brief \r
# description.\r
\r
ALWAYS_DETAILED_SEC    = NO\r
\r
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited \r
# members of a class in the documentation of that class as if those members were \r
# ordinary class members. Constructors, destructors and assignment operators of \r
# the base classes will not be shown.\r
\r
INLINE_INHERITED_MEMB  = NO\r
\r
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full \r
# path before files name in the file list and in the header files. If set \r
# to NO the shortest path that makes the file name unique will be used.\r
\r
FULL_PATH_NAMES        = NO\r
\r
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag \r
# can be used to strip a user-defined part of the path. Stripping is \r
# only done if one of the specified strings matches the left-hand part of \r
# the path. The tag can be used to show relative paths in the file list. \r
# If left blank the directory from which doxygen is run is used as the \r
# path to strip.\r
\r
STRIP_FROM_PATH        = \r
\r
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of \r
# the path mentioned in the documentation of a class, which tells \r
# the reader which header file to include in order to use a class. \r
# If left blank only the name of the header file containing the class \r
# definition is used. Otherwise one should specify the include paths that \r
# are normally passed to the compiler using the -I flag.\r
\r
STRIP_FROM_INC_PATH    = \r
\r
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter \r
# (but less readable) file names. This can be useful is your file systems \r
# doesn't support long names like on DOS, Mac, or CD-ROM.\r
\r
SHORT_NAMES            = NO\r
\r
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen \r
# will interpret the first line (until the first dot) of a JavaDoc-style \r
# comment as the brief description. If set to NO, the JavaDoc \r
# comments will behave just like the Qt-style comments (thus requiring an \r
# explicit @brief command for a brief description.\r
\r
JAVADOC_AUTOBRIEF      = NO\r
\r
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen \r
# treat a multi-line C++ special comment block (i.e. a block of //! or /// \r
# comments) as a brief description. This used to be the default behaviour. \r
# The new default is to treat a multi-line C++ comment block as a detailed \r
# description. Set this tag to YES if you prefer the old behaviour instead.\r
\r
MULTILINE_CPP_IS_BRIEF = NO\r
\r
# If the DETAILS_AT_TOP tag is set to YES then Doxygen \r
# will output the detailed description near the top, like JavaDoc.\r
# If set to NO, the detailed description appears after the member \r
# documentation.\r
\r
DETAILS_AT_TOP         = NO\r
\r
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented \r
# member inherits the documentation from any documented member that it \r
# re-implements.\r
\r
INHERIT_DOCS           = YES\r
\r
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC \r
# tag is set to YES, then doxygen will reuse the documentation of the first \r
# member in the group (if any) for the other members of the group. By default \r
# all members of a group must be documented explicitly.\r
\r
DISTRIBUTE_GROUP_DOC   = NO\r
\r
# The TAB_SIZE tag can be used to set the number of spaces in a tab. \r
# Doxygen uses this value to replace tabs by spaces in code fragments.\r
\r
TAB_SIZE               = 8\r
\r
# This tag can be used to specify a number of aliases that acts \r
# as commands in the documentation. An alias has the form "name=value". \r
# For example adding "sideeffect=\par Side Effects:\n" will allow you to \r
# put the command \sideeffect (or @sideeffect) in the documentation, which \r
# will result in a user-defined paragraph with heading "Side Effects:". \r
# You can put \n's in the value part of an alias to insert newlines.\r
\r
ALIASES                = \r
\r
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources \r
# only. Doxygen will then generate output that is more tailored for C. \r
# For instance, some of the names that are used will be different. The list \r
# of all members will be omitted, etc.\r
\r
OPTIMIZE_OUTPUT_FOR_C  = YES\r
\r
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources \r
# only. Doxygen will then generate output that is more tailored for Java. \r
# For instance, namespaces will be presented as packages, qualified scopes \r
# will look different, etc.\r
\r
OPTIMIZE_OUTPUT_JAVA   = NO\r
\r
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of \r
# the same type (for instance a group of public functions) to be put as a \r
# subgroup of that type (e.g. under the Public Functions section). Set it to \r
# NO to prevent subgrouping. Alternatively, this can be done per class using \r
# the \nosubgrouping command.\r
\r
SUBGROUPING            = YES\r
\r
#---------------------------------------------------------------------------\r
# Build related configuration options\r
#---------------------------------------------------------------------------\r
\r
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in \r
# documentation are documented, even if no documentation was available. \r
# Private class members and static file members will be hidden unless \r
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES\r
\r
EXTRACT_ALL            = YES\r
\r
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class \r
# will be included in the documentation.\r
\r
EXTRACT_PRIVATE        = YES\r
\r
# If the EXTRACT_STATIC tag is set to YES all static members of a file \r
# will be included in the documentation.\r
\r
EXTRACT_STATIC         = YES\r
\r
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) \r
# defined locally in source files will be included in the documentation. \r
# If set to NO only classes defined in header files are included.\r
\r
EXTRACT_LOCAL_CLASSES  = YES\r
\r
# This flag is only useful for Objective-C code. When set to YES local \r
# methods, which are defined in the implementation section but not in \r
# the interface are included in the documentation. \r
# If set to NO (the default) only methods in the interface are included.\r
\r
EXTRACT_LOCAL_METHODS  = NO\r
\r
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all \r
# undocumented members of documented classes, files or namespaces. \r
# If set to NO (the default) these members will be included in the \r
# various overviews, but no documentation section is generated. \r
# This option has no effect if EXTRACT_ALL is enabled.\r
\r
HIDE_UNDOC_MEMBERS     = NO\r
\r
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all \r
# undocumented classes that are normally visible in the class hierarchy. \r
# If set to NO (the default) these classes will be included in the various \r
# overviews. This option has no effect if EXTRACT_ALL is enabled.\r
\r
HIDE_UNDOC_CLASSES     = NO\r
\r
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all \r
# friend (class|struct|union) declarations. \r
# If set to NO (the default) these declarations will be included in the \r
# documentation.\r
\r
HIDE_FRIEND_COMPOUNDS  = NO\r
\r
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any \r
# documentation blocks found inside the body of a function. \r
# If set to NO (the default) these blocks will be appended to the \r
# function's detailed documentation block.\r
\r
HIDE_IN_BODY_DOCS      = NO\r
\r
# The INTERNAL_DOCS tag determines if documentation \r
# that is typed after a \internal command is included. If the tag is set \r
# to NO (the default) then the documentation will be excluded. \r
# Set it to YES to include the internal documentation.\r
\r
INTERNAL_DOCS          = NO\r
\r
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate \r
# file names in lower-case letters. If set to YES upper-case letters are also \r
# allowed. This is useful if you have classes or files whose names only differ \r
# in case and if your file system supports case sensitive file names. Windows \r
# and Mac users are advised to set this option to NO.\r
\r
CASE_SENSE_NAMES       = NO\r
\r
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen \r
# will show members with their full class and namespace scopes in the \r
# documentation. If set to YES the scope will be hidden.\r
\r
HIDE_SCOPE_NAMES       = NO\r
\r
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen \r
# will put a list of the files that are included by a file in the documentation \r
# of that file.\r
\r
SHOW_INCLUDE_FILES     = YES\r
\r
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] \r
# is inserted in the documentation for inline members.\r
\r
INLINE_INFO            = YES\r
\r
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen \r
# will sort the (detailed) documentation of file and class members \r
# alphabetically by member name. If set to NO the members will appear in \r
# declaration order.\r
\r
SORT_MEMBER_DOCS       = YES\r
\r
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the \r
# brief documentation of file, namespace and class members alphabetically \r
# by member name. If set to NO (the default) the members will appear in \r
# declaration order.\r
\r
SORT_BRIEF_DOCS        = NO\r
\r
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be \r
# sorted by fully-qualified names, including namespaces. If set to \r
# NO (the default), the class list will be sorted only by class name, \r
# not including the namespace part. \r
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\r
# Note: This option applies only to the class list, not to the \r
# alphabetical list.\r
\r
SORT_BY_SCOPE_NAME     = NO\r
\r
# The GENERATE_TODOLIST tag can be used to enable (YES) or \r
# disable (NO) the todo list. This list is created by putting \todo \r
# commands in the documentation.\r
\r
GENERATE_TODOLIST      = YES\r
\r
# The GENERATE_TESTLIST tag can be used to enable (YES) or \r
# disable (NO) the test list. This list is created by putting \test \r
# commands in the documentation.\r
\r
GENERATE_TESTLIST      = YES\r
\r
# The GENERATE_BUGLIST tag can be used to enable (YES) or \r
# disable (NO) the bug list. This list is created by putting \bug \r
# commands in the documentation.\r
\r
GENERATE_BUGLIST       = YES\r
\r
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or \r
# disable (NO) the deprecated list. This list is created by putting \r
# \deprecated commands in the documentation.\r
\r
GENERATE_DEPRECATEDLIST= YES\r
\r
# The ENABLED_SECTIONS tag can be used to enable conditional \r
# documentation sections, marked by \if sectionname ... \endif.\r
\r
ENABLED_SECTIONS       = \r
\r
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines \r
# the initial value of a variable or define consists of for it to appear in \r
# the documentation. If the initializer consists of more lines than specified \r
# here it will be hidden. Use a value of 0 to hide initializers completely. \r
# The appearance of the initializer of individual variables and defines in the \r
# documentation can be controlled using \showinitializer or \hideinitializer \r
# command in the documentation regardless of this setting.\r
\r
MAX_INITIALIZER_LINES  = 30\r
\r
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated \r
# at the bottom of the documentation of classes and structs. If set to YES the \r
# list will mention the files that were used to generate the documentation.\r
\r
SHOW_USED_FILES        = YES\r
\r
#---------------------------------------------------------------------------\r
# configuration options related to warning and progress messages\r
#---------------------------------------------------------------------------\r
\r
# The QUIET tag can be used to turn on/off the messages that are generated \r
# by doxygen. Possible values are YES and NO. If left blank NO is used.\r
\r
QUIET                  = NO\r
\r
# The WARNINGS tag can be used to turn on/off the warning messages that are \r
# generated by doxygen. Possible values are YES and NO. If left blank \r
# NO is used.\r
\r
WARNINGS               = YES\r
\r
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings \r
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will \r
# automatically be disabled.\r
\r
WARN_IF_UNDOCUMENTED   = YES\r
\r
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for \r
# potential errors in the documentation, such as not documenting some \r
# parameters in a documented function, or documenting parameters that \r
# don't exist or using markup commands wrongly.\r
\r
WARN_IF_DOC_ERROR      = YES\r
\r
# The WARN_FORMAT tag determines the format of the warning messages that \r
# doxygen can produce. The string should contain the $file, $line, and $text \r
# tags, which will be replaced by the file and line number from which the \r
# warning originated and the warning text.\r
\r
WARN_FORMAT            = "$file:$line: $text"\r
\r
# The WARN_LOGFILE tag can be used to specify a file to which warning \r
# and error messages should be written. If left blank the output is written \r
# to stderr.\r
\r
WARN_LOGFILE           = \r
\r
#---------------------------------------------------------------------------\r
# configuration options related to the input files\r
#---------------------------------------------------------------------------\r
\r
# The INPUT tag can be used to specify the files and/or directories that contain \r
# documented source files. You may enter file names like "myfile.cpp" or \r
# directories like "/usr/src/myproject". Separate the files or directories \r
# with spaces.\r
\r
INPUT                  = inc/nmeap.h\r
\r
# If the value of the INPUT tag contains directories, you can use the \r
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
# and *.h) to filter out the source-files in the directories. If left \r
# blank the following patterns are tested: \r
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp \r
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm\r
\r
FILE_PATTERNS          = *.h\r
\r
# The RECURSIVE tag can be used to turn specify whether or not subdirectories \r
# should be searched for input files as well. Possible values are YES and NO. \r
# If left blank NO is used.\r
\r
RECURSIVE              = YES\r
\r
# The EXCLUDE tag can be used to specify files and/or directories that should \r
# excluded from the INPUT source files. This way you can easily exclude a \r
# subdirectory from a directory tree whose root is specified with the INPUT tag.\r
\r
EXCLUDE                = \r
\r
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories \r
# that are symbolic links (a Unix filesystem feature) are excluded from the input.\r
\r
EXCLUDE_SYMLINKS       = NO\r
\r
# If the value of the INPUT tag contains directories, you can use the \r
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude \r
# certain files from those directories.\r
\r
EXCLUDE_PATTERNS       = \r
\r
# The EXAMPLE_PATH tag can be used to specify one or more files or \r
# directories that contain example code fragments that are included (see \r
# the \include command).\r
\r
EXAMPLE_PATH           = \r
\r
# If the value of the EXAMPLE_PATH tag contains directories, you can use the \r
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
# and *.h) to filter out the source-files in the directories. If left \r
# blank all files are included.\r
\r
EXAMPLE_PATTERNS       = \r
\r
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be \r
# searched for input files to be used with the \include or \dontinclude \r
# commands irrespective of the value of the RECURSIVE tag. \r
# Possible values are YES and NO. If left blank NO is used.\r
\r
EXAMPLE_RECURSIVE      = NO\r
\r
# The IMAGE_PATH tag can be used to specify one or more files or \r
# directories that contain image that are included in the documentation (see \r
# the \image command).\r
\r
IMAGE_PATH             = \r
\r
# The INPUT_FILTER tag can be used to specify a program that doxygen should \r
# invoke to filter for each input file. Doxygen will invoke the filter program \r
# by executing (via popen()) the command <filter> <input-file>, where <filter> \r
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an \r
# input file. Doxygen will then use the output that the filter program writes \r
# to standard output.  If FILTER_PATTERNS is specified, this tag will be \r
# ignored.\r
\r
INPUT_FILTER           = \r
\r
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern \r
# basis.  Doxygen will compare the file name with each pattern and apply the \r
# filter if there is a match.  The filters are a list of the form: \r
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further \r
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER \r
# is applied to all files.\r
\r
FILTER_PATTERNS        = \r
\r
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using \r
# INPUT_FILTER) will be used to filter the input files when producing source \r
# files to browse (i.e. when SOURCE_BROWSER is set to YES).\r
\r
FILTER_SOURCE_FILES    = NO\r
\r
#---------------------------------------------------------------------------\r
# configuration options related to source browsing\r
#---------------------------------------------------------------------------\r
\r
# If the SOURCE_BROWSER tag is set to YES then a list of source files will \r
# be generated. Documented entities will be cross-referenced with these sources. \r
# Note: To get rid of all source code in the generated output, make sure also \r
# VERBATIM_HEADERS is set to NO.\r
\r
SOURCE_BROWSER         = NO\r
\r
# Setting the INLINE_SOURCES tag to YES will include the body \r
# of functions and classes directly in the documentation.\r
\r
INLINE_SOURCES         = NO\r
\r
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct \r
# doxygen to hide any special comment blocks from generated source code \r
# fragments. Normal C and C++ comments will always remain visible.\r
\r
STRIP_CODE_COMMENTS    = NO\r
\r
# If the REFERENCED_BY_RELATION tag is set to YES (the default) \r
# then for each documented function all documented \r
# functions referencing it will be listed.\r
\r
REFERENCED_BY_RELATION = YES\r
\r
# If the REFERENCES_RELATION tag is set to YES (the default) \r
# then for each documented function all documented entities \r
# called/used by that function will be listed.\r
\r
REFERENCES_RELATION    = YES\r
\r
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen \r
# will generate a verbatim copy of the header file for each class for \r
# which an include is specified. Set to NO to disable this.\r
\r
VERBATIM_HEADERS       = YES\r
\r
#---------------------------------------------------------------------------\r
# configuration options related to the alphabetical class index\r
#---------------------------------------------------------------------------\r
\r
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index \r
# of all compounds will be generated. Enable this if the project \r
# contains a lot of classes, structs, unions or interfaces.\r
\r
ALPHABETICAL_INDEX     = NO\r
\r
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then \r
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns \r
# in which this list will be split (can be a number in the range [1..20])\r
\r
COLS_IN_ALPHA_INDEX    = 5\r
\r
# In case all classes in a project start with a common prefix, all \r
# classes will be put under the same header in the alphabetical index. \r
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that \r
# should be ignored while generating the index headers.\r
\r
IGNORE_PREFIX          = \r
\r
#---------------------------------------------------------------------------\r
# configuration options related to the HTML output\r
#---------------------------------------------------------------------------\r
\r
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will \r
# generate HTML output.\r
\r
GENERATE_HTML          = YES\r
\r
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. \r
# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
# put in front of it. If left blank `html' will be used as the default path.\r
\r
HTML_OUTPUT            = html\r
\r
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for \r
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank \r
# doxygen will generate files with .html extension.\r
\r
HTML_FILE_EXTENSION    = .html\r
\r
# The HTML_HEADER tag can be used to specify a personal HTML header for \r
# each generated HTML page. If it is left blank doxygen will generate a \r
# standard header.\r
\r
HTML_HEADER            = \r
\r
# The HTML_FOOTER tag can be used to specify a personal HTML footer for \r
# each generated HTML page. If it is left blank doxygen will generate a \r
# standard footer.\r
\r
HTML_FOOTER            = \r
\r
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading \r
# style sheet that is used by each HTML page. It can be used to \r
# fine-tune the look of the HTML output. If the tag is left blank doxygen \r
# will generate a default style sheet. Note that doxygen will try to copy \r
# the style sheet file to the HTML output directory, so don't put your own \r
# stylesheet in the HTML output directory as well, or it will be erased!\r
\r
HTML_STYLESHEET        = \r
\r
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, \r
# files or namespaces will be aligned in HTML using tables. If set to \r
# NO a bullet list will be used.\r
\r
HTML_ALIGN_MEMBERS     = YES\r
\r
# If the GENERATE_HTMLHELP tag is set to YES, additional index files \r
# will be generated that can be used as input for tools like the \r
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) \r
# of the generated HTML documentation.\r
\r
GENERATE_HTMLHELP      = NO\r
\r
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can \r
# be used to specify the file name of the resulting .chm file. You \r
# can add a path in front of the file if the result should not be \r
# written to the html output directory.\r
\r
CHM_FILE               = \r
\r
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can \r
# be used to specify the location (absolute path including file name) of \r
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run \r
# the HTML help compiler on the generated index.hhp.\r
\r
HHC_LOCATION           = \r
\r
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag \r
# controls if a separate .chi index file is generated (YES) or that \r
# it should be included in the master .chm file (NO).\r
\r
GENERATE_CHI           = NO\r
\r
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag \r
# controls whether a binary table of contents is generated (YES) or a \r
# normal table of contents (NO) in the .chm file.\r
\r
BINARY_TOC             = NO\r
\r
# The TOC_EXPAND flag can be set to YES to add extra items for group members \r
# to the contents of the HTML help documentation and to the tree view.\r
\r
TOC_EXPAND             = NO\r
\r
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at \r
# top of each HTML page. The value NO (the default) enables the index and \r
# the value YES disables it.\r
\r
DISABLE_INDEX          = NO\r
\r
# This tag can be used to set the number of enum values (range [1..20]) \r
# that doxygen will group on one line in the generated HTML documentation.\r
\r
ENUM_VALUES_PER_LINE   = 4\r
\r
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be\r
# generated containing a tree-like index structure (just like the one that \r
# is generated for HTML Help). For this to work a browser that supports \r
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, \r
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are \r
# probably better off using the HTML help feature.\r
\r
GENERATE_TREEVIEW      = NO\r
\r
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be \r
# used to set the initial width (in pixels) of the frame in which the tree \r
# is shown.\r
\r
TREEVIEW_WIDTH         = 250\r
\r
#---------------------------------------------------------------------------\r
# configuration options related to the LaTeX output\r
#---------------------------------------------------------------------------\r
\r
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will \r
# generate Latex output.\r
\r
GENERATE_LATEX         = NO\r
\r
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. \r
# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
# put in front of it. If left blank `latex' will be used as the default path.\r
\r
LATEX_OUTPUT           = latex\r
\r
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be \r
# invoked. If left blank `latex' will be used as the default command name.\r
\r
LATEX_CMD_NAME         = latex\r
\r
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to \r
# generate index for LaTeX. If left blank `makeindex' will be used as the \r
# default command name.\r
\r
MAKEINDEX_CMD_NAME     = makeindex\r
\r
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact \r
# LaTeX documents. This may be useful for small projects and may help to \r
# save some trees in general.\r
\r
COMPACT_LATEX          = NO\r
\r
# The PAPER_TYPE tag can be used to set the paper type that is used \r
# by the printer. Possible values are: a4, a4wide, letter, legal and \r
# executive. If left blank a4wide will be used.\r
\r
PAPER_TYPE             = a4wide\r
\r
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX \r
# packages that should be included in the LaTeX output.\r
\r
EXTRA_PACKAGES         = \r
\r
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for \r
# the generated latex document. The header should contain everything until \r
# the first chapter. If it is left blank doxygen will generate a \r
# standard header. Notice: only use this tag if you know what you are doing!\r
\r
LATEX_HEADER           = \r
\r
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated \r
# is prepared for conversion to pdf (using ps2pdf). The pdf file will \r
# contain links (just like the HTML output) instead of page references \r
# This makes the output suitable for online browsing using a pdf viewer.\r
\r
PDF_HYPERLINKS         = NO\r
\r
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of \r
# plain latex in the generated Makefile. Set this option to YES to get a \r
# higher quality PDF documentation.\r
\r
USE_PDFLATEX           = NO\r
\r
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. \r
# command to the generated LaTeX files. This will instruct LaTeX to keep \r
# running if errors occur, instead of asking the user for help. \r
# This option is also used when generating formulas in HTML.\r
\r
LATEX_BATCHMODE        = NO\r
\r
# If LATEX_HIDE_INDICES is set to YES then doxygen will not \r
# include the index chapters (such as File Index, Compound Index, etc.) \r
# in the output.\r
\r
LATEX_HIDE_INDICES     = NO\r
\r
#---------------------------------------------------------------------------\r
# configuration options related to the RTF output\r
#---------------------------------------------------------------------------\r
\r
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output \r
# The RTF output is optimized for Word 97 and may not look very pretty with \r
# other RTF readers or editors.\r
\r
GENERATE_RTF           = NO\r
\r
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. \r
# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
# put in front of it. If left blank `rtf' will be used as the default path.\r
\r
RTF_OUTPUT             = rtf\r
\r
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact \r
# RTF documents. This may be useful for small projects and may help to \r
# save some trees in general.\r
\r
COMPACT_RTF            = NO\r
\r
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated \r
# will contain hyperlink fields. The RTF file will \r
# contain links (just like the HTML output) instead of page references. \r
# This makes the output suitable for online browsing using WORD or other \r
# programs which support those fields. \r
# Note: wordpad (write) and others do not support links.\r
\r
RTF_HYPERLINKS         = NO\r
\r
# Load stylesheet definitions from file. Syntax is similar to doxygen's \r
# config file, i.e. a series of assignments. You only have to provide \r
# replacements, missing definitions are set to their default value.\r
\r
RTF_STYLESHEET_FILE    = \r
\r
# Set optional variables used in the generation of an rtf document. \r
# Syntax is similar to doxygen's config file.\r
\r
RTF_EXTENSIONS_FILE    = \r
\r
#---------------------------------------------------------------------------\r
# configuration options related to the man page output\r
#---------------------------------------------------------------------------\r
\r
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will \r
# generate man pages\r
\r
GENERATE_MAN           = NO\r
\r
# The MAN_OUTPUT tag is used to specify where the man pages will be put. \r
# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
# put in front of it. If left blank `man' will be used as the default path.\r
\r
MAN_OUTPUT             = man\r
\r
# The MAN_EXTENSION tag determines the extension that is added to \r
# the generated man pages (default is the subroutine's section .3)\r
\r
MAN_EXTENSION          = .3\r
\r
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, \r
# then it will generate one additional man file for each entity \r
# documented in the real man page(s). These additional files \r
# only source the real man page, but without them the man command \r
# would be unable to find the correct page. The default is NO.\r
\r
MAN_LINKS              = NO\r
\r
#---------------------------------------------------------------------------\r
# configuration options related to the XML output\r
#---------------------------------------------------------------------------\r
\r
# If the GENERATE_XML tag is set to YES Doxygen will \r
# generate an XML file that captures the structure of \r
# the code including all documentation.\r
\r
GENERATE_XML           = NO\r
\r
# The XML_OUTPUT tag is used to specify where the XML pages will be put. \r
# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
# put in front of it. If left blank `xml' will be used as the default path.\r
\r
XML_OUTPUT             = xml\r
\r
# The XML_SCHEMA tag can be used to specify an XML schema, \r
# which can be used by a validating XML parser to check the \r
# syntax of the XML files.\r
\r
XML_SCHEMA             = \r
\r
# The XML_DTD tag can be used to specify an XML DTD, \r
# which can be used by a validating XML parser to check the \r
# syntax of the XML files.\r
\r
XML_DTD                = \r
\r
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will \r
# dump the program listings (including syntax highlighting \r
# and cross-referencing information) to the XML output. Note that \r
# enabling this will significantly increase the size of the XML output.\r
\r
XML_PROGRAMLISTING     = YES\r
\r
#---------------------------------------------------------------------------\r
# configuration options for the AutoGen Definitions output\r
#---------------------------------------------------------------------------\r
\r
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will \r
# generate an AutoGen Definitions (see autogen.sf.net) file \r
# that captures the structure of the code including all \r
# documentation. Note that this feature is still experimental \r
# and incomplete at the moment.\r
\r
GENERATE_AUTOGEN_DEF   = NO\r
\r
#---------------------------------------------------------------------------\r
# configuration options related to the Perl module output\r
#---------------------------------------------------------------------------\r
\r
# If the GENERATE_PERLMOD tag is set to YES Doxygen will \r
# generate a Perl module file that captures the structure of \r
# the code including all documentation. Note that this \r
# feature is still experimental and incomplete at the \r
# moment.\r
\r
GENERATE_PERLMOD       = NO\r
\r
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate \r
# the necessary Makefile rules, Perl scripts and LaTeX code to be able \r
# to generate PDF and DVI output from the Perl module output.\r
\r
PERLMOD_LATEX          = NO\r
\r
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be \r
# nicely formatted so it can be parsed by a human reader.  This is useful \r
# if you want to understand what is going on.  On the other hand, if this \r
# tag is set to NO the size of the Perl module output will be much smaller \r
# and Perl will parse it just the same.\r
\r
PERLMOD_PRETTY         = YES\r
\r
# The names of the make variables in the generated doxyrules.make file \r
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. \r
# This is useful so different doxyrules.make files included by the same \r
# Makefile don't overwrite each other's variables.\r
\r
PERLMOD_MAKEVAR_PREFIX = \r
\r
#---------------------------------------------------------------------------\r
# Configuration options related to the preprocessor   \r
#---------------------------------------------------------------------------\r
\r
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will \r
# evaluate all C-preprocessor directives found in the sources and include \r
# files.\r
\r
ENABLE_PREPROCESSING   = YES\r
\r
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro \r
# names in the source code. If set to NO (the default) only conditional \r
# compilation will be performed. Macro expansion can be done in a controlled \r
# way by setting EXPAND_ONLY_PREDEF to YES.\r
\r
MACRO_EXPANSION        = NO\r
\r
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES \r
# then the macro expansion is limited to the macros specified with the \r
# PREDEFINED and EXPAND_AS_PREDEFINED tags.\r
\r
EXPAND_ONLY_PREDEF     = NO\r
\r
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files \r
# in the INCLUDE_PATH (see below) will be search if a #include is found.\r
\r
SEARCH_INCLUDES        = YES\r
\r
# The INCLUDE_PATH tag can be used to specify one or more directories that \r
# contain include files that are not input files but should be processed by \r
# the preprocessor.\r
\r
INCLUDE_PATH           = \r
\r
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard \r
# patterns (like *.h and *.hpp) to filter out the header-files in the \r
# directories. If left blank, the patterns specified with FILE_PATTERNS will \r
# be used.\r
\r
INCLUDE_FILE_PATTERNS  = \r
\r
# The PREDEFINED tag can be used to specify one or more macro names that \r
# are defined before the preprocessor is started (similar to the -D option of \r
# gcc). The argument of the tag is a list of macros of the form: name \r
# or name=definition (no spaces). If the definition and the = are \r
# omitted =1 is assumed.\r
\r
PREDEFINED             = \r
\r
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then \r
# this tag can be used to specify a list of macro names that should be expanded. \r
# The macro definition that is found in the sources will be used. \r
# Use the PREDEFINED tag if you want to use a different macro definition.\r
\r
EXPAND_AS_DEFINED      = \r
\r
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then \r
# doxygen's preprocessor will remove all function-like macros that are alone \r
# on a line, have an all uppercase name, and do not end with a semicolon. Such \r
# function macros are typically used for boiler-plate code, and will confuse the \r
# parser if not removed.\r
\r
SKIP_FUNCTION_MACROS   = YES\r
\r
#---------------------------------------------------------------------------\r
# Configuration::additions related to external references   \r
#---------------------------------------------------------------------------\r
\r
# The TAGFILES option can be used to specify one or more tagfiles. \r
# Optionally an initial location of the external documentation \r
# can be added for each tagfile. The format of a tag file without \r
# this location is as follows: \r
#   TAGFILES = file1 file2 ... \r
# Adding location for the tag files is done as follows: \r
#   TAGFILES = file1=loc1 "file2 = loc2" ... \r
# where "loc1" and "loc2" can be relative or absolute paths or \r
# URLs. If a location is present for each tag, the installdox tool \r
# does not have to be run to correct the links.\r
# Note that each tag file must have a unique name\r
# (where the name does NOT include the path)\r
# If a tag file is not located in the directory in which doxygen \r
# is run, you must also specify the path to the tagfile here.\r
\r
TAGFILES               = \r
\r
# When a file name is specified after GENERATE_TAGFILE, doxygen will create \r
# a tag file that is based on the input files it reads.\r
\r
GENERATE_TAGFILE       = \r
\r
# If the ALLEXTERNALS tag is set to YES all external classes will be listed \r
# in the class index. If set to NO only the inherited external classes \r
# will be listed.\r
\r
ALLEXTERNALS           = NO\r
\r
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed \r
# in the modules index. If set to NO, only the current project's groups will \r
# be listed.\r
\r
EXTERNAL_GROUPS        = YES\r
\r
# The PERL_PATH should be the absolute path and name of the perl script \r
# interpreter (i.e. the result of `which perl').\r
\r
PERL_PATH              = /usr/bin/perl\r
\r
#---------------------------------------------------------------------------\r
# Configuration options related to the dot tool   \r
#---------------------------------------------------------------------------\r
\r
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will \r
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or \r
# super classes. Setting the tag to NO turns the diagrams off. Note that this \r
# option is superseded by the HAVE_DOT option below. This is only a fallback. It is \r
# recommended to install and use dot, since it yields more powerful graphs.\r
\r
CLASS_DIAGRAMS         = YES\r
\r
# If set to YES, the inheritance and collaboration graphs will hide \r
# inheritance and usage relations if the target is undocumented \r
# or is not a class.\r
\r
HIDE_UNDOC_RELATIONS   = YES\r
\r
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is \r
# available from the path. This tool is part of Graphviz, a graph visualization \r
# toolkit from AT&T and Lucent Bell Labs. The other options in this section \r
# have no effect if this option is set to NO (the default)\r
\r
HAVE_DOT               = NO\r
\r
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
# will generate a graph for each documented class showing the direct and \r
# indirect inheritance relations. Setting this tag to YES will force the \r
# the CLASS_DIAGRAMS tag to NO.\r
\r
CLASS_GRAPH            = YES\r
\r
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
# will generate a graph for each documented class showing the direct and \r
# indirect implementation dependencies (inheritance, containment, and \r
# class references variables) of the class with other documented classes.\r
\r
COLLABORATION_GRAPH    = YES\r
\r
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and \r
# collaboration diagrams in a style similar to the OMG's Unified Modeling \r
# Language.\r
\r
UML_LOOK               = NO\r
\r
# If set to YES, the inheritance and collaboration graphs will show the \r
# relations between templates and their instances.\r
\r
TEMPLATE_RELATIONS     = NO\r
\r
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT \r
# tags are set to YES then doxygen will generate a graph for each documented \r
# file showing the direct and indirect include dependencies of the file with \r
# other documented files.\r
\r
INCLUDE_GRAPH          = YES\r
\r
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and \r
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each \r
# documented header file showing the documented files that directly or \r
# indirectly include this file.\r
\r
INCLUDED_BY_GRAPH      = YES\r
\r
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will \r
# generate a call dependency graph for every global function or class method. \r
# Note that enabling this option will significantly increase the time of a run. \r
# So in most cases it will be better to enable call graphs for selected \r
# functions only using the \callgraph command.\r
\r
CALL_GRAPH             = NO\r
\r
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen \r
# will graphical hierarchy of all classes instead of a textual one.\r
\r
GRAPHICAL_HIERARCHY    = YES\r
\r
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images \r
# generated by dot. Possible values are png, jpg, or gif\r
# If left blank png will be used.\r
\r
DOT_IMAGE_FORMAT       = png\r
\r
# The tag DOT_PATH can be used to specify the path where the dot tool can be \r
# found. If left blank, it is assumed the dot tool can be found on the path.\r
\r
DOT_PATH               = \r
\r
# The DOTFILE_DIRS tag can be used to specify one or more directories that \r
# contain dot files that are included in the documentation (see the \r
# \dotfile command).\r
\r
DOTFILE_DIRS           = \r
\r
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width \r
# (in pixels) of the graphs generated by dot. If a graph becomes larger than \r
# this value, doxygen will try to truncate the graph, so that it fits within \r
# the specified constraint. Beware that most browsers cannot cope with very \r
# large images.\r
\r
MAX_DOT_GRAPH_WIDTH    = 1024\r
\r
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height \r
# (in pixels) of the graphs generated by dot. If a graph becomes larger than \r
# this value, doxygen will try to truncate the graph, so that it fits within \r
# the specified constraint. Beware that most browsers cannot cope with very \r
# large images.\r
\r
MAX_DOT_GRAPH_HEIGHT   = 1024\r
\r
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the \r
# graphs generated by dot. A depth value of 3 means that only nodes reachable \r
# from the root by following a path via at most 3 edges will be shown. Nodes that \r
# lay further from the root node will be omitted. Note that setting this option to \r
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also \r
# note that a graph may be further truncated if the graph's image dimensions are \r
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). \r
# If 0 is used for the depth value (the default), the graph is not depth-constrained.\r
\r
MAX_DOT_GRAPH_DEPTH    = 0\r
\r
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will \r
# generate a legend page explaining the meaning of the various boxes and \r
# arrows in the dot generated graphs.\r
\r
GENERATE_LEGEND        = YES\r
\r
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will \r
# remove the intermediate dot files that are used to generate \r
# the various graphs.\r
\r
DOT_CLEANUP            = YES\r
\r
#---------------------------------------------------------------------------\r
# Configuration::additions related to the search engine   \r
#---------------------------------------------------------------------------\r
\r
# The SEARCHENGINE tag specifies whether or not a search engine should be \r
# used. If set to NO the values of all tags below this one will be ignored.\r
\r
SEARCHENGINE           = NO\r