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
This commit is contained in:
Frank Voorburg 2018-07-17 15:03:50 +00:00
parent 86562a934d
commit 9de5ea2629
4 changed files with 76 additions and 0 deletions

View File

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

View File

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

19
Doc/doxygen/DoxyfileOpenBLT.sh Executable file
View File

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

19
Doc/doxygen/DoxyfileSeedNKey.sh Executable file
View File

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