Minor documentation improvements.

[pub/lufa.git] / Bootloaders / Printer / Doxygen.conf

diff --git a/Bootloaders/Printer/Doxygen.conf b/Bootloaders/Printer/Doxygen.conf
index 8d9a807..b6566d1 100644 (file)
--- a/Bootloaders/Printer/Doxygen.conf
+++ b/Bootloaders/Printer/Doxygen.conf
@@ -1,104 +1,112 @@
-# Doxyfile 1.8.3.1\r
+# Doxyfile 1.8.5\r

 \r
 # This file describes the settings to be used by the documentation system\r
 # doxygen (www.doxygen.org) for a project.\r
 #\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
+# All text after a double hash (##) is considered a comment and is placed in\r
+# front of the TAG it is preceding.\r
+#\r
+# All text after a single hash (#) is considered a comment and will be ignored.\r

 # The format is:\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
+# 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
 # This tag specifies the encoding used for all characters in the config file\r
 \r
 #---------------------------------------------------------------------------\r
 # Project related configuration options\r
 #---------------------------------------------------------------------------\r
 \r
 # This tag specifies the encoding used for all characters in the config file\r

-# that follow. The default is UTF-8 which is also the encoding used for all\r
-# text before the first occurrence of this tag. Doxygen uses libiconv (or the\r
-# iconv built into libc) for the transcoding. See\r
-# http://www.gnu.org/software/libiconv for the list of possible encodings.\r
+# that follow. The default is UTF-8 which is also the encoding used for all text\r
+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv\r
+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv\r
+# for the list of possible encodings.\r
+# The default value is: UTF-8.\r

 \r
 DOXYFILE_ENCODING      = UTF-8\r
 \r
 \r
 DOXYFILE_ENCODING      = UTF-8\r
 \r

-# The PROJECT_NAME tag is a single word (or sequence of words) that should\r
-# identify the project. Note that if you do not use Doxywizard you need\r
-# to put quotes around the project name if it contains spaces.\r
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by\r
+# double-quotes, unless you are using Doxywizard) that should identify the\r
+# project for which the documentation is generated. This name is used in the\r
+# title of most generated pages and in a few other places.\r
+# The default value is: My Project.\r

 \r
 PROJECT_NAME           = "LUFA Library - Printer Class Bootloader"\r
 \r
 \r
 PROJECT_NAME           = "LUFA Library - Printer Class Bootloader"\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
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This\r
+# could be handy for archiving the generated documentation or if some version\r
+# control system is used.\r

 \r
 PROJECT_NUMBER         =\r
 \r
 # Using the PROJECT_BRIEF tag one can provide an optional one line description\r
 \r
 PROJECT_NUMBER         =\r
 \r
 # Using the PROJECT_BRIEF tag one can provide an optional one line description\r

-# for a project that appears at the top of each page and should give viewer\r
-# a quick idea about the purpose of the project. Keep the description short.\r
+# for a project that appears at the top of each page and should give viewer a\r
+# quick idea about the purpose of the project. Keep the description short.\r

 \r
 PROJECT_BRIEF          =\r
 \r
 \r
 PROJECT_BRIEF          =\r
 \r

-# With the PROJECT_LOGO tag one can specify an logo or icon that is\r
-# included in the documentation. The maximum height of the logo should not\r
-# exceed 55 pixels and the maximum width should not exceed 200 pixels.\r
-# Doxygen will copy the logo to the output directory.\r
+# With the PROJECT_LOGO tag one can specify an logo or icon that is included in\r
+# the documentation. The maximum height of the logo should not exceed 55 pixels\r
+# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo\r
+# to the output directory.\r

 \r
 PROJECT_LOGO           =\r
 \r
 \r
 PROJECT_LOGO           =\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
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path\r
+# into which the generated documentation will be written. If a relative path is\r
+# entered, it will be relative to the location where doxygen was started. If\r
+# left blank the current directory will be used.\r

 \r
 OUTPUT_DIRECTORY       = ./Documentation/\r
 \r
 \r
 OUTPUT_DIRECTORY       = ./Documentation/\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
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-\r
+# directories (in 2 levels) under the output directory of each output format and\r
+# will distribute the generated files over these directories. Enabling this\r
+# option can be useful when feeding doxygen a huge amount of source files, where\r
+# putting all generated files in the same directory would otherwise causes\r
+# performance problems for the file system.\r
+# The default value is: NO.\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
 \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
-# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,\r
-# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,\r
-# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English\r
-# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,\r
-# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,\r
-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.\r
+# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-\r
+# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,\r
+# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,\r
+# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,\r
+# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,\r
+# Turkish, Ukrainian and Vietnamese.\r
+# The default value is: English.\r

 \r
 OUTPUT_LANGUAGE        = English\r
 \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
+# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member\r
+# descriptions after the members that are listed in the file and class\r
+# documentation (similar to Javadoc). Set to NO to disable this.\r
+# The default value is: YES.\r

 \r
 BRIEF_MEMBER_DESC      = YES\r
 \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
+# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief\r
+# description of a member or function before the detailed description\r
+#\r
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the\r

 # brief descriptions will be completely suppressed.\r
 # brief descriptions will be completely suppressed.\r

+# The default value is: YES.\r

 \r
 REPEAT_BRIEF           = YES\r
 \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
+# This tag implements a quasi-intelligent brief description abbreviator that is\r
+# used to form the text in various listings. Each string in this list, if found\r
+# as the leading text of the brief description, will be stripped from the text\r
+# and the result, after processing the whole list, is used as the annotated\r
+# text. Otherwise, the brief description is used as-is. If left blank, the\r
+# following values are used ($name is automatically replaced with the name of\r
+# the entity):The $name class, The $name widget, The $name file, is, provides,\r
+# specifies, contains, represents, a, an and the.\r

 \r
 ABBREVIATE_BRIEF       = "The $name class" \\r
                          "The $name widget" \\r
 \r
 ABBREVIATE_BRIEF       = "The $name class" \\r
                          "The $name widget" \\r


@@ -113,8 +121,9 @@ ABBREVIATE_BRIEF       = "The $name class" \
                          the\r
 \r
 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then\r
                          the\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
+# doxygen will generate a detailed section even if there is only a brief\r

 # description.\r
 # description.\r

+# The default value is: NO.\r

 \r
 ALWAYS_DETAILED_SEC    = NO\r
 \r
 \r
 ALWAYS_DETAILED_SEC    = NO\r
 \r


@@ -122,179 +131,204 @@ ALWAYS_DETAILED_SEC    = NO
 # 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
 # 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

+# The default value is: NO.\r

 \r
 INLINE_INHERITED_MEMB  = NO\r
 \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
+# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path\r
+# before files name in the file list and in the header files. If set to NO the\r
+# shortest path that makes the file name unique will be used\r
+# The default value is: YES.\r

 \r
 FULL_PATH_NAMES        = YES\r
 \r
 \r
 FULL_PATH_NAMES        = YES\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. Note that you specify absolute paths here, but also\r
-# relative paths, which will be relative from the directory where doxygen is\r
-# started.\r
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.\r
+# Stripping is only done if one of the specified strings matches the left-hand\r
+# part of 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 path to\r
+# strip.\r
+#\r
+# Note that you can specify absolute paths here, but also relative paths, which\r
+# will be relative from the directory where doxygen is started.\r
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.\r

 \r
 STRIP_FROM_PATH        =\r
 \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
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the\r
+# path mentioned in the documentation of a class, which tells the reader which\r
+# header file to include in order to use a class. If left blank only the name of\r
+# the header file containing the class definition is used. Otherwise one should\r
+# specify the list of include paths that are normally passed to the compiler\r
+# using the -I flag.\r

 \r
 STRIP_FROM_INC_PATH    =\r
 \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 if your file system\r
-# doesn't support long names like on DOS, Mac, or CD-ROM.\r
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but\r
+# less readable) file names. This can be useful is your file systems doesn't\r
+# support long names like on DOS, Mac, or CD-ROM.\r
+# The default value is: NO.\r

 \r
 SHORT_NAMES            = YES\r
 \r
 \r
 SHORT_NAMES            = 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 regular Qt-style comments\r
-# (thus requiring an explicit @brief command for a brief description.)\r
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the\r
+# first line (until the first dot) of a Javadoc-style comment as the brief\r
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-\r
+# style comments (thus requiring an explicit @brief command for a brief\r
+# description.)\r
+# The default value is: NO.\r

 \r
 JAVADOC_AUTOBRIEF      = NO\r
 \r
 \r
 JAVADOC_AUTOBRIEF      = NO\r
 \r

-# If the QT_AUTOBRIEF tag is set to YES then Doxygen will\r
-# interpret the first line (until the first dot) of a Qt-style\r
-# comment as the brief description. If set to NO, the comments\r
-# will behave just like regular Qt-style comments (thus requiring\r
-# an explicit \brief command for a brief description.)\r
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first\r
+# line (until the first dot) of a Qt-style comment as the brief description. If\r
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus\r
+# requiring an explicit \brief command for a brief description.)\r
+# The default value is: NO.\r

 \r
 QT_AUTOBRIEF           = NO\r
 \r
 \r
 QT_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
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a\r
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as\r
+# a brief description. This used to be the default behavior. The new default is\r
+# to treat a multi-line C++ comment block as a detailed description. Set this\r
+# tag to YES if you prefer the old behavior instead.\r
+#\r
+# Note that setting this tag to YES also means that rational rose comments are\r
+# not recognized any more.\r
+# The default value is: NO.\r

 \r
 MULTILINE_CPP_IS_BRIEF = NO\r
 \r
 \r
 MULTILINE_CPP_IS_BRIEF = 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
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the\r
+# documentation from any documented member that it re-implements.\r
+# The default value is: YES.\r

 \r
 INHERIT_DOCS           = YES\r
 \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
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a\r
+# new page for each member. If set to NO, the documentation of a member will be\r
+# part of the file/class/namespace that contains it.\r
+# The default value is: NO.\r

 \r
 SEPARATE_MEMBER_PAGES  = NO\r
 \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
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen\r
+# uses this value to replace tabs by spaces in code fragments.\r
+# Minimum value: 1, maximum value: 16, default value: 4.\r

 \r
 TAB_SIZE               = 4\r
 \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
+# This tag can be used to specify a number of aliases that act as commands in\r
+# the documentation. An alias has the form:\r
+# name=value\r
+# For example adding\r
+# "sideeffect=@par Side Effects:\n"\r
+# will allow you to put the command \sideeffect (or @sideeffect) in the\r
+# documentation, which will result in a user-defined paragraph with heading\r
+# "Side Effects:". You can put \n's in the value part of an alias to insert\r
+# newlines.\r

 \r
 ALIASES                =\r
 \r
 # This tag can be used to specify a number of word-keyword mappings (TCL only).\r
 \r
 ALIASES                =\r
 \r
 # This tag can be used to specify a number of word-keyword mappings (TCL only).\r

-# A mapping has the form "name=value". For example adding\r
-# "class=itcl::class" will allow you to use the command class in the\r
-# itcl::class meaning.\r
+# A mapping has the form "name=value". For example adding "class=itcl::class"\r
+# will allow you to use the command class in the itcl::class meaning.\r

 \r
 TCL_SUBST              =\r
 \r
 \r
 TCL_SUBST              =\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
+# 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. For\r
+# instance, some of the names that are used will be different. The list of all\r
+# members will be omitted, etc.\r
+# The default value is: NO.\r

 \r
 OPTIMIZE_OUTPUT_FOR_C  = YES\r
 \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\r
-# Java. For instance, namespaces will be presented as packages, qualified\r
-# scopes will look different, etc.\r
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or\r
+# Python sources only. Doxygen will then generate output that is more tailored\r
+# for that language. For instance, namespaces will be presented as packages,\r
+# qualified scopes will look different, etc.\r
+# The default value is: NO.\r

 \r
 OPTIMIZE_OUTPUT_JAVA   = NO\r
 \r
 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\r
 \r
 OPTIMIZE_OUTPUT_JAVA   = NO\r
 \r
 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran\r

-# sources only. Doxygen will then generate output that is more tailored for\r
-# Fortran.\r
+# sources. Doxygen will then generate output that is tailored for Fortran.\r
+# The default value is: NO.\r

 \r
 OPTIMIZE_FOR_FORTRAN   = NO\r
 \r
 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\r
 \r
 OPTIMIZE_FOR_FORTRAN   = NO\r
 \r
 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL\r

-# sources. Doxygen will then generate output that is tailored for\r
-# VHDL.\r
+# sources. Doxygen will then generate output that is tailored for VHDL.\r
+# The default value is: NO.\r

 \r
 OPTIMIZE_OUTPUT_VHDL   = NO\r
 \r
 # Doxygen selects the parser to use depending on the extension of the files it\r
 # parses. With this tag you can assign which parser to use for a given\r
 # extension. Doxygen has a built-in mapping, but you can override or extend it\r
 \r
 OPTIMIZE_OUTPUT_VHDL   = NO\r
 \r
 # Doxygen selects the parser to use depending on the extension of the files it\r
 # parses. With this tag you can assign which parser to use for a given\r
 # extension. Doxygen has a built-in mapping, but you can override or extend it\r

-# using this tag. The format is ext=language, where ext is a file extension,\r
-# and language is one of the parsers supported by doxygen: IDL, Java,\r
-# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,\r
-# C++. For instance to make doxygen treat .inc files as Fortran files (default\r
-# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note\r
-# that for custom extensions you also need to set FILE_PATTERNS otherwise the\r
-# files are not read by doxygen.\r
+# using this tag. The format is ext=language, where ext is a file extension, and\r
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,\r
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make\r
+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C\r
+# (default is Fortran), use: inc=Fortran f=C.\r
+#\r
+# Note For files without extension you can use no_extension as a placeholder.\r
+#\r
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise\r
+# the files are not read by doxygen.\r

 \r
 EXTENSION_MAPPING      =\r
 \r
 \r
 EXTENSION_MAPPING      =\r
 \r

-# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all\r
-# comments according to the Markdown format, which allows for more readable\r
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments\r
+# according to the Markdown format, which allows for more readable\r

 # documentation. See http://daringfireball.net/projects/markdown/ for details.\r
 # documentation. See http://daringfireball.net/projects/markdown/ for details.\r

-# The output of markdown processing is further processed by doxygen, so you\r
-# can mix doxygen, HTML, and XML commands with Markdown formatting.\r
-# Disable only in case of backward compatibilities issues.\r
+# The output of markdown processing is further processed by doxygen, so you can\r
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in\r
+# case of backward compatibilities issues.\r
+# The default value is: YES.\r

 \r
 MARKDOWN_SUPPORT       = NO\r
 \r
 \r
 MARKDOWN_SUPPORT       = NO\r
 \r

-# When enabled doxygen tries to link words that correspond to documented classes,\r
-# or namespaces to their corresponding documentation. Such a link can be\r
-# prevented in individual cases by by putting a % sign in front of the word or\r
-# globally by setting AUTOLINK_SUPPORT to NO.\r
+# When enabled doxygen tries to link words that correspond to documented\r
+# classes, or namespaces to their corresponding documentation. Such a link can\r
+# be prevented in individual cases by by putting a % sign in front of the word\r
+# or globally by setting AUTOLINK_SUPPORT to NO.\r
+# The default value is: YES.\r

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

-# to 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 makes the inheritance and collaboration\r
+# to include (a tag file for) the STL sources as input, then you should set this\r
+# tag to YES in order to let doxygen match functions declarations and\r
+# definitions whose arguments contain STL classes (e.g. func(std::string);\r
+# versus func(std::string) {}). This also make the inheritance and collaboration\r

 # diagrams that involve STL classes more complete and accurate.\r
 # diagrams that involve STL classes more complete and accurate.\r

+# The default value is: NO.\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
 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

+# The default value is: NO.\r

 \r
 CPP_CLI_SUPPORT        = NO\r
 \r
 \r
 CPP_CLI_SUPPORT        = NO\r
 \r

-# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.\r
-# Doxygen will parse them like normal C++ but will assume all classes use public\r
-# instead of private inheritance when no explicit protection keyword is present.\r
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:\r
+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen\r
+# will parse them like normal C++ but will assume all classes use public instead\r
+# of private inheritance when no explicit protection keyword is present.\r
+# The default value is: NO.\r

 \r
 SIP_SUPPORT            = NO\r
 \r
 # For Microsoft's IDL there are propget and propput attributes to indicate\r
 \r
 SIP_SUPPORT            = NO\r
 \r
 # For Microsoft's IDL there are propget and propput attributes to indicate\r

-# getter and setter methods for a property. Setting this option to YES (the\r
-# default) will make doxygen replace the get and set methods by a property in\r
-# the documentation. This will only work if the methods are indeed getting or\r
-# setting a simple type. If this is not the case, or you want to show the\r
-# methods anyway, you should set this option to NO.\r
+# getter and setter methods for a property. Setting this option to YES will make\r
+# doxygen to replace the get and set methods by a property in the documentation.\r
+# This will only work if the methods are indeed getting or setting a simple\r
+# type. If this is not the case, or you want to show the methods anyway, you\r
+# should set this option to NO.\r
+# The default value is: YES.\r

 \r
 IDL_PROPERTY_SUPPORT   = YES\r
 \r
 \r
 IDL_PROPERTY_SUPPORT   = YES\r
 \r


@@ -302,67 +336,61 @@ IDL_PROPERTY_SUPPORT   = YES
 # 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
 # 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

+# The default value is: NO.\r

 \r
 DISTRIBUTE_GROUP_DOC   = NO\r
 \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
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type\r
+# (for instance a group of public functions) to be put as a subgroup of that\r
+# type (e.g. under the Public Functions section). Set it to NO to prevent\r
+# subgrouping. Alternatively, this can be done per class using the\r
+# \nosubgrouping command.\r
+# The default value is: YES.\r

 \r
 SUBGROUPING            = YES\r
 \r
 \r
 SUBGROUPING            = YES\r
 \r

-# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and\r
-# unions are shown inside the group in which they are included (e.g. using\r
-# @ingroup) instead of on a separate page (for HTML and Man pages) or\r
-# section (for LaTeX and RTF).\r
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions\r
+# are shown inside the group in which they are included (e.g. using \ingroup)\r
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX\r
+# and RTF).\r
+#\r
+# Note that this feature does not work in combination with\r
+# SEPARATE_MEMBER_PAGES.\r
+# The default value is: NO.\r

 \r
 INLINE_GROUPED_CLASSES = NO\r
 \r
 \r
 INLINE_GROUPED_CLASSES = NO\r
 \r

-# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and\r
-# unions with only public data fields will be shown inline in the documentation\r
-# of the scope in which they are defined (i.e. file, namespace, or group\r
-# documentation), provided this scope is documented. If set to NO (the default),\r
-# structs, classes, and unions are shown on a separate page (for HTML and Man\r
-# pages) or section (for LaTeX and RTF).\r
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions\r
+# with only public data fields or simple typedef fields will be shown inline in\r
+# the documentation of the scope in which they are defined (i.e. file,\r
+# namespace, or group documentation), provided this scope is documented. If set\r
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and\r
+# Man pages) or section (for LaTeX and RTF).\r
+# The default value is: NO.\r

 \r
 INLINE_SIMPLE_STRUCTS  = NO\r
 \r
 \r
 INLINE_SIMPLE_STRUCTS  = NO\r
 \r

-# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum\r
-# is documented as struct, union, or enum with the name of the typedef. So\r
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or\r
+# enum is documented as struct, union, or enum with the name of the typedef. So\r

 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct\r
 # with name TypeT. When disabled the typedef will appear as a member of a file,\r
 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct\r
 # with name TypeT. When disabled the typedef will appear as a member of a file,\r

-# namespace, or class. And the struct will be named TypeS. This can typically\r
-# be useful for C code in case the coding convention dictates that all compound\r
+# namespace, or class. And the struct will be named TypeS. This can typically be\r
+# useful for C code in case the coding convention dictates that all compound\r

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

+# The default value is: NO.\r

 \r
 TYPEDEF_HIDES_STRUCT   = NO\r
 \r
 \r
 TYPEDEF_HIDES_STRUCT   = NO\r
 \r

-# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to\r
-# determine which symbols to keep in memory and which to flush to disk.\r
-# When the cache is full, less often used symbols will be written to disk.\r
-# For small to medium size projects (<1000 input files) the default value is\r
-# probably good enough. For larger projects a too small cache size can cause\r
-# doxygen to be busy swapping symbols to and from disk most of the time\r
-# causing a significant performance penalty.\r
-# If the system has enough physical memory increasing the cache will improve the\r
-# performance by keeping more symbols in memory. Note that the value works on\r
-# a logarithmic scale so increasing the size by one will roughly double the\r
-# memory usage. The cache size is given by this formula:\r
-# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,\r
-# corresponding to a cache size of 2^16 = 65536 symbols.\r
-\r
-SYMBOL_CACHE_SIZE      = 0\r
-\r
-# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be\r
-# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given\r
-# their name and scope. Since this can be an expensive process and often the\r
-# same symbol appear multiple times in the code, doxygen keeps a cache of\r
-# pre-resolved symbols. If the cache is too small doxygen will become slower.\r
-# If the cache is too large, memory is wasted. The cache size is given by this\r
-# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,\r
-# corresponding to a cache size of 2^16 = 65536 symbols.\r
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\r
+# cache is used to resolve symbols given their name and scope. Since this can be\r
+# an expensive process and often the same symbol appears multiple times in the\r
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small\r
+# doxygen will become slower. If the cache is too large, memory is wasted. The\r
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range\r
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536\r
+# symbols. At the end of a run doxygen will report the cache usage and suggest\r
+# the optimal cache size from a speed point of view.\r
+# Minimum value: 0, maximum value: 9, default value: 0.\r

 \r
 LOOKUP_CACHE_SIZE      = 0\r
 \r
 \r
 LOOKUP_CACHE_SIZE      = 0\r
 \r


@@ -371,344 +399,384 @@ LOOKUP_CACHE_SIZE      = 0
 #---------------------------------------------------------------------------\r
 \r
 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in\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
+# documentation are documented, even if no documentation was available. Private\r
+# class members and static file members will be hidden unless the\r
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.\r
+# Note: This will also disable the warnings about undocumented members that are\r
+# normally produced when WARNINGS is set to YES.\r
+# The default value is: NO.\r

 \r
 EXTRACT_ALL            = YES\r
 \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
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will\r
+# be included in the documentation.\r
+# The default value is: NO.\r

 \r
 EXTRACT_PRIVATE        = YES\r
 \r
 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal\r
 # scope will be included in the documentation.\r
 \r
 EXTRACT_PRIVATE        = YES\r
 \r
 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal\r
 # scope will be included in the documentation.\r

+# The default value is: NO.\r

 \r
 EXTRACT_PACKAGE        = NO\r
 \r
 \r
 EXTRACT_PACKAGE        = NO\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
+# If the EXTRACT_STATIC tag is set to YES all static members of a file will be\r
+# included in the documentation.\r
+# The default value is: NO.\r

 \r
 EXTRACT_STATIC         = YES\r
 \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
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined\r
+# locally in source files will be included in the documentation. If set to NO\r
+# only classes defined in header files are included. Does not have any effect\r
+# for Java sources.\r
+# The default value is: YES.\r

 \r
 EXTRACT_LOCAL_CLASSES  = YES\r
 \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
+# This flag is only useful for Objective-C code. When set to YES local methods,\r
+# which are defined in the implementation section but not in the interface are\r
+# included in the documentation. If set to NO only methods in the interface are\r
+# included.\r
+# The default value is: NO.\r

 \r
 EXTRACT_LOCAL_METHODS  = NO\r
 \r
 # If this flag is set to YES, the members of anonymous namespaces will be\r
 # extracted and appear in the documentation as a namespace called\r
 \r
 EXTRACT_LOCAL_METHODS  = NO\r
 \r
 # If this flag is set to YES, the members of anonymous namespaces will be\r
 # extracted and appear in the documentation as a namespace called\r

-# 'anonymous_namespace{file}', where file will be replaced with the base\r
-# name of the file that contains the anonymous namespace. By default\r
-# anonymous namespaces are hidden.\r
+# 'anonymous_namespace{file}', where file will be replaced with the base name of\r
+# the file that contains the anonymous namespace. By default anonymous namespace\r
+# are hidden.\r
+# The default value is: NO.\r

 \r
 EXTRACT_ANON_NSPACES   = NO\r
 \r
 \r
 EXTRACT_ANON_NSPACES   = 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
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all\r
+# undocumented members inside documented classes or files. If set to NO these\r
+# members will be included in the various overviews, but no documentation\r
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.\r
+# The default value is: NO.\r

 \r
 HIDE_UNDOC_MEMBERS     = NO\r
 \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
+# 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. If set\r
+# to NO these classes will be included in the various overviews. This option has\r
+# no effect if EXTRACT_ALL is enabled.\r
+# The default value is: NO.\r

 \r
 HIDE_UNDOC_CLASSES     = NO\r
 \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
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend\r
+# (class|struct|union) declarations. If set to NO these declarations will be\r
+# included in the documentation.\r
+# The default value is: NO.\r

 \r
 HIDE_FRIEND_COMPOUNDS  = NO\r
 \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
+# 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. If set to NO these\r
+# blocks will be appended to the function's detailed documentation block.\r
+# The default value is: NO.\r

 \r
 HIDE_IN_BODY_DOCS      = NO\r
 \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
+# The INTERNAL_DOCS tag determines if documentation that is typed after a\r
+# \internal command is included. If the tag is set to NO then the documentation\r
+# will be excluded. Set it to YES to include the internal documentation.\r
+# The default value is: NO.\r

 \r
 INTERNAL_DOCS          = NO\r
 \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
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file\r
+# 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
 # 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

+# The default value is: system dependent.\r

 \r
 CASE_SENSE_NAMES       = NO\r
 \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
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with\r
+# their full class and namespace scopes in the documentation. If set to YES the\r
+# scope will be hidden.\r
+# The default value is: NO.\r

 \r
 HIDE_SCOPE_NAMES       = NO\r
 \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
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of\r
+# the files that are included by a file in the documentation of that file.\r
+# The default value is: YES.\r

 \r
 SHOW_INCLUDE_FILES     = YES\r
 \r
 \r
 SHOW_INCLUDE_FILES     = YES\r
 \r

-# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen\r
-# will list include files with double quotes in the documentation\r
-# rather than with sharp brackets.\r
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include\r
+# files with double quotes in the documentation rather than with sharp brackets.\r
+# The default value is: NO.\r

 \r
 FORCE_LOCAL_INCLUDES   = NO\r
 \r
 \r
 FORCE_LOCAL_INCLUDES   = NO\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
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the\r
+# documentation for inline members.\r
+# The default value is: YES.\r

 \r
 INLINE_INFO            = YES\r
 \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
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the\r
+# (detailed) documentation of file and class members alphabetically by member\r
+# name. If set to NO the members will appear in declaration order.\r
+# The default value is: YES.\r

 \r
 SORT_MEMBER_DOCS       = YES\r
 \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
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief\r
+# descriptions of file, namespace and class members alphabetically by member\r
+# name. If set to NO the members will appear in declaration order.\r
+# The default value is: NO.\r

 \r
 SORT_BRIEF_DOCS        = NO\r
 \r
 \r
 SORT_BRIEF_DOCS        = NO\r
 \r

-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen\r
-# will sort the (brief and detailed) documentation of class members so that\r
-# constructors and destructors are listed first. If set to NO (the default)\r
-# the constructors will appear in the respective orders defined by\r
-# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.\r
-# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO\r
-# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.\r
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the\r
+# (brief and detailed) documentation of class members so that constructors and\r
+# destructors are listed first. If set to NO the constructors will appear in the\r
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.\r
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief\r
+# member documentation.\r
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting\r
+# detailed member documentation.\r
+# The default value is: NO.\r

 \r
 SORT_MEMBERS_CTORS_1ST = NO\r
 \r
 \r
 SORT_MEMBERS_CTORS_1ST = NO\r
 \r

-# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the\r
-# hierarchy of group names into alphabetical order. If set to NO (the default)\r
-# the group names will appear in their defined order.\r
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy\r
+# of group names into alphabetical order. If set to NO the group names will\r
+# appear in their defined order.\r
+# The default value is: NO.\r

 \r
 SORT_GROUP_NAMES       = NO\r
 \r
 \r
 SORT_GROUP_NAMES       = 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
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by\r
+# fully-qualified names, including namespaces. If set to NO, the class list will\r
+# be sorted only by class name, 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 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
+# Note: This option applies only to the class list, not to the alphabetical\r
+# list.\r
+# The default value is: NO.\r

 \r
 SORT_BY_SCOPE_NAME     = NO\r
 \r
 \r
 SORT_BY_SCOPE_NAME     = NO\r
 \r

-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to\r
-# do proper type resolution of all parameters of a function it will reject a\r
-# match between the prototype and the implementation of a member function even\r
-# if there is only one candidate or it is obvious which candidate to choose\r
-# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen\r
-# will still accept a match between prototype and implementation in such cases.\r
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper\r
+# type resolution of all parameters of a function it will reject a match between\r
+# the prototype and the implementation of a member function even if there is\r
+# only one candidate or it is obvious which candidate to choose by doing a\r
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still\r
+# accept a match between prototype and implementation in such cases.\r
+# The default value is: NO.\r

 \r
 STRICT_PROTO_MATCHING  = NO\r
 \r
 \r
 STRICT_PROTO_MATCHING  = 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
+# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the\r
+# todo list. This list is created by putting \todo commands in the\r
+# documentation.\r
+# The default value is: YES.\r

 \r
 GENERATE_TODOLIST      = NO\r
 \r
 \r
 GENERATE_TODOLIST      = NO\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
+# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the\r
+# test list. This list is created by putting \test commands in the\r
+# documentation.\r
+# The default value is: YES.\r

 \r
 GENERATE_TESTLIST      = NO\r
 \r
 \r
 GENERATE_TESTLIST      = NO\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
+# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug\r
+# list. This list is created by putting \bug commands in the documentation.\r
+# The default value is: YES.\r

 \r
 GENERATE_BUGLIST       = NO\r
 \r
 \r
 GENERATE_BUGLIST       = NO\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
+# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)\r
+# the deprecated list. This list is created by putting \deprecated commands in\r
+# the documentation.\r
+# The default value is: YES.\r

 \r
 GENERATE_DEPRECATEDLIST= YES\r
 \r
 \r
 GENERATE_DEPRECATEDLIST= YES\r
 \r

-# The ENABLED_SECTIONS tag can be used to enable conditional\r
-# documentation sections, marked by \if section-label ... \endif\r
-# and \cond section-label ... \endcond blocks.\r
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation\r
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>\r
+# ... \endcond blocks.\r

 \r
 ENABLED_SECTIONS       =\r
 \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 macro 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 macros in the\r
-# documentation can be controlled using \showinitializer or \hideinitializer\r
-# command in the documentation regardless of this setting.\r
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the\r
+# initial value of a variable or macro / define can have for it to appear in the\r
+# documentation. If the initializer consists of more lines than specified here\r
+# it will be hidden. Use a value of 0 to hide initializers completely. The\r
+# appearance of the value of individual variables and macros / defines can be\r
+# controlled using \showinitializer or \hideinitializer command in the\r
+# documentation regardless of this setting.\r
+# Minimum value: 0, maximum value: 10000, default value: 30.\r

 \r
 MAX_INITIALIZER_LINES  = 30\r
 \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
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at\r
+# the bottom of the documentation of classes and structs. If set to YES the list\r
+# will mention the files that were used to generate the documentation.\r
+# The default value is: YES.\r

 \r
 SHOW_USED_FILES        = YES\r
 \r
 \r
 SHOW_USED_FILES        = YES\r
 \r

-# Set the SHOW_FILES tag to NO to disable the generation of the Files page.\r
-# This will remove the Files entry from the Quick Index and from the\r
-# Folder Tree View (if specified). The default is YES.\r
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This\r
+# will remove the Files entry from the Quick Index and from the Folder Tree View\r
+# (if specified).\r
+# The default value is: YES.\r

 \r
 SHOW_FILES             = YES\r
 \r
 \r
 SHOW_FILES             = YES\r
 \r

-# Set the SHOW_NAMESPACES tag to NO to disable the generation of the\r
-# Namespaces page.\r
-# This will remove the Namespaces entry from the Quick Index\r
-# and from the Folder Tree View (if specified). The default is YES.\r
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces\r
+# page. This will remove the Namespaces entry from the Quick Index and from the\r
+# Folder Tree View (if specified).\r
+# The default value is: YES.\r

 \r
 SHOW_NAMESPACES        = YES\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\r
 # the version control system). Doxygen will invoke the program by executing (via\r
 \r
 SHOW_NAMESPACES        = YES\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\r
 # the 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
+# popen()) the command command input-file, where command is the value of the\r
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided\r
+# by doxygen. Whatever the program writes to standard output is used as the file\r
+# version. For an example see the documentation.\r

 \r
 FILE_VERSION_FILTER    =\r
 \r
 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\r
 # by doxygen. The layout file controls the global structure of the generated\r
 # output files in an output format independent way. To create the layout file\r
 \r
 FILE_VERSION_FILTER    =\r
 \r
 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed\r
 # by doxygen. The layout file controls the global structure of the generated\r
 # output files in an output format independent way. To create the layout file\r

-# that represents doxygen's defaults, run doxygen with the -l option.\r
-# You can optionally specify a file name after the option, if omitted\r
-# DoxygenLayout.xml will be used as the name of the layout file.\r
+# that represents doxygen's defaults, run doxygen with the -l option. You can\r
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml\r
+# will be used as the name of the layout file.\r
+#\r
+# Note that if you run doxygen from a directory containing a file called\r
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE\r
+# tag is left empty.\r

 \r
 LAYOUT_FILE            =\r
 \r
 \r
 LAYOUT_FILE            =\r
 \r

-# The CITE_BIB_FILES tag can be used to specify one or more bib files\r
-# containing the references data. This must be a list of .bib files. The\r
-# .bib extension is automatically appended if omitted. Using this command\r
-# requires the bibtex tool to be installed. See also\r
-# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style\r
-# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this\r
-# feature you need bibtex and perl available in the search path. Do not use\r
-# file names with spaces, bibtex cannot handle them.\r
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing\r
+# the reference definitions. This must be a list of .bib files. The .bib\r
+# extension is automatically appended if omitted. This requires the bibtex tool\r
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.\r
+# For LaTeX the style of the bibliography can be controlled using\r
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the\r
+# search path. Do not use file names with spaces, bibtex cannot handle them. See\r
+# also \cite for info how to create references.\r

 \r
 CITE_BIB_FILES         =\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 CITE_BIB_FILES         =\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options related to warning and progress messages\r
+# Configuration options related to warning and progress messages\r

 #---------------------------------------------------------------------------\r
 \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
+# The QUIET tag can be used to turn on/off the messages that are generated to\r
+# standard output by doxygen. If QUIET is set to YES this implies that the\r
+# messages are off.\r
+# The default value is: NO.\r

 \r
 QUIET                  = YES\r
 \r
 # The WARNINGS tag can be used to turn on/off the warning messages that are\r
 \r
 QUIET                  = YES\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
+# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES\r
+# this implies that the warnings are on.\r
+#\r
+# Tip: Turn warnings on while writing the documentation.\r
+# The default value is: YES.\r

 \r
 WARNINGS               = YES\r
 \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
+# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate\r
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag\r
+# will automatically be disabled.\r
+# The default value is: YES.\r

 \r
 WARN_IF_UNDOCUMENTED   = YES\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
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for\r
+# potential errors in the documentation, such as not documenting some parameters\r
+# in a documented function, or documenting parameters that don't exist or using\r
+# markup commands wrongly.\r
+# The default value is: YES.\r

 \r
 WARN_IF_DOC_ERROR      = YES\r
 \r
 \r
 WARN_IF_DOC_ERROR      = YES\r
 \r

-# The WARN_NO_PARAMDOC option can be enabled 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
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that\r
+# are documented, but have no documentation for their parameters or return\r
+# value. If set to NO doxygen will only warn about wrong or incomplete parameter\r
+# documentation, but not about the absence of documentation.\r
+# The default value is: NO.\r

 \r
 WARN_NO_PARAMDOC       = YES\r
 \r
 \r
 WARN_NO_PARAMDOC       = 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. 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
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen\r
+# can produce. The string should contain the $file, $line, and $text tags, which\r
+# will be replaced by the file and line number from which the warning originated\r
+# and the warning text. Optionally the format may contain $version, which will\r
+# be replaced by the version of the file (if it could be obtained via\r
+# FILE_VERSION_FILTER)\r
+# The default value is: $file:$line: $text.\r

 \r
 WARN_FORMAT            = "$file:$line: $text"\r
 \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
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error\r
+# messages should be written. If left blank the output is written to standard\r
+# error (stderr).\r

 \r
 WARN_LOGFILE           =\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 WARN_LOGFILE           =\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options related to the input files\r
+# Configuration options related to the input files\r

 #---------------------------------------------------------------------------\r
 \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
+# The INPUT tag is 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 with\r
+# spaces.\r
+# Note: If this tag is empty the current directory is searched.\r

 \r
 INPUT                  = ./\r
 \r
 # This tag can be used to specify the character encoding of the source files\r
 \r
 INPUT                  = ./\r
 \r
 # This tag can be used to specify the character encoding of the source files\r

-# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is\r
-# also the default input encoding. Doxygen uses libiconv (or the iconv built\r
-# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for\r
-# the list of possible encodings.\r
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses\r
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv\r
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of\r
+# possible encodings.\r
+# The default value is: UTF-8.\r

 \r
 INPUT_ENCODING         = UTF-8\r
 \r
 # If the value of the INPUT tag contains directories, you can use the\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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh\r
-# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py\r
-# *.f90 *.f *.for *.vhd *.vhdl\r
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and\r
+# *.h) to filter out the source-files in the directories. If left blank the\r
+# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,\r
+# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,\r
+# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,\r
+# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,\r
+# *.qsf, *.as and *.js.\r

 \r
 FILE_PATTERNS          = *.h \\r
                          *.c \\r
                          *.txt\r
 \r
 \r
 FILE_PATTERNS          = *.h \\r
                          *.c \\r
                          *.txt\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
+# The RECURSIVE tag can be used to specify whether or not subdirectories should\r
+# be searched for input files as well.\r
+# The default value is: NO.\r

 \r
 RECURSIVE              = YES\r
 \r
 # The EXCLUDE tag can be used to specify files and/or directories that should be\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
 RECURSIVE              = YES\r
 \r
 # The EXCLUDE tag can be used to specify files and/or directories that should be\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

 # Note that relative paths are relative to the directory from which doxygen is\r
 # run.\r
 \r
 # Note that relative paths are relative to the directory from which doxygen is\r
 # run.\r
 \r


@@ -717,14 +785,16 @@ EXCLUDE                = Documentation/
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\r
 # directories that are symbolic links (a Unix file system feature) are excluded\r
 # from the input.\r
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or\r
 # directories that are symbolic links (a Unix file system feature) are excluded\r
 # from the input.\r

+# The default value is: NO.\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
 \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. 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
+# certain files from those directories.\r
+#\r
+# Note that the wildcards are matched against the file with absolute path, so to\r
+# exclude all test directories for example use the pattern */test/*\r

 \r
 EXCLUDE_PATTERNS       =\r
 \r
 \r
 EXCLUDE_PATTERNS       =\r
 \r


@@ -733,820 +803,1100 @@ EXCLUDE_PATTERNS       =
 # output. The symbol name can be a fully qualified name, a word, or if the\r
 # wildcard * is used, a substring. Examples: ANamespace, AClass,\r
 # AClass::ANamespace, ANamespace::*Test\r
 # output. The symbol name can be a fully qualified name, a word, or if the\r
 # wildcard * is used, a substring. Examples: ANamespace, AClass,\r
 # AClass::ANamespace, ANamespace::*Test\r

+#\r
+# Note that the wildcards are matched against the file with absolute path, so to\r
+# exclude all test directories use the pattern */test/*\r

 \r
 EXCLUDE_SYMBOLS        = __* \\r
                          INCLUDE_FROM_*\r
 \r
 \r
 EXCLUDE_SYMBOLS        = __* \\r
                          INCLUDE_FROM_*\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
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories\r
+# that contain example code fragments that are included (see the \include\r
+# command).\r

 \r
 EXAMPLE_PATH           =\r
 \r
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the\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
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and\r
+# *.h) to filter out the source-files in the directories. If left blank all\r
+# files are included.\r

 \r
 EXAMPLE_PATTERNS       = *\r
 \r
 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be\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
+# searched for input files to be used with the \include or \dontinclude commands\r
+# irrespective of the value of the RECURSIVE tag.\r
+# The default value is: NO.\r

 \r
 EXAMPLE_RECURSIVE      = NO\r
 \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
+# The IMAGE_PATH tag can be used to specify one or more files or directories\r
+# that contain images that are to be included in the documentation (see the\r
+# \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
 \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.\r
-# If FILTER_PATTERNS is specified, this tag will be\r
-# ignored.\r
+# by executing (via popen()) the command:\r
+#\r
+# <filter> <input-file>\r
+#\r
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the\r
+# name of an input file. Doxygen will then use the output that the filter\r
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag\r
+# will be ignored.\r
+#\r
+# Note that the filter must not add or remove lines; it is applied before the\r
+# code is scanned, but not when the output code is generated. If lines are added\r
+# or removed, the anchors will not be placed correctly.\r

 \r
 INPUT_FILTER           =\r
 \r
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\r
 \r
 INPUT_FILTER           =\r
 \r
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern\r

-# basis.\r
-# Doxygen will compare the file name with each pattern and apply the\r
-# filter if there is a match.\r
-# 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 or if\r
-# non of the patterns match the file name, INPUT_FILTER is applied.\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: pattern=filter\r
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how\r
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the\r
+# patterns match the file name, INPUT_FILTER is applied.\r

 \r
 FILTER_PATTERNS        =\r
 \r
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using\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
+# INPUT_FILTER ) will also be used to filter the input files that are used for\r
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).\r
+# The default value is: NO.\r

 \r
 FILTER_SOURCE_FILES    = NO\r
 \r
 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\r
 \r
 FILTER_SOURCE_FILES    = NO\r
 \r
 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\r

-# pattern. A pattern will override the setting for FILTER_PATTERN (if any)\r
-# and it is also possible to disable source filtering for a specific pattern\r
-# using *.ext= (so without naming a filter). This option only has effect when\r
-# FILTER_SOURCE_FILES is enabled.\r
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and\r
+# it is also possible to disable source filtering for a specific pattern using\r
+# *.ext= (so without naming a filter).\r
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.\r

 \r
 FILTER_SOURCE_PATTERNS =\r
 \r
 \r
 FILTER_SOURCE_PATTERNS =\r
 \r

-# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that\r
-# is part of the input, its contents will be placed on the main page (index.html).\r
-# This can be useful if you have a project on for instance GitHub and want reuse\r
-# the introduction page also for the doxygen output.\r
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that\r
+# is part of the input, its contents will be placed on the main page\r
+# (index.html). This can be useful if you have a project on for instance GitHub\r
+# and want to reuse the introduction page also for the doxygen output.\r

 \r
 USE_MDFILE_AS_MAINPAGE =\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 USE_MDFILE_AS_MAINPAGE =\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options related to source browsing\r
+# Configuration options related to source browsing\r

 #---------------------------------------------------------------------------\r
 \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
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be\r
+# generated. Documented entities will be cross-referenced with these sources.\r
+#\r
+# Note: To get rid of all source code in the generated output, make sure that\r
+# also VERBATIM_HEADERS is set to NO.\r
+# The default value is: NO.\r

 \r
 SOURCE_BROWSER         = NO\r
 \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
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,\r
+# classes and enums directly into the documentation.\r
+# The default value is: NO.\r

 \r
 INLINE_SOURCES         = 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, C++ and Fortran comments will always remain visible.\r
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any\r
+# special comment blocks from generated source code fragments. Normal C, C++ and\r
+# Fortran comments will always remain visible.\r
+# The default value is: YES.\r

 \r
 STRIP_CODE_COMMENTS    = YES\r
 \r
 \r
 STRIP_CODE_COMMENTS    = YES\r
 \r

-# If the REFERENCED_BY_RELATION tag is set to YES\r
-# then for each documented function all documented\r
-# functions referencing it will be listed.\r
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented\r
+# function all documented functions referencing it will be listed.\r
+# The default value is: NO.\r

 \r
 REFERENCED_BY_RELATION = NO\r
 \r
 \r
 REFERENCED_BY_RELATION = NO\r
 \r

-# If the REFERENCES_RELATION tag is set to YES\r
-# then for each documented function all documented entities\r
-# called/used by that function will be listed.\r
+# If the REFERENCES_RELATION tag is set to YES then for each documented function\r
+# all documented entities called/used by that function will be listed.\r
+# The default value is: NO.\r

 \r
 REFERENCES_RELATION    = NO\r
 \r
 \r
 REFERENCES_RELATION    = NO\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.\r
-# Otherwise they will link to the documentation.\r
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set\r
+# to YES, then the hyperlinks from functions in REFERENCES_RELATION and\r
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will\r
+# link to the documentation.\r
+# The default value is: YES.\r

 \r
 REFERENCES_LINK_SOURCE = NO\r
 \r
 \r
 REFERENCES_LINK_SOURCE = NO\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
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the\r
+# source code will show a tooltip with additional information such as prototype,\r
+# brief description and links to the definition and documentation. Since this\r
+# will make the HTML file larger and loading of large files a bit slower, you\r
+# can opt to disable this feature.\r
+# The default value is: YES.\r
+# This tag requires that the tag SOURCE_BROWSER is set to YES.\r
+\r
+SOURCE_TOOLTIPS        = YES\r
+\r
+# If the USE_HTAGS tag is set to YES then the references to source code will\r
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in\r
+# source browser. The htags tool is part of GNU's global source tagging system\r
+# (see http://www.gnu.org/software/global/global.html). You will need version\r
+# 4.8.6 or higher.\r
+#\r
+# To use it do the following:\r
+# - Install the latest version of global\r
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file\r
+# - Make sure the INPUT points to the root of the source tree\r
+# - Run doxygen as normal\r
+#\r
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these\r
+# tools must be available from the command line (i.e. in the search path).\r
+#\r
+# The result: instead of the source browser generated by doxygen, the links to\r
+# source code will now point to the output of htags.\r
+# The default value is: NO.\r
+# This tag requires that the tag SOURCE_BROWSER is set to YES.\r

 \r
 USE_HTAGS              = NO\r
 \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
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a\r
+# verbatim copy of the header file for each class for which an include is\r
+# specified. Set to NO to disable this.\r
+# See also: Section \class.\r
+# The default value is: YES.\r

 \r
 VERBATIM_HEADERS       = NO\r
 \r
 \r
 VERBATIM_HEADERS       = NO\r
 \r

+# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the\r
+# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the\r
+# cost of reduced performance. This can be particularly helpful with template\r
+# rich C++ code for which doxygen's built-in parser lacks the necessary type\r
+# information.\r
+# Note: The availability of this option depends on whether or not doxygen was\r
+# compiled with the --with-libclang option.\r
+# The default value is: NO.\r
+\r
+CLANG_ASSISTED_PARSING = NO\r
+\r
+# If clang assisted parsing is enabled you can provide the compiler with command\r
+# line options that you would normally use when invoking the compiler. Note that\r
+# the include paths will already be set by doxygen for the files and directories\r
+# specified with INPUT and INCLUDE_PATH.\r
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.\r
+\r
+CLANG_OPTIONS          =\r
+\r

 #---------------------------------------------------------------------------\r
 #---------------------------------------------------------------------------\r

-# configuration options related to the alphabetical class index\r
+# Configuration options related to the alphabetical class index\r

 #---------------------------------------------------------------------------\r
 \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
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all\r
+# compounds will be generated. Enable this if the project contains a lot of\r
+# classes, structs, unions or interfaces.\r
+# The default value is: YES.\r

 \r
 ALPHABETICAL_INDEX     = YES\r
 \r
 \r
 ALPHABETICAL_INDEX     = YES\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
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in\r
+# which the alphabetical index list will be split.\r
+# Minimum value: 1, maximum value: 20, default value: 5.\r
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\r

 \r
 COLS_IN_ALPHA_INDEX    = 5\r
 \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
+# In case all classes in a project start with a common prefix, all classes will\r
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag\r
+# can be used to specify a prefix (or a list of prefixes) that should be ignored\r
+# while generating the index headers.\r
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.\r

 \r
 IGNORE_PREFIX          =\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 IGNORE_PREFIX          =\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options related to the HTML output\r
+# Configuration options related to the HTML output\r

 #---------------------------------------------------------------------------\r
 \r
 #---------------------------------------------------------------------------\r
 \r

-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will\r
-# generate HTML output.\r
+# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output\r
+# The default value is: YES.\r

 \r
 GENERATE_HTML          = YES\r
 \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
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a\r
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\r
+# it.\r
+# The default directory is: html.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_OUTPUT            = html\r
 \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
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each\r
+# generated HTML page (for example: .htm, .php, .asp).\r
+# The default value is: .html.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_FILE_EXTENSION    = .html\r
 \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. Note that when using a custom header you are responsible\r
-#  for the proper inclusion of any scripts and style sheets that doxygen\r
-# needs, which is dependent on the configuration options used.\r
-# It is advised to generate a default header using "doxygen -w html\r
-# header.html footer.html stylesheet.css YourConfigFile" and then modify\r
-# that header. Note that the header is subject to change so you typically\r
-# have to redo this when upgrading to a newer version of doxygen or when\r
-# changing the value of configuration settings such as GENERATE_TREEVIEW!\r
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for\r
+# each generated HTML page. If the tag is left blank doxygen will generate a\r
+# standard header.\r
+#\r
+# To get valid HTML the header file that includes any scripts and style sheets\r
+# that doxygen needs, which is dependent on the configuration options used (e.g.\r
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a\r
+# default header using\r
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css\r
+# YourConfigFile\r
+# and then modify the file new_header.html. See also section "Doxygen usage"\r
+# for information on how to generate the default header that doxygen normally\r
+# uses.\r
+# Note: The header is subject to change so you typically have to regenerate the\r
+# default header when upgrading to a newer version of doxygen. For a description\r
+# of the possible markers and block names see the documentation.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_HEADER            =\r
 \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
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each\r
+# generated HTML page. If the tag is left blank doxygen will generate a standard\r
+# footer. See HTML_HEADER for more information on how to generate a default\r
+# footer and what special commands can be used inside the footer. See also\r
+# section "Doxygen usage" for information on how to generate the default footer\r
+# that doxygen normally uses.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_FOOTER            =\r
 \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 left blank doxygen will\r
-# generate a default style sheet. Note that it is recommended to use\r
-# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this\r
-# tag will in the future become obsolete.\r
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style\r
+# sheet that is used by each HTML page. It can be used to fine-tune the look of\r
+# the HTML output. If left blank doxygen will generate a default style sheet.\r
+# See also section "Doxygen usage" for information on how to generate the style\r
+# sheet that doxygen normally uses.\r
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as\r
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become\r
+# obsolete.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_STYLESHEET        =\r
 \r
 \r
 HTML_STYLESHEET        =\r
 \r

-# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional\r
-# user-defined cascading style sheet that is included after the standard\r
-# style sheets created by doxygen. Using this option one can overrule\r
-# certain style aspects. This is preferred over using HTML_STYLESHEET\r
-# since it does not replace the standard style sheet and is therefor more\r
-# robust against future updates. Doxygen will copy the style sheet file to\r
-# the output directory.\r
+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-\r
+# defined cascading style sheet that is included after the standard style sheets\r
+# created by doxygen. Using this option one can overrule certain style aspects.\r
+# This is preferred over using HTML_STYLESHEET since it does not replace the\r
+# standard style sheet and is therefor more robust against future updates.\r
+# Doxygen will copy the style sheet file to the output directory. For an example\r
+# see the documentation.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_EXTRA_STYLESHEET  =\r
 \r
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\r
 # other source files which should be copied to the HTML output directory. Note\r
 # that these files will be copied to the base HTML output directory. Use the\r
 \r
 HTML_EXTRA_STYLESHEET  =\r
 \r
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\r
 # other source files which should be copied to the HTML output directory. Note\r
 # that these files will be copied to the base HTML output directory. Use the\r

-# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\r
-# files. In the HTML_STYLESHEET file, use the file name only. Also note that\r
-# the files will be copied as-is; there are no commands or markers available.\r
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\r
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the\r
+# files will be copied as-is; there are no commands or markers available.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_EXTRA_FILES       =\r
 \r
 \r
 HTML_EXTRA_FILES       =\r
 \r

-# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.\r
-# Doxygen will adjust the colors in the style sheet and background images\r
-# according to this color. Hue is specified as an angle on a colorwheel,\r
-# see http://en.wikipedia.org/wiki/Hue for more information.\r
-# For instance the value 0 represents red, 60 is yellow, 120 is green,\r
-# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.\r
-# The allowed range is 0 to 359.\r
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen\r
+# will adjust the colors in the stylesheet and background images according to\r
+# this color. Hue is specified as an angle on a colorwheel, see\r
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value\r
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300\r
+# purple, and 360 is red again.\r
+# Minimum value: 0, maximum value: 359, default value: 220.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_COLORSTYLE_HUE    = 220\r
 \r
 \r
 HTML_COLORSTYLE_HUE    = 220\r
 \r

-# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of\r
-# the colors in the HTML output. For a value of 0 the output will use\r
-# grayscales only. A value of 255 will produce the most vivid colors.\r
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors\r
+# in the HTML output. For a value of 0 the output will use grayscales only. A\r
+# value of 255 will produce the most vivid colors.\r
+# Minimum value: 0, maximum value: 255, default value: 100.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_COLORSTYLE_SAT    = 100\r
 \r
 \r
 HTML_COLORSTYLE_SAT    = 100\r
 \r

-# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to\r
-# the luminance component of the colors in the HTML output. Values below\r
-# 100 gradually make the output lighter, whereas values above 100 make\r
-# the output darker. The value divided by 100 is the actual gamma applied,\r
-# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,\r
-# and 100 does not change the gamma.\r
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the\r
+# luminance component of the colors in the HTML output. Values below 100\r
+# gradually make the output lighter, whereas values above 100 make the output\r
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents\r
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not\r
+# change the gamma.\r
+# Minimum value: 40, maximum value: 240, default value: 80.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_COLORSTYLE_GAMMA  = 80\r
 \r
 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\r
 \r
 HTML_COLORSTYLE_GAMMA  = 80\r
 \r
 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML\r

-# page will contain the date and time when the page was generated. Setting\r
-# this to NO can help when comparing the output of multiple runs.\r
+# page will contain the date and time when the page was generated. Setting this\r
+# to NO can help when comparing the output of multiple runs.\r
+# The default value is: YES.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_TIMESTAMP         = NO\r
 \r
 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\r
 # documentation will contain sections that can be hidden and shown after the\r
 # page has loaded.\r
 \r
 HTML_TIMESTAMP         = NO\r
 \r
 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML\r
 # documentation will contain sections that can be hidden and shown after the\r
 # page has loaded.\r

+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_DYNAMIC_SECTIONS  = YES\r
 \r
 \r
 HTML_DYNAMIC_SECTIONS  = YES\r
 \r

-# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of\r
-# entries shown in the various tree structured indices initially; the user\r
-# can expand and collapse entries dynamically later on. Doxygen will expand\r
-# the tree to such a level that at most the specified number of entries are\r
-# visible (unless a fully collapsed tree already exceeds this amount).\r
-# So setting the number of entries 1 will produce a full collapsed tree by\r
-# default. 0 is a special value representing an infinite number of entries\r
-# and will result in a full expanded tree by default.\r
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries\r
+# shown in the various tree structured indices initially; the user can expand\r
+# and collapse entries dynamically later on. Doxygen will expand the tree to\r
+# such a level that at most the specified number of entries are visible (unless\r
+# a fully collapsed tree already exceeds this amount). So setting the number of\r
+# entries 1 will produce a full collapsed tree by default. 0 is a special value\r
+# representing an infinite number of entries and will result in a full expanded\r
+# tree by default.\r
+# Minimum value: 0, maximum value: 9999, default value: 100.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 HTML_INDEX_NUM_ENTRIES = 100\r
 \r
 \r
 HTML_INDEX_NUM_ENTRIES = 100\r
 \r

-# If the GENERATE_DOCSET tag is set to YES, additional index files\r
-# will be generated that can be used as input for Apple's Xcode 3\r
-# integrated development environment, introduced with OSX 10.5 (Leopard).\r
-# To create a documentation set, doxygen will generate a Makefile in the\r
-# HTML output directory. Running make will produce the docset in that\r
-# directory and running "make install" will install the docset in\r
-# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find\r
-# it at startup.\r
-# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html\r
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be\r
+# generated that can be used as input for Apple's Xcode 3 integrated development\r
+# environment (see: http://developer.apple.com/tools/xcode/), introduced with\r
+# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a\r
+# Makefile in the HTML output directory. Running make will produce the docset in\r
+# that directory and running make install will install the docset in\r
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at\r
+# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html\r

 # for more information.\r
 # for more information.\r

+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 GENERATE_DOCSET        = NO\r
 \r
 \r
 GENERATE_DOCSET        = NO\r
 \r

-# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the\r
-# feed. A documentation feed provides an umbrella under which multiple\r
-# documentation sets from a single provider (such as a company or product suite)\r
-# can be grouped.\r
+# This tag determines the name of the docset feed. A documentation feed provides\r
+# an umbrella under which multiple documentation sets from a single provider\r
+# (such as a company or product suite) can be grouped.\r
+# The default value is: Doxygen generated docs.\r
+# This tag requires that the tag GENERATE_DOCSET is set to YES.\r

 \r
 DOCSET_FEEDNAME        = "Doxygen generated docs"\r
 \r
 \r
 DOCSET_FEEDNAME        = "Doxygen generated docs"\r
 \r

-# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that\r
-# should uniquely identify the documentation set bundle. This should be a\r
-# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen\r
-# will append .docset to the name.\r
+# This tag specifies a string that should uniquely identify the documentation\r
+# set bundle. This should be a reverse domain-name style string, e.g.\r
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.\r
+# The default value is: org.doxygen.Project.\r
+# This tag requires that the tag GENERATE_DOCSET is set to YES.\r

 \r
 DOCSET_BUNDLE_ID       = org.doxygen.Project\r
 \r
 \r
 DOCSET_BUNDLE_ID       = org.doxygen.Project\r
 \r

-# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely\r
-# identify the documentation publisher. This should be a reverse domain-name\r
-# style string, e.g. com.mycompany.MyDocSet.documentation.\r
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify\r
+# the documentation publisher. This should be a reverse domain-name style\r
+# string, e.g. com.mycompany.MyDocSet.documentation.\r
+# The default value is: org.doxygen.Publisher.\r
+# This tag requires that the tag GENERATE_DOCSET is set to YES.\r

 \r
 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher\r
 \r
 \r
 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher\r
 \r

-# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.\r
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.\r
+# The default value is: Publisher.\r
+# This tag requires that the tag GENERATE_DOCSET is set to YES.\r

 \r
 DOCSET_PUBLISHER_NAME  = Publisher\r
 \r
 \r
 DOCSET_PUBLISHER_NAME  = Publisher\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 compiled HTML help file (.chm)\r
-# of the generated HTML documentation.\r
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three\r
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The\r
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop\r
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on\r
+# Windows.\r
+#\r
+# The HTML Help Workshop contains a compiler that can convert all HTML output\r
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML\r
+# files are now used as the Windows 98 help format, and will replace the old\r
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed\r
+# HTML files also contain an index, a table of contents, and you can search for\r
+# words in the documentation. The HTML workshop also contains a viewer for\r
+# compressed HTML files.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 GENERATE_HTMLHELP      = NO\r
 \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
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm\r
+# file. You can add a path in front of the file if the result should not be\r

 # written to the html output directory.\r
 # written to the html output directory.\r

+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\r

 \r
 CHM_FILE               =\r
 \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 HHC_LOCATION tag can be used to specify the location (absolute path\r
+# including file name) of the HTML help compiler ( hhc.exe). If non-empty\r
+# doxygen will try to run the HTML help compiler on the generated index.hhp.\r
+# The file has to be specified with full path.\r
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\r

 \r
 HHC_LOCATION           =\r
 \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
+# The GENERATE_CHI flag controls if a separate .chi index file is generated (\r
+# YES) or that it should be included in the master .chm file ( NO).\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\r

 \r
 GENERATE_CHI           = NO\r
 \r
 \r
 GENERATE_CHI           = NO\r
 \r

-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING\r
-# is used to encode HtmlHelp index (hhk), content (hhc) and project file\r
-# content.\r
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)\r
+# and project file content.\r
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\r

 \r
 CHM_INDEX_ENCODING     =\r
 \r
 \r
 CHM_INDEX_ENCODING     =\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
+# The BINARY_TOC flag controls whether a binary table of contents is generated (\r
+# YES) or a normal table of contents ( NO) in the .chm file.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\r

 \r
 BINARY_TOC             = NO\r
 \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
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to\r
+# the table of contents of the HTML help documentation and to the tree view.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.\r

 \r
 TOC_EXPAND             = YES\r
 \r
 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\r
 \r
 TOC_EXPAND             = YES\r
 \r
 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and\r

-# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated\r
-# that can be used as input for Qt's qhelpgenerator to generate a\r
-# Qt Compressed Help (.qch) of the generated HTML documentation.\r
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that\r
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help\r
+# (.qch) of the generated HTML documentation.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 GENERATE_QHP           = NO\r
 \r
 \r
 GENERATE_QHP           = NO\r
 \r

-# If the QHG_LOCATION tag is specified, the QCH_FILE tag can\r
-# be used to specify the file name of the resulting .qch file.\r
-# The path specified is relative to the HTML output folder.\r
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify\r
+# the file name of the resulting .qch file. The path specified is relative to\r
+# the HTML output folder.\r
+# This tag requires that the tag GENERATE_QHP is set to YES.\r

 \r
 QCH_FILE               =\r
 \r
 \r
 QCH_FILE               =\r
 \r

-# The QHP_NAMESPACE tag specifies the namespace to use when generating\r
-# Qt Help Project output. For more information please see\r
-# http://doc.trolltech.com/qthelpproject.html#namespace\r
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help\r
+# Project output. For more information please see Qt Help Project / Namespace\r
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).\r
+# The default value is: org.doxygen.Project.\r
+# This tag requires that the tag GENERATE_QHP is set to YES.\r

 \r
 QHP_NAMESPACE          = org.doxygen.Project\r
 \r
 \r
 QHP_NAMESPACE          = org.doxygen.Project\r
 \r

-# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating\r
-# Qt Help Project output. For more information please see\r
-# http://doc.trolltech.com/qthelpproject.html#virtual-folders\r
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt\r
+# Help Project output. For more information please see Qt Help Project / Virtual\r
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-\r
+# folders).\r
+# The default value is: doc.\r
+# This tag requires that the tag GENERATE_QHP is set to YES.\r

 \r
 QHP_VIRTUAL_FOLDER     = doc\r
 \r
 \r
 QHP_VIRTUAL_FOLDER     = doc\r
 \r

-# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to\r
-# add. For more information please see\r
-# http://doc.trolltech.com/qthelpproject.html#custom-filters\r
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom\r
+# filter to add. For more information please see Qt Help Project / Custom\r
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\r
+# filters).\r
+# This tag requires that the tag GENERATE_QHP is set to YES.\r

 \r
 QHP_CUST_FILTER_NAME   =\r
 \r
 \r
 QHP_CUST_FILTER_NAME   =\r
 \r

-# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the\r
-# custom filter to add. For more information please see\r
-# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">\r
-# Qt Help Project / Custom Filters</a>.\r
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the\r
+# custom filter to add. For more information please see Qt Help Project / Custom\r
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-\r
+# filters).\r
+# This tag requires that the tag GENERATE_QHP is set to YES.\r

 \r
 QHP_CUST_FILTER_ATTRS  =\r
 \r
 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\r
 \r
 QHP_CUST_FILTER_ATTRS  =\r
 \r
 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this\r

-# project's\r
-# filter section matches.\r
-# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">\r
-# Qt Help Project / Filter Attributes</a>.\r
+# project's filter section matches. Qt Help Project / Filter Attributes (see:\r
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).\r
+# This tag requires that the tag GENERATE_QHP is set to YES.\r

 \r
 QHP_SECT_FILTER_ATTRS  =\r
 \r
 \r
 QHP_SECT_FILTER_ATTRS  =\r
 \r

-# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can\r
-# be used to specify the location of Qt's qhelpgenerator.\r
-# If non-empty doxygen will try to run qhelpgenerator on the generated\r
-# .qhp file.\r
+# The QHG_LOCATION tag can be used to specify the location of Qt's\r
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the\r
+# generated .qhp file.\r
+# This tag requires that the tag GENERATE_QHP is set to YES.\r

 \r
 QHG_LOCATION           =\r
 \r
 \r
 QHG_LOCATION           =\r
 \r

-# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files\r
-#  will be generated, which together with the HTML files, form an Eclipse help\r
-# plugin. To install this plugin and make it available under the help contents\r
-# menu in Eclipse, the contents of the directory containing the HTML and XML\r
-# files needs to be copied into the plugins directory of eclipse. The name of\r
-# the directory within the plugins directory should be the same as\r
-# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before\r
-# the help appears.\r
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be\r
+# generated, together with the HTML files, they form an Eclipse help plugin. To\r
+# install this plugin and make it available under the help contents menu in\r
+# Eclipse, the contents of the directory containing the HTML and XML files needs\r
+# to be copied into the plugins directory of eclipse. The name of the directory\r
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.\r
+# After copying Eclipse needs to be restarted before the help appears.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 GENERATE_ECLIPSEHELP   = NO\r
 \r
 \r
 GENERATE_ECLIPSEHELP   = NO\r
 \r

-# A unique identifier for the eclipse help plugin. When installing the plugin\r
-# the directory name containing the HTML and XML files should also have\r
-# this name.\r
+# A unique identifier for the Eclipse help plugin. When installing the plugin\r
+# the directory name containing the HTML and XML files should also have this\r
+# name. Each documentation set should have its own identifier.\r
+# The default value is: org.doxygen.Project.\r
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.\r

 \r
 ECLIPSE_DOC_ID         = org.doxygen.Project\r
 \r
 \r
 ECLIPSE_DOC_ID         = org.doxygen.Project\r
 \r

-# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)\r
-# at top of each HTML page. The value NO (the default) enables the index and\r
-# the value YES disables it. Since the tabs have the same information as the\r
-# navigation tree you can set this option to NO if you already set\r
-# GENERATE_TREEVIEW to YES.\r
+# If you want full control over the layout of the generated HTML pages it might\r
+# be necessary to disable the index and replace it with your own. The\r
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top\r
+# of each HTML page. A value of NO enables the index and the value YES disables\r
+# it. Since the tabs in the index contain the same information as the navigation\r
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 DISABLE_INDEX          = YES\r
 \r
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\r
 \r
 DISABLE_INDEX          = YES\r
 \r
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\r

-# structure should be generated to display hierarchical information.\r
-# If the tag value is set to YES, a side panel will be generated\r
-# 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 (i.e. any modern browser).\r
-# Windows users are probably better off using the HTML help feature.\r
-# Since the tree basically has the same information as the tab index you\r
-# could consider to set DISABLE_INDEX to NO when enabling this option.\r
+# structure should be generated to display hierarchical information. If the tag\r
+# value is set to YES, a side panel will be generated containing a tree-like\r
+# index structure (just like the one that is generated for HTML Help). For this\r
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required\r
+# (i.e. any modern browser). Windows users are probably better off using the\r
+# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can\r
+# further fine-tune the look of the index. As an example, the default style\r
+# sheet generated by doxygen has an example that shows how to put an image at\r
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has\r
+# the same information as the tab index, you could consider setting\r
+# DISABLE_INDEX to YES when enabling this option.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 GENERATE_TREEVIEW      = YES\r
 \r
 \r
 GENERATE_TREEVIEW      = YES\r
 \r

-# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values\r
-# (range [0,1..20]) that doxygen will group on one line in the generated HTML\r
-# documentation. Note that a value of 0 will completely suppress the enum\r
-# values from appearing in the overview section.\r
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that\r
+# doxygen will group on one line in the generated HTML documentation.\r
+#\r
+# Note that a value of 0 will completely suppress the enum values from appearing\r
+# in the overview section.\r
+# Minimum value: 0, maximum value: 20, default value: 4.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 ENUM_VALUES_PER_LINE   = 1\r
 \r
 \r
 ENUM_VALUES_PER_LINE   = 1\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
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used\r
+# to set the initial width (in pixels) of the frame in which the tree is shown.\r
+# Minimum value: 0, maximum value: 1500, default value: 250.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 TREEVIEW_WIDTH         = 250\r
 \r
 \r
 TREEVIEW_WIDTH         = 250\r
 \r

-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open\r
-# links to external symbols imported via tag files in a separate window.\r
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to\r
+# external symbols imported via tag files in a separate window.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 EXT_LINKS_IN_WINDOW    = NO\r
 \r
 \r
 EXT_LINKS_IN_WINDOW    = NO\r
 \r

-# Use this tag to change the font size of Latex formulas included\r
-# as images in the HTML documentation. The default is 10. Note that\r
-# when you change the font size after a successful doxygen run you need\r
-# to manually remove any form_*.png images from the HTML output directory\r
-# to force them to be regenerated.\r
+# Use this tag to change the font size of LaTeX formulas included as images in\r
+# the HTML documentation. When you change the font size after a successful\r
+# doxygen run you need to manually remove any form_*.png images from the HTML\r
+# output directory to force them to be regenerated.\r
+# Minimum value: 8, maximum value: 50, default value: 10.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 FORMULA_FONTSIZE       = 10\r
 \r
 # Use the FORMULA_TRANPARENT tag to determine whether or not the images\r
 \r
 FORMULA_FONTSIZE       = 10\r
 \r
 # Use the FORMULA_TRANPARENT tag to determine whether or not the images\r

-# generated for formulas are transparent PNGs. Transparent PNGs are\r
-# not supported properly for IE 6.0, but are supported on all modern browsers.\r
-# Note that when changing this option you need to delete any form_*.png files\r
-# in the HTML output before the changes have effect.\r
+# generated for formulas are transparent PNGs. Transparent PNGs are not\r
+# supported properly for IE 6.0, but are supported on all modern browsers.\r
+#\r
+# Note that when changing this option you need to delete any form_*.png files in\r
+# the HTML output directory before the changes have effect.\r
+# The default value is: YES.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 FORMULA_TRANSPARENT    = YES\r
 \r
 \r
 FORMULA_TRANSPARENT    = YES\r
 \r

-# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax\r
-# (see http://www.mathjax.org) which uses client side Javascript for the\r
-# rendering instead of using prerendered bitmaps. Use this if you do not\r
-# have LaTeX installed or if you want to formulas look prettier in the HTML\r
-# output. When enabled you may also need to install MathJax separately and\r
-# configure the path to it using the MATHJAX_RELPATH option.\r
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see\r
+# http://www.mathjax.org) which uses client side Javascript for the rendering\r
+# instead of using prerendered bitmaps. Use this if you do not have LaTeX\r
+# installed or if you want to formulas look prettier in the HTML output. When\r
+# enabled you may also need to install MathJax separately and configure the path\r
+# to it using the MATHJAX_RELPATH option.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 USE_MATHJAX            = NO\r
 \r
 # When MathJax is enabled you can set the default output format to be used for\r
 \r
 USE_MATHJAX            = NO\r
 \r
 # When MathJax is enabled you can set the default output format to be used for\r

-# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and\r
-# SVG. The default value is HTML-CSS, which is slower, but has the best\r
-# compatibility.\r
+# the MathJax output. See the MathJax site (see:\r
+# http://docs.mathjax.org/en/latest/output.html) for more details.\r
+# Possible values are: HTML-CSS (which is slower, but has the best\r
+# compatibility), NativeMML (i.e. MathML) and SVG.\r
+# The default value is: HTML-CSS.\r
+# This tag requires that the tag USE_MATHJAX is set to YES.\r

 \r
 MATHJAX_FORMAT         = HTML-CSS\r
 \r
 \r
 MATHJAX_FORMAT         = HTML-CSS\r
 \r

-# When MathJax is enabled you need to specify the location relative to the\r
-# HTML output directory using the MATHJAX_RELPATH option. The destination\r
-# directory should contain the MathJax.js script. For instance, if the mathjax\r
-# directory is located at the same level as the HTML output directory, then\r
-# MATHJAX_RELPATH should be ../mathjax. The default value points to\r
-# the MathJax Content Delivery Network so you can quickly see the result without\r
-# installing MathJax.\r
-# However, it is strongly recommended to install a local\r
-# copy of MathJax from http://www.mathjax.org before deployment.\r
+# When MathJax is enabled you need to specify the location relative to the HTML\r
+# output directory using the MATHJAX_RELPATH option. The destination directory\r
+# should contain the MathJax.js script. For instance, if the mathjax directory\r
+# is located at the same level as the HTML output directory, then\r
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax\r
+# Content Delivery Network so you can quickly see the result without installing\r
+# MathJax. However, it is strongly recommended to install a local copy of\r
+# MathJax from http://www.mathjax.org before deployment.\r
+# The default value is: http://cdn.mathjax.org/mathjax/latest.\r
+# This tag requires that the tag USE_MATHJAX is set to YES.\r

 \r
 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest\r
 \r
 \r
 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest\r
 \r

-# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension\r
-# names that should be enabled during MathJax rendering.\r
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax\r
+# extension names that should be enabled during MathJax rendering. For example\r
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols\r
+# This tag requires that the tag USE_MATHJAX is set to YES.\r

 \r
 MATHJAX_EXTENSIONS     =\r
 \r
 \r
 MATHJAX_EXTENSIONS     =\r
 \r

-# When the SEARCHENGINE tag is enabled doxygen will generate a search box\r
-# for the HTML output. The underlying search engine uses javascript\r
-# and DHTML and should work on any modern browser. Note that when using\r
-# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets\r
-# (GENERATE_DOCSET) there is already a search function so this one should\r
-# typically be disabled. For large projects the javascript based search engine\r
-# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.\r
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces\r
+# of code that will be used on startup of the MathJax code. See the MathJax site\r
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an\r
+# example see the documentation.\r
+# This tag requires that the tag USE_MATHJAX is set to YES.\r
+\r
+MATHJAX_CODEFILE       =\r
+\r
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for\r
+# the HTML output. The underlying search engine uses javascript and DHTML and\r
+# should work on any modern browser. Note that when using HTML help\r
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)\r
+# there is already a search function so this one should typically be disabled.\r
+# For large projects the javascript based search engine can be slow, then\r
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to\r
+# search using the keyboard; to jump to the search box use <access key> + S\r
+# (what the <access key> is depends on the OS and browser, but it is typically\r
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down\r
+# key> to jump into the search results window, the results can be navigated\r
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel\r
+# the search. The filter options can be selected when the cursor is inside the\r
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>\r
+# to select a filter and <Enter> or <escape> to activate or cancel the filter\r
+# option.\r
+# The default value is: YES.\r
+# This tag requires that the tag GENERATE_HTML is set to YES.\r

 \r
 SEARCHENGINE           = NO\r
 \r
 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be\r
 \r
 SEARCHENGINE           = NO\r
 \r
 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be\r

-# implemented using a web server instead of a web client using Javascript.\r
-# There are two flavours of web server based search depending on the\r
+# implemented using a web server instead of a web client using Javascript. There\r
+# are two flavours of web server based searching depending on the\r

 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for\r
 # searching and an index file used by the script. When EXTERNAL_SEARCH is\r
 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for\r
 # searching and an index file used by the script. When EXTERNAL_SEARCH is\r

-# enabled the indexing and searching needs to be provided by external tools.\r
-# See the manual for details.\r
+# enabled the indexing and searching needs to be provided by external tools. See\r
+# the section "External Indexing and Searching" for details.\r
+# The default value is: NO.\r
+# This tag requires that the tag SEARCHENGINE is set to YES.\r

 \r
 SERVER_BASED_SEARCH    = NO\r
 \r
 \r
 SERVER_BASED_SEARCH    = NO\r
 \r

-# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP\r
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP\r

 # script for searching. Instead the search results are written to an XML file\r
 # which needs to be processed by an external indexer. Doxygen will invoke an\r
 # script for searching. Instead the search results are written to an XML file\r
 # which needs to be processed by an external indexer. Doxygen will invoke an\r

-# external search engine pointed to by the SEARCHENGINE_URL option to obtain\r
-# the search results. Doxygen ships with an example indexer (doxyindexer) and\r
-# search engine (doxysearch.cgi) which are based on the open source search engine\r
-# library Xapian. See the manual for configuration details.\r
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the\r
+# search results.\r
+#\r
+# Doxygen ships with an example indexer ( doxyindexer) and search engine\r
+# (doxysearch.cgi) which are based on the open source search engine library\r
+# Xapian (see: http://xapian.org/).\r
+#\r
+# See the section "External Indexing and Searching" for details.\r
+# The default value is: NO.\r
+# This tag requires that the tag SEARCHENGINE is set to YES.\r

 \r
 EXTERNAL_SEARCH        = NO\r
 \r
 # The SEARCHENGINE_URL should point to a search engine hosted by a web server\r
 \r
 EXTERNAL_SEARCH        = NO\r
 \r
 # The SEARCHENGINE_URL should point to a search engine hosted by a web server\r

-# which will returned the search results when EXTERNAL_SEARCH is enabled.\r
-# Doxygen ships with an example search engine (doxysearch) which is based on\r
-# the open source search engine library Xapian. See the manual for configuration\r
-# details.\r
+# which will return the search results when EXTERNAL_SEARCH is enabled.\r
+#\r
+# Doxygen ships with an example indexer ( doxyindexer) and search engine\r
+# (doxysearch.cgi) which are based on the open source search engine library\r
+# Xapian (see: http://xapian.org/). See the section "External Indexing and\r
+# Searching" for details.\r
+# This tag requires that the tag SEARCHENGINE is set to YES.\r

 \r
 SEARCHENGINE_URL       =\r
 \r
 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed\r
 # search data is written to a file for indexing by an external tool. With the\r
 # SEARCHDATA_FILE tag the name of this file can be specified.\r
 \r
 SEARCHENGINE_URL       =\r
 \r
 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed\r
 # search data is written to a file for indexing by an external tool. With the\r
 # SEARCHDATA_FILE tag the name of this file can be specified.\r

+# The default file is: searchdata.xml.\r
+# This tag requires that the tag SEARCHENGINE is set to YES.\r

 \r
 SEARCHDATA_FILE        = searchdata.xml\r
 \r
 \r
 SEARCHDATA_FILE        = searchdata.xml\r
 \r

-# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the\r
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the\r

 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is\r
 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple\r
 # projects and redirect the results back to the right project.\r
 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is\r
 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple\r
 # projects and redirect the results back to the right project.\r

+# This tag requires that the tag SEARCHENGINE is set to YES.\r

 \r
 EXTERNAL_SEARCH_ID     =\r
 \r
 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen\r
 # projects other than the one defined by this configuration file, but that are\r
 # all added to the same external search index. Each project needs to have a\r
 \r
 EXTERNAL_SEARCH_ID     =\r
 \r
 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen\r
 # projects other than the one defined by this configuration file, but that are\r
 # all added to the same external search index. Each project needs to have a\r

-# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id\r
-# of to a relative location where the documentation can be found.\r
-# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...\r
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of\r
+# to a relative location where the documentation can be found. The format is:\r
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...\r
+# This tag requires that the tag SEARCHENGINE is set to YES.\r

 \r
 EXTRA_SEARCH_MAPPINGS  =\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 EXTRA_SEARCH_MAPPINGS  =\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options related to the LaTeX output\r
+# Configuration options related to the LaTeX output\r

 #---------------------------------------------------------------------------\r
 \r
 #---------------------------------------------------------------------------\r
 \r

-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will\r
-# generate Latex output.\r
+# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.\r
+# The default value is: YES.\r

 \r
 GENERATE_LATEX         = NO\r
 \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
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a\r
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\r
+# it.\r
+# The default directory is: latex.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 LATEX_OUTPUT           = latex\r
 \r
 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be\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
-# Note that when enabling USE_PDFLATEX this option is only used for\r
-# generating bitmaps for formulas in the HTML output, but not in the\r
-# Makefile that is written to the output directory.\r
+# invoked.\r
+#\r
+# Note that when enabling USE_PDFLATEX this option is only used for generating\r
+# bitmaps for formulas in the HTML output, but not in the Makefile that is\r
+# written to the output directory.\r
+# The default file is: latex.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 LATEX_CMD_NAME         = latex\r
 \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
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate\r
+# index for LaTeX.\r
+# The default file is: makeindex.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 MAKEINDEX_CMD_NAME     = makeindex\r
 \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
+# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX\r
+# documents. This may be useful for small projects and may help to save some\r
+# trees in general.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 COMPACT_LATEX          = NO\r
 \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, letter, legal and\r
-# executive. If left blank a4wide will be used.\r
+# The PAPER_TYPE tag can be used to set the paper type that is used by the\r
+# printer.\r
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x\r
+# 14 inches) and executive (7.25 x 10.5 inches).\r
+# The default value is: a4.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 PAPER_TYPE             = a4wide\r
 \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
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names\r
+# that should be included in the LaTeX output. To get the times font for\r
+# instance you can specify\r
+# EXTRA_PACKAGES=times\r
+# If left blank no extra packages will be included.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 EXTRA_PACKAGES         =\r
 \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
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the\r
+# generated LaTeX document. The header should contain everything until the first\r
+# chapter. If it is left blank doxygen will generate a standard header. See\r
+# section "Doxygen usage" for information on how to let doxygen write the\r
+# default header to a separate file.\r
+#\r
+# Note: Only use a user-defined header if you know what you are doing! The\r
+# following commands have a special meaning inside the header: $title,\r
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will\r
+# replace them by respectively the title of the page, the current date and time,\r
+# only the current date, the version number of doxygen, the project name (see\r
+# PROJECT_NAME), or the project number (see PROJECT_NUMBER).\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 LATEX_HEADER           =\r
 \r
 \r
 LATEX_HEADER           =\r
 \r

-# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for\r
-# the generated latex document. The footer should contain everything after\r
-# the last chapter. If it is left blank doxygen will generate a\r
-# standard footer. Notice: only use this tag if you know what you are doing!\r
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the\r
+# generated LaTeX document. The footer should contain everything after the last\r
+# chapter. If it is left blank doxygen will generate a standard footer.\r
+#\r
+# Note: Only use a user-defined footer if you know what you are doing!\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 LATEX_FOOTER           =\r
 \r
 \r
 LATEX_FOOTER           =\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
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or\r
+# other source files which should be copied to the LATEX_OUTPUT output\r
+# directory. Note that the files will be copied as-is; there are no commands or\r
+# markers available.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r
+\r
+LATEX_EXTRA_FILES      =\r
+\r
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is\r
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will\r
+# contain links (just like the HTML output) instead of page references. This\r
+# makes the output suitable for online browsing using a PDF viewer.\r
+# The default value is: YES.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 PDF_HYPERLINKS         = YES\r
 \r
 \r
 PDF_HYPERLINKS         = YES\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
+# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate\r
+# the PDF file directly from the LaTeX files. Set this option to YES to get a\r

 # higher quality PDF documentation.\r
 # higher quality PDF documentation.\r

+# The default value is: YES.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 USE_PDFLATEX           = YES\r
 \r
 \r
 USE_PDFLATEX           = YES\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
+# 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 running\r
+# if errors occur, instead of asking the user for help. This option is also used\r
+# when generating formulas in HTML.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 LATEX_BATCHMODE        = NO\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
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the\r
+# index chapters (such as File Index, Compound Index, etc.) in the output.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 LATEX_HIDE_INDICES     = NO\r
 \r
 \r
 LATEX_HIDE_INDICES     = NO\r
 \r

-# If LATEX_SOURCE_CODE is set to YES then doxygen will include\r
-# source code with syntax highlighting in the LaTeX output.\r
-# Note that which sources are shown also depends on other settings\r
-# such as SOURCE_BROWSER.\r
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source\r
+# code with syntax highlighting in the LaTeX output.\r
+#\r
+# Note that which sources are shown also depends on other settings such as\r
+# SOURCE_BROWSER.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 LATEX_SOURCE_CODE      = NO\r
 \r
 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the\r
 \r
 LATEX_SOURCE_CODE      = NO\r
 \r
 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the\r

-# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See\r
-# http://en.wikipedia.org/wiki/BibTeX for more info.\r
+# bibliography, e.g. plainnat, or ieeetr. See\r
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.\r
+# The default value is: plain.\r
+# This tag requires that the tag GENERATE_LATEX is set to YES.\r

 \r
 LATEX_BIB_STYLE        = plain\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 LATEX_BIB_STYLE        = plain\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options related to the RTF output\r
+# Configuration options related to the RTF output\r

 #---------------------------------------------------------------------------\r
 \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
+# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The\r
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF\r
+# readers/editors.\r
+# The default value is: NO.\r

 \r
 GENERATE_RTF           = NO\r
 \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
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a\r
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\r
+# it.\r
+# The default directory is: rtf.\r
+# This tag requires that the tag GENERATE_RTF is set to YES.\r

 \r
 RTF_OUTPUT             = rtf\r
 \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
+# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF\r
+# documents. This may be useful for small projects and may help to save some\r
+# trees in general.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_RTF is set to YES.\r

 \r
 COMPACT_RTF            = NO\r
 \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
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will\r
+# contain hyperlink fields. The RTF file will contain links (just like the HTML\r
+# output) instead of page references. This makes the output suitable for online\r
+# browsing using Word or some other Word compatible readers that support those\r
+# fields.\r
+#\r
+# Note: WordPad (write) and others do not support links.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_RTF is set to YES.\r

 \r
 RTF_HYPERLINKS         = NO\r
 \r
 \r
 RTF_HYPERLINKS         = NO\r
 \r

-# Load style sheet 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
+# Load stylesheet definitions from file. Syntax is similar to doxygen's config\r
+# file, i.e. a series of assignments. You only have to provide replacements,\r
+# missing definitions are set to their default value.\r
+#\r
+# See also section "Doxygen usage" for information on how to generate the\r
+# default style sheet that doxygen normally uses.\r
+# This tag requires that the tag GENERATE_RTF is set to YES.\r

 \r
 RTF_STYLESHEET_FILE    =\r
 \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
+# Set optional variables used in the generation of an RTF document. Syntax is\r
+# similar to doxygen's config file. A template extensions file can be generated\r
+# using doxygen -e rtf extensionFile.\r
+# This tag requires that the tag GENERATE_RTF is set to YES.\r

 \r
 RTF_EXTENSIONS_FILE    =\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 RTF_EXTENSIONS_FILE    =\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options related to the man page output\r
+# Configuration options related to the man page output\r

 #---------------------------------------------------------------------------\r
 \r
 #---------------------------------------------------------------------------\r
 \r

-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will\r
-# generate man pages\r
+# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for\r
+# classes and files.\r
+# The default value is: NO.\r

 \r
 GENERATE_MAN           = NO\r
 \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
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a\r
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\r
+# it. A directory man3 will be created inside the directory specified by\r
+# MAN_OUTPUT.\r
+# The default directory is: man.\r
+# This tag requires that the tag GENERATE_MAN is set to YES.\r

 \r
 MAN_OUTPUT             = man\r
 \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
+# The MAN_EXTENSION tag determines the extension that is added to the generated\r
+# man pages. In case the manual section does not start with a number, the number\r
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is\r
+# optional.\r
+# The default value is: .3.\r
+# This tag requires that the tag GENERATE_MAN is set to YES.\r

 \r
 MAN_EXTENSION          = .3\r
 \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
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it\r
+# will generate one additional man file for each entity documented in the real\r
+# man page(s). These additional files only source the real man page, but without\r
+# them the man command would be unable to find the correct page.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_MAN is set to YES.\r

 \r
 MAN_LINKS              = NO\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 MAN_LINKS              = NO\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options related to the XML output\r
+# Configuration options related to the XML output\r

 #---------------------------------------------------------------------------\r
 \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
+# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that\r
+# captures the structure of the code including all documentation.\r
+# The default value is: NO.\r

 \r
 GENERATE_XML           = NO\r
 \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
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a\r
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of\r
+# it.\r
+# The default directory is: xml.\r
+# This tag requires that the tag GENERATE_XML is set to YES.\r

 \r
 XML_OUTPUT             = xml\r
 \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
+# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a\r
+# validating XML parser to check the syntax of the XML files.\r
+# This tag requires that the tag GENERATE_XML is set to YES.\r

 \r
 XML_SCHEMA             =\r
 \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
+# The XML_DTD tag can be used to specify a XML DTD, which can be used by a\r
+# validating XML parser to check the syntax of the XML files.\r
+# This tag requires that the tag GENERATE_XML is set to YES.\r

 \r
 XML_DTD                =\r
 \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
+# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program\r
+# listings (including syntax highlighting and cross-referencing information) to\r
+# the XML output. Note that enabling this will significantly increase the size\r
+# of the XML output.\r
+# The default value is: YES.\r
+# This tag requires that the tag GENERATE_XML is set to YES.\r

 \r
 XML_PROGRAMLISTING     = YES\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 XML_PROGRAMLISTING     = YES\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options for the AutoGen Definitions output\r
+# Configuration options related to the DOCBOOK output\r

 #---------------------------------------------------------------------------\r
 \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
+# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files\r
+# that can be used to generate PDF.\r
+# The default value is: NO.\r
+\r
+GENERATE_DOCBOOK       = NO\r
+\r
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.\r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in\r
+# front of it.\r
+# The default directory is: docbook.\r
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.\r
+\r
+DOCBOOK_OUTPUT         = docbook\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 generate an AutoGen\r
+# Definitions (see http://autogen.sf.net) file that captures the structure of\r
+# the code including all documentation. Note that this feature is still\r
+# experimental and incomplete at the moment.\r
+# The default value is: NO.\r

 \r
 GENERATE_AUTOGEN_DEF   = NO\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 GENERATE_AUTOGEN_DEF   = NO\r
 \r
 #---------------------------------------------------------------------------\r

-# configuration options related to the Perl module output\r
+# Configuration options related to the Perl module output\r

 #---------------------------------------------------------------------------\r
 \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
+# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module\r
+# file that captures the structure of the code including all documentation.\r
+#\r
+# Note that this feature is still experimental and incomplete at the moment.\r
+# The default value is: NO.\r

 \r
 GENERATE_PERLMOD       = NO\r
 \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
+# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary\r
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI\r
+# output from the Perl module output.\r
+# The default value is: NO.\r
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.\r

 \r
 PERLMOD_LATEX          = NO\r
 \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.\r
-# This is useful\r
-# if you want to understand what is going on.\r
-# 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
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely\r
+# formatted so it can be parsed by a human reader. This is useful if you want to\r
+# understand what is going on. On the other hand, if this tag is set to NO the\r
+# size of the Perl module output will be much smaller and Perl will parse it\r
+# just the same.\r
+# The default value is: YES.\r
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.\r

 \r
 PERLMOD_PRETTY         = YES\r
 \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
+# The names of the make variables in the generated doxyrules.make file are\r
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful\r
+# so different doxyrules.make files included by the same Makefile don't\r
+# overwrite each other's variables.\r
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.\r

 \r
 PERLMOD_MAKEVAR_PREFIX =\r
 \r
 \r
 PERLMOD_MAKEVAR_PREFIX =\r
 \r


@@ -1554,108 +1904,130 @@ PERLMOD_MAKEVAR_PREFIX =
 # Configuration options related to the preprocessor\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
+# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all\r
+# C-preprocessor directives found in the sources and include files.\r
+# The default value is: YES.\r

 \r
 ENABLE_PREPROCESSING   = YES\r
 \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
+# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names\r
+# in the source code. If set to NO only conditional compilation will be\r
+# performed. Macro expansion can be done in a controlled way by setting\r
+# EXPAND_ONLY_PREDEF to YES.\r
+# The default value is: NO.\r
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.\r

 \r
 MACRO_EXPANSION        = YES\r
 \r
 \r
 MACRO_EXPANSION        = YES\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_DEFINED tags.\r
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then\r
+# the macro expansion is limited to the macros specified with the PREDEFINED and\r
+# EXPAND_AS_DEFINED tags.\r
+# The default value is: NO.\r
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.\r

 \r
 EXPAND_ONLY_PREDEF     = YES\r
 \r
 \r
 EXPAND_ONLY_PREDEF     = YES\r
 \r

-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files\r
-# pointed to by INCLUDE_PATH will be searched when a #include is found.\r
+# If the SEARCH_INCLUDES tag is set to YES the includes files in the\r
+# INCLUDE_PATH will be searched if a #include is found.\r
+# The default value is: YES.\r
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.\r

 \r
 SEARCH_INCLUDES        = YES\r
 \r
 # The INCLUDE_PATH tag can be used to specify one or more directories that\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
+# contain include files that are not input files but should be processed by the\r
+# preprocessor.\r
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.\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
 \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
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be\r
+# used.\r
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.\r

 \r
 INCLUDE_FILE_PATTERNS  =\r
 \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. To prevent a macro definition from being\r
-# undefined via #undef or recursively expanded use the := operator\r
-# instead of the = operator.\r
+# The PREDEFINED tag can be used to specify one or more macro names that are\r
+# defined before the preprocessor is started (similar to the -D option of e.g.\r
+# gcc). The argument of the tag is a list of macros of the form: name or\r
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"\r
+# is assumed. To prevent a macro definition from being undefined via #undef or\r
+# recursively expanded use the := operator instead of the = operator.\r
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.\r

 \r
 PREDEFINED             = __DOXYGEN__ \\r
                          PROGMEM \\r
                          ATTR_NO_INIT\r
 \r
 \r
 PREDEFINED             = __DOXYGEN__ \\r
                          PROGMEM \\r
                          ATTR_NO_INIT\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 that\r
-# overrules the definition found in the source code.\r
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this\r
+# tag can be used to specify a list of macro names that should be expanded. The\r
+# macro definition that is found in the sources will be used. Use the PREDEFINED\r
+# tag if you want to use a different macro definition that overrules the\r
+# definition found in the source code.\r
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.\r

 \r
 EXPAND_AS_DEFINED      =\r
 \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 references to function-like macros\r
-# that are alone on a line, have an all uppercase name, and do not end with a\r
-# semicolon, because these will confuse the parser if not removed.\r
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will\r
+# remove all refrences to function-like macros that are alone on a line, have an\r
+# all uppercase name, and do not end with a semicolon. Such function macros are\r
+# typically used for boiler-plate code, and will confuse the parser if not\r
+# removed.\r
+# The default value is: YES.\r
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.\r

 \r
 SKIP_FUNCTION_MACROS   = YES\r
 \r
 #---------------------------------------------------------------------------\r
 \r
 SKIP_FUNCTION_MACROS   = YES\r
 \r
 #---------------------------------------------------------------------------\r

-# Configuration::additions related to external references\r
+# Configuration options related to external references\r

 #---------------------------------------------------------------------------\r
 \r
 #---------------------------------------------------------------------------\r
 \r

-# The TAGFILES option can be used to specify one or more tagfiles. For each\r
-# tag file the location of the external documentation should be added. The\r
-# format of a tag file without this location is as follows:\r
-#\r
+# The TAGFILES tag can be used to specify one or more tag files. For each tag\r
+# file the location of the external documentation should be added. The format of\r
+# a tag file without this location is as follows:\r

 # TAGFILES = file1 file2 ...\r
 # Adding location for the tag files is done as follows:\r
 # TAGFILES = file1 file2 ...\r
 # Adding location for the tag files is done as follows:\r

-#\r

 # TAGFILES = file1=loc1 "file2 = loc2" ...\r
 # TAGFILES = file1=loc1 "file2 = loc2" ...\r

-# where "loc1" and "loc2" can be relative or absolute paths\r
-# or URLs. Note that each tag file must have a unique name (where the name does\r
-# NOT include the path). If a tag file is not located in the directory in which\r
-# doxygen is run, you must also specify the path to the tagfile here.\r
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the\r
+# section "Linking to external documentation" for more information about the use\r
+# of tag files.\r
+# Note: Each tag file must have an unique name (where the name does NOT include\r
+# the path). If a tag file is not located in the directory in which doxygen is\r
+# run, you must also specify the path to the tagfile here.\r

 \r
 TAGFILES               =\r
 \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
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a\r
+# tag file that is based on the input files it reads. See section "Linking to\r
+# external documentation" for more information about the usage of tag files.\r

 \r
 GENERATE_TAGFILE       =\r
 \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
+# If the ALLEXTERNALS tag is set to YES all external class will be listed in the\r
+# class index. If set to NO only the inherited external classes will be listed.\r
+# The default value is: NO.\r

 \r
 ALLEXTERNALS           = NO\r
 \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
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in\r
+# the modules index. If set to NO, only the current project's groups will be\r
+# listed.\r
+# The default value is: YES.\r

 \r
 EXTERNAL_GROUPS        = YES\r
 \r
 \r
 EXTERNAL_GROUPS        = YES\r
 \r

+# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in\r
+# the related pages index. If set to NO, only the current project's pages will\r
+# be listed.\r
+# The default value is: YES.\r
+\r
+EXTERNAL_PAGES         = YES\r
+\r

 # The PERL_PATH should be the absolute path and name of the perl script\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
+# interpreter (i.e. the result of 'which perl').\r
+# The default file (with absolute path) is: /usr/bin/perl.\r

 \r
 PERL_PATH              = /usr/bin/perl\r
 \r
 \r
 PERL_PATH              = /usr/bin/perl\r
 \r


@@ -1663,222 +2035,280 @@ PERL_PATH              = /usr/bin/perl
 # Configuration options related to the dot tool\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\r
-# or super classes. Setting the tag to NO turns the diagrams off. Note that\r
-# this option also works with HAVE_DOT disabled, but it is recommended to\r
-# install and use dot, since it yields more powerful graphs.\r
+# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram\r
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to\r
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT\r
+# disabled, but it is recommended to install and use dot, since it yields more\r
+# powerful graphs.\r
+# The default value is: YES.\r

 \r
 CLASS_DIAGRAMS         = NO\r
 \r
 # You can define message sequence charts within doxygen comments using the \msc\r
 \r
 CLASS_DIAGRAMS         = NO\r
 \r
 # You can define message sequence charts within doxygen comments using the \msc\r

-# command. Doxygen will then run the mscgen tool (see\r
-# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the\r
+# command. Doxygen will then run the mscgen tool (see:\r
+# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the\r

 # documentation. The MSCGEN_PATH tag allows you to specify the directory where\r
 # the mscgen tool resides. If left empty the tool is assumed to be found in the\r
 # default search path.\r
 \r
 MSCGEN_PATH            =\r
 \r
 # documentation. The MSCGEN_PATH tag allows you to specify the directory where\r
 # the mscgen tool resides. If left empty the tool is assumed to be found in the\r
 # 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
+# If set to YES, the inheritance and collaboration graphs will hide inheritance\r
+# and usage relations if the target is undocumented or is not a class.\r
+# The default value is: YES.\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
 \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
+# available from the path. This tool is part of Graphviz (see:\r
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent\r
+# Bell Labs. The other options in this section have no effect if this option is\r
+# set to NO\r
+# The default value is: NO.\r

 \r
 HAVE_DOT               = NO\r
 \r
 \r
 HAVE_DOT               = NO\r
 \r

-# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is\r
-# allowed to run in parallel. When set to 0 (the default) doxygen will\r
-# base this on the number of processors available in the system. You can set it\r
-# explicitly to a value larger than 0 to get control over the balance\r
-# between CPU load and processing speed.\r
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed\r
+# to run in parallel. When set to 0 doxygen will base this on the number of\r
+# processors available in the system. You can set it explicitly to a value\r
+# larger than 0 to get control over the balance between CPU load and processing\r
+# speed.\r
+# Minimum value: 0, maximum value: 32, default value: 0.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOT_NUM_THREADS        = 0\r
 \r
 \r
 DOT_NUM_THREADS        = 0\r
 \r

-# By default doxygen will use the Helvetica font for all dot files that\r
-# doxygen generates. When you want a differently looking font you can specify\r
-# the font name using DOT_FONTNAME. You need to make sure dot is able to find\r
-# the font, which can be done by putting it in a standard location or by setting\r
-# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the\r
-# directory containing the font.\r
+# When you want a differently looking font n the dot files that doxygen\r
+# generates you can specify the font name using DOT_FONTNAME. You need to make\r
+# sure dot is able to find the font, which can be done by putting it in a\r
+# standard location or by setting the DOTFONTPATH environment variable or by\r
+# setting DOT_FONTPATH to the directory containing the font.\r
+# The default value is: Helvetica.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 \r

-DOT_FONTNAME           = FreeSans\r
+DOT_FONTNAME           =\r

 \r
 \r

-# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.\r
-# The default size is 10pt.\r
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of\r
+# dot graphs.\r
+# Minimum value: 4, maximum value: 24, default value: 10.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOT_FONTSIZE           = 10\r
 \r
 \r
 DOT_FONTSIZE           = 10\r
 \r

-# By default doxygen will tell dot to use the Helvetica font.\r
-# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to\r
-# set the path where dot can find it.\r
+# By default doxygen will tell dot to use the default font as specified with\r
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set\r
+# the path where dot can find it using this tag.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOT_FONTPATH           =\r
 \r
 \r
 DOT_FONTPATH           =\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
-# CLASS_DIAGRAMS tag to NO.\r
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for\r
+# each documented class showing the direct and indirect inheritance relations.\r
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.\r
+# The default value is: YES.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 CLASS_GRAPH            = NO\r
 \r
 \r
 CLASS_GRAPH            = NO\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
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a\r
+# graph for each documented class showing the direct and indirect implementation\r
+# dependencies (inheritance, containment, and class references variables) of the\r
+# class with other documented classes.\r
+# The default value is: YES.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 COLLABORATION_GRAPH    = NO\r
 \r
 \r
 COLLABORATION_GRAPH    = NO\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
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for\r
+# groups, showing the direct groups dependencies.\r
+# The default value is: YES.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 GROUP_GRAPHS           = NO\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
 GROUP_GRAPHS           = NO\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

+# The default value is: NO.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 UML_LOOK               = NO\r
 \r
 \r
 UML_LOOK               = NO\r
 \r

-# If the UML_LOOK tag is enabled, the fields and methods are shown inside\r
-# the class node. If there are many fields or methods and many nodes the\r
-# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS\r
-# threshold limits the number of items for each type to make the size more\r
-# managable. Set this to 0 for no limit. Note that the threshold may be\r
-# exceeded by 50% before the limit is enforced.\r
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the\r
+# class node. If there are many fields or methods and many nodes the graph may\r
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the\r
+# number of items for each type to make the size more manageable. Set this to 0\r
+# for no limit. Note that the threshold may be exceeded by 50% before the limit\r
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,\r
+# but if the number exceeds 15, the total amount of fields shown is limited to\r
+# 10.\r
+# Minimum value: 0, maximum value: 100, default value: 10.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 UML_LIMIT_NUM_FIELDS   = 10\r
 \r
 \r
 UML_LIMIT_NUM_FIELDS   = 10\r
 \r

-# If set to YES, the inheritance and collaboration graphs will show the\r
-# relations between templates and their instances.\r
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and\r
+# collaboration graphs will show the relations between templates and their\r
+# instances.\r
+# The default value is: NO.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 TEMPLATE_RELATIONS     = NO\r
 \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
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to\r
+# YES then doxygen will generate a graph for each documented file showing the\r
+# direct and indirect include dependencies of the file with other documented\r
+# files.\r
+# The default value is: YES.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 INCLUDE_GRAPH          = NO\r
 \r
 \r
 INCLUDE_GRAPH          = NO\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
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are\r
+# set to YES then doxygen will generate a graph for each documented file showing\r
+# the direct and indirect include dependencies of the file with other documented\r
+# files.\r
+# The default value is: YES.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 INCLUDED_BY_GRAPH      = NO\r
 \r
 \r
 INCLUDED_BY_GRAPH      = NO\r
 \r

-# If the CALL_GRAPH and HAVE_DOT options are set to YES then\r
-# doxygen will generate a call dependency graph for every global function\r
-# or class method. Note that enabling this option will significantly increase\r
-# the time of a run. So in most cases it will be better to enable call graphs\r
-# for selected functions only using the \callgraph command.\r
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call\r
+# dependency graph for every global function or class method.\r
+#\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
+# The default value is: NO.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 CALL_GRAPH             = NO\r
 \r
 \r
 CALL_GRAPH             = NO\r
 \r

-# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then\r
-# doxygen will generate a caller dependency graph for every global function\r
-# or class method. Note that enabling this option will significantly increase\r
-# the time of a run. So in most cases it will be better to enable caller\r
-# graphs for selected functions only using the \callergraph command.\r
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller\r
+# dependency graph for every global function or class method.\r
+#\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
+# The default value is: NO.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 CALLER_GRAPH           = NO\r
 \r
 \r
 CALLER_GRAPH           = NO\r
 \r

-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen\r
-# will generate a graphical hierarchy of all classes instead of a textual one.\r
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical\r
+# hierarchy of all classes instead of a textual one.\r
+# The default value is: YES.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 GRAPHICAL_HIERARCHY    = NO\r
 \r
 \r
 GRAPHICAL_HIERARCHY    = NO\r
 \r

-# If the DIRECTORY_GRAPH 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
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the\r
+# dependencies a directory has on other directories in a graphical way. The\r
+# dependency relations are determined by the #include relations between the\r
+# files in the directories.\r
+# The default value is: YES.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DIRECTORY_GRAPH        = NO\r
 \r
 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images\r
 \r
 DIRECTORY_GRAPH        = NO\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 svg, png, jpg, or gif.\r
-# If left blank png will be used. If you choose svg you need to set\r
-# HTML_FILE_EXTENSION to xhtml in order to make the SVG files\r
-# visible in IE 9+ (other browsers do not have this requirement).\r
+# generated by dot.\r
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order\r
+# to make the SVG files visible in IE 9+ (other browsers do not have this\r
+# requirement).\r
+# Possible values are: png, jpg, gif and svg.\r
+# The default value is: png.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOT_IMAGE_FORMAT       = png\r
 \r
 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to\r
 # enable generation of interactive SVG images that allow zooming and panning.\r
 \r
 DOT_IMAGE_FORMAT       = png\r
 \r
 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to\r
 # enable generation of interactive SVG images that allow zooming and panning.\r

-# Note that this requires a modern browser other than Internet Explorer.\r
-# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you\r
-# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files\r
-# visible. Older versions of IE do not have SVG support.\r
+#\r
+# Note that this requires a modern browser other than Internet Explorer. Tested\r
+# and working are Firefox, Chrome, Safari, and Opera.\r
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make\r
+# the SVG files visible. Older versions of IE do not have SVG support.\r
+# The default value is: NO.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 INTERACTIVE_SVG        = NO\r
 \r
 \r
 INTERACTIVE_SVG        = NO\r
 \r

-# The tag DOT_PATH can be used to specify the path where the dot tool can be\r
+# The DOT_PATH tag 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 in the path.\r
 # found. If left blank, it is assumed the dot tool can be found in the path.\r

+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOT_PATH               =\r
 \r
 # The DOTFILE_DIRS tag can be used to specify one or more directories that\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
+# contain dot files that are included in the documentation (see the \dotfile\r
+# command).\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOTFILE_DIRS           =\r
 \r
 # The MSCFILE_DIRS tag can be used to specify one or more directories that\r
 \r
 DOTFILE_DIRS           =\r
 \r
 # The MSCFILE_DIRS tag can be used to specify one or more directories that\r

-# contain msc files that are included in the documentation (see the\r
-# \mscfile command).\r
+# contain msc files that are included in the documentation (see the \mscfile\r
+# command).\r

 \r
 MSCFILE_DIRS           =\r
 \r
 \r
 MSCFILE_DIRS           =\r
 \r

-# The 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 if the\r
-# number of direct children of the root node in a graph is already larger than\r
-# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note\r
-# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.\r
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes\r
+# that will be shown in the graph. If the number of nodes in a graph becomes\r
+# larger than this value, doxygen will truncate the graph, which is visualized\r
+# by representing a node as a red box. Note that doxygen if the number of direct\r
+# children of the root node in a graph is already larger than\r
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that\r
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.\r
+# Minimum value: 0, maximum value: 10000, default value: 50.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOT_GRAPH_MAX_NODES    = 15\r
 \r
 \r
 DOT_GRAPH_MAX_NODES    = 15\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\r
-# that lay further from the root node will be omitted. Note that setting this\r
-# option to 1 or 2 may greatly reduce the computation time needed for large\r
-# code bases. Also note that the size of a graph can be further restricted by\r
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs\r
+# generated by dot. A depth value of 3 means that only nodes reachable from the\r
+# root by following a path via at most 3 edges will be shown. Nodes that lay\r
+# further from the root node will be omitted. Note that setting this option to 1\r
+# or 2 may greatly reduce the computation time needed for large code bases. Also\r
+# note that the size of a graph can be further restricted by\r

 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.\r
 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.\r

+# Minimum value: 0, maximum value: 1000, default value: 0.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 MAX_DOT_GRAPH_DEPTH    = 2\r
 \r
 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent\r
 \r
 MAX_DOT_GRAPH_DEPTH    = 2\r
 \r
 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent\r

-# background. This is disabled by default, because dot on Windows does not\r
-# seem to support this out of the box. Warning: Depending on the platform used,\r
-# enabling this option may lead to badly anti-aliased labels on the edges of\r
-# a graph (i.e. they become hard to read).\r
+# background. This is disabled by default, because dot on Windows does not seem\r
+# to support this out of the box.\r
+#\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
+# The default value is: NO.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOT_TRANSPARENT        = YES\r
 \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
 \r
 DOT_TRANSPARENT        = YES\r
 \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
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support\r
+# this, this feature is disabled by default.\r
+# The default value is: NO.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOT_MULTI_TARGETS      = NO\r
 \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
-# arrows in the dot generated graphs.\r
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page\r
+# explaining the meaning of the various boxes and arrows in the dot generated\r
+# graphs.\r
+# The default value is: YES.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 GENERATE_LEGEND        = YES\r
 \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
+# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot\r
+# files that are used to generate the various graphs.\r
+# The default value is: YES.\r
+# This tag requires that the tag HAVE_DOT is set to YES.\r

 \r
 DOT_CLEANUP            = YES\r
 \r
 DOT_CLEANUP            = YES\r