From 089f39defc4e30084e76998c5ed6bfcc41d31dcb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20W=C3=A4ckerlin?= Date: Sun, 4 Sep 2016 19:13:01 +0000 Subject: [PATCH] fixed documentation problem: startuml is now part of doxygen --- ax_init_standard_project.m4 | 23 ++++++----------------- bootstrap.sh | 4 +--- doc/doxyfile.in | 5 +---- nodejs/doc/documentation.dox | 8 ++------ 4 files changed, 10 insertions(+), 30 deletions(-) diff --git a/ax_init_standard_project.m4 b/ax_init_standard_project.m4 index cbfeb7c..9d2bbda 100644 --- a/ax_init_standard_project.m4 +++ b/ax_init_standard_project.m4 @@ -545,6 +545,11 @@ AC_DEFUN([AX_USE_SCRIPTS], [ # 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 @@ -552,11 +557,6 @@ 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) - if test -f "${srcdir}/doc/plantuml.jar"; then - PLANTUML="doc/plantuml.jar" - AX_SUBST(PLANTUML) - fi - AM_CONDITIONAL(HAVE_PLANTUML, test -n "$PLANTUML") PDF_DOC=${PACKAGE_NAME}-${PACKAGE_VERSION}.pdf AC_SUBST(PDF_DOC) if test "$have_doxygen" = "no"; then @@ -581,21 +581,10 @@ 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 <@AUTHOR_NAME@"' if testtag AX_USE_PLANTUML; then - doxyadd ALIASES '"startuml{1}=@image html \\1\\n@image latex \\1\\n\\if DontIgnorePlantUMLCode"' - doxyadd ALIASES '"enduml=\\endif"' - doxyadd IMAGE_PATH '"gen-uml-images"' + doxyreplace PLANTUML_JAR_PATH '"@top_srcdir@/@PLANTUML@"' fi doxyreplace ENABLE_PREPROCESSING YES doxyreplace MACRO_EXPANSION YES diff --git a/doc/doxyfile.in b/doc/doxyfile.in index 599373d..fd85b83 100644 --- a/doc/doxyfile.in +++ b/doc/doxyfile.in @@ -229,8 +229,6 @@ TAB_SIZE = 2 # newlines. ALIASES = "id=\par File-ID\n" -ALIASES += "enduml=\endif" -ALIASES += "startuml{1}=@image html \1\n@image latex \1\n\if DontIgnorePlantUMLCode" ALIASES += "author=@AUTHOR_NAME@" ALIASES += "readme=@README_HTML@" ALIASES += "description=@DESCRIPTION@" @@ -881,7 +879,6 @@ EXAMPLE_RECURSIVE = YES # \image command). IMAGE_PATH = -IMAGE_PATH += "gen-uml-images" # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program @@ -2377,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 = +PLANTUML_JAR_PATH = "@top_srcdir@/@PLANTUML@" # 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 af1c4d3..a3aaa7c 100644 --- a/nodejs/doc/documentation.dox +++ b/nodejs/doc/documentation.dox @@ -97,9 +97,6 @@ @section overview System Overview - @image html overview.png - @image latex overview.png - @startuml{overview.png} interface "user" interface "user" as otheruser @@ -169,13 +166,12 @@ user >> browser [label="username, password"]; browser -> browser [label="create openpgp key pair"]; browser -> browser [label="locally store encrypted keys"]; + browser -> keyserver [label="upload(pubkey)"]; browser -> browser [label="msg=encrypt(datetime)"]; browser -> "safechat.ch" [label="logon(username, pubkey, msg)"]; "safechat.ch" -> "safechat.ch" [label="datetime=decrypt(msg)"]; "safechat.ch" -> "safechat.ch" [label="verify datetime"]; - "safechat.ch" => keyserver [label="lookup(username)"]; - keyserver >> "safechat.ch" [label="not found"]; - "safechat.ch" -> keyserver [label="upload(pubkey)"]; + "safechat.ch" -> keyserver [label="lookup(username)"]; "safechat.ch" -> browser [label="logon success"]; browser -> user [label="ready to chat"]; @endmsc