fixed documentation problem: startuml is now part of doxygen
This commit is contained in:
@@ -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 <<EOF
|
||||
#### Begin: Appended by $0
|
||||
doc: doxyfile @HAVE_PLANTUML_TRUE@ gen-uml-images
|
||||
doc: doxyfile
|
||||
doxygen doxyfile
|
||||
@PEDANTIC_TRUE@ test \! -s doxygen.errors
|
||||
|
||||
@HAVE_PLANTUML_TRUE@EXTRA_DIST = ${EXTRA_DIST} plantuml.jar
|
||||
@HAVE_PLANTUML_TRUE@
|
||||
@HAVE_PLANTUML_TRUE@gen-uml-images:
|
||||
@HAVE_PLANTUML_TRUE@ test -d gen-uml-images || mkdir gen-uml-images
|
||||
@HAVE_PLANTUML_TRUE@ eval \$\$(sed -n 's, *INPUT *\\(+\\?\\)= *\\(.*\\),INPUT\\1=" \\2",gp' doxyfile); \\
|
||||
@HAVE_PLANTUML_TRUE@ eval \$\$(sed -n 's, *FILE_PATTERNS *\\(+\\?\\)= *\\(.*\\),FILE_PATTERNS\\1=" \\2",gp' doxyfile); \\
|
||||
@HAVE_PLANTUML_TRUE@ SOURCES="**.("\$\$(echo \$\${FILE_PATTERNS} | sed 's,*.,,g;s, ,|,g')")"; \\
|
||||
@HAVE_PLANTUML_TRUE@ for src in \$\$INPUT; do \\
|
||||
@HAVE_PLANTUML_TRUE@ java -Djava.awt.headless=true -jar \${top_srcdir}/\${PLANTUML} -v -o \$\$(pwd)/gen-uml-images "\$\$src/\$\$SOURCES"; \\
|
||||
@HAVE_PLANTUML_TRUE@ done
|
||||
|
||||
clean-documentation:
|
||||
-rm doxygen.errors @PDF_DOC@
|
||||
distclean-documentation:
|
||||
|
@@ -1008,9 +1008,7 @@ if testtag AX_USE_DOXYGEN; then
|
||||
doxyadd ALIASES '"readme=@README_HTML@"'
|
||||
doxyadd ALIASES '"author=<a href="@AUTHOR_URL@" target="_blank">@AUTHOR_NAME@</a>"'
|
||||
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
|
||||
|
@@ -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=<a href="@AUTHOR_URL@" target="_blank">@AUTHOR_NAME@</a>"
|
||||
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.
|
||||
|
@@ -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
|
||||
|
Reference in New Issue
Block a user