webservices/safechat
1
0
Fork 0
Code Issues Pull Requests Releases Activity

allow plantuml with doxygen < 1.8.11

Browse Source
This commit is contained in:
Marc Wäckerlin
2016-09-07 20:35:52 +00:00
parent 1ed6bce542
commit 4f24653171
6 changed files with 98 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
ChangeLog
View File

@@ -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

27
ax_init_standard_project.m4
View File

@@ -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 <<EOF
#### Begin: Appended by $0
doc: doxyfile
doc: doxyfile @NEED_PLANTUML_TRUE@ den-uml-images
doxygen doxyfile
@PEDANTIC_TRUE@ test \! -s doxygen.errors
@NEED_PLANTUML_TRUE@EXTRA_DIST = ${EXTRA_DIST} plantuml.jar
@NEED_PLANTUML_TRUE@
@NEED_PLANTUML_TRUE@gen-uml-images:
@NEED_PLANTUML_TRUE@ test -d gen-uml-images || mkdir gen-uml-images
@NEED_PLANTUML_TRUE@ eval \$\$(sed -n 's, *INPUT *\\(+\\?\\)= *\\(.*\\),INPUT\\1=" \\2",gp' doxyfile); \\
@NEED_PLANTUML_TRUE@ eval \$\$(sed -n 's, *FILE_PATTERNS *\\(+\\?\\)= *\\(.*\\),FILE_PATTERNS\\1=" \\2",gp' doxyfile); \\
@NEED_PLANTUML_TRUE@ SOURCES="**.("\$\$(echo \$\${FILE_PATTERNS} | sed 's,*.,,g;s, ,|,g')")"; \\
@NEED_PLANTUML_TRUE@ for src in \$\$INPUT; do \\
@NEED_PLANTUML_TRUE@ java -Djava.awt.headless=true -jar \${top_srcdir}/doc/plantuml.jar -v -o \$\$(pwd)/gen-uml-images "\$\$src/\$\$SOURCES"; \\
@NEED_PLANTUML_TRUE@ done
clean-documentation:
-rm doxygen.errors @PDF_DOC@
-rm doxygen.errors @PDF_DOC@ @NEED_PLANTUML_TRUE@ gen-uml-images
distclean-documentation:
-rm -r html gen-uml-images
-rm -r html
-rm @PACKAGE_NAME@.doxytag
maintainer-clean-documentation:
-rm makefile.in

19
bootstrap.sh
View File

@@ -154,7 +154,7 @@ GENERATED FILES
* 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
* doc/plantuml.jar - if you enable AX_USE_PLANTUML
* doc/plantuml.jar - if you enable 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
@@ -243,11 +243,6 @@ FILES
* Enable LibTool library creation: AX_USE_LIBTOOL
* Enable Scripts: AX_USE_SCRIPTS
* Enable Doxygen documentation generation: AX_USE_DOXYGEN
* Enable PlantUML for Doxygen: AX_USE_PLANTUML
Example, add in doxygen documentation:
@startuml{overview.png}
Alice -> 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 <<EOF
margin: 0;
}
EOF
if testtag AX_USE_PLANTUML; then
if testtag AX_USE_DOXYGEN; then
copy doc/plantuml.jar
fi
if testtag AX_USE_DOXYGEN; then
@@ -1007,8 +1001,13 @@ if testtag AX_USE_DOXYGEN; then
doxyadd ALIASES '"description=@DESCRIPTION@"'
doxyadd ALIASES '"readme=@README_HTML@"'
doxyadd ALIASES '"author=<a href="@AUTHOR_URL@" target="_blank">@AUTHOR_NAME@</a>"'
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

1
configure.ac
View File

@@ -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:

2
doc/doxyfile.in
View File

@@ -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.

2
nodejs/doc/documentation.dox
View File

@@ -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: