improved doxygen

8 years ago · 40dbf10ae7
parent 1585767a62
commit 40dbf10ae7
5 changed files with 333 additions and 296 deletions
--- a/38
+++ b/38
@ -1,7 +1,35 @@
 C++ Matrix Template Library
-Library to provide mathematical matices as standard C++ types. Allows
+Library to provide mathematical matices as standard C++ types.
-any size of matrix containning any type of values. Supports matrix
+
-specific function, like trasnposition, determinant or inversion,
+Features:
-soupports mathematical operations like addition, subtraction,
+ * Allows any size of Matrix
-multiplication and division (using the inverse matrix).
+    * Either fixed size, size given as template parameter
    * Or variable size, size is given in constructor
 * Allows any of values, given as template üarameter
 * Supports matrix specific functions:
    * transposition
    * gaussian algorithm
    * determinant
    * inversion
 * Supports mathematical operations:
    * addition
    * subtraction,
    * multiplication
    * division (using the inverse matrix)
 * Higly stable and well tested
 Examples:
      const Matrix<T,2,4> m1(1, 2, 3, 4,
                             5, 6, 7, 8);
      const Matrix<T,2,4> m2(2, 4, 6, 8,
                             1, 3, 5, 7);
      const Matrix<T,2,4> m(m1+m2);
      const Matrix<T,2,4> res(3, 6, 9, 12,
                              6, 9, 12, 15);
      if (m==res) {
        std::cout<<"Yes, it is that easy!\n"<<m<<"\n";
      } else {
        std::cerr<<"Ooops!\n"
      }
--- a/ax_init_standard_project.m4
+++ b/ax_init_standard_project.m4
@ -170,15 +170,33 @@ AC_DEFUN([AX_INIT_STANDARD_PROJECT], [
  AM_CPPFLAGS+=" '-DMAKE_STRING(X)=\#X' '-DNAMESPACE=${PACKAGE_TARNAME//[^a-zA-Z0-9]/_}'"
  AX_SUBST(NUMBERS)
  AX_SUBST(HOME)
-  README=$(tail -n +3 README)
+  if test -f README.md; then
    README=$()
    DESCRIPTION=$(head -1 README.md)
  else
    README=$(tail -n +3 README)
    DESCRIPTION=$(head -1 README)
  fi
  if which pandoc 2>&1 > /dev/null; then   
    README_HTML=$(echo "$README" | pandoc -f markdown_github -t html | sed ':a;N;$!ba;s,\\n,\\\\n,g;s/\n/\\n/g;s,",\\",g')
  else
    README_HTML="${README}"
  fi
  AX_SUBST(README)
  _AM_SUBST_NOTMAKE([README])
-  DESCRIPTION=$(head -1 README)
+  AX_SUBST(README_HTML)
  _AM_SUBST_NOTMAKE([README_HTML])
  AX_SUBST(DESCRIPTION)
  _AM_SUBST_NOTMAKE([DESCRIPTION])
  AUTHOR=$(head -1 AUTHORS)
  AUTHOR_NAME=$(echo $AUTHOR | sed 's, *[[<(]].*$,,')
  AUTHOR_URL=$(echo $AUTHOR | sed 's,.*(\(http[[^)]]*\)).*,\1,')
  AUTHOR_MAIL=$(echo $AUTHOR | sed 's,.*<\(.*@.*\)>.*,\1,')
  AX_SUBST(AUTHOR)
  _AM_SUBST_NOTMAKE([AUTHOR])
  AX_SUBST(AUTHOR_NAME)
  AX_SUBST(AUTHOR_URL)
  AX_SUBST(AUTHOR_MAIL)
  DISTRO=$(lsb_release -sc 2>/dev/null || uname -s 2>/dev/null)
  AX_SUBST(DISTRO)
  ARCH=$((@<:@@<:@ $(uname -sm) =~ 64 @:>@@:>@ && echo amd64) || (@<:@@<:@ $(uname -sm) =~ 'i?86' @:>@@:>@ && echo i386 || uname -sm))
@ -444,7 +462,11 @@ EOF
 # use this in configure.ac to support debian packages
 AC_DEFUN([AX_USE_DEBIAN_PACKAGING], [
-  README_DEB=$(tail -n +3 README | sed -e 's/^ *$/./g' -e 's/^/ /g')
+  if test -f README.md; then
    README_DEB=$(tail -n +3 README.md | sed -e 's/^ *$/./g' -e 's/^/ /g')
  else
    README_DEB=$(tail -n +3 README | sed -e 's/^ *$/./g' -e 's/^/ /g')
  fi
  AC_SUBST(README_DEB)
  _AM_SUBST_NOTMAKE([README_DEB])
  AC_CONFIG_FILES([debian/changelog debian/control])
@ -506,7 +528,7 @@ AC_DEFUN([AX_USE_DOXYGEN], [
    AC_MSG_WARN([Missing program mscgen!
     - when you rebild documentation, there are no message state charts
     - there are precompiled derived files in the distribution]); fi
-  AC_CONFIG_FILES([doc/makefile doc/doxyfile])
+  AC_CONFIG_FILES([doc/makefile doc/doxyfile doc/header.html doc/footer.html])
  AX_ADD_MAKEFILE_TARGET_DEP([clean-am], [clean-documentation], [doc/makefile.in])
  AX_ADD_MAKEFILE_TARGET_DEP([distclean-am], [distclean-documentation], [doc/makefile.in])
  AX_ADD_MAKEFILE_TARGET_DEP([maintainer-clean-am], [maintainer-clean-documentation], [doc/makefile.in])
--- a/bootstrap.sh
+++ b/bootstrap.sh
@ -151,7 +151,11 @@ GENERATED FILES
    * scripts/makefile.am - if you enabled AX_USE_SCRIPTS
    * doc/makefile.am - if you enabled AX_USE_DOXYGEN
    * doc/doxyfile.in - if you enabled AX_USE_DOXYGEN
-    * test/makefile.am - if you enabled AX_BUILD_TEST or AX_USE_CPPUNIT
+    * doc/header.html.in - if you enabled AX_USE_DOXYGEN
    * doc/footer.html.in - if you enabled AX_USE_DOXYGEN
    * doc/style.css - if you enabled AX_USE_DOXYGEN
    * test/makefile.am - if you enabled AX_USE_CPPUNIT and AX_USE_CXX
    * test/${DEFAULT_PROJECT_NAME#lib}.cxx - if you enabled AX_BUILD_TEST or AX_USE_CPPUNIT
    * examples/makefile.am - if you enabled AX_BUILD_EXAMPLES
    * debian/changelog.in - if you enabled AX_USE_DEBIAN_PACKAGING
    * debian/control.in - if you enabled AX_USE_DEBIAN_PACKAGING
@ -192,6 +196,7 @@ FILES TO EDIT
    * src/makefile.am
    * html/makefile.am
    * test/makefile.am
    * test/${DEFAULT_PROJECT_NAME}.cxx
    * examples/makefile.am
 FILE DEPENDENCIES
@ -811,16 +816,51 @@ AM_CPPFLAGS = -I\${top_srcdir}/src -I\${top_builddir}/src
 AM_LDFLAGS = -L\${abs_top_builddir}/src/.libs
 $(if testtag AX_USE_LIBTOOL; then
 cat <<EOF3
-LDADD = -l${PACKAGE_NAME#lib}
+LDADD = -lcppunit -l${PACKAGE_NAME#lib}
 EOF3
 fi)
 EOF2
 fi)
-TESTS =
+check_PROGRAMS = ${PACKAGE_NAME#lib}
 TESTS = \${check_PROGRAMS}
 ${PACKAGE_NAME#lib}_SOURCES = ${PACKAGE_NAME#lib}.cxx
 MAINTAINERCLEANFILES = makefile.in
 EOF
 to --condition AX_USE_CPPUNIT --condition AX_USE_CXX test/${PACKAGE_NAME#lib}.cxx <<EOF
 ${CHEADER}
 #include <cppunit/TestFixture.h>
 #include <cppunit/ui/text/TestRunner.h>
 #include <cppunit/extensions/HelperMacros.h>
 #include <cppunit/extensions/TestFactoryRegistry.h>
 #include <cppunit/XmlOutputter.h>
 #include <fstream>
 /// @todo Rename DummyTest and DummyTest::dummy()
 /// @todo Write test cases
 class DummyTest: public CppUnit::TestFixture { 
  public:
    void dummy() {
    }
    CPPUNIT_TEST_SUITE(DummyTest);
    CPPUNIT_TEST(dummy);
    CPPUNIT_TEST_SUITE_END();
 };
 CPPUNIT_TEST_SUITE_REGISTRATION(DummyTest);
 int main(int argc, char** argv) try {
  std::ofstream ofs((*argv+std::string(".xml")).c_str());
  CppUnit::TextUi::TestRunner runner;
  runner.setOutputter(new CppUnit::XmlOutputter(&runner.result(), ofs));
  runner.addTest(CppUnit::TestFactoryRegistry::getRegistry().makeTest());
  return runner.run() ? 0 : 1;
 } catch (std::exception& e) {
  std::cerr<<"***Exception: "<<e.what()<<std::endl;
  return 1;
 }
 EOF
 to --condition AX_BUILD_EXAMPLES examples/makefile.am <<EOF
 ${HEADER}AM_CPPFLAGS = -I\${top_srcdir}/src -I\${top_builddir}/src
 AM_LDFLAGS = -L\${abs_top_builddir}/src/.libs
@ -836,6 +876,58 @@ www_DATA =
 MAINTAINERCLEANFILES = makefile.in
 EOF
 to --condition AX_USE_DOXYGEN doc/header.html.in <<EOF
 <!-- HTML header for doxygen 1.8.6-->
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen \$doxygenversion"/>
 <!--BEGIN PROJECT_NAME--><title>\$projectname: \$title</title><!--END PROJECT_NAME-->
 <!--BEGIN !PROJECT_NAME--><title>\$title</title><!--END !PROJECT_NAME-->
 <link href="\$relpath^tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="\$relpath^jquery.js"></script>
 <script type="text/javascript" src="\$relpath^dynsections.js"></script>
 \$treeview
 \$search
 \$mathjax
 <link href="\$relpath^\$stylesheet" rel="stylesheet" type="text/css" />
 \$extrastylesheet
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 <div id="titlearea">
  <div id="projecthead">
    <div id="projectlogo"><img alt="" src="\$relpath^\$projectlogo"/></div>
    <div id="projectname">\$projectname</span>&#160;<span id="projectnumber">\$projectnumber</div>
    <div id="projectbrief">\$projectbrief</div>
  </div>
  <nav>
    <a href="https://dev.marc.waeckerlin.org/projects/\$projectname" target="_blank">Project Management</a>
    <a href="https://dev.marc.waeckerlin.org/repository/sources/\$projectname/" target="_blank">Download</a>
    <div>\$searchbox</div>
  </nav>
 </div>
 EOF
 to --condition AX_USE_DOXYGEN doc/footer.html.in <<EOF
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    \$navpath
    <li class="footer"><a href="@AUTHOR_URL@" target="_blank">@AUTHOR_NAME@</a></li>
  </ul>
 </div>
 </body>
 </html>
 EOF
 to --condition AX_USE_DOXYGEN doc/style.css <<EOF
 #titlearea {
  display: flex;
  justify-content: space-between;
  align-items: flex-end;
 }
 EOF
 if testtag AX_USE_DOXYGEN; then
    if ! checkfile doc/doxyfile.in || \
        contains doc/doxyfile.in "${rebuildfiles[@]}"; then
@ -856,12 +948,15 @@ if testtag AX_USE_DOXYGEN; then
        doxyreplace MULTILINE_CPP_IS_BRIEF YES
        doxyreplace TAB_SIZE 2
        doxyreplace ALIASES '"id=\\par File-ID\\n"'
-        doxyadd ALIASES '"copy=\\par Copyright\\n"'
+        doxyadd ALIASES '"copy=\\par Copyright by <a href="@AUTHOR_URL@" target="_blank">@AUTHOR_NAME@</a>\\n"'
        doxyadd ALIASES '"license=\\par License\\n"'
        doxyadd ALIASES '"classmutex=\\par Reentrant:\\nAccess is locked with class static mutex @c "'
        doxyadd ALIASES '"instancemutex=\\par Reentrant:\\nAccess is locked with per instance mutex @c "'
        doxyadd ALIASES '"mutex=\\par Reentrant:\\nAccess is locked with mutex @c "'
        doxyadd ALIASES '"api=\\xrefitem api \\"API Call\\" \\"\\""'
        doxyadd ALIASES '"description=@DESCRIPTION@"'
        doxyadd ALIASES '"readme=@README_HTML@"'
        doxyadd ALIASES '"author=<a href="@AUTHOR_URL@" target="_blank">@AUTHOR_NAME@</a>"'
        doxyreplace ENABLE_PREPROCESSING YES
        doxyreplace MACRO_EXPANSION YES
        doxyadd PREDEFINED '"NAMESPACE=@PACKAGE_NAME@"'
@ -890,7 +985,13 @@ if testtag AX_USE_DOXYGEN; then
        fi
        doxyreplace FILE_PATTERNS '*.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt *.sql'
        doxyreplace RECURSIVE YES
-        doxyreplace EXCLUDE_PATTERNS "moc_* uic_* qrc_*"
+        doxyreplace EXCLUDE_PATTERNS "moc_* uic_* qrc_* version.[ch]xx"
        doxyreplace HTML_HEADER header.html
        doxyreplace HTML_FOOTER footer.html
        doxyreplace HTML_EXTRA_STYLESHEET style.css
        doxyreplace HTML_DYNAMIC_SECTIONS YES
        doxyreplace DISABLE_INDEX YES
        doxyreplace GENERATE_TREEVIEW YES 
        if testtag AX_BUILD_EXAMPLES; then
            doxyreplace EXAMPLE_PATH @top_srcdir@/examples
        fi
@ -899,7 +1000,6 @@ if testtag AX_USE_DOXYGEN; then
        doxyreplace SOURCE_BROWSER YES
        doxyreplace INLINE_SOURCES YES
        doxyreplace GENERATE_TESTLIST YES
        doxyreplace GENERATE_TREEVIEW NO
        doxyreplace SEARCHENGINE NO
        doxyreplace GENERATE_HTML YES
        doxyreplace GENERATE_LATEX NO
--- a/doc/doxyfile.in
+++ b/doc/doxyfile.in
@ -1,4 +1,4 @@
-# Doxyfile 1.8.11
+# Doxyfile 1.8.6
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
@ -46,10 +46,10 @@ PROJECT_NUMBER         = @PACKAGE_VERSION@
 PROJECT_BRIEF          = @DESCRIPTION@
-# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
-# in the documentation. The maximum height of the logo should not exceed 55
+# the documentation. The maximum height of the logo should not exceed 55 pixels
-# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
-# the logo to the output directory.
+# to the output directory.
 PROJECT_LOGO           = @top_srcdir@/@PACKAGE_LOGO@
@ -60,7 +60,7 @@ PROJECT_LOGO           = @top_srcdir@/@PACKAGE_LOGO@
 OUTPUT_DIRECTORY       =
-# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# 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 output 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
@ -70,14 +70,6 @@ OUTPUT_DIRECTORY       =
 CREATE_SUBDIRS         = NO
 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
 # characters to appear in the names of generated files. If set to NO, non-ASCII
 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
 # U+3044.
 # The default value is: NO.
 ALLOW_UNICODE_NAMES    = 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.
@ -93,14 +85,14 @@ ALLOW_UNICODE_NAMES    = NO
 OUTPUT_LANGUAGE        = English
-# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
+# If the BRIEF_MEMBER_DESC tag is set to YES 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.
 # The default value is: YES.
 BRIEF_MEMBER_DESC      = YES
-# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
+# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
 # description of a member or function before the detailed description
 #
 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
@ -135,7 +127,7 @@ ALWAYS_DETAILED_SEC    = NO
 INLINE_INHERITED_MEMB  = YES
-# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
+# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full 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
 # The default value is: YES.
@ -205,9 +197,9 @@ MULTILINE_CPP_IS_BRIEF = YES
 INHERIT_DOCS           = YES
-# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
-# page for each member. If set to NO, the documentation of a member will be part
+# new page for each member. If set to NO, the documentation of a member will be
-# of the file/class/namespace that contains it.
+# part of the file/class/namespace that contains it.
 # The default value is: NO.
 SEPARATE_MEMBER_PAGES  = NO
@ -229,12 +221,15 @@ TAB_SIZE               = 2
 # newlines.
 ALIASES                = "id=\par File-ID\n"
 ALIASES += "author=<a href="@AUTHOR_URL@" target="_blank">@AUTHOR_NAME@</a>"
 ALIASES += "readme=@README_HTML@"
 ALIASES += "description=@DESCRIPTION@"
 ALIASES += "api=\xrefitem api \"API Call\" \"\""
 ALIASES += "mutex=\par Reentrant:\nAccess is locked with mutex @c "
 ALIASES += "instancemutex=\par Reentrant:\nAccess is locked with per instance mutex @c "
 ALIASES += "classmutex=\par Reentrant:\nAccess is locked with class static mutex @c "
 ALIASES += "license=\par License\n"
-ALIASES += "copy=\par Copyright\n"
+ALIASES += "copy=\par Copyright by <a href="@AUTHOR_URL@" target="_blank">@AUTHOR_NAME@</a>\n"
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding "class=itcl::class"
@ -275,14 +270,11 @@ OPTIMIZE_OUTPUT_VHDL   = NO
 # extension. Doxygen has a built-in mapping, but you can override or extend it
 # using this tag. The format is ext=language, where ext is a file extension, and
 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
-# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
-# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
-# Fortran. In the later case the parser tries to guess whether the code is fixed
+# (default is Fortran), use: inc=Fortran f=C.
 # or free formatted code, this is the default for Fortran type files), VHDL. For
 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
 #
-# Note: For files without extension you can use no_extension as a placeholder.
+# Note For files without extension you can use no_extension as a placeholder.
 #
 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
 # the files are not read by doxygen.
@ -301,8 +293,8 @@ MARKDOWN_SUPPORT       = YES
 # When enabled doxygen tries to link words that correspond to documented
 # classes, or namespaces to their corresponding documentation. Such a link can
-# be prevented in individual cases by putting a % sign in front of the word or
+# be prevented in individual cases by by putting a % sign in front of the word
-# globally by setting AUTOLINK_SUPPORT to NO.
+# or globally by setting AUTOLINK_SUPPORT to NO.
 # The default value is: YES.
 AUTOLINK_SUPPORT       = YES
@ -342,20 +334,13 @@ SIP_SUPPORT            = NO
 IDL_PROPERTY_SUPPORT   = 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
+# 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 default
 # all members of a group must be documented explicitly.
 # The default value is: NO.
 DISTRIBUTE_GROUP_DOC   = YES
 # If one adds a struct or class to a group and this option is enabled, then also
 # any nested class or struct is added to the same group. By default this option
 # is disabled and one has to add nested compounds explicitly via \ingroup.
 # The default value is: NO.
 GROUP_NESTED_COMPOUNDS = NO
 # Set the SUBGROUPING tag to YES to allow class member groups 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
@ -414,7 +399,7 @@ LOOKUP_CACHE_SIZE      = 0
 # Build related configuration options
 #---------------------------------------------------------------------------
-# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
+# 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 respectively EXTRACT_STATIC tags are set to YES.
@ -424,35 +409,35 @@ LOOKUP_CACHE_SIZE      = 0
 EXTRACT_ALL            = YES
-# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
 # be included in the documentation.
 # The default value is: NO.
 EXTRACT_PRIVATE        = YES
-# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
 # scope will be included in the documentation.
 # The default value is: NO.
 EXTRACT_PACKAGE        = YES
-# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
 # included in the documentation.
 # The default value is: NO.
 EXTRACT_STATIC         = YES
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# 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,
+# locally in source files will be included in the documentation. If set to NO
 # only classes defined in header files are included. Does not have any effect
 # for Java sources.
 # The default value is: YES.
 EXTRACT_LOCAL_CLASSES  = YES
-# This flag is only useful for Objective-C code. If set to YES, local methods,
+# 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, only methods in the interface are
+# included in the documentation. If set to NO only methods in the interface are
 # included.
 # The default value is: NO.
@ -477,21 +462,21 @@ HIDE_UNDOC_MEMBERS     = 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, these classes will be included in the various overviews. This option
+# to NO these classes will be included in the various overviews. This option has
-# has no effect if EXTRACT_ALL is enabled.
+# no effect if EXTRACT_ALL is enabled.
 # The default value is: NO.
 HIDE_UNDOC_CLASSES     = NO
 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
-# (class|struct|union) declarations. If set to NO, these declarations will be
+# (class|struct|union) declarations. If set to NO these declarations will be
 # included in the documentation.
 # The default value is: NO.
 HIDE_FRIEND_COMPOUNDS  = 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, these
+# documentation blocks found inside the body of a function. If set to NO these
 # blocks will be appended to the function's detailed documentation block.
 # The default value is: NO.
@ -505,7 +490,7 @@ HIDE_IN_BODY_DOCS      = NO
 INTERNAL_DOCS          = 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 also
+# names in lower-case letters. If set to YES upper-case letters are also
 # allowed. This is useful if you have classes or files whose names only differ
 # in case and if your file system supports case sensitive file names. Windows
 # and Mac users are advised to set this option to NO.
@ -514,19 +499,12 @@ INTERNAL_DOCS          = NO
 CASE_SENSE_NAMES       = YES
 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
-# their full class and namespace scopes in the documentation. If set to YES, the
+# their full class and namespace scopes in the documentation. If set to YES the
 # scope will be hidden.
 # The default value is: NO.
 HIDE_SCOPE_NAMES       = NO
 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
 # append additional text to a page's title, such as Class Reference. If set to
 # YES the compound reference will be hidden.
 # The default value is: NO.
 HIDE_COMPOUND_REFERENCE= NO
 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
 # the files that are included by a file in the documentation of that file.
 # The default value is: YES.
@ -554,14 +532,14 @@ INLINE_INFO            = YES
 # If the SORT_MEMBER_DOCS tag is set to YES 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.
+# name. If set to NO the members will appear in declaration order.
 # The default value is: YES.
 SORT_MEMBER_DOCS       = YES
 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
 # descriptions of file, namespace and class members alphabetically by member
-# name. If set to NO, the members will appear in declaration order. Note that
+# name. If set to NO the members will appear in declaration order. Note that
 # this will also influence the order of the classes in the class list.
 # The default value is: NO.
@ -606,25 +584,27 @@ SORT_BY_SCOPE_NAME     = NO
 STRICT_PROTO_MATCHING  = NO
-# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
+# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
-# list. This list is created by putting \todo commands in the documentation.
+# todo list. This list is created by putting \todo commands in the
 # documentation.
 # The default value is: YES.
 GENERATE_TODOLIST      = YES
-# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
+# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
-# list. This list is created by putting \test commands in the documentation.
+# test list. This list is created by putting \test commands in the
 # documentation.
 # The default value is: YES.
 GENERATE_TESTLIST      = YES
-# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the 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.
 # The default value is: YES.
 GENERATE_BUGLIST       = YES
-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
+# 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.
 # The default value is: YES.
@ -649,8 +629,8 @@ ENABLED_SECTIONS       =
 MAX_INITIALIZER_LINES  = 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
+# the bottom of the documentation of classes and structs. If set to YES the list
-# list will mention the files that were used to generate the documentation.
+# will mention the files that were used to generate the documentation.
 # The default value is: YES.
 SHOW_USED_FILES        = YES
@ -698,7 +678,8 @@ LAYOUT_FILE            =
 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
 # For LaTeX the style of the bibliography can be controlled using
 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
-# search path. See also \cite for info how to create references.
+# search path. Do not use file names with spaces, bibtex cannot handle them. See
 # also \cite for info how to create references.
 CITE_BIB_FILES         =
@ -714,7 +695,7 @@ CITE_BIB_FILES         =
 QUIET                  = NO
 # The WARNINGS tag can be used to turn on/off the warning messages that are
-# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
 # this implies that the warnings are on.
 #
 # Tip: Turn warnings on while writing the documentation.
@ -722,7 +703,7 @@ QUIET                  = NO
 WARNINGS               = YES
-# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
+# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
 # will automatically be disabled.
 # The default value is: YES.
@ -739,18 +720,12 @@ WARN_IF_DOC_ERROR      = YES
 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
 # are documented, but have no documentation for their parameters or return
-# value. If set to NO, doxygen will only warn about wrong or incomplete
+# value. If set to NO doxygen will only warn about wrong or incomplete parameter
-# parameter documentation, but not about the absence of documentation.
+# documentation, but not about the absence of documentation.
 # The default value is: NO.
 WARN_NO_PARAMDOC       = NO
 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
 # a warning is encountered.
 # The default value is: NO.
 WARN_AS_ERROR          = NO
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which
 # will be replaced by the file and line number from which the warning originated
@ -774,7 +749,7 @@ WARN_LOGFILE           = doxygen.errors
 # The INPUT tag is used to specify the files and/or directories that contain
 # documented source files. You may enter file names like myfile.cpp or
 # directories like /usr/src/myproject. Separate the files or directories with
-# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
+# spaces.
 # Note: If this tag is empty the current directory is searched.
 INPUT                  = @top_srcdir@/src
@ -791,17 +766,12 @@ INPUT_ENCODING         = UTF-8
 # If the value of the INPUT tag contains directories, you can use the
 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
-# *.h) to filter out the source-files in the directories.
+# *.h) to filter out the source-files in the directories. If left blank the
-#
+# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
-# Note that for custom extensions or not directly supported extensions you also
+# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
-# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
-# read by doxygen.
+# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
-#
+# *.qsf, *.as and *.js.
 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
 # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
 FILE_PATTERNS          = *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt *.sql
@ -834,7 +804,7 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
-EXCLUDE_PATTERNS       = moc_* uic_* qrc_*
+EXCLUDE_PATTERNS       = moc_* uic_* qrc_* version.[ch]xx
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@ -887,10 +857,6 @@ IMAGE_PATH             =
 # Note that the filter must not add or remove lines; it is applied before the
 # code is scanned, but not when the output code is generated. If lines are added
 # or removed, the anchors will not be placed correctly.
 #
 # Note that for custom extensions or not directly supported extensions you also
 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
 # properly processed by doxygen.
 INPUT_FILTER           =
@ -900,15 +866,11 @@ INPUT_FILTER           =
 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
 # patterns match the file name, INPUT_FILTER is applied.
 #
 # Note that for custom extensions or not directly supported extensions you also
 # need to set EXTENSION_MAPPING for the extension otherwise the files are not
 # properly processed by doxygen.
 FILTER_PATTERNS        = *.wt=doxygen-webtester.sed *.sql=@top_srcdir@/sql-to-dot.sed
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
-# INPUT_FILTER) will also be used to filter the input files that are used for
+# INPUT_FILTER ) will also be used to filter the input files that are used for
 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
 # The default value is: NO.
@ -968,7 +930,7 @@ REFERENCED_BY_RELATION = NO
 REFERENCES_RELATION    = NO
 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
-# to YES then the hyperlinks from functions in REFERENCES_RELATION and
+# 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.
 # The default value is: YES.
@ -1015,25 +977,6 @@ USE_HTAGS              = NO
 VERBATIM_HEADERS       = YES
 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
 # cost of reduced performance. This can be particularly helpful with template
 # rich C++ code for which doxygen's built-in parser lacks the necessary type
 # information.
 # Note: The availability of this option depends on whether or not doxygen was
 # generated with the -Duse-libclang=ON option for CMake.
 # The default value is: NO.
 CLANG_ASSISTED_PARSING = NO
 # If clang assisted parsing is enabled you can provide the compiler with command
 # line options that you would normally use when invoking the compiler. Note that
 # the include paths will already be set by doxygen for the files and directories
 # specified with INPUT and INCLUDE_PATH.
 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
 CLANG_OPTIONS          =
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
@ -1064,7 +1007,7 @@ IGNORE_PREFIX          =
 # Configuration options related to the HTML output
 #---------------------------------------------------------------------------
-# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
 # The default value is: YES.
 GENERATE_HTML          = YES
@ -1102,7 +1045,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_HEADER            =
+HTML_HEADER            = header.html
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@ -1112,7 +1055,7 @@ HTML_HEADER            =
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_FOOTER            =
+HTML_FOOTER            = footer.html
 # 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
@ -1126,18 +1069,16 @@ HTML_FOOTER            =
 HTML_STYLESHEET        =
-# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
-# cascading style sheets that are included after the standard style sheets
+# defined cascading style sheet that is included after the standard style sheets
 # created by doxygen. Using this option one can overrule certain style aspects.
 # This is preferred over using HTML_STYLESHEET since it does not replace the
-# standard style sheet and is therefore more robust against future updates.
+# standard style sheet and is therefor more robust against future updates.
-# Doxygen will copy the style sheet files to the output directory.
+# Doxygen will copy the style sheet file to the output directory. For an example
-# Note: The order of the extra style sheet files is of importance (e.g. the last
+# see the documentation.
 # style sheet in the list overrules the setting of the previous ones in the
 # list). For an example see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_STYLESHEET  = style.css
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
@ -1150,7 +1091,7 @@ HTML_EXTRA_STYLESHEET  =
 HTML_EXTRA_FILES       =
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
-# will adjust the colors in the style sheet and background images according to
+# 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
@ -1181,12 +1122,11 @@ HTML_COLORSTYLE_GAMMA  = 80
 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
 # page will contain the date and time when the page was generated. Setting this
-# to YES can help to show when doxygen was last run and thus if the
+# to NO can help when comparing the output of multiple runs.
-# documentation is up to date.
+# The default value is: YES.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_TIMESTAMP         = NO
+HTML_TIMESTAMP         = 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 the
@ -1194,7 +1134,7 @@ HTML_TIMESTAMP         = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_DYNAMIC_SECTIONS  = NO
+HTML_DYNAMIC_SECTIONS  = YES
 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
 # shown in the various tree structured indices initially; the user can expand
@ -1279,29 +1219,28 @@ GENERATE_HTMLHELP      = NO
 CHM_FILE               =
 # 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,
+# 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.
 # The file has to be specified with full path.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 HHC_LOCATION           =
-# The GENERATE_CHI flag controls if a separate .chi index file is generated
+# 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).
+# YES) or that it should be included in the master .chm file ( NO).
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 GENERATE_CHI           = NO
-# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
 # and project file content.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 CHM_INDEX_ENCODING     =
-# The BINARY_TOC flag controls whether a binary table of contents is generated
+# 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. Furthermore it
+# YES) or a normal table of contents ( NO) in the .chm file.
 # enables the Previous and Next buttons.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
@ -1406,7 +1345,7 @@ ECLIPSE_DOC_ID         = org.doxygen.Project
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-DISABLE_INDEX          = NO
+DISABLE_INDEX          = YES
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 # structure should be generated to display hierarchical information. If the tag
@ -1414,7 +1353,7 @@ DISABLE_INDEX          = NO
 # 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. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
 # further fine-tune the look of the index. As an example, the default style
 # sheet generated by doxygen has an example that shows how to put an image at
 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
@ -1423,7 +1362,7 @@ DISABLE_INDEX          = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.
@ -1442,7 +1381,7 @@ ENUM_VALUES_PER_LINE   = 4
 TREEVIEW_WIDTH         = 250
-# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# 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.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
@ -1471,7 +1410,7 @@ FORMULA_TRANSPARENT    = 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 pre-rendered bitmaps. Use this if you do not have LaTeX
+# 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 may also need to install MathJax separately and configure the path
 # to it using the MATHJAX_RELPATH option.
@ -1541,11 +1480,11 @@ SEARCHENGINE           = NO
 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
 # implemented using a web server instead of a web client using Javascript. There
-# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# are two flavours of web server based searching depending on the
-# setting. When disabled, doxygen will generate a PHP script for searching and
+# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
-# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# searching and an index file used by the script. When EXTERNAL_SEARCH is
-# and searching needs to be provided by external tools. See the section
+# enabled the indexing and searching needs to be provided by external tools. See
-# "External Indexing and Searching" for details.
+# the section "External Indexing and Searching" for details.
 # The default value is: NO.
 # This tag requires that the tag SEARCHENGINE is set to YES.
@ -1557,7 +1496,7 @@ SERVER_BASED_SEARCH    = NO
 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
 # search results.
 #
-# Doxygen ships with an example indexer (doxyindexer) and search engine
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
 # (doxysearch.cgi) which are based on the open source search engine library
 # Xapian (see: http://xapian.org/).
 #
@ -1570,7 +1509,7 @@ EXTERNAL_SEARCH        = NO
 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
 # which will return the search results when EXTERNAL_SEARCH is enabled.
 #
-# Doxygen ships with an example indexer (doxyindexer) and search engine
+# Doxygen ships with an example indexer ( doxyindexer) and search engine
 # (doxysearch.cgi) which are based on the open source search engine library
 # Xapian (see: http://xapian.org/). See the section "External Indexing and
 # Searching" for details.
@ -1608,7 +1547,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # Configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
-# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
 # The default value is: YES.
 GENERATE_LATEX         = NO
@ -1639,7 +1578,7 @@ LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
-# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
+# 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.
 # The default value is: NO.
@ -1657,12 +1596,9 @@ COMPACT_LATEX          = NO
 PAPER_TYPE             = a4
 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
-# that should be included in the LaTeX output. The package can be specified just
+# that should be included in the LaTeX output. To get the times font for
-# by its name or with the correct syntax as to be used with the LaTeX
+# instance you can specify
-# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times
 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
 # To use the option intlimits with the amsmath package you can specify:
 # EXTRA_PACKAGES=[intlimits]{amsmath}
 # If left blank no extra packages will be included.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
@ -1676,36 +1612,23 @@ EXTRA_PACKAGES         =
 #
 # Note: Only use a user-defined header if you know what you are doing! The
 # following commands have a special meaning inside the header: $title,
-# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
-# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# replace them by respectively the title of the page, the current date and time,
-# string, for the replacement values of the other commands the user is referred
+# only the current date, the version number of doxygen, the project name (see
-# to HTML_HEADER.
+# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 LATEX_HEADER           =
 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
 # generated LaTeX document. The footer should contain everything after the last
-# chapter. If it is left blank doxygen will generate a standard footer. See
+# chapter. If it is left blank doxygen will generate a standard footer.
 # LATEX_HEADER for more information on how to generate a default footer and what
 # special commands can be used inside the footer.
 #
 # Note: Only use a user-defined footer if you know what you are doing!
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 LATEX_FOOTER           =
 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
 # LaTeX style sheets that are included after the standard style sheets created
 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
 # will copy the style sheet files to the output directory.
 # Note: The order of the extra style sheet files is of importance (e.g. the last
 # style sheet in the list overrules the setting of the previous ones in the
 # list).
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 LATEX_EXTRA_STYLESHEET =
 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the LATEX_OUTPUT output
 # directory. Note that the files will be copied as-is; there are no commands or
@ -1723,8 +1646,8 @@ LATEX_EXTRA_FILES      =
 PDF_HYPERLINKS         = YES
-# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
-# the PDF file directly from the LaTeX files. Set this option to YES, to get a
+# the PDF file directly from the LaTeX files. Set this option to YES to get a
 # higher quality PDF documentation.
 # The default value is: YES.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
@ -1765,19 +1688,11 @@ LATEX_SOURCE_CODE      = NO
 LATEX_BIB_STYLE        = plain
 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
 # 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.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 LATEX_TIMESTAMP        = NO
 #---------------------------------------------------------------------------
 # Configuration options related to the RTF output
 #---------------------------------------------------------------------------
-# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
+# 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 too pretty with other RTF
 # readers/editors.
 # The default value is: NO.
@ -1792,7 +1707,7 @@ GENERATE_RTF           = NO
 RTF_OUTPUT             = rtf
-# If the COMPACT_RTF tag is set to YES, doxygen generates more compact 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 save some
 # trees in general.
 # The default value is: NO.
@ -1829,21 +1744,11 @@ RTF_STYLESHEET_FILE    =
 RTF_EXTENSIONS_FILE    =
 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
 # with syntax highlighting in the RTF output.
 #
 # Note that which sources are shown also depends on other settings such as
 # SOURCE_BROWSER.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_RTF is set to YES.
 RTF_SOURCE_CODE        = NO
 #---------------------------------------------------------------------------
 # Configuration options related to the man page output
 #---------------------------------------------------------------------------
-# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
 # classes and files.
 # The default value is: NO.
@ -1867,13 +1772,6 @@ MAN_OUTPUT             = man
 MAN_EXTENSION          = .3
 # The MAN_SUBDIR tag determines the name of the directory created within
 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
 # MAN_EXTENSION with the initial . removed.
 # This tag requires that the tag GENERATE_MAN is set to YES.
 MAN_SUBDIR             =
 # 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
@ -1887,7 +1785,7 @@ MAN_LINKS              = NO
 # Configuration options related to the XML output
 #---------------------------------------------------------------------------
-# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
+# 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.
 # The default value is: NO.
@ -1901,7 +1799,19 @@ GENERATE_XML           = NO
 XML_OUTPUT             = xml
-# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
+# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
 # validating XML parser to check the syntax of the XML files.
 # This tag requires that the tag GENERATE_XML is set to YES.
 XML_SCHEMA             =
 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
 # validating XML parser to check the syntax of the XML files.
 # This tag requires that the tag GENERATE_XML is set to YES.
 XML_DTD                =
 # 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.
@ -1914,7 +1824,7 @@ XML_PROGRAMLISTING     = YES
 # Configuration options related to the DOCBOOK output
 #---------------------------------------------------------------------------
-# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
 # that can be used to generate PDF.
 # The default value is: NO.
@ -1928,23 +1838,14 @@ GENERATE_DOCBOOK       = NO
 DOCBOOK_OUTPUT         = docbook
 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
 # program listings (including syntax highlighting and cross-referencing
 # information) to the DOCBOOK output. Note that enabling this will significantly
 # increase the size of the DOCBOOK output.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
 DOCBOOK_PROGRAMLISTING = NO
 #---------------------------------------------------------------------------
 # Configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
-# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
-# AutoGen Definitions (see http://autogen.sf.net) file that captures the
+# Definitions (see http://autogen.sf.net) file that captures the structure of
-# structure of the code including all documentation. Note that this feature is
+# the code including all documentation. Note that this feature is still
-# still experimental and incomplete at the moment.
+# experimental and incomplete at the moment.
 # The default value is: NO.
 GENERATE_AUTOGEN_DEF   = NO
@ -1953,7 +1854,7 @@ GENERATE_AUTOGEN_DEF   = NO
 # Configuration options related to the Perl module output
 #---------------------------------------------------------------------------
-# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
+# 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.
@ -1961,7 +1862,7 @@ GENERATE_AUTOGEN_DEF   = NO
 GENERATE_PERLMOD       = NO
-# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
+# 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.
 # The default value is: NO.
@ -1969,9 +1870,9 @@ GENERATE_PERLMOD       = NO
 PERLMOD_LATEX          = NO
-# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
+# 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
+# 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.
 # The default value is: YES.
@ -1991,14 +1892,14 @@ PERLMOD_MAKEVAR_PREFIX =
 # Configuration options related to the preprocessor
 #---------------------------------------------------------------------------
-# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
 # C-preprocessor directives found in the sources and include files.
 # The default value is: YES.
 ENABLE_PREPROCESSING   = YES
-# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
-# in the source code. If set to NO, only conditional compilation will be
+# in the source code. If set to NO only conditional compilation will be
 # performed. Macro expansion can be done in a controlled way by setting
 # EXPAND_ONLY_PREDEF to YES.
 # The default value is: NO.
@ -2014,7 +1915,7 @@ MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = NO
-# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# If the SEARCH_INCLUDES tag is set to YES the includes files in the
 # INCLUDE_PATH will be searched if a #include is found.
 # The default value is: YES.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
@ -2057,9 +1958,9 @@ PREDEFINED += "NAMESPACE=@PACKAGE_NAME@"
 EXPAND_AS_DEFINED      =
 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
-# remove all references to function-like macros that are alone on a line, have
+# remove all refrences to function-like macros that are alone on a line, have an
-# an all uppercase name, and do not end with a semicolon. Such function macros
+# all uppercase name, and do not end with a semicolon. Such function macros are
-# are typically used for boiler-plate code, and will confuse the parser if not
+# typically used for boiler-plate code, and will confuse the parser if not
 # removed.
 # The default value is: YES.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
@ -2079,7 +1980,7 @@ SKIP_FUNCTION_MACROS   = YES
 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
 # section "Linking to external documentation" for more information about the use
 # of tag files.
-# Note: Each tag file must have a unique name (where the name does NOT include
+# Note: Each tag file must have an 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.
@ -2091,21 +1992,20 @@ TAGFILES               =
 GENERATE_TAGFILE       = @PACKAGE_NAME@.doxytag
-# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
-# the class index. If set to NO, only the inherited external classes will be
+# class index. If set to NO only the inherited external classes will be listed.
 # listed.
 # The default value is: NO.
 ALLEXTERNALS           = NO
-# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
-# in the modules index. If set to NO, only the current project's groups will be
+# the modules index. If set to NO, only the current project's groups will be
 # listed.
 # The default value is: YES.
 EXTERNAL_GROUPS        = YES
-# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
 # the related pages index. If set to NO, only the current project's pages will
 # be listed.
 # The default value is: YES.
@ -2122,7 +2022,7 @@ PERL_PATH              = /usr/bin/perl
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
-# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
 # (in HTML 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 install and use dot, since it yields more
@ -2147,7 +2047,7 @@ MSCGEN_PATH            =
 DIA_PATH               =
-# If set to YES the inheritance and collaboration graphs will hide inheritance
+# 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.
 # The default value is: YES.
@ -2158,7 +2058,7 @@ HIDE_UNDOC_RELATIONS   = NO
 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
 # Bell Labs. The other options in this section have no effect if this option is
 # set to NO
-# The default value is: YES.
+# The default value is: NO.
 HAVE_DOT               = YES
@ -2172,7 +2072,7 @@ HAVE_DOT               = YES
 DOT_NUM_THREADS        = 0
-# When you want a differently looking font in the dot files that doxygen
+# When you want a differently looking font n the dot files that doxygen
 # generates 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
@ -2220,7 +2120,7 @@ COLLABORATION_GRAPH    = YES
 GROUP_GRAPHS           = YES
-# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
+# 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.
 # The default value is: NO.
@ -2272,8 +2172,7 @@ INCLUDED_BY_GRAPH      = YES
 #
 # Note that enabling this option will significantly increase the time of a run.
 # So in most cases it will be better to enable call graphs for selected
-# functions only using the \callgraph command. Disabling a call graph can be
+# functions only using the \callgraph command.
 # accomplished by means of the command \hidecallgraph.
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
@ -2284,8 +2183,7 @@ CALL_GRAPH             = NO
 #
 # Note that enabling this option will significantly increase 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. Disabling a caller graph can be
+# functions only using the \callergraph command.
 # accomplished by means of the command \hidecallergraph.
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
@ -2308,17 +2206,11 @@ GRAPHICAL_HIERARCHY    = YES
 DIRECTORY_GRAPH        = YES
 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
-# generated by dot. For an explanation of the image formats see the section
+# generated by dot.
 # output formats in the documentation of the dot tool (Graphviz (see:
 # http://www.graphviz.org/)).
 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
 # to make the SVG files visible in IE 9+ (other browsers do not have this
 # requirement).
-# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
+# Possible values are: png, jpg, gif and svg.
 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
 # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
 # png:gdiplus:gdiplus.
 # The default value is: png.
 # This tag requires that the tag HAVE_DOT is set to YES.
@ -2361,19 +2253,6 @@ MSCFILE_DIRS           =
 DIAFILE_DIRS           =
 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
 # path where java can find the plantuml.jar file. If left blank, it is assumed
 # PlantUML is not used or called during a preprocessing step. Doxygen will
 # generate a warning when it encounters a \startuml command in this case and
 # will not generate output for the diagram.
 PLANTUML_JAR_PATH      =
 # When using plantuml, the specified paths are searched for files specified by
 # the !include statement in a plantuml block.
 PLANTUML_INCLUDE_PATH  =
 # 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
@ -2410,14 +2289,14 @@ MAX_DOT_GRAPH_DEPTH    = 0
 DOT_TRANSPARENT        = YES
-# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
 # 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.
 # The default value is: NO.
 # This tag requires that the tag HAVE_DOT is set to YES.
-DOT_MULTI_TARGETS      = NO
+DOT_MULTI_TARGETS      = YES
 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
 # explaining the meaning of the various boxes and arrows in the dot generated
@ -2427,7 +2306,7 @@ DOT_MULTI_TARGETS      = NO
 GENERATE_LEGEND        = YES
-# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
 # files that are used to generate the various graphs.
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
--- a/src/matrix.hxx
+++ b/src/matrix.hxx
@ -16,6 +16,14 @@
 #include <stdexcept>
 #include  <functional>
 /** @mainpage @description
    @readme
    */
 /// Mathematical Classes and Functions
 /** */
 namespace math {
  template<typename TYPE>