-# Doxyfile 1.2.18\r
+# Doxyfile 1.5.2\r
\r
# This file describes the settings to be used by the documentation system\r
# doxygen (www.doxygen.org) for a project\r
# Values that contain spaces should be placed between quotes (" ")\r
\r
#---------------------------------------------------------------------------\r
-# General configuration options\r
+# Project related configuration options\r
#---------------------------------------------------------------------------\r
\r
+# This tag specifies the encoding used for all characters in the config file that \r
+# follow. The default is UTF-8 which is also the encoding used for all text before \r
+# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into \r
+# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of \r
+# possible encodings.\r
+\r
+DOXYFILE_ENCODING = UTF-8\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
\r
OUTPUT_DIRECTORY = \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 \r
+# source files, where putting all generated files in the same directory would \r
+# otherwise 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, Dutch, \r
-# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en \r
-# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese, \r
-# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.\r
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, \r
+# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, \r
+# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, \r
+# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, \r
+# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.\r
\r
OUTPUT_LANGUAGE = English\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 \r
+# used as the annotated text. Otherwise, the brief description is used as-is. \r
+# If left blank, the following values are used ("$name" is automatically \r
+# replaced with the name of the entity): "The $name class" "The $name widget" \r
+# "The $name file" "is" "provides" "specifies" "contains" \r
+# "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 \r
+# inherited members of a class in the documentation of that class as if those \r
+# members were ordinary class members. Constructors, destructors and assignment \r
+# operators of 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 = YES\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 the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce \r
+# a new page for each member. If set to NO, the documentation of a member will \r
+# be part of the file/class/namespace that contains it.\r
+\r
+SEPARATE_MEMBER_PAGES = 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 = 4\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 \r
+# sources 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 \r
+# sources 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
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to \r
+# include (a tag file for) the STL sources as input, then you should \r
+# set this tag to YES in order to let doxygen match functions declarations and \r
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. \r
+# func(std::string) {}). This also make the inheritance and collaboration \r
+# diagrams that involve STL classes more complete and accurate.\r
+\r
+BUILTIN_STL_SUPPORT = NO\r
+\r
+# If you use Microsoft's C++/CLI language, you should set this option to YES to\r
+# enable parsing support.\r
+\r
+CPP_CLI_SUPPORT = NO\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
+# 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
\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
\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 class will be included in the various \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
HIDE_FRIEND_COMPOUNDS = 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\r
-# prepend the brief description of a member or function before the\r
-# detailed description. Note: if both HIDE_UNDOC_MEMBERS and\r
-# BRIEF_MEMBER_DESC are set to NO, the brief descriptions will be\r
-# completely suppressed.\r
-\r
-REPEAT_BRIEF = YES\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\r
-# all inherited members of a class in the documentation of that class\r
-# as if those members were ordinary class members. Constructors,\r
-# destructors and assignment operators of the base classes will not be\r
-# 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. It is allowed to use relative paths in the argument list.\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
-STRIP_FROM_PATH = \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
\r
INTERNAL_DOCS = YES\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 = YES\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
+# 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
-# users are adviced to set this option to NO.\r
+# and Mac users are advised to set this option to NO.\r
\r
CASE_SENSE_NAMES = YES\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 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 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 = NO\r
-\r
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen \r
-# will put list of the files that are included by a file in the documentation \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 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
-# explict @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 = YES\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
-# reimplements.\r
-\r
-INHERIT_DOCS = 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
\r
SORT_MEMBER_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
+# 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
-DISTRIBUTE_GROUP_DOC = NO\r
+SORT_BRIEF_DOCS = 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
+# 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
-TAB_SIZE = 4\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
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 \deprecated commands in the documentation.\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
-# 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
# 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 consist of for it to appear in \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
\r
MAX_INITIALIZER_LINES = 30\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 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
+# If the sources in your project are distributed over multiple directories \r
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy \r
+# in the documentation. The default is NO.\r
+\r
SHOW_DIRECTORIES = NO\r
\r
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that \r
+# doxygen should invoke to get the current version for each file (typically from the \r
+# version control system). Doxygen will invoke the program by executing (via \r
+# popen()) the command <command> <input-file>, where <command> is the value of \r
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file \r
+# provided by doxygen. Whatever the program writes to standard output \r
+# is used as the file version. See the manual for examples.\r
+\r
+FILE_VERSION_FILTER = \r
+\r
#---------------------------------------------------------------------------\r
# configuration options related to warning and progress messages\r
#---------------------------------------------------------------------------\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
+# This WARN_NO_PARAMDOC option can be abled to get warnings for \r
+# functions that are documented, but have no documentation for their parameters \r
+# or return value. If set to NO (the default) doxygen will only warn about \r
+# wrong or incomplete parameter documentation, but not about the absence of \r
+# documentation.\r
+\r
+WARN_NO_PARAMDOC = NO\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
+# warning originated and the warning text. Optionally the format may contain \r
+# $version, which will be replaced by the version of the file (if it could \r
+# be obtained via FILE_VERSION_FILTER)\r
\r
WARN_FORMAT = "$file:$line: $text"\r
\r
\r
INPUT = \r
\r
+# This tag can be used to specify the character encoding of the source files that \r
+# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default \r
+# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. \r
+# See http://www.gnu.org/software/libiconv for the list of possible encodings.\r
+\r
+INPUT_ENCODING = UTF-8\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\r
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx \r
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py\r
\r
FILE_PATTERNS = \r
\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
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or \r
+# directories that are symbolic links (a Unix filesystem feature) are excluded \r
+# 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
+# certain files from those directories. Note that the wildcards are matched \r
+# against the file with absolute path, so to exclude all test directories \r
+# for example use the pattern */test/*\r
\r
EXCLUDE_PATTERNS = \r
\r
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names \r
+# (namespaces, classes, functions, etc.) that should be excluded from the output. \r
+# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, \r
+# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test\r
+\r
+EXCLUDE_SYMBOLS = \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
# 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.\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
\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
+# 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
\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 = YES\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
REFERENCES_RELATION = YES\r
\r
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)\r
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from\r
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will\r
+# link to the source code. Otherwise they will link to the documentstion.\r
+\r
+REFERENCES_LINK_SOURCE = YES\r
+\r
+# If the USE_HTAGS tag is set to YES then the references to source code \r
+# will point to the HTML generated by the htags(1) tool instead of doxygen \r
+# built-in source browser. The htags tool is part of GNU's global source \r
+# tagging system (see http://www.gnu.org/software/global/global.html). You \r
+# will need version 4.8.6 or higher.\r
+\r
+USE_HTAGS = NO\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 = NO\r
+\r
#---------------------------------------------------------------------------\r
# configuration options related to the alphabetical class index\r
#---------------------------------------------------------------------------\r
\r
HTML_FOOTER = footer.html\r
\r
-# The HTML_STYLESHEET tag can be used to specify a user defined cascading \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\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 = stylesheet.css\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 dir.\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
+# 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
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
+# to the contents of the HTML help documentation and to the tree view.\r
\r
TOC_EXPAND = YES\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\r
-# that is generated for HTML Help). For this to work a browser that\r
-# supports JavaScript and frames is required (for instance Mozilla,\r
-# Netscape 4.0+, or Internet explorer 4.0+). Note that for large\r
-# projects the tree generation can take a very long time. In such\r
-# cases it is better to disable this feature. Windows users are\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
LATEX_OUTPUT = latex\r
\r
-# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.\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
\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 optimised for Word 97 and may not look very pretty with \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
RTF_HYPERLINKS = NO\r
\r
# Load stylesheet definitions from file. Syntax is similar to doxygen's \r
-# config file, i.e. a series of assigments. You only have to provide \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
# 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. Note that this \r
-# feature is still experimental and incomplete at the \r
-# moment.\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_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
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 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
+# PREDEFINED and EXPAND_AS_DEFINED tags.\r
\r
EXPAND_ONLY_PREDEF = NO\r
\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
+# omitted =1 is assumed. To prevent a macro definition from being \r
+# undefined via #undef or recursively expanded use the := operator \r
+# instead of the = operator.\r
\r
PREDEFINED = _WIN32 \\r
UNICODE \\r
_UNICODE\r
\r
-# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then \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\r
-# alone on a line, have an all uppercase name, and do not end with a\r
-# semicolon. Such function macros are typically used for boiler-plate\r
-# code, and will confuse the parser if not removed.\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 \r
+# the parser if not removed.\r
\r
SKIP_FUNCTION_MACROS = YES\r
\r
#---------------------------------------------------------------------------\r
-# Configuration::addtions related to external references \r
+# Configuration::additions related to external references \r
#---------------------------------------------------------------------------\r
\r
-# The TAGFILES tag can be used to specify one or more tagfiles.\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
#---------------------------------------------------------------------------\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 superceded by the HAVE_DOT option below. This is only a fallback. It is \r
-# recommended to install and use dot, since it yield more powerful graphs.\r
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base \r
+# or super classes. Setting the tag to NO turns the diagrams off. Note that \r
+# this option is superseded by the HAVE_DOT option below. This is only a \r
+# fallback. It is recommended to install and use dot, since it yields more \r
+# powerful graphs.\r
\r
CLASS_DIAGRAMS = YES\r
\r
+# You can define message sequence charts within doxygen comments using the \msc \r
+# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to \r
+# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to \r
+# specify the directory where the mscgen tool resides. If left empty the tool is assumed to \r
+# be found in the default search path.\r
+\r
+MSCGEN_PATH = \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
COLLABORATION_GRAPH = YES\r
\r
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen \r
+# will generate a graph for groups, showing the direct groups dependencies\r
+\r
+GROUP_GRAPHS = 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
\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 CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will \r
+# generate a caller 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 caller graphs for selected \r
+# functions only using the \callergraph command.\r
+\r
+CALLER_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
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES \r
+# then doxygen will show the dependencies a directory has on other directories \r
+# in a graphical way. The dependency relations are determined by the #include\r
+# relations between the files in the directories.\r
+\r
+DIRECTORY_GRAPH = 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
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
+# found. If left blank, it is assumed the dot tool can be found in the path.\r
\r
DOT_PATH = \r
\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
+# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of \r
+# nodes that will be shown in the graph. If the number of nodes in a graph \r
+# becomes larger than this value, doxygen will truncate the graph, which is \r
+# visualized by representing a node as a red box. Note that doxygen will always \r
+# show the root nodes and its direct children regardless of this setting.\r
+\r
+DOT_GRAPH_MAX_NODES = 50\r
\r
-MAX_DOT_GRAPH_WIDTH = 1024\r
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent \r
+# background. This is disabled by default, which results in a white background. \r
+# Warning: Depending on the platform used, enabling this option may lead to \r
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to \r
+# read).\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
+DOT_TRANSPARENT = NO\r
\r
-MAX_DOT_GRAPH_HEIGHT = 1024\r
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output \r
+# files in one run (i.e. multiple -o and -T options on the command line). This \r
+# makes dot run faster, but since only newer versions of dot (>1.8.10) \r
+# support this, this feature is disabled by default.\r
+\r
+DOT_MULTI_TARGETS = NO\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
GENERATE_LEGEND = YES\r
\r
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will \r
-# remove the intermedate dot files that are used to generate \r
+# remove the intermediate dot files that are used to generate \r
# the various graphs.\r
\r
DOT_CLEANUP = YES\r
\r
#---------------------------------------------------------------------------\r
-# Configuration::addtions related to the search engine \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
-\r
-# The CGI_NAME tag should be the name of the CGI script that \r
-# starts the search engine (doxysearch) with the correct parameters. \r
-# A script with this name will be generated by doxygen.\r
-\r
-CGI_NAME = search.cgi\r
-\r
-# The CGI_URL tag should be the absolute URL to the directory where the \r
-# cgi binaries are located. See the documentation of your http daemon for \r
-# details.\r
-\r
-CGI_URL = \r
-\r
-# The DOC_URL tag should be the absolute URL to the directory where the \r
-# documentation is located. If left blank the absolute path to the \r
-# documentation, with file:// prepended to it, will be used.\r
-\r
-DOC_URL = \r
-\r
-# The DOC_ABSPATH tag should be the absolute path to the directory where the \r
-# documentation is located. If left blank the directory on the local machine \r
-# will be used.\r
-\r
-DOC_ABSPATH = \r
-\r
-# The BIN_ABSPATH tag must point to the directory where the doxysearch binary \r
-# is installed.\r
-\r
-BIN_ABSPATH = /usr/local/bin/\r
-\r
-# The EXT_DOC_PATHS tag can be used to specify one or more paths to \r
-# documentation generated for other projects. This allows doxysearch to search \r
-# the documentation for these projects as well.\r
-\r
-EXT_DOC_PATHS = \r
projects / krb5.git / commitdiff