documentation fixed

2016-08-28 07:58:43 +00:00
parent 669459943c
commit 12eccb4df5
5 changed files with 69 additions and 14 deletions
--- a/2
+++ b/2
@@ -1 +1 @@
-/usr/share/automake-1.14/COPYING
+/usr/share/automake-1.15/COPYING
--- a/21
+++ b/21
@@ -1,3 +1,24 @@
+2016-08-26 14:10  
+
+	* COPYING, INSTALL, ax_init_standard_project.m4, bootstrap.sh,
+	  doc/doxyfile.in: updated documentation build
+
+2016-08-25 19:53  
+
+	* configure.ac, debian/control.in, src/matrix.hxx, test/basic.cxx,
+	  test/makefile.am, test/matricxx.cxx: documentation updated
+
+2016-08-25 18:56  
+
+	* README, ax_init_standard_project.m4, bootstrap.sh, configure.ac,
+	  doc/header.html.in, doc/style.css: documentation anhanced
+
+2016-08-25 18:02  
+
+	* COPYING, ChangeLog, INSTALL, README, ax_init_standard_project.m4,
+	  doc/doxyfile.in, doc/footer.html.in, doc/header.html.in,
+	  doc/style.css, test/matricxx.cxx: documentation anhanced
+
 2016-08-25 15:00  

 	* README, ax_init_standard_project.m4, bootstrap.sh,
--- a/2
+++ b/2
@@ -1 +1 @@
-/usr/share/automake-1.14/INSTALL
+/usr/share/automake-1.15/INSTALL
--- a/ax_init_standard_project.m4
+++ b/ax_init_standard_project.m4
@@ -171,22 +171,19 @@ AC_DEFUN([AX_INIT_STANDARD_PROJECT], [
  AX_SUBST(NUMBERS)
  AX_SUBST(HOME)
  if test -f README.md; then
-    README=$(tail -n +3 README.md)
+    README=$()
    DESCRIPTION=$(head -1 README.md)
  else
    README=$(tail -n +3 README)
    DESCRIPTION=$(head -1 README)
  fi
-  README_ESCAPED=$(echo "$README" | sed ':a;N;$!ba;s/\n/\\n/g;s,",\\",g')
  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')
+    README_HTML=$(echo "$README" | pandoc -f markdown_github -t html | sed ':a;N;$!ba;s,\\\(.\),\\\\<span>\1</span>,g;s/\n/\\n/g;s,",\\",g;s,  ,\&nbsp;\&nbsp;,g')
  else
    README_HTML="${README}"
  fi
  AX_SUBST(README)
  _AM_SUBST_NOTMAKE([README])
-  AX_SUBST(README_ESCAPED)
-  _AM_SUBST_NOTMAKE([README_ESCAPED])
  AX_SUBST(README_HTML)
  _AM_SUBST_NOTMAKE([README_HTML])
  AX_SUBST(DESCRIPTION)
@@ -200,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))
--- a/bootstrap.sh
+++ b/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="https://dev.marc.waeckerlin.org/repository/sources/\$projectname/" target="_blank">Download</a>
+    <a href="@PROJECT_URL@" target="_blank">Project Management</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
@@ -1026,7 +1059,7 @@ if testtag AX_USE_DEBIAN_PACKAGING; then

 -- @AUTHOR@  @BUILD_DATE@
 EOF
-    BUILD_DEPENDS="debhelper, ${VCSDEPENDS} pkg-config, automake, libtool, autotools-dev, lsb-release $(if testtag AX_USE_DOXYGEN; then echo -n ", doxygen, graphviz, mscgen"; fi; if testtag AX_USE_CPPUNIT; then echo -n ", libcppunit-dev"; fi; if testtag AX_CXX_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n ", qt5-default | libqt4-core | libqtcore4, qt5-qmake | qt4-qmake, qtbase5-dev | libqt4-dev, qtbase5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools"; fi)"
+    BUILD_DEPENDS="debhelper, ${VCSDEPENDS} pkg-config, automake, libtool, autotools-dev, pandoc, lsb-release $(if testtag AX_USE_DOXYGEN; then echo -n ", doxygen, graphviz, mscgen"; fi; if testtag AX_USE_CPPUNIT; then echo -n ", libcppunit-dev"; fi; if testtag AX_CXX_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n ", qt5-default | libqt4-core | libqtcore4, qt5-qmake | qt4-qmake, qtbase5-dev | libqt4-dev, qtbase5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools"; fi)"
    to debian/control.in <<EOF
 Source: @PACKAGE_NAME@
 Priority: extra