From 848913f85b7a54b58299663c3fdaf57fdcff47a3 Mon Sep 17 00:00:00 2001 From: AJRepo Date: Wed, 20 May 2020 01:20:09 -0500 Subject: [PATCH] Fix/Updates for debian documentation Add information for building doxygen documentation on debian and fix for hardcoded path for dot. --- doc/README | 7 +++++++ doc/dot | 11 ++++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/doc/README b/doc/README index 2d8755731..ea1e6e719 100644 --- a/doc/README +++ b/doc/README @@ -12,3 +12,10 @@ $doxygen Doxyfile The html file index.html should be in doc/html. +Debian +===================== +#To build documentation first install dependencies (doxygen, doxyqml and dot): +sudo apt install doxygen graphviz doxyqml + +#Then build documentation in the doc/ directory +doxygen ./Doxyfile diff --git a/doc/dot b/doc/dot index 48ed5a4ab..07f4f280d 100755 --- a/doc/dot +++ b/doc/dot @@ -34,4 +34,13 @@ do fi done -/usr/local/bin/dot ${ARGS} +if [[ -x "/usr/local/bin/dot" ]] +then + /usr/local/bin/dot ${ARGS} +elif [[ -x "/usr/bin/dot" ]] +then + /usr/bin/dot ${ARGS} +else + echo "Program dot not found: See file doc/dot" + exit 1 +fi -- 2.22.0