From 7d761eabd3bb06a167d51178c631929577756089 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20W=C3=A4ckerlin?= Date: Thu, 25 Aug 2016 19:54:06 +0000 Subject: [PATCH] documentation updated --- COPYING | 2 +- ChangeLog | 38 +++++++++++++ INSTALL | 2 +- ax_init_standard_project.m4 | 34 +++++++++-- bootstrap.sh | 110 +++++++++++++++++++++++++++++++++--- configure.ac | 3 + debian/control.in | 2 +- doc/footer.html.in | 8 +++ doc/header.html.in | 33 +++++++++++ doc/style.css | 16 ++++++ 10 files changed, 234 insertions(+), 14 deletions(-) create mode 100644 doc/footer.html.in create mode 100644 doc/header.html.in create mode 100644 doc/style.css diff --git a/COPYING b/COPYING index caeca07..88798ab 120000 --- a/COPYING +++ b/COPYING @@ -1 +1 @@ -/usr/share/automake-1.14/COPYING \ No newline at end of file +/usr/share/automake-1.15/COPYING \ No newline at end of file diff --git a/ChangeLog b/ChangeLog index e69de29..8864a29 100644 --- a/ChangeLog +++ b/ChangeLog @@ -0,0 +1,38 @@ +2016-08-25 15:00 + + * src/neuron.hxx: more docu + +2016-08-25 09:24 + + * src/neuron.hxx: move documentation to main page + +2016-08-25 07:51 + + * src/neuron.hxx: move documentation to main page + +2016-08-24 14:53 + + * COPYING, INSTALL, bootstrap.sh, src/neuron.hxx, test/makefile.am, + test/neuron.cxx: with dummy test + +2016-08-24 12:44 + + * build-in-docker.conf: added mrw repo + +2016-08-24 12:23 + + * ., AUTHORS, ChangeLog, NEWS, README, autogen.sh, ax_check_qt.m4, + ax_cxx_compile_stdcxx_11.m4, ax_init_standard_project.m4, + bootstrap.sh, build-in-docker.conf, build-in-docker.sh, + build-resource-file.sh, configure.ac, debian, + debian/changelog.in, debian/compat, debian/control.in, + debian/docs, debian/libneuron-dev.install, + debian/libneuron.install, debian/rules, doc, doc/doxyfile.in, + doc/makefile.am, examples, examples/makefile.am, + libneuron.desktop.in, libneuron.spec.in, + mac-create-app-bundle.sh, makefile.am, makefile_test.inc.am, + resolve-debbuilddeps.sh, resolve-rpmbuilddeps.sh, sql-to-dot.sed, + src, src/libneuron.pc.in, src/makefile.am, src/neuron.hxx, + src/version.cxx, src/version.hxx, test, test/makefile.am: initial + version + diff --git a/INSTALL b/INSTALL index f812f5a..ddcdb76 120000 --- a/INSTALL +++ b/INSTALL @@ -1 +1 @@ -/usr/share/automake-1.14/INSTALL \ No newline at end of file +/usr/share/automake-1.15/INSTALL \ No newline at end of file diff --git a/ax_init_standard_project.m4 b/ax_init_standard_project.m4 index ab87e67..7c6a416 100644 --- a/ax_init_standard_project.m4 +++ b/ax_init_standard_project.m4 @@ -170,15 +170,37 @@ 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,\\\(.\),\\\\\1,g;s/\n/\\n/g;s,",\\",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) + 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)) @@ -444,7 +466,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 +532,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]) diff --git a/bootstrap.sh b/bootstrap.sh index 9964660..8a7c967 100755 --- a/bootstrap.sh +++ b/bootstrap.sh @@ -151,6 +151,9 @@ 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 + * 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 @@ -566,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 < #include @@ -676,7 +700,8 @@ class ${PackageName}: public QMainWindow, protected Ui::${PackageName} { #endif EOF - to --condition AX_USE_CXX src/${PACKAGE_NAME}.ui < ${PackageName} @@ -758,7 +783,7 @@ EOF to --condition AX_USE_CXX src/version.cxx < + + + + + + +\$projectname: \$title +\$title + + + +\$treeview +\$search +\$mathjax + +\$extrastylesheet + + +
+ +
+
+ +
\$projectname \$projectnumber
+
\$projectbrief
+
+ +
+EOF +to --condition AX_USE_DOXYGEN doc/footer.html.in < + +
+ + +EOF +to --condition AX_USE_DOXYGEN doc/style.css <@AUTHOR_NAME@\\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=@AUTHOR_NAME@"' doxyreplace ENABLE_PREPROCESSING YES doxyreplace MACRO_EXPANSION YES doxyadd PREDEFINED '"NAMESPACE=@PACKAGE_NAME@"' @@ -927,7 +1018,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 @@ -936,7 +1033,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 @@ -963,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 < + + + + diff --git a/doc/header.html.in b/doc/header.html.in new file mode 100644 index 0000000..311876f --- /dev/null +++ b/doc/header.html.in @@ -0,0 +1,33 @@ + + + + + + + +$projectname: $title +$title + + + +$treeview +$search +$mathjax + +$extrastylesheet + + +
+ +
+
+ +
$projectname $projectnumber
+
$projectbrief
+
+ +
diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..8765b9a --- /dev/null +++ b/doc/style.css @@ -0,0 +1,16 @@ +#titlearea { + display: flex; + justify-content: space-between; + 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; +}