From kde-commits Mon Jun 30 21:14:35 2014 From: Patrick Spendrin Date: Mon, 30 Jun 2014 21:14:35 +0000 To: kde-commits Subject: [kcwsh] /: add documentation for kcwsh Message-Id: X-MARC-Message: https://marc.info/?l=kde-commits&m=140416288915601 Git commit d8f9ce6f93a5ab99eb4e58dd2a004733d8d7b932 by Patrick Spendrin. Committed on 30/06/2014 at 20:20. Pushed by sengels into branch 'master'. add documentation for kcwsh M +15 -0 CMakeLists.txt M +1 -1 Doxyfile A +5 -0 Mainpage.dox C +806 -765 doc/Doxyfile.in [from: Doxyfile - 078% similarity] http://commits.kde.org/kcwsh/d8f9ce6f93a5ab99eb4e58dd2a004733d8d7b932 diff --git a/CMakeLists.txt b/CMakeLists.txt index 85c1c59..d9f90ef 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -4,6 +4,7 @@ cmake_minimum_required(VERSION 2.8.12) = option(BUILD_GUI_TEST "build a gui app for testing purposes" ON) option(BUILD_TESTS "build unittests" ON) +option(BUILD_DOCS "build documentation" ON) = set(CMAKE_AUTOMOC ON) = @@ -87,6 +88,20 @@ install(EXPORT KcwSHTargets DESTINATION lib/cmake/kcwsh = COMPONENT devel) add_subdirectory(frontends) add_subdirectory(examples) = +if(BUILD_DOCS) + # add a target to generate API documentation with Doxygen + find_package(Doxygen) + if(DOXYGEN_FOUND) + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile.in ${CMAKE= _CURRENT_BINARY_DIR}/Doxyfile @ONLY) + add_custom_target(doc ALL + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating API documentation with Doxygen" VERBATIM + ) + endif() + install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs/html DESTINATION do= c/kcwsh COMPONENT doc) +endif() + if(BUILD_TESTS) add_subdirectory(tests) endif() diff --git a/Doxyfile b/Doxyfile index 01462b9..84f0e0c 100644 --- a/Doxyfile +++ b/Doxyfile @@ -650,7 +650,7 @@ EXCLUDE_PATTERNS =3D # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test = -EXCLUDE_SYMBOLS =3D +EXCLUDE_SYMBOLS =3D InputWriter OutputReader = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see diff --git a/Mainpage.dox b/Mainpage.dox new file mode 100644 index 0000000..628f540 --- /dev/null +++ b/Mainpage.dox @@ -0,0 +1,5 @@ +/** @mainpage kcwsh +kcwsh is a library which provides you with an interface to MS Windows cons= ole applications. +It wraps the console window and gives you control over all of the console = windows properties +so you can reimplement your own GUI interface. +*/ \ No newline at end of file diff --git a/Doxyfile b/doc/Doxyfile.in similarity index 78% copy from Doxyfile copy to doc/Doxyfile.in index 01462b9..bc07f8f 100644 --- a/Doxyfile +++ b/doc/Doxyfile.in @@ -1,301 +1,313 @@ # Doxyfile 1.7.3 = # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. +# doxygen (www.doxygen.org) for a project # -# All text after a hash (#) is considered a comment and will be ignored. +# All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG =3D value [value, ...] # For lists items can also be appended using: # TAG +=3D value [value, ...] -# Values that contain spaces should be placed between quotes (" "). +# Values that contain spaces should be placed between quotes (" ") = #-------------------------------------------------------------------------= -- # Project related configuration options #-------------------------------------------------------------------------= -- = -# This tag specifies the encoding used for all characters in the config fi= le -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or = the -# iconv built into libc) for the transcoding. See +# This tag specifies the encoding used for all characters in the config fi= le = +# that follow. The default is UTF-8 which is also the encoding used for al= l = +# text before the first occurrence of this tag. Doxygen uses libiconv (or = the = +# iconv built into libc) for the transcoding. See = # http://www.gnu.org/software/libiconv for the list of possible encodings. = DOXYFILE_ENCODING =3D UTF-8 = -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded = # by quotes) that should identify the project. = -PROJECT_NAME =3D +PROJECT_NAME =3D kcwsh = -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# The PROJECT_NUMBER tag can be used to enter a project or revision number= . = +# This could be handy for archiving the generated documentation or = # if some version control system is used. = -PROJECT_NUMBER =3D +PROJECT_NUMBER =3D = = -# Using the PROJECT_BRIEF tag one can provide an optional one line descrip= tion for a project that appears at the top of each page and should give vie= wer a quick idea about the purpose of the project. Keep the description sho= rt. +# Using the PROJECT_BRIEF tag one can provide an optional one line descrip= tion +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description shor= t. = -PROJECT_BRIEF =3D +PROJECT_BRIEF =3D = = -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# With the PROJECT_LOGO tag one can specify an logo or icon that is = +# included in the documentation. The maximum height of the logo should not = +# exceed 55 pixels and the maximum width should not exceed 200 pixels. = # Doxygen will copy the logo to the output directory. = -PROJECT_LOGO =3D +PROJECT_LOGO =3D = = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) = +# base path where the generated documentation will be put. = +# If a relative path is entered, it will be relative to the location = # where doxygen was started. If left blank the current directory will be u= sed. = -OUTPUT_DIRECTORY =3D +OUTPUT_DIRECTORY =3D @CMAKE_CURRENT_BINARY_DIR@/docs = -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each ou= tput -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory wo= uld +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create = +# 4096 sub-directories (in 2 levels) under the output directory of each ou= tput = +# format and will distribute the generated files over these directories. = +# Enabling this option can be useful when feeding doxygen a huge amount of = +# source files, where putting all generated files in the same directory wo= uld = # otherwise cause performance problems for the file system. = CREATE_SUBDIRS =3D NO = -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, Germa= n, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# The OUTPUT_LANGUAGE tag is used to specify the language in which all = +# documentation generated by doxygen is written. Doxygen will use this = +# information to generate all constant output in the proper language. = +# The default language is English, other supported languages are: = +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, = +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, Germa= n, = +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English = +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian= , = +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak= , = # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. = OUTPUT_LANGUAGE =3D English = -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will = +# include brief member descriptions after the members that are listed in = +# the file and class documentation (similar to JavaDoc). = # Set to NO to disable this. = BRIEF_MEMBER_DESC =3D YES = -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed descri= ption. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend = +# the brief description of a member or function before the detailed descri= ption. = +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, th= e = # brief descriptions will be completely suppressed. = REPEAT_BRIEF =3D YES = -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, wil= l be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-= is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widg= et" -# "The $name file" "is" "provides" "specifies" "contains" +# This tag implements a quasi-intelligent brief description abbreviator = +# that is used to form the text in various listings. Each string = +# in this list, if found as the leading text of the brief description, wil= l be = +# stripped from the text and the result after processing the whole list, i= s = +# used as the annotated text. Otherwise, the brief description is used as-= is. = +# If left blank, the following values are used ("$name" is automatically = +# replaced with the name of the entity): "The $name class" "The $name widg= et" = +# "The $name file" "is" "provides" "specifies" "contains" = # "represents" "a" "an" "the" = -ABBREVIATE_BRIEF =3D - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +ABBREVIATE_BRIEF =3D "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES the= n = +# Doxygen will generate a detailed section even if there is only a brief = # description. = ALWAYS_DETAILED_SEC =3D NO = -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if th= ose -# members were ordinary class members. Constructors, destructors and assig= nment +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all = +# inherited members of a class in the documentation of that class as if th= ose = +# members were ordinary class members. Constructors, destructors and assig= nment = # operators of the base classes will not be shown. = INLINE_INHERITED_MEMB =3D NO = -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the f= ull -# path before files name in the file list and in the header files. If set +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the f= ull = +# path before files name in the file list and in the header files. If set = # to NO the shortest path that makes the file name unique will be used. = FULL_PATH_NAMES =3D YES = -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag = +# can be used to strip a user-defined part of the path. Stripping is = +# only done if one of the specified strings matches the left-hand part of = +# the path. The tag can be used to show relative paths in the file list. = +# If left blank the directory from which doxygen is run is used as the = # path to strip. = -STRIP_FROM_PATH =3D +STRIP_FROM_PATH =3D = = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of = +# the path mentioned in the documentation of a class, which tells = +# the reader which header file to include in order to use a class. = +# If left blank only the name of the header file containing the class = +# definition is used. Otherwise one should specify the include paths that = # are normally passed to the compiler using the -I flag. = -STRIP_FROM_INC_PATH =3D +STRIP_FROM_INC_PATH =3D = = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter = +# (but less readable) file names. This can be useful if your file system = # doesn't support long names like on DOS, Mac, or CD-ROM. = SHORT_NAMES =3D NO = -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen = +# will interpret the first line (until the first dot) of a JavaDoc-style = +# comment as the brief description. If set to NO, the JavaDoc = +# comments will behave just like regular Qt-style comments = # (thus requiring an explicit @brief command for a brief description.) = JAVADOC_AUTOBRIEF =3D NO = -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will = +# interpret the first line (until the first dot) of a Qt-style = +# comment as the brief description. If set to NO, the comments = +# will behave just like regular Qt-style comments (thus requiring = # an explicit \brief command for a brief description.) = QT_AUTOBRIEF =3D NO = -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen = +# treat a multi-line C++ special comment block (i.e. a block of //! or /// = +# comments) as a brief description. This used to be the default behaviour. = +# The new default is to treat a multi-line C++ comment block as a detailed = # description. Set this tag to YES if you prefer the old behaviour instead. = MULTILINE_CPP_IS_BRIEF =3D NO = -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented = +# member inherits the documentation from any documented member that it = # re-implements. = INHERIT_DOCS =3D YES = -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member = will +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produc= e = +# a new page for each member. If set to NO, the documentation of a member = will = # be part of the file/class/namespace that contains it. = SEPARATE_MEMBER_PAGES =3D NO = -# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. = # Doxygen uses this value to replace tabs by spaces in code fragments. = TAB_SIZE =3D 8 = -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=3Dvalue". -# For example adding "sideeffect=3D\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". +# This tag can be used to specify a number of aliases that acts = +# as commands in the documentation. An alias has the form "name=3Dvalue". = +# For example adding "sideeffect=3D\par Side Effects:\n" will allow you to = +# put the command \sideeffect (or @sideeffect) in the documentation, which = +# will result in a user-defined paragraph with heading "Side Effects:". = # You can put \n's in the value part of an alias to insert newlines. = -ALIASES =3D +ALIASES =3D = = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored fo= r C. -# For instance, some of the names that are used will be different. The list +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C = +# sources only. Doxygen will then generate output that is more tailored fo= r C. = +# For instance, some of the names that are used will be different. The lis= t = # of all members will be omitted, etc. = OPTIMIZE_OUTPUT_FOR_C =3D NO = -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java = +# sources only. Doxygen will then generate output that is more tailored fo= r = +# Java. For instance, namespaces will be presented as packages, qualified = # scopes will look different, etc. = OPTIMIZE_OUTPUT_JAVA =3D NO = -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fort= ran -# sources only. Doxygen will then generate output that is more tailored for +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fort= ran = +# sources only. Doxygen will then generate output that is more tailored fo= r = # Fortran. = OPTIMIZE_FOR_FORTRAN =3D NO = -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL = +# sources. Doxygen will then generate output that is tailored for = # VHDL. = OPTIMIZE_OUTPUT_VHDL =3D NO = -# Doxygen selects the parser to use depending on the extension of the file= s it -# parses. With this tag you can assign which parser to use for a given ext= ension. -# Doxygen has a built-in mapping, but you can override or extend it using = this -# tag. The format is ext=3Dlanguage, where ext is a file extension, and la= nguage -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CShar= p, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to= make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files= as C -# (default is Fortran), use: inc=3DFortran f=3DC. Note that for custom ext= ensions +# Doxygen selects the parser to use depending on the extension of the file= s it = +# parses. With this tag you can assign which parser to use for a given ext= ension. = +# Doxygen has a built-in mapping, but you can override or extend it using = this = +# tag. The format is ext=3Dlanguage, where ext is a file extension, and la= nguage = +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CShar= p, C, = +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to= make = +# doxygen treat .inc files as Fortran files (default is PHP), and .f files= as C = +# (default is Fortran), use: inc=3DFortran f=3DC. Note that for custom ext= ensions = # you also need to set FILE_PATTERNS otherwise the files are not read by d= oxygen. = -EXTENSION_MAPPING =3D +EXTENSION_MAPPING =3D = = -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not = want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations= and -# definitions whose arguments contain STL classes (e.g. func(std::string);= v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not = want = +# to include (a tag file for) the STL sources as input, then you should = +# set this tag to YES in order to let doxygen match functions declarations= and = +# definitions whose arguments contain STL classes (e.g. func(std::string);= v.s. = +# func(std::string) {}). This also makes the inheritance and collaboration = # diagrams that involve STL classes more complete and accurate. = BUILTIN_STL_SUPPORT =3D NO = -# If you use Microsoft's C++/CLI language, you should set this option to Y= ES to +# If you use Microsoft's C++/CLI language, you should set this option to Y= ES to = # enable parsing support. = CPP_CLI_SUPPORT =3D NO = -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources o= nly. -# Doxygen will parse them like normal C++ but will assume all classes use = public +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources o= nly. = +# Doxygen will parse them like normal C++ but will assume all classes use = public = # instead of private inheritance when no explicit protection keyword is pr= esent. = SIP_SUPPORT =3D NO = -# For Microsoft's IDL there are propget and propput attributes to indicate= getter -# and setter methods for a property. Setting this option to YES (the defau= lt) -# will make doxygen replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the +# For Microsoft's IDL there are propget and propput attributes to indicate= getter = +# and setter methods for a property. Setting this option to YES (the defau= lt) = +# will make doxygen replace the get and set methods by a property in the = +# documentation. This will only work if the methods are indeed getting or = +# setting a simple type. If this is not the case, or you want to show the = # methods anyway, you should set this option to NO. = IDL_PROPERTY_SUPPORT =3D YES = -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP= _DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By defa= ult +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP= _DOC = +# tag is set to YES, then doxygen will reuse the documentation of the firs= t = +# member in the group (if any) for the other members of the group. By defa= ult = # all members of a group must be documented explicitly. = DISTRIBUTE_GROUP_DOC =3D NO = -# Set the SUBGROUPING tag to YES (the default) to allow class member group= s of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it = to -# NO to prevent subgrouping. Alternatively, this can be done per class usi= ng +# Set the SUBGROUPING tag to YES (the default) to allow class member group= s of = +# the same type (for instance a group of public functions) to be put as a = +# subgroup of that type (e.g. under the Public Functions section). Set it = to = +# NO to prevent subgrouping. Alternatively, this can be done per class usi= ng = # the \nosubgrouping command. = SUBGROUPING =3D YES = -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or e= num -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a str= uct -# with name TypeT. When disabled the typedef will appear as a member of a = file, -# namespace, or class. And the struct will be named TypeS. This can typica= lly -# be useful for C code in case the coding convention dictates that all com= pound +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or e= num = +# is documented as struct, union, or enum with the name of the typedef. So = +# typedef struct TypeS {} TypeT, will appear in the documentation as a str= uct = +# with name TypeT. When disabled the typedef will appear as a member of a = file, = +# namespace, or class. And the struct will be named TypeS. This can typica= lly = +# be useful for C code in case the coding convention dictates that all com= pound = # types are typedef'ed and only the typedef is referenced, never the tag n= ame. = TYPEDEF_HIDES_STRUCT =3D NO = -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value = is -# probably good enough. For larger projects a too small cache size can cau= se -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will impro= ve the -# performance by keeping more symbols in memory. Note that the value works= on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to = +# determine which symbols to keep in memory and which to flush to disk. = +# When the cache is full, less often used symbols will be written to disk. = +# For small to medium size projects (<1000 input files) the default value = is = +# probably good enough. For larger projects a too small cache size can cau= se = +# doxygen to be busy swapping symbols to and from disk most of the time = +# causing a significant performance penalty. = +# If the system has enough physical memory increasing the cache will impro= ve the = +# performance by keeping more symbols in memory. Note that the value works= on = +# a logarithmic scale so increasing the size by one will roughly double th= e = +# memory usage. The cache size is given by this formula: = +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, = # corresponding to a cache size of 2^16 =3D 65536 symbols = SYMBOL_CACHE_SIZE =3D 0 @@ -304,468 +316,498 @@ SYMBOL_CACHE_SIZE =3D 0 # Build related configuration options #-------------------------------------------------------------------------= -- = -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in = +# documentation are documented, even if no documentation was available. = +# Private class members and static file members will be hidden unless = # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES = -EXTRACT_ALL =3D NO +EXTRACT_ALL =3D YES = -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class = # will be included in the documentation. = EXTRACT_PRIVATE =3D NO = -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# If the EXTRACT_STATIC tag is set to YES all static members of a file = # will be included in the documentation. = EXTRACT_STATIC =3D NO = -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) = +# defined locally in source files will be included in the documentation. = # If set to NO only classes defined in header files are included. = EXTRACT_LOCAL_CLASSES =3D YES = -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. +# This flag is only useful for Objective-C code. When set to YES local = +# methods, which are defined in the implementation section but not in = +# the interface are included in the documentation. = # If set to NO (the default) only methods in the interface are included. = -EXTRACT_LOCAL_METHODS =3D NO +EXTRACT_LOCAL_METHODS =3D YES = -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default +# If this flag is set to YES, the members of anonymous namespaces will be = +# extracted and appear in the documentation as a namespace called = +# 'anonymous_namespace{file}', where file will be replaced with the base = +# name of the file that contains the anonymous namespace. By default = # anonymous namespaces are hidden. = EXTRACT_ANON_NSPACES =3D NO = -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all = +# undocumented members of documented classes, files or namespaces. = +# If set to NO (the default) these members will be included in the = +# various overviews, but no documentation section is generated. = # This option has no effect if EXTRACT_ALL is enabled. = HIDE_UNDOC_MEMBERS =3D NO = -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all = +# undocumented classes that are normally visible in the class hierarchy. = +# If set to NO (the default) these classes will be included in the various = # overviews. This option has no effect if EXTRACT_ALL is enabled. = HIDE_UNDOC_CLASSES =3D NO = -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all = +# friend (class|struct|union) declarations. = +# If set to NO (the default) these declarations will be included in the = # documentation. = HIDE_FRIEND_COMPOUNDS =3D NO = -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any = +# documentation blocks found inside the body of a function. = +# If set to NO (the default) these blocks will be appended to the = # function's detailed documentation block. = HIDE_IN_BODY_DOCS =3D NO = -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. +# The INTERNAL_DOCS tag determines if documentation = +# that is typed after a \internal command is included. If the tag is set = +# to NO (the default) then the documentation will be excluded. = # Set it to YES to include the internal documentation. = INTERNAL_DOCS =3D NO = -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are a= lso -# allowed. This is useful if you have classes or files whose names only di= ffer -# in case and if your file system supports case sensitive file names. Wind= ows +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate = +# file names in lower-case letters. If set to YES upper-case letters are a= lso = +# allowed. This is useful if you have classes or files whose names only di= ffer = +# in case and if your file system supports case sensitive file names. Wind= ows = # and Mac users are advised to set this option to NO. = CASE_SENSE_NAMES =3D NO = -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen = +# will show members with their full class and namespace scopes in the = # documentation. If set to YES the scope will be hidden. = HIDE_SCOPE_NAMES =3D NO = -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the document= ation +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen = +# will put a list of the files that are included by a file in the document= ation = # of that file. = SHOW_INCLUDE_FILES =3D YES = -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen = +# will list include files with double quotes in the documentation = # rather than with sharp brackets. = FORCE_LOCAL_INCLUDES =3D NO = -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] = # is inserted in the documentation for inline members. = INLINE_INFO =3D YES = -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen = +# will sort the (detailed) documentation of file and class members = +# alphabetically by member name. If set to NO the members will appear in = # declaration order. = SORT_MEMBER_DOCS =3D YES = -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the = +# brief documentation of file, namespace and class members alphabetically = +# by member name. If set to NO (the default) the members will appear in = # declaration order. = SORT_BRIEF_DOCS =3D NO = -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen = +# will sort the (brief and detailed) documentation of class members so tha= t = +# constructors and destructors are listed first. If set to NO (the default= ) = +# the constructors will appear in the respective orders defined by = +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. = +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO = # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. = SORT_MEMBERS_CTORS_1ST =3D NO = -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the defa= ult) +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the = +# hierarchy of group names into alphabetical order. If set to NO (the defa= ult) = # the group names will appear in their defined order. = SORT_GROUP_NAMES =3D NO = -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be = +# sorted by fully-qualified names, including namespaces. If set to = +# NO (the default), the class list will be sorted only by class name, = +# not including the namespace part. = +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. = +# Note: This option applies only to the class list, not to the = # alphabetical list. = SORT_BY_SCOPE_NAME =3D NO = -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do p= roper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function = even if there is only one candidate or it is obvious which candidate to cho= ose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxy= gen +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject= a = +# match between the prototype and the implementation of a member function = even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxyg= en = # will still accept a match between prototype and implementation in such c= ases. = STRICT_PROTO_MATCHING =3D NO = -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo +# The GENERATE_TODOLIST tag can be used to enable (YES) or = +# disable (NO) the todo list. This list is created by putting \todo = # commands in the documentation. = GENERATE_TODOLIST =3D YES = -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test +# The GENERATE_TESTLIST tag can be used to enable (YES) or = +# disable (NO) the test list. This list is created by putting \test = # commands in the documentation. = GENERATE_TESTLIST =3D YES = -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or = +# disable (NO) the bug list. This list is created by putting \bug = # commands in the documentation. = GENERATE_BUGLIST =3D YES = -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or = +# disable (NO) the deprecated list. This list is created by putting = # \deprecated commands in the documentation. = GENERATE_DEPRECATEDLIST=3D YES = -# The ENABLED_SECTIONS tag can be used to enable conditional +# The ENABLED_SECTIONS tag can be used to enable conditional = # documentation sections, marked by \if sectionname ... \endif. = -ENABLED_SECTIONS =3D +ENABLED_SECTIONS =3D = = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specif= ied -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in = the -# documentation can be controlled using \showinitializer or \hideinitializ= er +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines = +# the initial value of a variable or macro consists of for it to appear in = +# the documentation. If the initializer consists of more lines than specif= ied = +# here it will be hidden. Use a value of 0 to hide initializers completely= . = +# The appearance of the initializer of individual variables and macros in = the = +# documentation can be controlled using \showinitializer or \hideinitializ= er = # command in the documentation regardless of this setting. = MAX_INITIALIZER_LINES =3D 30 = -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES= the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated = +# at the bottom of the documentation of classes and structs. If set to YES= the = # list will mention the files that were used to generate the documentation. = SHOW_USED_FILES =3D YES = -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hie= rarchy +# If the sources in your project are distributed over multiple directories = +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hie= rarchy = # in the documentation. The default is NO. = SHOW_DIRECTORIES =3D NO = -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the +# Set the SHOW_FILES tag to NO to disable the generation of the Files page= . = +# This will remove the Files entry from the Quick Index and from the = # Folder Tree View (if specified). The default is YES. = SHOW_FILES =3D YES = -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the = +# Namespaces page. This will remove the Namespaces entry from the Quick I= ndex = # and from the Folder Tree View (if specified). The default is YES. = SHOW_NAMESPACES =3D YES = -# The FILE_VERSION_FILTER tag can be used to specify a program or script t= hat -# doxygen should invoke to get the current version for each file (typicall= y from -# the version control system). Doxygen will invoke the program by executin= g (via -# popen()) the command , where is the valu= e of -# the FILE_VERSION_FILTER tag, and is the name of an input fi= le -# provided by doxygen. Whatever the program writes to standard output +# The FILE_VERSION_FILTER tag can be used to specify a program or script t= hat = +# doxygen should invoke to get the current version for each file (typicall= y from = +# the version control system). Doxygen will invoke the program by executin= g (via = +# popen()) the command , where is the valu= e of = +# the FILE_VERSION_FILTER tag, and is the name of an input fi= le = +# provided by doxygen. Whatever the program writes to standard output = # is used as the file version. See the manual for examples. = -FILE_VERSION_FILTER =3D +FILE_VERSION_FILTER =3D = = -# The LAYOUT_FILE tag can be used to specify a layout file which will be p= arsed -# by doxygen. The layout file controls the global structure of the generat= ed -# output files in an output format independent way. The create the layout = file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted +# The LAYOUT_FILE tag can be used to specify a layout file which will be p= arsed = +# by doxygen. The layout file controls the global structure of the generat= ed = +# output files in an output format independent way. The create the layout = file = +# that represents doxygen's defaults, run doxygen with the -l option. = +# You can optionally specify a file name after the option, if omitted = # DoxygenLayout.xml will be used as the name of the layout file. = -LAYOUT_FILE =3D +LAYOUT_FILE =3D = = #-------------------------------------------------------------------------= -- # configuration options related to warning and progress messages #-------------------------------------------------------------------------= -- = -# The QUIET tag can be used to turn on/off the messages that are generated +# The QUIET tag can be used to turn on/off the messages that are generated = # by doxygen. Possible values are YES and NO. If left blank NO is used. = QUIET =3D NO = -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank +# The WARNINGS tag can be used to turn on/off the warning messages that ar= e = +# generated by doxygen. Possible values are YES and NO. If left blank = # NO is used. = WARNINGS =3D YES = -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnin= gs -# for undocumented members. If EXTRACT_ALL is set to YES then this flag wi= ll +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnin= gs = +# for undocumented members. If EXTRACT_ALL is set to YES then this flag wi= ll = # automatically be disabled. = WARN_IF_UNDOCUMENTED =3D YES = -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for = +# potential errors in the documentation, such as not documenting some = +# parameters in a documented function, or documenting parameters that = # don't exist or using markup commands wrongly. = WARN_IF_DOC_ERROR =3D YES = -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their param= eters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of +# The WARN_NO_PARAMDOC option can be enabled to get warnings for = +# functions that are documented, but have no documentation for their param= eters = +# or return value. If set to NO (the default) doxygen will only warn about = +# wrong or incomplete parameter documentation, but not about the absence o= f = # documentation. = WARN_NO_PARAMDOC =3D NO = -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $te= xt -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may conta= in -# $version, which will be replaced by the version of the file (if it could +# The WARN_FORMAT tag determines the format of the warning messages that = +# doxygen can produce. The string should contain the $file, $line, and $te= xt = +# tags, which will be replaced by the file and line number from which the = +# warning originated and the warning text. Optionally the format may conta= in = +# $version, which will be replaced by the version of the file (if it could = # be obtained via FILE_VERSION_FILTER) = WARN_FORMAT =3D "$file:$line: $text" = -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written +# The WARN_LOGFILE tag can be used to specify a file to which warning = +# and error messages should be written. If left blank the output is writte= n = # to stderr. = -WARN_LOGFILE =3D +WARN_LOGFILE =3D = = #-------------------------------------------------------------------------= -- # configuration options related to the input files #-------------------------------------------------------------------------= -- = -# The INPUT tag can be used to specify the files and/or directories that c= ontain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories +# The INPUT tag can be used to specify the files and/or directories that c= ontain = +# documented source files. You may enter file names like "myfile.cpp" or = +# directories like "/usr/src/myproject". Separate the files or directories = # with spaces. = -INPUT =3D +INPUT =3D @CMAKE_CURRENT_SOURCE_DIR@ = -# This tag can be used to specify the character encoding of the source fil= es -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv bui= lt -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv= for +# This tag can be used to specify the character encoding of the source fil= es = +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which i= s = +# also the default input encoding. Doxygen uses libiconv (or the iconv bui= lt = +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv= for = # the list of possible encodings. = INPUT_ENCODING =3D UTF-8 = -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *= .hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# If the value of the INPUT tag contains directories, you can use the = +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp = +# and *.h) to filter out the source-files in the directories. If left = +# blank the following patterns are tested: = +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *= .hh = +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.p= y = # *.f90 *.f *.for *.vhd *.vhdl = -FILE_PATTERNS =3D - -# The RECURSIVE tag can be used to turn specify whether or not subdirector= ies -# should be searched for input files as well. Possible values are YES and = NO. +FILE_PATTERNS =3D *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.idl \ + *.odl \ + *.cs \ + *.php \ + *.php3 \ + *.inc \ + *.m \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.dox + +# The RECURSIVE tag can be used to turn specify whether or not subdirector= ies = +# should be searched for input files as well. Possible values are YES and = NO. = # If left blank NO is used. = RECURSIVE =3D NO = -# The EXCLUDE tag can be used to specify files and/or directories that sho= uld -# excluded from the INPUT source files. This way you can easily exclude a +# The EXCLUDE tag can be used to specify files and/or directories that sho= uld = +# excluded from the INPUT source files. This way you can easily exclude a = # subdirectory from a directory tree whose root is specified with the INPU= T tag. = -EXCLUDE =3D +EXCLUDE =3D = = -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix file system feature) are exc= luded +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or = +# directories that are symbolic links (a Unix file system feature) are exc= luded = # from the input. = EXCLUDE_SYMLINKS =3D NO = -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories +# If the value of the INPUT tag contains directories, you can use the = +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude = +# certain files from those directories. Note that the wildcards are matche= d = +# against the file with absolute path, so to exclude all test directories = # for example use the pattern */test/* = -EXCLUDE_PATTERNS =3D +EXCLUDE_PATTERNS =3D = = -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names = +# (namespaces, classes, functions, etc.) that should be excluded from the = +# output. The symbol name can be a fully qualified name, a word, or if the = +# wildcard * is used, a substring. Examples: ANamespace, AClass, = # AClass::ANamespace, ANamespace::*Test = -EXCLUDE_SYMBOLS =3D +EXCLUDE_SYMBOLS =3D = = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see +# The EXAMPLE_PATH tag can be used to specify one or more files or = +# directories that contain example code fragments that are included (see = # the \include command). = -EXAMPLE_PATH =3D +EXAMPLE_PATH =3D = = -# If the value of the EXAMPLE_PATH tag contains directories, you can use t= he -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left +# If the value of the EXAMPLE_PATH tag contains directories, you can use t= he = +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp = +# and *.h) to filter out the source-files in the directories. If left = # blank all files are included. = -EXAMPLE_PATTERNS =3D +EXAMPLE_PATTERNS =3D * = -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be = +# searched for input files to be used with the \include or \dontinclude = +# commands irrespective of the value of the RECURSIVE tag. = # Possible values are YES and NO. If left blank NO is used. = EXAMPLE_RECURSIVE =3D NO = -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (s= ee +# The IMAGE_PATH tag can be used to specify one or more files or = +# directories that contain image that are included in the documentation (s= ee = # the \image command). = -IMAGE_PATH =3D +IMAGE_PATH =3D = = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter pro= gram -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program wri= tes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be +# The INPUT_FILTER tag can be used to specify a program that doxygen shoul= d = +# invoke to filter for each input file. Doxygen will invoke the filter pro= gram = +# by executing (via popen()) the command , where = +# is the value of the INPUT_FILTER tag, and is the name of an = +# input file. Doxygen will then use the output that the filter program wri= tes = +# to standard output. If FILTER_PATTERNS is specified, this tag will be = # ignored. = -INPUT_FILTER =3D +INPUT_FILTER =3D = = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pat= tern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=3Dfilter (like *.cpp=3Dmy_cpp_filter). See INPUT_FILTER for furt= her -# info on how filters are used. If FILTER_PATTERNS is empty or if +# The FILTER_PATTERNS tag can be used to specify filters on a per file pat= tern = +# basis. Doxygen will compare the file name with each pattern and apply t= he = +# filter if there is a match. The filters are a list of the form: = +# pattern=3Dfilter (like *.cpp=3Dmy_cpp_filter). See INPUT_FILTER for furt= her = +# info on how filters are used. If FILTER_PATTERNS is empty or if = # non of the patterns match the file name, INPUT_FILTER is applied. = -FILTER_PATTERNS =3D +FILTER_PATTERNS =3D = = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set u= sing -# INPUT_FILTER) will be used to filter the input files when producing sour= ce +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set u= sing = +# INPUT_FILTER) will be used to filter the input files when producing sour= ce = # files to browse (i.e. when SOURCE_BROWSER is set to YES). = FILTER_SOURCE_FILES =3D NO = -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per= file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific patte= rn -# using *.ext=3D (so without naming a filter). This option only has effect= when +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per= file = +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) = +# and it is also possible to disable source filtering for a specific patte= rn = +# using *.ext=3D (so without naming a filter). This option only has effect= when = # FILTER_SOURCE_FILES is enabled. = -FILTER_SOURCE_PATTERNS =3D +FILTER_SOURCE_PATTERNS =3D = = #-------------------------------------------------------------------------= -- # configuration options related to source browsing #-------------------------------------------------------------------------= -- = -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these so= urces. -# Note: To get rid of all source code in the generated output, make sure a= lso +# If the SOURCE_BROWSER tag is set to YES then a list of source files will = +# be generated. Documented entities will be cross-referenced with these so= urces. = +# Note: To get rid of all source code in the generated output, make sure a= lso = # VERBATIM_HEADERS is set to NO. = SOURCE_BROWSER =3D NO = -# Setting the INLINE_SOURCES tag to YES will include the body +# Setting the INLINE_SOURCES tag to YES will include the body = # of functions and classes directly in the documentation. = INLINE_SOURCES =3D NO = -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct = +# doxygen to hide any special comment blocks from generated source code = # fragments. Normal C and C++ comments will always remain visible. = STRIP_CODE_COMMENTS =3D YES = -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented +# If the REFERENCED_BY_RELATION tag is set to YES = +# then for each documented function all documented = # functions referencing it will be listed. = REFERENCED_BY_RELATION =3D NO = -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities +# If the REFERENCES_RELATION tag is set to YES = +# then for each documented function all documented entities = # called/used by that function will be listed. = REFERENCES_RELATION =3D NO = -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) = +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from = +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will = +# link to the source code. Otherwise they will link to the documentation. = REFERENCES_LINK_SOURCE =3D YES = -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You +# If the USE_HTAGS tag is set to YES then the references to source code = +# will point to the HTML generated by the htags(1) tool instead of doxygen = +# built-in source browser. The htags tool is part of GNU's global source = +# tagging system (see http://www.gnu.org/software/global/global.html). You = # will need version 4.8.6 or higher. = USE_HTAGS =3D NO = -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen = +# will generate a verbatim copy of the header file for each class for = # which an include is specified. Set to NO to disable this. = VERBATIM_HEADERS =3D YES @@ -774,141 +816,141 @@ VERBATIM_HEADERS =3D YES # configuration options related to the alphabetical class index #-------------------------------------------------------------------------= -- = -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index = +# of all compounds will be generated. Enable this if the project = # contains a lot of classes, structs, unions or interfaces. = ALPHABETICAL_INDEX =3D YES = -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then = +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns = # in which this list will be split (can be a number in the range [1..20]) = COLS_IN_ALPHA_INDEX =3D 5 = -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# In case all classes in a project start with a common prefix, all = +# classes will be put under the same header in the alphabetical index. = +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that = # should be ignored while generating the index headers. = -IGNORE_PREFIX =3D +IGNORE_PREFIX =3D = = #-------------------------------------------------------------------------= -- # configuration options related to the HTML output #-------------------------------------------------------------------------= -- = -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will = # generate HTML output. = GENERATE_HTML =3D YES = -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. = +# If a relative path is entered the value of OUTPUT_DIRECTORY will be = # put in front of it. If left blank `html' will be used as the default pat= h. = HTML_OUTPUT =3D html = -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left bl= ank +# The HTML_FILE_EXTENSION tag can be used to specify the file extension fo= r = +# each generated HTML page (for example: .htm,.php,.asp). If it is left bl= ank = # doxygen will generate files with .html extension. = HTML_FILE_EXTENSION =3D .html = -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_HEADER tag can be used to specify a personal HTML header for = +# each generated HTML page. If it is left blank doxygen will generate a = # standard header. = -HTML_HEADER =3D +HTML_HEADER =3D = = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_FOOTER tag can be used to specify a personal HTML footer for = +# each generated HTML page. If it is left blank doxygen will generate a = # standard footer. = -HTML_FOOTER =3D +HTML_FOOTER =3D = = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading = +# style sheet that is used by each HTML page. It can be used to = +# fine-tune the look of the HTML output. If the tag is left blank doxygen = +# will generate a default style sheet. Note that doxygen will try to copy = +# the style sheet file to the HTML output directory, so don't put your own = # stylesheet in the HTML output directory as well, or it will be erased! = -HTML_STYLESHEET =3D +HTML_STYLESHEET =3D = = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the stylesheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. = +# Doxygen will adjust the colors in the stylesheet and background images = +# according to this color. Hue is specified as an angle on a colorwheel, = +# see http://en.wikipedia.org/wiki/Hue for more information. = +# For instance the value 0 represents red, 60 is yellow, 120 is green, = +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. = # The allowed range is 0 to 359. = HTML_COLORSTYLE_HUE =3D 220 = -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of = +# the colors in the HTML output. For a value of 0 the output will use = # grayscales only. A value of 255 will produce the most vivid colors. = HTML_COLORSTYLE_SAT =3D 100 = -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to = +# the luminance component of the colors in the HTML output. Values below = +# 100 gradually make the output lighter, whereas values above 100 make = +# the output darker. The value divided by 100 is the actual gamma applied, = +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2= , = # and 100 does not change the gamma. = HTML_COLORSTYLE_GAMMA =3D 80 = -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generate= d HTML -# page will contain the date and time when the page was generated. Setting +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generate= d HTML = +# page will contain the date and time when the page was generated. Setting = # this to NO can help when comparing the output of multiple runs. = HTML_TIMESTAMP =3D YES = -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, = +# files or namespaces will be aligned in HTML using tables. If set to = # NO a bullet list will be used. = HTML_ALIGN_MEMBERS =3D YES = -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after t= he -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML = +# documentation will contain sections that can be hidden and shown after t= he = +# page has loaded. For this to work a browser that supports = +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox = # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). = HTML_DYNAMIC_SECTIONS =3D NO = -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# If the GENERATE_DOCSET tag is set to YES, additional index files = +# will be generated that can be used as input for Apple's Xcode 3 = +# integrated development environment, introduced with OSX 10.5 (Leopard). = +# To create a documentation set, doxygen will generate a Makefile in the = +# HTML output directory. Running make will produce the docset in that = +# directory and running "make install" will install the docset in = +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find = +# it at startup. = +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html = # for more information. = GENERATE_DOCSET =3D NO = -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of = the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product = suite) +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of = the = +# feed. A documentation feed provides an umbrella under which multiple = +# documentation sets from a single provider (such as a company or product = suite) = # can be grouped. = DOCSET_FEEDNAME =3D "Doxygen generated docs" = -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that = +# should uniquely identify the documentation set bundle. This should be a = +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen = # will append .docset to the name. = DOCSET_BUNDLE_ID =3D org.doxygen.Project = -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely i= dentify -# the documentation publisher. This should be a reverse domain-name style +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely i= dentify = +# the documentation publisher. This should be a reverse domain-name style = # string, e.g. com.mycompany.MyDocSet.documentation. = DOCSET_PUBLISHER_ID =3D org.doxygen.Publisher @@ -917,209 +959,211 @@ DOCSET_PUBLISHER_ID =3D org.doxygen.Publisher = DOCSET_PUBLISHER_NAME =3D Publisher = -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# If the GENERATE_HTMLHELP tag is set to YES, additional index files = +# will be generated that can be used as input for tools like the = +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm= ) = # of the generated HTML documentation. = GENERATE_HTMLHELP =3D NO = -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can = +# be used to specify the file name of the resulting .chm file. You = +# can add a path in front of the file if the result should not be = # written to the html output directory. = -CHM_FILE =3D +CHM_FILE =3D = = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can = +# be used to specify the location (absolute path including file name) of = +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run = # the HTML help compiler on the generated index.hhp. = -HHC_LOCATION =3D +HHC_LOCATION =3D = = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag = +# controls if a separate .chi index file is generated (YES) or that = # it should be included in the master .chm file (NO). = GENERATE_CHI =3D NO = -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING = +# is used to encode HtmlHelp index (hhk), content (hhc) and project file = # content. = -CHM_INDEX_ENCODING =3D +CHM_INDEX_ENCODING =3D = = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag = +# controls whether a binary table of contents is generated (YES) or a = # normal table of contents (NO) in the .chm file. = BINARY_TOC =3D NO = -# The TOC_EXPAND flag can be set to YES to add extra items for group membe= rs +# The TOC_EXPAND flag can be set to YES to add extra items for group membe= rs = # to the contents of the HTML help documentation and to the tree view. = TOC_EXPAND =3D NO = -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and = +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated = +# that can be used as input for Qt's qhelpgenerator to generate a = # Qt Compressed Help (.qch) of the generated HTML documentation. = GENERATE_QHP =3D NO = -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can = +# be used to specify the file name of the resulting .qch file. = # The path specified is relative to the HTML output folder. = -QCH_FILE =3D +QCH_FILE =3D = = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see +# The QHP_NAMESPACE tag specifies the namespace to use when generating = +# Qt Help Project output. For more information please see = # http://doc.trolltech.com/qthelpproject.html#namespace = QHP_NAMESPACE =3D org.doxygen.Project = -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generatin= g = +# Qt Help Project output. For more information please see = # http://doc.trolltech.com/qthelpproject.html#virtual-folders = QHP_VIRTUAL_FOLDER =3D doc = -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter= to -# add. For more information please see +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter= to = +# add. For more information please see = # http://doc.trolltech.com/qthelpproject.html#custom-filters = -QHP_CUST_FILTER_NAME =3D +QHP_CUST_FILTER_NAME =3D = = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the = +# custom filter to add. For more information please see = +# = # Qt Help Project / Custom Filters. = -QHP_CUST_FILTER_ATTRS =3D +QHP_CUST_FILTER_ATTRS =3D = = -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this = +# project's = +# filter section matches. = +# = # Qt Help Project / Filter Attributes. = -QHP_SECT_FILTER_ATTRS =3D +QHP_SECT_FILTER_ATTRS =3D = = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can = +# be used to specify the location of Qt's qhelpgenerator. = +# If non-empty doxygen will try to run qhelpgenerator on the generated = # .qhp file. = -QHG_LOCATION =3D +QHG_LOCATION =3D = = -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse = help -# plugin. To install this plugin and make it available under the help cont= ents -# menu in Eclipse, the contents of the directory containing the HTML and X= ML -# files needs to be copied into the plugins directory of eclipse. The name= of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted be= fore +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files = +# will be generated, which together with the HTML files, form an Eclipse h= elp = +# plugin. To install this plugin and make it available under the help cont= ents = +# menu in Eclipse, the contents of the directory containing the HTML and X= ML = +# files needs to be copied into the plugins directory of eclipse. The name= of = +# the directory within the plugins directory should be the same as = +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted be= fore = # the help appears. = GENERATE_ECLIPSEHELP =3D NO = -# A unique identifier for the eclipse help plugin. When installing the plu= gin -# the directory name containing the HTML and XML files should also have +# A unique identifier for the eclipse help plugin. When installing the plu= gin = +# the directory name containing the HTML and XML files should also have = # this name. = ECLIPSE_DOC_ID =3D org.doxygen.Project = -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at = +# top of each HTML page. The value NO (the default) enables the index and = # the value YES disables it. = DISABLE_INDEX =3D NO = -# This tag can be used to set the number of enum values (range [0,1..20]) -# that doxygen will group on one line in the generated HTML documentation. -# Note that a value of 0 will completely suppress the enum values from app= earing in the overview section. +# This tag can be used to set the number of enum values (range [0,1..20]) = +# that doxygen will group on one line in the generated HTML documentation. = +# Note that a value of 0 will completely suppress the enum values from +# appearing in the overview section. = ENUM_VALUES_PER_LINE =3D 4 = -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index = +# structure should be generated to display hierarchical information. = +# If the tag value is set to YES, a side panel will be generated = +# containing a tree-like index structure (just like the one that = +# is generated for HTML Help). For this to work a browser that supports = +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). = # Windows users are probably better off using the HTML help feature. = GENERATE_TREEVIEW =3D NO = -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Director= ies, +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Director= ies, = # and Class Hierarchy pages using a tree view instead of an ordered list. = USE_INLINE_TREES =3D NO = -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be = +# used to set the initial width (in pixels) of the frame in which the tree = # is shown. = TREEVIEW_WIDTH =3D 250 = -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open = # links to external symbols imported via tag files in a separate window. = EXT_LINKS_IN_WINDOW =3D NO = -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory +# Use this tag to change the font size of Latex formulas included = +# as images in the HTML documentation. The default is 10. Note that = +# when you change the font size after a successful doxygen run you need = +# to manually remove any form_*.png images from the HTML output directory = # to force them to be regenerated. = FORMULA_FONTSIZE =3D 10 = -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern brows= ers. -# Note that when changing this option you need to delete any form_*.png fi= les +# Use the FORMULA_TRANPARENT tag to determine whether or not the images = +# generated for formulas are transparent PNGs. Transparent PNGs are = +# not supported properly for IE 6.0, but are supported on all modern brows= ers. = +# Note that when changing this option you need to delete any form_*.png fi= les = # in the HTML output before the changes have effect. = FORMULA_TRANSPARENT =3D YES = -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you also need to install MathJax separately and +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax = +# (see http://www.mathjax.org) which uses client side Javascript for the = +# rendering instead of using prerendered bitmaps. Use this if you do not = +# have LaTeX installed or if you want to formulas look prettier in the HTM= L = +# output. When enabled you also need to install MathJax separately and = # configure the path to it using the MATHJAX_RELPATH option. = USE_MATHJAX =3D NO = -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mat= hjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the ma= thjax.org site, so you can quickly see the result without installing -# MathJax, but it is strongly recommended to install a local copy of MathJ= ax +# When MathJax is enabled you need to specify the location relative to the = +# HTML output directory using the MATHJAX_RELPATH option. The destination = +# directory should contain the MathJax.js script. For instance, if the mat= hjax = +# directory is located at the same level as the HTML output directory, the= n = +# MATHJAX_RELPATH should be ../mathjax. The default value points to the +# mathjax.org site, so you can quickly see the result without installing = +# MathJax, but it is strongly recommended to install a local copy of MathJ= ax = # before deployment. = MATHJAX_RELPATH =3D http://www.mathjax.org/mathjax = -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search en= gine +# When the SEARCHENGINE tag is enabled doxygen will generate a search box = +# for the HTML output. The underlying search engine uses javascript = +# and DHTML and should work on any modern browser. Note that when using = +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets = +# (GENERATE_DOCSET) there is already a search function so this one should = +# typically be disabled. For large projects the javascript based search en= gine = # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solu= tion. = SEARCHENGINE =3D YES = -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a PHP enabled web server instead of at the web client -# using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server -# based approach is that it scales better to large projects and allows -# full text search. The disadvantages are that it is more difficult to set= up +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be = +# implemented using a PHP enabled web server instead of at the web client = +# using Javascript. Doxygen will generate the search PHP script and index = +# file to put on the web server. The advantage of the server = +# based approach is that it scales better to large projects and allows = +# full text search. The disadvantages are that it is more difficult to set= up = # and does not have live searching capabilities. = SERVER_BASED_SEARCH =3D NO @@ -1128,84 +1172,84 @@ SERVER_BASED_SEARCH =3D NO # configuration options related to the LaTeX output #-------------------------------------------------------------------------= -- = -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will = # generate Latex output. = -GENERATE_LATEX =3D YES +GENERATE_LATEX =3D NO = -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put= . = +# If a relative path is entered the value of OUTPUT_DIRECTORY will be = # put in front of it. If left blank `latex' will be used as the default pa= th. = LATEX_OUTPUT =3D latex = -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to = be -# invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to = be = +# invoked. If left blank `latex' will be used as the default command name. = +# Note that when enabling USE_PDFLATEX this option is only used for = +# generating bitmaps for formulas in the HTML output, but not in the = # Makefile that is written to the output directory. = LATEX_CMD_NAME =3D latex = -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to = +# generate index for LaTeX. If left blank `makeindex' will be used as the = # default command name. = MAKEINDEX_CMD_NAME =3D makeindex = -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact = +# LaTeX documents. This may be useful for small projects and may help to = # save some trees in general. = COMPACT_LATEX =3D NO = -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, letter, legal and +# The PAPER_TYPE tag can be used to set the paper type that is used = +# by the printer. Possible values are: a4, letter, legal and = # executive. If left blank a4wide will be used. = PAPER_TYPE =3D a4 = -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX = # packages that should be included in the LaTeX output. = -EXTRA_PACKAGES =3D +EXTRA_PACKAGES =3D = = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for = +# the generated latex document. The header should contain everything until = +# the first chapter. If it is left blank doxygen will generate a = # standard header. Notice: only use this tag if you know what you are doin= g! = -LATEX_HEADER =3D +LATEX_HEADER =3D = = -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated = +# is prepared for conversion to pdf (using ps2pdf). The pdf file will = +# contain links (just like the HTML output) instead of page references = # This makes the output suitable for online browsing using a pdf viewer. = PDF_HYPERLINKS =3D YES = -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of = +# plain latex in the generated Makefile. Set this option to YES to get a = # higher quality PDF documentation. = USE_PDFLATEX =3D YES = -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmo= de. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmo= de. = +# command to the generated LaTeX files. This will instruct LaTeX to keep = +# running if errors occur, instead of asking the user for help. = # This option is also used when generating formulas in HTML. = LATEX_BATCHMODE =3D NO = -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) +# If LATEX_HIDE_INDICES is set to YES then doxygen will not = +# include the index chapters (such as File Index, Compound Index, etc.) = # in the output. = LATEX_HIDE_INDICES =3D NO = -# If LATEX_SOURCE_CODE is set to YES then doxygen will include -# source code with syntax highlighting in the LaTeX output. -# Note that which sources are shown also depends on other settings +# If LATEX_SOURCE_CODE is set to YES then doxygen will include = +# source code with syntax highlighting in the LaTeX output. = +# Note that which sources are shown also depends on other settings = # such as SOURCE_BROWSER. = LATEX_SOURCE_CODE =3D NO @@ -1214,68 +1258,68 @@ LATEX_SOURCE_CODE =3D NO # configuration options related to the RTF output #-------------------------------------------------------------------------= -- = -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output = +# The RTF output is optimized for Word 97 and may not look very pretty wit= h = # other RTF readers or editors. = GENERATE_RTF =3D NO = -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. = +# If a relative path is entered the value of OUTPUT_DIRECTORY will be = # put in front of it. If left blank `rtf' will be used as the default path. = RTF_OUTPUT =3D rtf = -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact = +# RTF documents. This may be useful for small projects and may help to = # save some trees in general. = COMPACT_RTF =3D NO = -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated = +# will contain hyperlink fields. The RTF file will = +# contain links (just like the HTML output) instead of page references. = +# This makes the output suitable for online browsing using WORD or other = +# programs which support those fields. = # Note: wordpad (write) and others do not support links. = RTF_HYPERLINKS =3D NO = -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide +# Load stylesheet definitions from file. Syntax is similar to doxygen's = +# config file, i.e. a series of assignments. You only have to provide = # replacements, missing definitions are set to their default value. = -RTF_STYLESHEET_FILE =3D +RTF_STYLESHEET_FILE =3D = = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. = # Syntax is similar to doxygen's config file. = -RTF_EXTENSIONS_FILE =3D +RTF_EXTENSIONS_FILE =3D = = #-------------------------------------------------------------------------= -- # configuration options related to the man page output #-------------------------------------------------------------------------= -- = -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will = # generate man pages = GENERATE_MAN =3D NO = -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The MAN_OUTPUT tag is used to specify where the man pages will be put. = +# If a relative path is entered the value of OUTPUT_DIRECTORY will be = # put in front of it. If left blank `man' will be used as the default path. = MAN_OUTPUT =3D man = -# The MAN_EXTENSION tag determines the extension that is added to +# The MAN_EXTENSION tag determines the extension that is added to = # the generated man pages (default is the subroutine's section .3) = MAN_EXTENSION =3D .3 = -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, = +# then it will generate one additional man file for each entity = +# documented in the real man page(s). These additional files = +# only source the real man page, but without them the man command = # would be unable to find the correct page. The default is NO. = MAN_LINKS =3D NO @@ -1284,33 +1328,33 @@ MAN_LINKS =3D NO # configuration options related to the XML output #-------------------------------------------------------------------------= -- = -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of +# If the GENERATE_XML tag is set to YES Doxygen will = +# generate an XML file that captures the structure of = # the code including all documentation. = GENERATE_XML =3D NO = -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The XML_OUTPUT tag is used to specify where the XML pages will be put. = +# If a relative path is entered the value of OUTPUT_DIRECTORY will be = # put in front of it. If left blank `xml' will be used as the default path. = XML_OUTPUT =3D xml = -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the +# The XML_SCHEMA tag can be used to specify an XML schema, = +# which can be used by a validating XML parser to check the = # syntax of the XML files. = -XML_SCHEMA =3D +XML_SCHEMA =3D = = -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the +# The XML_DTD tag can be used to specify an XML DTD, = +# which can be used by a validating XML parser to check the = # syntax of the XML files. = -XML_DTD =3D +XML_DTD =3D = = -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will = +# dump the program listings (including syntax highlighting = +# and cross-referencing information) to the XML output. Note that = # enabling this will significantly increase the size of the XML output. = XML_PROGRAMLISTING =3D YES @@ -1319,10 +1363,10 @@ XML_PROGRAMLISTING =3D YES # configuration options for the AutoGen Definitions output #-------------------------------------------------------------------------= -- = -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will = +# generate an AutoGen Definitions (see autogen.sf.net) file = +# that captures the structure of the code including all = +# documentation. Note that this feature is still experimental = # and incomplete at the moment. = GENERATE_AUTOGEN_DEF =3D NO @@ -1331,98 +1375,97 @@ GENERATE_AUTOGEN_DEF =3D NO # configuration options related to the Perl module output #-------------------------------------------------------------------------= -- = -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the +# If the GENERATE_PERLMOD tag is set to YES Doxygen will = +# generate a Perl module file that captures the structure of = +# the code including all documentation. Note that this = +# feature is still experimental and incomplete at the = # moment. = GENERATE_PERLMOD =3D NO = -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate = +# the necessary Makefile rules, Perl scripts and LaTeX code to be able = # to generate PDF and DVI output from the Perl module output. = PERLMOD_LATEX =3D NO = -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. -# This is useful -# if you want to understand what is going on. -# On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be = +# nicely formatted so it can be parsed by a human reader. This is useful = +# if you want to understand what is going on. On the other hand, if this = +# tag is set to NO the size of the Perl module output will be much smaller = # and Perl will parse it just the same. = PERLMOD_PRETTY =3D YES = -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same +# The names of the make variables in the generated doxyrules.make file = +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. = +# This is useful so different doxyrules.make files included by the same = # Makefile don't overwrite each other's variables. = -PERLMOD_MAKEVAR_PREFIX =3D +PERLMOD_MAKEVAR_PREFIX =3D = = #-------------------------------------------------------------------------= -- # Configuration options related to the preprocessor #-------------------------------------------------------------------------= -- = -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will = +# evaluate all C-preprocessor directives found in the sources and include = # files. = ENABLE_PREPROCESSING =3D YES = -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controll= ed +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro = +# names in the source code. If set to NO (the default) only conditional = +# compilation will be performed. Macro expansion can be done in a controll= ed = # way by setting EXPAND_ONLY_PREDEF to YES. = MACRO_EXPANSION =3D NO = -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES = +# then the macro expansion is limited to the macros specified with the = # PREDEFINED and EXPAND_AS_DEFINED tags. = EXPAND_ONLY_PREDEF =3D NO = -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes file= s = # in the INCLUDE_PATH (see below) will be search if a #include is found. = SEARCH_INCLUDES =3D YES = -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by +# The INCLUDE_PATH tag can be used to specify one or more directories that = +# contain include files that are not input files but should be processed b= y = # the preprocessor. = -INCLUDE_PATH =3D +INCLUDE_PATH =3D = = -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS wi= ll +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcar= d = +# patterns (like *.h and *.hpp) to filter out the header-files in the = +# directories. If left blank, the patterns specified with FILE_PATTERNS wi= ll = # be used. = -INCLUDE_FILE_PATTERNS =3D +INCLUDE_FILE_PATTERNS =3D = = -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option= of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=3Ddefinition (no spaces). If the definition and the =3D are -# omitted =3D1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the :=3D operator +# The PREDEFINED tag can be used to specify one or more macro names that = +# are defined before the preprocessor is started (similar to the -D option= of = +# gcc). The argument of the tag is a list of macros of the form: name = +# or name=3Ddefinition (no spaces). If the definition and the =3D are = +# omitted =3D1 is assumed. To prevent a macro definition from being = +# undefined via #undef or recursively expanded use the :=3D operator = # instead of the =3D operator. = -PREDEFINED =3D +PREDEFINED =3D = = -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be exp= anded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition t= hat overrules the definition found in the source code. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then = +# this tag can be used to specify a list of macro names that should be exp= anded. = +# The macro definition that is found in the sources will be used. = +# Use the PREDEFINED tag if you want to use a different macro definition t= hat +# overrules the definition found in the source code. = -EXPAND_AS_DEFINED =3D +EXPAND_AS_DEFINED =3D = = -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all references to function-like macros -# that are alone on a line, have an all uppercase name, and do not end wit= h a +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then = +# doxygen's preprocessor will remove all references to function-like macro= s = +# that are alone on a line, have an all uppercase name, and do not end wit= h a = # semicolon, because these will confuse the parser if not removed. = SKIP_FUNCTION_MACROS =3D YES @@ -1431,43 +1474,41 @@ SKIP_FUNCTION_MACROS =3D YES # Configuration::additions related to external references #-------------------------------------------------------------------------= -- = -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# -# TAGFILES =3D file1 file2 ... -# Adding location for the tag files is done as follows: -# -# TAGFILES =3D file1=3Dloc1 "file2 =3D loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen +# The TAGFILES option can be used to specify one or more tagfiles. = +# Optionally an initial location of the external documentation = +# can be added for each tagfile. The format of a tag file without = +# this location is as follows: = +# TAGFILES =3D file1 file2 ... = +# Adding location for the tag files is done as follows: = +# TAGFILES =3D file1=3Dloc1 "file2 =3D loc2" ... = +# where "loc1" and "loc2" can be relative or absolute paths or = +# URLs. If a location is present for each tag, the installdox tool = +# does not have to be run to correct the links. = +# Note that each tag file must have a unique name = +# (where the name does NOT include the path) = +# If a tag file is not located in the directory in which doxygen = # is run, you must also specify the path to the tagfile here. = -TAGFILES =3D +TAGFILES =3D = = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# When a file name is specified after GENERATE_TAGFILE, doxygen will creat= e = # a tag file that is based on the input files it reads. = -GENERATE_TAGFILE =3D +GENERATE_TAGFILE =3D = = -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes +# If the ALLEXTERNALS tag is set to YES all external classes will be liste= d = +# in the class index. If set to NO only the inherited external classes = # will be listed. = ALLEXTERNALS =3D NO = -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be lis= ted -# in the modules index. If set to NO, only the current project's groups wi= ll +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be lis= ted = +# in the modules index. If set to NO, only the current project's groups wi= ll = # be listed. = EXTERNAL_GROUPS =3D YES = -# The PERL_PATH should be the absolute path and name of the perl script +# The PERL_PATH should be the absolute path and name of the perl script = # interpreter (i.e. the result of `which perl'). = PERL_PATH =3D /usr/bin/perl @@ -1476,204 +1517,204 @@ PERL_PATH =3D /usr/bin/perl # Configuration options related to the dot tool #-------------------------------------------------------------------------= -- = -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with= base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option also works with HAVE_DOT disabled, but it is recommended to +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will = +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with= base = +# or super classes. Setting the tag to NO turns the diagrams off. Note tha= t = +# this option also works with HAVE_DOT disabled, but it is recommended to = # install and use dot, since it yields more powerful graphs. = -CLASS_DIAGRAMS =3D YES +CLASS_DIAGRAMS =3D NO = -# You can define message sequence charts within doxygen comments using the= \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in= the -# documentation. The MSCGEN_PATH tag allows you to specify the directory w= here -# the mscgen tool resides. If left empty the tool is assumed to be found i= n the +# You can define message sequence charts within doxygen comments using the= \msc = +# command. Doxygen will then run the mscgen tool (see = +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in= the = +# documentation. The MSCGEN_PATH tag allows you to specify the directory w= here = +# the mscgen tool resides. If left empty the tool is assumed to be found i= n the = # default search path. = -MSCGEN_PATH =3D +MSCGEN_PATH =3D = = -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# If set to YES, the inheritance and collaboration graphs will hide = +# inheritance and usage relations if the target is undocumented = # or is not a class. = HIDE_UNDOC_RELATIONS =3D YES = -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool= is -# available from the path. This tool is part of Graphviz, a graph visualiz= ation -# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool= is = +# available from the path. This tool is part of Graphviz, a graph visualiz= ation = +# toolkit from AT&T and Lucent Bell Labs. The other options in this sectio= n = # have no effect if this option is set to NO (the default) = -HAVE_DOT =3D NO +HAVE_DOT =3D YES = -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is -# allowed to run in parallel. When set to 0 (the default) doxygen will -# base this on the number of processors available in the system. You can s= et it -# explicitly to a value larger than 0 to get control over the balance +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is = +# allowed to run in parallel. When set to 0 (the default) doxygen will = +# base this on the number of processors available in the system. You can s= et it = +# explicitly to a value larger than 0 to get control over the balance = # between CPU load and processing speed. = DOT_NUM_THREADS =3D 0 = -# By default doxygen will write a font called Helvetica to the output -# directory and reference it in all dot files that doxygen generates. -# When you want a differently looking font you can specify the font name -# using DOT_FONTNAME. You need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the direc= tory +# By default doxygen will write a font called Helvetica to the output = +# directory and reference it in all dot files that doxygen generates. = +# When you want a differently looking font you can specify the font name = +# using DOT_FONTNAME. You need to make sure dot is able to find the font, = +# which can be done by putting it in a standard location or by setting the = +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the direc= tory = # containing the font. = DOT_FONTNAME =3D Helvetica = -# The DOT_FONTSIZE tag can be used to set the size of the font of dot grap= hs. +# The DOT_FONTSIZE tag can be used to set the size of the font of dot grap= hs. = # The default size is 10pt. = DOT_FONTSIZE =3D 10 = -# By default doxygen will tell dot to use the output directory to look for= the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot +# By default doxygen will tell dot to use the output directory to look for= the = +# FreeSans.ttf font (which doxygen will put there itself). If you specify = a = +# different font using DOT_FONTNAME you can set the path where dot = # can find it using this tag. = -DOT_FONTPATH =3D +DOT_FONTPATH =3D = = -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen = +# will generate a graph for each documented class showing the direct and = +# indirect inheritance relations. Setting this tag to YES will force the = # the CLASS_DIAGRAMS tag to NO. = CLASS_GRAPH =3D YES = -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen = +# will generate a graph for each documented class showing the direct and = +# indirect implementation dependencies (inheritance, containment, and = # class references variables) of the class with other documented classes. = COLLABORATION_GRAPH =3D YES = -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen = # will generate a graph for groups, showing the direct groups dependencies = GROUP_GRAPHS =3D YES = -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and = +# collaboration diagrams in a style similar to the OMG's Unified Modeling = # Language. = UML_LOOK =3D NO = -# If set to YES, the inheritance and collaboration graphs will show the +# If set to YES, the inheritance and collaboration graphs will show the = # relations between templates and their instances. = TEMPLATE_RELATIONS =3D NO = -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each document= ed -# file showing the direct and indirect include dependencies of the file wi= th +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DO= T = +# tags are set to YES then doxygen will generate a graph for each document= ed = +# file showing the direct and indirect include dependencies of the file wi= th = # other documented files. = INCLUDE_GRAPH =3D YES = -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and = +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each = +# documented header file showing the documented files that directly or = # indirectly include this file. = INCLUDED_BY_GRAPH =3D YES = -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly incre= ase -# the time of a run. So in most cases it will be better to enable call gra= phs +# If the CALL_GRAPH and HAVE_DOT options are set to YES then = +# doxygen will generate a call dependency graph for every global function = +# or class method. Note that enabling this option will significantly incre= ase = +# the time of a run. So in most cases it will be better to enable call gra= phs = # for selected functions only using the \callgraph command. = CALL_GRAPH =3D NO = -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly incre= ase -# the time of a run. So in most cases it will be better to enable caller +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then = +# doxygen will generate a caller dependency graph for every global functio= n = +# or class method. Note that enabling this option will significantly incre= ase = +# the time of a run. So in most cases it will be better to enable caller = # graphs for selected functions only using the \callergraph command. = CALLER_GRAPH =3D NO = -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen = # will generate a graphical hierarchy of all classes instead of a textual = one. = GRAPHICAL_HIERARCHY =3D YES = -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directo= ries -# in a graphical way. The dependency relations are determined by the #incl= ude +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YE= S = +# then doxygen will show the dependencies a directory has on other directo= ries = +# in a graphical way. The dependency relations are determined by the #incl= ude = # relations between the files in the directories. = DIRECTORY_GRAPH =3D YES = -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the imag= es -# generated by dot. Possible values are png, svg, gif or svg. +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the imag= es = +# generated by dot. Possible values are png, svg, gif or svg. = # If left blank png will be used. = DOT_IMAGE_FORMAT =3D png = -# The tag DOT_PATH can be used to specify the path where the dot tool can = be +# The tag DOT_PATH can be used to specify the path where the dot tool can = be = # found. If left blank, it is assumed the dot tool can be found in the pat= h. = -DOT_PATH =3D +DOT_PATH =3D = = -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the +# The DOTFILE_DIRS tag can be used to specify one or more directories that = +# contain dot files that are included in the documentation (see the = # \dotfile command). = -DOTFILE_DIRS =3D +DOTFILE_DIRS =3D = = -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the +# The MSCFILE_DIRS tag can be used to specify one or more directories that = +# contain msc files that are included in the documentation (see the = # \mscfile command). = -MSCFILE_DIRS =3D +MSCFILE_DIRS =3D = = -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger = than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of = +# nodes that will be shown in the graph. If the number of nodes in a graph = +# becomes larger than this value, doxygen will truncate the graph, which i= s = +# visualized by representing a node as a red box. Note that doxygen if the = +# number of direct children of the root node in a graph is already larger = than = +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note = # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPT= H. = DOT_GRAPH_MAX_NODES =3D 50 = -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reacha= ble -# from the root by following a path via at most 3 edges will be shown. Nod= es -# that lay further from the root node will be omitted. Note that setting t= his -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted= by +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the = +# graphs generated by dot. A depth value of 3 means that only nodes reacha= ble = +# from the root by following a path via at most 3 edges will be shown. Nod= es = +# that lay further from the root node will be omitted. Note that setting t= his = +# option to 1 or 2 may greatly reduce the computation time needed for larg= e = +# code bases. Also note that the size of a graph can be further restricted= by = # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. = MAX_DOT_GRAPH_DEPTH =3D 0 = -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform = used, -# enabling this option may lead to badly anti-aliased labels on the edges = of +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent = +# background. This is disabled by default, because dot on Windows does not = +# seem to support this out of the box. Warning: Depending on the platform = used, = +# enabling this option may lead to badly anti-aliased labels on the edges = of = # a graph (i.e. they become hard to read). = DOT_TRANSPARENT =3D NO = -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple outp= ut -# files in one run (i.e. multiple -o and -T options on the command line). = This -# makes dot run faster, but since only newer versions of dot (>1.8.10) +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple outp= ut = +# files in one run (i.e. multiple -o and -T options on the command line). = This = +# makes dot run faster, but since only newer versions of dot (>1.8.10) = # support this, this feature is disabled by default. = DOT_MULTI_TARGETS =3D NO = -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will = +# generate a legend page explaining the meaning of the various boxes and = # arrows in the dot generated graphs. = GENERATE_LEGEND =3D YES = -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will = +# remove the intermediate dot files that are used to generate = # the various graphs. = DOT_CLEANUP =3D YES