WolfSSL
/
wolfssl
mirror of https://github.com/wolfSSL/wolfssl.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Added wolfssl vs doxygen api checking, removed storing warnings and errors in files

pull/1361/head
connerwolfssl 2018-03-06 10:13:13 -07:00
parent ba40a71a3c
commit 5a1bdff0bd
3 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/README_DOXYGEN
View File

@ -5,21 +5,19 @@ wolfSSL with Doxygen 1.8.13
cmake
make
git
latex (With pdflatex included. However the pdflatex dependency can be removed by
latex-see below (With pdflatex included. However the pdflatex dependency can be removed by
setting USE_PDFLATEX to NO in the file "Doxyfile" located at
doc/formats/pdf/Doxyfile )
The following texlive packages were used when creating this
documentation:
texlive [installed]
texlive-base [installed,automatic]
texlive-binaries [installed]
texlive-font-utils [installed]
texlive-fonts-recommended [installed,automatic]
texlive-latex-base [installed,automatic]
texlive-latex-extra [installed]
texlive-latex-recommended [installed]
texlive-pictures [installed,automatic]
The following texlive packages were installed when creating this
documentation on Linux Mint:
sudo apt install texlive
sudo apt install texlive-latex-extra
For Mac users Basic Tex from TUG is recommended. After installing BasicTex
additional dependencies will need to be met:
% sudo tlmgr update --self
% sudo tlmgr install tabu varwidth multirow adjustbox collectbox sectsty tocloft collection-fontsextra
---- Generating the Documentation ----

7
doc/generate_documentation.sh
View File

@ -24,6 +24,13 @@ echo "Please install make"
exit 1
fi
./check_api.sh
if [ $? = 1 ]; then
echo "Not all API match"
exit 1
fi
if [ ! -e "build/bin/doxygen" ]; then
mkdir -p build
cd build

6
doc/include.am
View File

@ -6,11 +6,11 @@ dist_doc_DATA+= doc/README.txt
dox-pdf:
echo "Generating PDF"
cd doc && ./generate_documentation.sh -pdf > ./doxygen_pdf_warnings || (echo "HTML generation failed $$?"; exit 1)
cd doc && ./generate_documentation.sh -pdf || (echo "HTML generation failed $$?"; exit 1)
dox-html:
echo "Generating HTML"
cd doc && ./generate_documentation.sh -html > ./doxygen_html_warnings || (echo "HTML generation failed $$?"; exit 1)
cd doc && ./generate_documentation.sh -html || (echo "HTML generation failed $$?"; exit 1)
dox: dox-html dox-pdf
@ -19,5 +19,3 @@ clean-local:
-rm -rf doc/html/
-rm -f doc/refman.pdf
-rm -f doc/doxygen_warnings
-rm -f doc/doxygen_html_warnings
-rm -f doc/doxygen_pdf_warnings