From 9de5ea26290ab1e379c06e55ff5d4e8aed2a3658 Mon Sep 17 00:00:00 2001 From: Frank Voorburg Date: Tue, 17 Jul 2018 15:03:50 +0000 Subject: [PATCH] Refs #564. Added shell scripts for generating the Doxygen reference manuals under Linux. git-svn-id: https://svn.code.sf.net/p/openblt/code/trunk@537 5dc33758-31d5-4daf-9ae8-b24bf3d40d73 --- Doc/doxygen/DoxyfileBootCommander.sh | 19 +++++++++++++++++++ Doc/doxygen/DoxyfileLibOpenBLT.sh | 19 +++++++++++++++++++ Doc/doxygen/DoxyfileOpenBLT.sh | 19 +++++++++++++++++++ Doc/doxygen/DoxyfileSeedNKey.sh | 19 +++++++++++++++++++ 4 files changed, 76 insertions(+) create mode 100755 Doc/doxygen/DoxyfileBootCommander.sh create mode 100755 Doc/doxygen/DoxyfileLibOpenBLT.sh create mode 100755 Doc/doxygen/DoxyfileOpenBLT.sh create mode 100755 Doc/doxygen/DoxyfileSeedNKey.sh diff --git a/Doc/doxygen/DoxyfileBootCommander.sh b/Doc/doxygen/DoxyfileBootCommander.sh new file mode 100755 index 00000000..635c1f9f --- /dev/null +++ b/Doc/doxygen/DoxyfileBootCommander.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +# Shell script to generate a reference manual from the comments in the source code, with +# Doxygen. The following tools should be installed and accessible on the default path: +# - Doxygen +# - Graphviz +# - Make +# - Texlive-Latex +# +# On Debian based systems: sudo apt install make doxygen graphviz texlive-latex-base +# texlive-latex-extra +# On openSUSE based systems: sudo zypper install make doxygen graphviz texlive-latex +# texlive-tabu texlive-tocloft +rm -rf ../RM_BootCommander.pdf +doxygen DoxyfileBootCommander +cd output/BootCommander/latex/ +make +cp refman.pdf ../../../../RM_BootCommander.pdf +cd ../../../ diff --git a/Doc/doxygen/DoxyfileLibOpenBLT.sh b/Doc/doxygen/DoxyfileLibOpenBLT.sh new file mode 100755 index 00000000..fb6561e4 --- /dev/null +++ b/Doc/doxygen/DoxyfileLibOpenBLT.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +# Shell script to generate a reference manual from the comments in the source code, with +# Doxygen. The following tools should be installed and accessible on the default path: +# - Doxygen +# - Graphviz +# - Make +# - Texlive-Latex +# +# On Debian based systems: sudo apt install make doxygen graphviz texlive-latex-base +# texlive-latex-extra +# On openSUSE based systems: sudo zypper install make doxygen graphviz texlive-latex +# texlive-tabu texlive-tocloft +rm -rf ../RM_LibOpenBLT.pdf +doxygen DoxyfileLibOpenBLT +cd output/LibOpenBLT/latex/ +make +cp refman.pdf ../../../../RM_LibOpenBLT.pdf +cd ../../../ diff --git a/Doc/doxygen/DoxyfileOpenBLT.sh b/Doc/doxygen/DoxyfileOpenBLT.sh new file mode 100755 index 00000000..fd652947 --- /dev/null +++ b/Doc/doxygen/DoxyfileOpenBLT.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +# Shell script to generate a reference manual from the comments in the source code, with +# Doxygen. The following tools should be installed and accessible on the default path: +# - Doxygen +# - Graphviz +# - Make +# - Texlive-Latex +# +# On Debian based systems: sudo apt install make doxygen graphviz texlive-latex-base +# texlive-latex-extra +# On openSUSE based systems: sudo zypper install make doxygen graphviz texlive-latex +# texlive-tabu texlive-tocloft +rm -rf ../RM_OpenBLT.pdf +doxygen DoxyfileOpenBLT +cd output/OpenBLT/latex/ +make +cp refman.pdf ../../../../RM_OpenBLT.pdf +cd ../../../ diff --git a/Doc/doxygen/DoxyfileSeedNKey.sh b/Doc/doxygen/DoxyfileSeedNKey.sh new file mode 100755 index 00000000..7c2e8009 --- /dev/null +++ b/Doc/doxygen/DoxyfileSeedNKey.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +# Shell script to generate a reference manual from the comments in the source code, with +# Doxygen. The following tools should be installed and accessible on the default path: +# - Doxygen +# - Graphviz +# - Make +# - Texlive-Latex +# +# On Debian based systems: sudo apt install make doxygen graphviz texlive-latex-base +# texlive-latex-extra +# On openSUSE based systems: sudo zypper install make doxygen graphviz texlive-latex +# texlive-tabu texlive-tocloft +rm -rf ../RM_SeedNKey.pdf +doxygen DoxyfileSeedNKey +cd output/SeedNKey/latex/ +make +cp refman.pdf ../../../../RM_SeedNKey.pdf +cd ../../../