documentation anhanced

README

@@ -1,23 +1,23 @@
 C++ Matrix Template Library
 
-Library to provide mathematical matices as standard C++ types.
+Library to provide mathematical matrices as standard C++ types that behave like standard types.
 
 Features:
  * Allows any size of 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
+ * Allows any type of values, given as template parameter
  * Supports matrix specific functions:
     * transposition
     * gaussian algorithm
-    * determinant
+    * determinant using gauss algorithm
-    * inversion
+    * inversion using gauss-jordan algorithm
  * Supports mathematical operations:
     * addition
-    * subtraction,
+    * subtraction
     * multiplication
     * division (using the inverse matrix)
- * Higly stable and well tested
+ * Higly stable and well tested in >200 tests
 
 Example with templated size:
 

ax_init_standard_project.m4

@@ -197,6 +197,10 @@ AC_DEFUN([AX_INIT_STANDARD_PROJECT], [
   AX_SUBST(AUTHOR_NAME)
   AX_SUBST(AUTHOR_URL)
   AX_SUBST(AUTHOR_MAIL)
+  PROJECT_URL="${PROJECT_URL:-${AUTHOR_URL}/projects/${PACKAGE_NAME}}"
+  SOURCE_DOWNLOAD="${SOURCE_DOWNLOAD:-${AUTHOR_URL}/downloads/${PACKAGE_NAME}}"
+  AX_SUBST(PROJECT_URL)
+  AX_SUBST(SOURCE_DOWNLOAD)
   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))

bootstrap.sh

@@ -569,6 +569,20 @@ if ! testtag AX_CHECK_QT && \
    ! testtag AX_REQUIRE_QT; then
     echo "${HEADER}MAINTAINERCLEANFILES = makefile.in" | \
         to --condition AX_USE_CXX src/makefile.am
+    if ! ls src/*.[ch]xx; then
+        to --condition AX_USE_CXX src/${PACKAGE_NAME#lib}.hxx <<EOF
+${CHEADER}#ifndef ${PackageName^^}_HXX
+#define ${PackageName^^}_HXX
+
+/** @mainpage @description
+
+    @readme
+
+    */
+
+#endif
+EOF
+    fi
 elif ! test -e src/makefile.am; then
     to --condition AX_USE_CXX src/makefile.am <<EOF
 ${HEADER}bin_PROGRAMS = ${PACKAGE_NAME}
@@ -659,10 +673,17 @@ int main(int argc, char *argv[]) try {
   return 1;
  }
 EOF
-    to --condition AX_USE_CXX src/${PACKAGE_NAME}.hxx <<EOF
+    if ! ls src/*.[ch]xx; then
+        to --condition AX_USE_CXX src/${PACKAGE_NAME#lib}.hxx <<EOF
 ${CHEADER}#ifndef ${PackageName^^}_HXX
 #define ${PackageName^^}_HXX
 
+/** @mainpage @description
+
+    @readme
+
+    */
+
 #include <QMainWindow>
 #include <ui_${PACKAGE_NAME}.hxx>
 
@@ -679,7 +700,8 @@ class ${PackageName}: public QMainWindow, protected Ui::${PackageName} {
 
 #endif
 EOF
-    to --condition AX_USE_CXX src/${PACKAGE_NAME}.ui <<EOF
+    fi
+    to --condition AX_USE_CXX src/${PACKAGE_NAME#lib}.ui <<EOF
 <?xml version="1.0" encoding="UTF-8"?>
 <ui version="4.0">
  <class>${PackageName}</class>
@@ -761,7 +783,7 @@ EOF
 to --condition AX_USE_CXX src/version.cxx <<EOF
 /*! @file
 
-    @id $Id\$
+    @id \$Id\$
 */
 //       1         2         3         4         5         6         7         8
 // 45678901234567890123456789012345678901234567890123456789012345678901234567890
@@ -905,8 +927,8 @@ to --condition AX_USE_DOXYGEN doc/header.html.in <<EOF
     <div id="projectbrief">\$projectbrief</div>
   </div>
   <nav>
-    <a href="https://dev.marc.waeckerlin.org/projects/\$projectname" target="_blank">Project Management</a>
+    <a href="@PROJECT_URL@" target="_blank">Project Management</a>
-    <a href="https://dev.marc.waeckerlin.org/repository/sources/\$projectname/" target="_blank">Download</a>
+    <a href="@SOURCE_DOWNLOAD@" target="_blank">Download</a>
     <div>\$searchbox</div>
   </nav>
 </div>
@@ -925,7 +947,18 @@ to --condition AX_USE_DOXYGEN doc/style.css <<EOF
 #titlearea {
   display: flex;
   justify-content: space-between;
-  align-items: flex-end;
+  align-items: flex-begin;
+}
+#titlearea nav {
+  padding: 0;
+  margin: 0;
+}
+#titlearea nav a {
+  background-color: lightgray;
+  border: 1px solid gray;
+  color: black;
+  padding: 1ex;
+  margin: 0;
 }
 EOF
 if testtag AX_USE_DOXYGEN; then

configure.ac

@@ -17,6 +17,9 @@ AC_INIT(x_package_name, x_version, x_bugreport, x_package_name)
 AM_INIT_AUTOMAKE([1.9 tar-pax parallel-tests color-tests])
 AX_INIT_STANDARD_PROJECT
 
+PROJECT_URL="https://dev.marc.waeckerlin.org/redmine/libmatricxx/"
+SOURCE_DOWNLOAD="https://dev.marc.waeckerlin.org/repository/sources/libmatricxx/"
+
 # requirements, uncomment, what you need:
 AX_USE_CXX
 AX_USE_LIBTOOL

doc/header.html.in

@@ -26,8 +26,8 @@ $extrastylesheet
     <div id="projectbrief">$projectbrief</div>
   </div>
   <nav>
-    <a href="https://dev.marc.waeckerlin.org/projects/$projectname" target="_blank">Project Management</a>
+    <a href="@PROJECT_URL@" target="_blank">Project Management</a>
-    <a href="https://dev.marc.waeckerlin.org/repository/sources/$projectname/" target="_blank">Download</a>
+    <a href="@SOURCE_DOWNLOAD@" target="_blank">Download</a>
     <div>$searchbox</div>
   </nav>
 </div>

doc/style.css

@@ -1,5 +1,16 @@
 #titlearea {
   display: flex;
   justify-content: space-between;
-  align-items: flex-end;
+  align-items: flex-begin;
+}
+#titlearea nav {
+  padding: 0;
+  margin: 0;
+}
+#titlearea nav a {
+  background-color: lightgray;
+  border: 1px solid gray;
+  color: black;
+  padding: 1ex;
+  margin: 0;
 }