From 4f246531719f1c9724d5467dd16985e339220b91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20W=C3=A4ckerlin?= Date: Wed, 7 Sep 2016 20:35:52 +0000 Subject: [PATCH] allow plantuml with doxygen < 1.8.11 --- ChangeLog | 72 ++++++++++++++++++++++++++++++++++++ ax_init_standard_project.m4 | 27 ++++++++------ bootstrap.sh | 19 +++++----- configure.ac | 1 - doc/doxyfile.in | 2 +- nodejs/doc/documentation.dox | 2 +- 6 files changed, 98 insertions(+), 25 deletions(-) diff --git a/ChangeLog b/ChangeLog index 92e1da4..2172152 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,75 @@ +2016-09-07 08:34 + + * nodejs/doc/documentation.dox: more documentation + +2016-09-04 19:13 + + * ax_init_standard_project.m4, bootstrap.sh, doc/doxyfile.in, + nodejs/doc/documentation.dox: fixed documentation problem: + startuml is now part of doxygen + +2016-09-03 17:33 + + * ax_init_standard_project.m4, bootstrap.sh, doc/doxyfile.in, + nodejs/doc/documentation.dox: hack to fix uml image + +2016-09-03 15:26 + + * ax_init_standard_project.m4: fix build + +2016-09-03 10:51 + + * COPYING, INSTALL, bootstrap.sh, doc/doxyfile.in, + nodejs/doc/documentation.dox, nodejs/public/javascripts/ext, + nodejs/public/javascripts/ext/jquery.cssemoticons.js, + nodejs/public/javascripts/ext/jquery.js, + nodejs/public/javascripts/ext/openpgp.js, + nodejs/public/javascripts/ext/openpgp.worker.js, + nodejs/public/javascripts/jquery.cssemoticons.js, + nodejs/public/javascripts/jquery.js, + nodejs/public/javascripts/openpgp.js, + nodejs/public/javascripts/openpgp.worker.js, + nodejs/views/index.ejs: documentation updated + +2016-09-02 14:27 + + * COPYING, INSTALL, ax_init_standard_project.m4, bootstrap.sh, + configure.ac, doc/doxyfile.in, doc/plantuml.jar, + nodejs/doc/documentation.dox, resolve-debbuilddeps.sh: updated + docu + +2016-09-02 07:33 + + * COPYING, INSTALL, nodejs/doc/documentation.dox: fixed + documentation + +2016-09-01 14:02 + + * COPYING, INSTALL, ax_init_standard_project.m4, bootstrap.sh, + configure.ac, doc/doxyfile.in, nodejs/doc/documentation.dox, + resolve-debbuilddeps.sh: added docu + +2016-08-31 18:16 + + * debian/control.in: fixed cordova build + +2016-08-30 20:00 + + * resolve-debbuilddeps.sh: fix build in docker + +2016-08-30 19:02 marc + + * COPYING, ChangeLog, INSTALL, autogen.sh, + ax_cxx_compile_stdcxx_11.m4, ax_init_standard_project.m4, + bootstrap.sh, build-in-docker.sh, configure.ac, doc/doxyfile.in, + doc/footer.html.in, doc/header.html.in, doc/style.css, + mac-create-app-bundle.sh, makefile_test.inc.am, + resolve-rpmbuilddeps.sh, sql-to-dot.sed: documentation updated + +2016-06-08 11:12 marc + + * nodejs/makefile.am: cleanup makefile + 2016-01-19 16:20 marc * build-in-docker.sh: build fixed diff --git a/ax_init_standard_project.m4 b/ax_init_standard_project.m4 index 9d2bbda..c146faa 100644 --- a/ax_init_standard_project.m4 +++ b/ax_init_standard_project.m4 @@ -543,20 +543,12 @@ AC_DEFUN([AX_USE_SCRIPTS], [ AC_CONFIG_FILES([scripts/makefile]) ]) -# use this in configure.ac to support PlantUML in Doxygen generation -AC_DEFUN([AX_USE_PLANTUML], [ - if test -f "${srcdir}/doc/plantuml.jar"; then - PLANTUML="doc/plantuml.jar" - AX_SUBST(PLANTUML) - fi - AM_CONDITIONAL(HAVE_PLANTUML, test -n "$PLANTUML") -]) - # use this in configure.ac to support Doxygen documentation generation AC_DEFUN([AX_USE_DOXYGEN], [ AC_CHECK_PROG(have_doxygen, doxygen, yes, no) AC_CHECK_PROG(have_dot, dot, yes, no) AC_CHECK_PROG(have_mscgen, mscgen, yes, no) + AM_CONDITIONAL(NEED_PLANTUML, test "$have_doxygen" = "yes" -a "1.8.11" != $((echo "1.8.11"; doxygen -v) | sort -V | head -1)) PDF_DOC=${PACKAGE_NAME}-${PACKAGE_VERSION}.pdf AC_SUBST(PDF_DOC) if test "$have_doxygen" = "no"; then @@ -581,14 +573,25 @@ AC_DEFUN([AX_USE_DOXYGEN], [ AX_ADD_MAKEFILE_TARGET_DEP([.PHONY], [pdf gen-uml-images], [doc/makefile.in]) test -f doc/makefile.in && cat >> doc/makefile.in < Bob: test - @enduml * Enable Debian packaging by calling "make deb": AX_USE_DEBIAN_PACKAGING * Enable RPM packaging by calling "make rpm": AX_USE_RPM_PACKAGING * Enable C++ testing using CppUnit: AX_USE_CPPUNIT @@ -555,7 +550,6 @@ AX_INIT_STANDARD_PROJECT #AX_USE_LIBTOOL #AX_USE_SCRIPTS #AX_USE_DOXYGEN -#AX_USE_PLANTUML #AX_USE_DEBIAN_PACKAGING #AX_USE_RPM_PACKAGING #AX_USE_CPPUNIT @@ -975,7 +969,7 @@ to --condition AX_USE_DOXYGEN doc/style.css <@AUTHOR_NAME@"' - if testtag AX_USE_PLANTUML; then - doxyreplace PLANTUML_JAR_PATH '"@top_srcdir@/@PLANTUML@"' + # hack plantuml for doxygen < 1.8.11 + if test "1.8.11" = $((echo "1.8.11"; doxygen -v) | sort -V | head -1); then + doxyreplace PLANTUML_JAR_PATH '"@top_srcdir@/doc/plantuml.jar"' + else + doxyadd ALIASES '"startuml{1}=@image html \\1\\n@image latex \\1\\n\\if DontIgnorePlantUMLCode"' + doxyadd ALIASES '"enduml=\\endif"' + doxyadd IMAGE_PATH '"gen-uml-images"' fi doxyreplace ENABLE_PREPROCESSING YES doxyreplace MACRO_EXPANSION YES diff --git a/configure.ac b/configure.ac index 3b19c8f..438bc50 100644 --- a/configure.ac +++ b/configure.ac @@ -29,7 +29,6 @@ AX_USE_RPM_PACKAGING #AX_USE_CPPUNIT AX_BUILD_TEST #AX_BUILD_EXAMPLES -AX_USE_PLANTUML AX_USE_NODEJS # qt features, uncomment, what you need: diff --git a/doc/doxyfile.in b/doc/doxyfile.in index fd85b83..9b0be96 100644 --- a/doc/doxyfile.in +++ b/doc/doxyfile.in @@ -2374,7 +2374,7 @@ DIAFILE_DIRS = # generate a warning when it encounters a \startuml command in this case and # will not generate output for the diagram. -PLANTUML_JAR_PATH = "@top_srcdir@/@PLANTUML@" +PLANTUML_JAR_PATH = "@top_srcdir@/doc/plantuml.jar" # When using plantuml, the specified paths are searched for files specified by # the !include statement in a plantuml block. diff --git a/nodejs/doc/documentation.dox b/nodejs/doc/documentation.dox index f175bcb..809e4ab 100644 --- a/nodejs/doc/documentation.dox +++ b/nodejs/doc/documentation.dox @@ -14,7 +14,7 @@ https://dev.marc.waeckerlin.org/redmine/projects/safechat Implementation Details: @ref security, @ref api, @ref protocol, - @ref database + @ref database, @ref design SafeChat is a chat program designed to protect your privacy. It is designed to be: