From 17e88b47f6f94ff82d97933c2d3fcd6bda0fa0c3 Mon Sep 17 00:00:00 2001 From: connerwolfssl Date: Thu, 8 Feb 2018 10:05:30 -0700 Subject: [PATCH] Migrated documentation directory to doc. README updated. Error fixes. Moved make options to doc/include.am --- Makefile.am | 17 --- documentation/README => doc/README_DOXYGEN | 24 +++- .../dox_comments/header_files/aes.h | 0 .../dox_comments/header_files/arc4.h | 0 .../dox_comments/header_files/asn.h | 0 .../dox_comments/header_files/asn_public.h | 0 .../dox_comments/header_files/blake2.h | 0 .../dox_comments/header_files/bn.h | 0 .../dox_comments/header_files/camellia.h | 4 +- .../dox_comments/header_files/chacha.h | 0 .../header_files/chacha20_poly1305.h | 0 .../dox_comments/header_files/coding.h | 0 .../dox_comments/header_files/compress.h | 0 .../dox_comments/header_files/curve25519.h | 0 .../dox_comments/header_files/des3.h | 0 .../dox_comments/header_files/dh.h | 0 .../header_files/doxygen_groups.h | 0 .../dox_comments/header_files/dsa.h | 0 .../dox_comments/header_files/ecc.h | 1 + .../dox_comments/header_files/ed25519.h | 0 .../dox_comments/header_files/error-crypt.h | 0 .../dox_comments/header_files/evp.h | 0 .../dox_comments/header_files/hash.h | 0 .../dox_comments/header_files/hc128.h | 0 .../dox_comments/header_files/hmac.h | 0 .../dox_comments/header_files/idea.h | 0 .../dox_comments/header_files/logging.h | 0 .../dox_comments/header_files/md2.h | 0 .../dox_comments/header_files/md4.h | 0 .../dox_comments/header_files/md5.h | 0 .../dox_comments/header_files/memory.h | 0 .../dox_comments/header_files/pem.h | 0 .../dox_comments/header_files/pkcs7.h | 0 .../dox_comments/header_files/poly1305.h | 0 .../dox_comments/header_files/pwdbased.h | 0 .../dox_comments/header_files/rabbit.h | 0 .../dox_comments/header_files/random.h | 0 .../dox_comments/header_files/ripemd.h | 0 .../dox_comments/header_files/rsa.h | 0 .../dox_comments/header_files/sha.h | 0 .../dox_comments/header_files/sha256.h | 0 .../dox_comments/header_files/sha512.h | 0 .../dox_comments/header_files/signature.h | 0 .../dox_comments/header_files/srp.h | 0 .../dox_comments/header_files/ssl.h | 0 .../dox_comments/header_files/tfm.h | 0 .../dox_comments/header_files/types.h | 0 .../dox_comments/header_files/wc_encrypt.h | 0 .../dox_comments/header_files/wc_port.h | 0 .../dox_comments/header_files/wolfio.h | 0 {documentation => doc}/formats/html/Doxyfile | 0 .../formats/html/footer.html | 0 .../formats/html/header.html | 0 .../html/html_changes/customdoxygen.css | 0 .../formats/html/html_changes/doxygen.css | 0 .../formats/html/html_changes/menu.js | 0 .../formats/html/html_changes/menudata.js | 0 .../html/html_changes/search/search.css | 0 .../html/html_changes/search/search.js | 0 .../formats/html/html_changes/tabs.css | 0 .../formats/html/mainpage.dox | 0 {documentation => doc}/formats/pdf/Doxyfile | 0 {documentation => doc}/formats/pdf/header.tex | 4 +- .../generate_documentation.sh | 17 +-- .../images/wolfssl_logo.png | Bin doc/include.am | 18 +++ documentation/formats/README | 133 ------------------ 67 files changed, 45 insertions(+), 173 deletions(-) rename documentation/README => doc/README_DOXYGEN (87%) rename {documentation => doc}/dox_comments/header_files/aes.h (100%) rename {documentation => doc}/dox_comments/header_files/arc4.h (100%) rename {documentation => doc}/dox_comments/header_files/asn.h (100%) rename {documentation => doc}/dox_comments/header_files/asn_public.h (100%) rename {documentation => doc}/dox_comments/header_files/blake2.h (100%) rename {documentation => doc}/dox_comments/header_files/bn.h (100%) rename {documentation => doc}/dox_comments/header_files/camellia.h (99%) rename {documentation => doc}/dox_comments/header_files/chacha.h (100%) rename {documentation => doc}/dox_comments/header_files/chacha20_poly1305.h (100%) rename {documentation => doc}/dox_comments/header_files/coding.h (100%) rename {documentation => doc}/dox_comments/header_files/compress.h (100%) rename {documentation => doc}/dox_comments/header_files/curve25519.h (100%) rename {documentation => doc}/dox_comments/header_files/des3.h (100%) rename {documentation => doc}/dox_comments/header_files/dh.h (100%) rename {documentation => doc}/dox_comments/header_files/doxygen_groups.h (100%) rename {documentation => doc}/dox_comments/header_files/dsa.h (100%) rename {documentation => doc}/dox_comments/header_files/ecc.h (99%) rename {documentation => doc}/dox_comments/header_files/ed25519.h (100%) rename {documentation => doc}/dox_comments/header_files/error-crypt.h (100%) rename {documentation => doc}/dox_comments/header_files/evp.h (100%) rename {documentation => doc}/dox_comments/header_files/hash.h (100%) rename {documentation => doc}/dox_comments/header_files/hc128.h (100%) rename {documentation => doc}/dox_comments/header_files/hmac.h (100%) rename {documentation => doc}/dox_comments/header_files/idea.h (100%) rename {documentation => doc}/dox_comments/header_files/logging.h (100%) rename {documentation => doc}/dox_comments/header_files/md2.h (100%) rename {documentation => doc}/dox_comments/header_files/md4.h (100%) rename {documentation => doc}/dox_comments/header_files/md5.h (100%) rename {documentation => doc}/dox_comments/header_files/memory.h (100%) rename {documentation => doc}/dox_comments/header_files/pem.h (100%) rename {documentation => doc}/dox_comments/header_files/pkcs7.h (100%) rename {documentation => doc}/dox_comments/header_files/poly1305.h (100%) rename {documentation => doc}/dox_comments/header_files/pwdbased.h (100%) rename {documentation => doc}/dox_comments/header_files/rabbit.h (100%) rename {documentation => doc}/dox_comments/header_files/random.h (100%) rename {documentation => doc}/dox_comments/header_files/ripemd.h (100%) rename {documentation => doc}/dox_comments/header_files/rsa.h (100%) rename {documentation => doc}/dox_comments/header_files/sha.h (100%) rename {documentation => doc}/dox_comments/header_files/sha256.h (100%) rename {documentation => doc}/dox_comments/header_files/sha512.h (100%) rename {documentation => doc}/dox_comments/header_files/signature.h (100%) rename {documentation => doc}/dox_comments/header_files/srp.h (100%) rename {documentation => doc}/dox_comments/header_files/ssl.h (100%) rename {documentation => doc}/dox_comments/header_files/tfm.h (100%) rename {documentation => doc}/dox_comments/header_files/types.h (100%) rename {documentation => doc}/dox_comments/header_files/wc_encrypt.h (100%) rename {documentation => doc}/dox_comments/header_files/wc_port.h (100%) rename {documentation => doc}/dox_comments/header_files/wolfio.h (100%) rename {documentation => doc}/formats/html/Doxyfile (100%) rename {documentation => doc}/formats/html/footer.html (100%) rename {documentation => doc}/formats/html/header.html (100%) rename {documentation => doc}/formats/html/html_changes/customdoxygen.css (100%) rename {documentation => doc}/formats/html/html_changes/doxygen.css (100%) rename {documentation => doc}/formats/html/html_changes/menu.js (100%) rename {documentation => doc}/formats/html/html_changes/menudata.js (100%) rename {documentation => doc}/formats/html/html_changes/search/search.css (100%) rename {documentation => doc}/formats/html/html_changes/search/search.js (100%) rename {documentation => doc}/formats/html/html_changes/tabs.css (100%) rename {documentation => doc}/formats/html/mainpage.dox (100%) rename {documentation => doc}/formats/pdf/Doxyfile (100%) rename {documentation => doc}/formats/pdf/header.tex (99%) rename {documentation => doc}/generate_documentation.sh (77%) rename {documentation => doc}/images/wolfssl_logo.png (100%) delete mode 100644 documentation/formats/README diff --git a/Makefile.am b/Makefile.am index a93b58828..aec8e4fa3 100644 --- a/Makefile.am +++ b/Makefile.am @@ -150,14 +150,6 @@ tests/unit.log: testsuite/testsuite.log DISTCLEANFILES+= cyassl-config DISTCLEANFILES+= wolfssl-config -clean-local: - -rm -rf documentation/build/ - -rm -rf documentation/html/ - -rm -f documentation/refman.pdf - -rm -f documentation/doxygen_warnings - -rm -f documentation/doxygen_html_warnings - -rm -f documentation/doxygen_pdf_warnings - maintainer-clean-local: -rm Makefile.in -rm aclocal.m4 @@ -216,12 +208,3 @@ merge-clean: @find ./ | $(GREP) \.BASE | xargs rm -f @find ./ | $(GREP) \~$$ | xargs rm -f -dox-pdf: - echo "Generating PDF" - cd documentation && ./generate_documentation.sh -pdf > ./doxygen_pdf_warnings || (echo "HTML generation failed $$?"; exit 1) - -dox-html: - echo "Generating HTML" - cd documentation && ./generate_documentation.sh -html > ./doxygen_html_warnings || (echo "HTML generation failed $$?"; exit 1) - -dox: dox-html dox-pdf diff --git a/documentation/README b/doc/README_DOXYGEN similarity index 87% rename from documentation/README rename to doc/README_DOXYGEN index 0edb6babd..a7614b8d5 100644 --- a/documentation/README +++ b/doc/README_DOXYGEN @@ -5,9 +5,21 @@ wolfSSL with Doxygen 1.8.13 cmake make git -latex (with pdflatex included) -( The pdflatex dependency can be removed by setting USE_PDFLATEX to NO in the -file "Doxyfile" located at documentation/formats/pdf/Doxyfile ) +latex (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] ---- Generating the Documentation ---- @@ -24,8 +36,8 @@ some time to run. This is because the doxygen repository must be clones and then built along with the time taken to make the documentation. Once documentation generation has completed to open the html use a browser to -open documentation/html/index.html. To open the generated pdf looking for -refman.pdf located and documentation/refman.pdf. +open doc/html/index.html. To open the generated pdf looking for +refman.pdf located and doc/refman.pdf. ---- Configure ---- @@ -74,7 +86,7 @@ Below are some the the settings that are currently used: ---- Embedding Documentation ---- -Doxygen API documentation should be placed in the documentation/dox_comments/ +Doxygen API documentation should be placed in the doc/dox_comments/ directory. The documentation should be stored in a file in this directory with the same name of the file in which the API resides in the wolfssl repository. C code header files (*.h) should be used when writing the API documentation. If API in a diff --git a/documentation/dox_comments/header_files/aes.h b/doc/dox_comments/header_files/aes.h similarity index 100% rename from documentation/dox_comments/header_files/aes.h rename to doc/dox_comments/header_files/aes.h diff --git a/documentation/dox_comments/header_files/arc4.h b/doc/dox_comments/header_files/arc4.h similarity index 100% rename from documentation/dox_comments/header_files/arc4.h rename to doc/dox_comments/header_files/arc4.h diff --git a/documentation/dox_comments/header_files/asn.h b/doc/dox_comments/header_files/asn.h similarity index 100% rename from documentation/dox_comments/header_files/asn.h rename to doc/dox_comments/header_files/asn.h diff --git a/documentation/dox_comments/header_files/asn_public.h b/doc/dox_comments/header_files/asn_public.h similarity index 100% rename from documentation/dox_comments/header_files/asn_public.h rename to doc/dox_comments/header_files/asn_public.h diff --git a/documentation/dox_comments/header_files/blake2.h b/doc/dox_comments/header_files/blake2.h similarity index 100% rename from documentation/dox_comments/header_files/blake2.h rename to doc/dox_comments/header_files/blake2.h diff --git a/documentation/dox_comments/header_files/bn.h b/doc/dox_comments/header_files/bn.h similarity index 100% rename from documentation/dox_comments/header_files/bn.h rename to doc/dox_comments/header_files/bn.h diff --git a/documentation/dox_comments/header_files/camellia.h b/doc/dox_comments/header_files/camellia.h similarity index 99% rename from documentation/dox_comments/header_files/camellia.h rename to doc/dox_comments/header_files/camellia.h index addf33569..485281ec0 100644 --- a/documentation/dox_comments/header_files/camellia.h +++ b/doc/dox_comments/header_files/camellia.h @@ -62,7 +62,7 @@ WOLFSSL_API int wc_CamelliaSetKey(Camellia* cam, \endcode \sa wc_CamelliaSetKey - */ +*/ WOLFSSL_API int wc_CamelliaSetIV(Camellia* cam, const byte* iv); /*! \ingroup Camellia @@ -115,7 +115,7 @@ WOLFSSL_API int wc_CamelliaEncryptDirect(Camellia* cam, byte* out, byte decrypted[16]; wc_CamelliaDecryptDirect(&cam, decrypted, cipher); - \endode + \endcode \sa wc_CamelliaEncryptDirect */ diff --git a/documentation/dox_comments/header_files/chacha.h b/doc/dox_comments/header_files/chacha.h similarity index 100% rename from documentation/dox_comments/header_files/chacha.h rename to doc/dox_comments/header_files/chacha.h diff --git a/documentation/dox_comments/header_files/chacha20_poly1305.h b/doc/dox_comments/header_files/chacha20_poly1305.h similarity index 100% rename from documentation/dox_comments/header_files/chacha20_poly1305.h rename to doc/dox_comments/header_files/chacha20_poly1305.h diff --git a/documentation/dox_comments/header_files/coding.h b/doc/dox_comments/header_files/coding.h similarity index 100% rename from documentation/dox_comments/header_files/coding.h rename to doc/dox_comments/header_files/coding.h diff --git a/documentation/dox_comments/header_files/compress.h b/doc/dox_comments/header_files/compress.h similarity index 100% rename from documentation/dox_comments/header_files/compress.h rename to doc/dox_comments/header_files/compress.h diff --git a/documentation/dox_comments/header_files/curve25519.h b/doc/dox_comments/header_files/curve25519.h similarity index 100% rename from documentation/dox_comments/header_files/curve25519.h rename to doc/dox_comments/header_files/curve25519.h diff --git a/documentation/dox_comments/header_files/des3.h b/doc/dox_comments/header_files/des3.h similarity index 100% rename from documentation/dox_comments/header_files/des3.h rename to doc/dox_comments/header_files/des3.h diff --git a/documentation/dox_comments/header_files/dh.h b/doc/dox_comments/header_files/dh.h similarity index 100% rename from documentation/dox_comments/header_files/dh.h rename to doc/dox_comments/header_files/dh.h diff --git a/documentation/dox_comments/header_files/doxygen_groups.h b/doc/dox_comments/header_files/doxygen_groups.h similarity index 100% rename from documentation/dox_comments/header_files/doxygen_groups.h rename to doc/dox_comments/header_files/doxygen_groups.h diff --git a/documentation/dox_comments/header_files/dsa.h b/doc/dox_comments/header_files/dsa.h similarity index 100% rename from documentation/dox_comments/header_files/dsa.h rename to doc/dox_comments/header_files/dsa.h diff --git a/documentation/dox_comments/header_files/ecc.h b/doc/dox_comments/header_files/ecc.h similarity index 99% rename from documentation/dox_comments/header_files/ecc.h rename to doc/dox_comments/header_files/ecc.h index a68a4b305..7af35c4e8 100644 --- a/documentation/dox_comments/header_files/ecc.h +++ b/doc/dox_comments/header_files/ecc.h @@ -741,6 +741,7 @@ int wc_ecc_point_is_at_infinity(ecc_point *p); mp_int multiplicand; mp_int modulus; int map; + \endcode \sa none */ diff --git a/documentation/dox_comments/header_files/ed25519.h b/doc/dox_comments/header_files/ed25519.h similarity index 100% rename from documentation/dox_comments/header_files/ed25519.h rename to doc/dox_comments/header_files/ed25519.h diff --git a/documentation/dox_comments/header_files/error-crypt.h b/doc/dox_comments/header_files/error-crypt.h similarity index 100% rename from documentation/dox_comments/header_files/error-crypt.h rename to doc/dox_comments/header_files/error-crypt.h diff --git a/documentation/dox_comments/header_files/evp.h b/doc/dox_comments/header_files/evp.h similarity index 100% rename from documentation/dox_comments/header_files/evp.h rename to doc/dox_comments/header_files/evp.h diff --git a/documentation/dox_comments/header_files/hash.h b/doc/dox_comments/header_files/hash.h similarity index 100% rename from documentation/dox_comments/header_files/hash.h rename to doc/dox_comments/header_files/hash.h diff --git a/documentation/dox_comments/header_files/hc128.h b/doc/dox_comments/header_files/hc128.h similarity index 100% rename from documentation/dox_comments/header_files/hc128.h rename to doc/dox_comments/header_files/hc128.h diff --git a/documentation/dox_comments/header_files/hmac.h b/doc/dox_comments/header_files/hmac.h similarity index 100% rename from documentation/dox_comments/header_files/hmac.h rename to doc/dox_comments/header_files/hmac.h diff --git a/documentation/dox_comments/header_files/idea.h b/doc/dox_comments/header_files/idea.h similarity index 100% rename from documentation/dox_comments/header_files/idea.h rename to doc/dox_comments/header_files/idea.h diff --git a/documentation/dox_comments/header_files/logging.h b/doc/dox_comments/header_files/logging.h similarity index 100% rename from documentation/dox_comments/header_files/logging.h rename to doc/dox_comments/header_files/logging.h diff --git a/documentation/dox_comments/header_files/md2.h b/doc/dox_comments/header_files/md2.h similarity index 100% rename from documentation/dox_comments/header_files/md2.h rename to doc/dox_comments/header_files/md2.h diff --git a/documentation/dox_comments/header_files/md4.h b/doc/dox_comments/header_files/md4.h similarity index 100% rename from documentation/dox_comments/header_files/md4.h rename to doc/dox_comments/header_files/md4.h diff --git a/documentation/dox_comments/header_files/md5.h b/doc/dox_comments/header_files/md5.h similarity index 100% rename from documentation/dox_comments/header_files/md5.h rename to doc/dox_comments/header_files/md5.h diff --git a/documentation/dox_comments/header_files/memory.h b/doc/dox_comments/header_files/memory.h similarity index 100% rename from documentation/dox_comments/header_files/memory.h rename to doc/dox_comments/header_files/memory.h diff --git a/documentation/dox_comments/header_files/pem.h b/doc/dox_comments/header_files/pem.h similarity index 100% rename from documentation/dox_comments/header_files/pem.h rename to doc/dox_comments/header_files/pem.h diff --git a/documentation/dox_comments/header_files/pkcs7.h b/doc/dox_comments/header_files/pkcs7.h similarity index 100% rename from documentation/dox_comments/header_files/pkcs7.h rename to doc/dox_comments/header_files/pkcs7.h diff --git a/documentation/dox_comments/header_files/poly1305.h b/doc/dox_comments/header_files/poly1305.h similarity index 100% rename from documentation/dox_comments/header_files/poly1305.h rename to doc/dox_comments/header_files/poly1305.h diff --git a/documentation/dox_comments/header_files/pwdbased.h b/doc/dox_comments/header_files/pwdbased.h similarity index 100% rename from documentation/dox_comments/header_files/pwdbased.h rename to doc/dox_comments/header_files/pwdbased.h diff --git a/documentation/dox_comments/header_files/rabbit.h b/doc/dox_comments/header_files/rabbit.h similarity index 100% rename from documentation/dox_comments/header_files/rabbit.h rename to doc/dox_comments/header_files/rabbit.h diff --git a/documentation/dox_comments/header_files/random.h b/doc/dox_comments/header_files/random.h similarity index 100% rename from documentation/dox_comments/header_files/random.h rename to doc/dox_comments/header_files/random.h diff --git a/documentation/dox_comments/header_files/ripemd.h b/doc/dox_comments/header_files/ripemd.h similarity index 100% rename from documentation/dox_comments/header_files/ripemd.h rename to doc/dox_comments/header_files/ripemd.h diff --git a/documentation/dox_comments/header_files/rsa.h b/doc/dox_comments/header_files/rsa.h similarity index 100% rename from documentation/dox_comments/header_files/rsa.h rename to doc/dox_comments/header_files/rsa.h diff --git a/documentation/dox_comments/header_files/sha.h b/doc/dox_comments/header_files/sha.h similarity index 100% rename from documentation/dox_comments/header_files/sha.h rename to doc/dox_comments/header_files/sha.h diff --git a/documentation/dox_comments/header_files/sha256.h b/doc/dox_comments/header_files/sha256.h similarity index 100% rename from documentation/dox_comments/header_files/sha256.h rename to doc/dox_comments/header_files/sha256.h diff --git a/documentation/dox_comments/header_files/sha512.h b/doc/dox_comments/header_files/sha512.h similarity index 100% rename from documentation/dox_comments/header_files/sha512.h rename to doc/dox_comments/header_files/sha512.h diff --git a/documentation/dox_comments/header_files/signature.h b/doc/dox_comments/header_files/signature.h similarity index 100% rename from documentation/dox_comments/header_files/signature.h rename to doc/dox_comments/header_files/signature.h diff --git a/documentation/dox_comments/header_files/srp.h b/doc/dox_comments/header_files/srp.h similarity index 100% rename from documentation/dox_comments/header_files/srp.h rename to doc/dox_comments/header_files/srp.h diff --git a/documentation/dox_comments/header_files/ssl.h b/doc/dox_comments/header_files/ssl.h similarity index 100% rename from documentation/dox_comments/header_files/ssl.h rename to doc/dox_comments/header_files/ssl.h diff --git a/documentation/dox_comments/header_files/tfm.h b/doc/dox_comments/header_files/tfm.h similarity index 100% rename from documentation/dox_comments/header_files/tfm.h rename to doc/dox_comments/header_files/tfm.h diff --git a/documentation/dox_comments/header_files/types.h b/doc/dox_comments/header_files/types.h similarity index 100% rename from documentation/dox_comments/header_files/types.h rename to doc/dox_comments/header_files/types.h diff --git a/documentation/dox_comments/header_files/wc_encrypt.h b/doc/dox_comments/header_files/wc_encrypt.h similarity index 100% rename from documentation/dox_comments/header_files/wc_encrypt.h rename to doc/dox_comments/header_files/wc_encrypt.h diff --git a/documentation/dox_comments/header_files/wc_port.h b/doc/dox_comments/header_files/wc_port.h similarity index 100% rename from documentation/dox_comments/header_files/wc_port.h rename to doc/dox_comments/header_files/wc_port.h diff --git a/documentation/dox_comments/header_files/wolfio.h b/doc/dox_comments/header_files/wolfio.h similarity index 100% rename from documentation/dox_comments/header_files/wolfio.h rename to doc/dox_comments/header_files/wolfio.h diff --git a/documentation/formats/html/Doxyfile b/doc/formats/html/Doxyfile similarity index 100% rename from documentation/formats/html/Doxyfile rename to doc/formats/html/Doxyfile diff --git a/documentation/formats/html/footer.html b/doc/formats/html/footer.html similarity index 100% rename from documentation/formats/html/footer.html rename to doc/formats/html/footer.html diff --git a/documentation/formats/html/header.html b/doc/formats/html/header.html similarity index 100% rename from documentation/formats/html/header.html rename to doc/formats/html/header.html diff --git a/documentation/formats/html/html_changes/customdoxygen.css b/doc/formats/html/html_changes/customdoxygen.css similarity index 100% rename from documentation/formats/html/html_changes/customdoxygen.css rename to doc/formats/html/html_changes/customdoxygen.css diff --git a/documentation/formats/html/html_changes/doxygen.css b/doc/formats/html/html_changes/doxygen.css similarity index 100% rename from documentation/formats/html/html_changes/doxygen.css rename to doc/formats/html/html_changes/doxygen.css diff --git a/documentation/formats/html/html_changes/menu.js b/doc/formats/html/html_changes/menu.js similarity index 100% rename from documentation/formats/html/html_changes/menu.js rename to doc/formats/html/html_changes/menu.js diff --git a/documentation/formats/html/html_changes/menudata.js b/doc/formats/html/html_changes/menudata.js similarity index 100% rename from documentation/formats/html/html_changes/menudata.js rename to doc/formats/html/html_changes/menudata.js diff --git a/documentation/formats/html/html_changes/search/search.css b/doc/formats/html/html_changes/search/search.css similarity index 100% rename from documentation/formats/html/html_changes/search/search.css rename to doc/formats/html/html_changes/search/search.css diff --git a/documentation/formats/html/html_changes/search/search.js b/doc/formats/html/html_changes/search/search.js similarity index 100% rename from documentation/formats/html/html_changes/search/search.js rename to doc/formats/html/html_changes/search/search.js diff --git a/documentation/formats/html/html_changes/tabs.css b/doc/formats/html/html_changes/tabs.css similarity index 100% rename from documentation/formats/html/html_changes/tabs.css rename to doc/formats/html/html_changes/tabs.css diff --git a/documentation/formats/html/mainpage.dox b/doc/formats/html/mainpage.dox similarity index 100% rename from documentation/formats/html/mainpage.dox rename to doc/formats/html/mainpage.dox diff --git a/documentation/formats/pdf/Doxyfile b/doc/formats/pdf/Doxyfile similarity index 100% rename from documentation/formats/pdf/Doxyfile rename to doc/formats/pdf/Doxyfile diff --git a/documentation/formats/pdf/header.tex b/doc/formats/pdf/header.tex similarity index 99% rename from documentation/formats/pdf/header.tex rename to doc/formats/pdf/header.tex index 8ecb0e42d..198826649 100644 --- a/documentation/formats/pdf/header.tex +++ b/doc/formats/pdf/header.tex @@ -72,9 +72,9 @@ \fancyhead[RO]{\fancyplain{}{\bfseries\thepage}} \fancyfoot[LE]{\fancyplain{}{}} \fancyfoot[CE]{\fancyplain{}{}} -\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Copyright © 2017 wolfSSL Inc. +\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Copyright © 2018 wolfSSL Inc. All rights reserved. }} -\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Copyright © 2017 wolfSSL Inc. +\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Copyright © 2018 wolfSSL Inc. All rights reserved. }} \fancyfoot[CO]{\fancyplain{}{}} \fancyfoot[RO]{\fancyplain{}{}} diff --git a/documentation/generate_documentation.sh b/doc/generate_documentation.sh similarity index 77% rename from documentation/generate_documentation.sh rename to doc/generate_documentation.sh index b0ce7bb40..a6ec5b59c 100755 --- a/documentation/generate_documentation.sh +++ b/doc/generate_documentation.sh @@ -24,17 +24,8 @@ echo "Please install make" exit 1 fi -if [ ! -e "build" ]; then -echo "build directory not present...creating directory..." -mkdir build -cd build -echo "cloning doxygen 1.8.13..." -git clone https://github.com/doxygen/doxygen --branch Release_1_8_13 -cmake -G "Unix Makefiles" doxygen/ -make -cd .. -else if [ ! -e "build/bin/doxygen" ]; then +mkdir -p build cd build echo "cloning doxygen 1.8.13..." git clone https://github.com/doxygen/doxygen --branch Release_1_8_13 @@ -42,7 +33,6 @@ cmake -G "Unix Makefiles" doxygen/ make cd .. fi -fi if [ $1 = "-html" ] || [ $1 = "-all" ]; then #HTML GENERATION @@ -50,13 +40,14 @@ cp -r formats/html/* ./ echo "generating html..." build/bin/doxygen Doxyfile cp html_changes/search/* html/search/ -cp html_changes/* html/ +cp html_changes/*.css html/ +cp html_changes/*.js html/ rm footer.html header.html rm -rf html_changes rm mainpage.dox rm Doxyfile echo "finished generating html..." -echo "To view the html files use a browser to open the index.html file located at documentation/html/index.html" +echo "To view the html files use a browser to open the index.html file located at doc/html/index.html" fi #PDF GENERATION diff --git a/documentation/images/wolfssl_logo.png b/doc/images/wolfssl_logo.png similarity index 100% rename from documentation/images/wolfssl_logo.png rename to doc/images/wolfssl_logo.png diff --git a/doc/include.am b/doc/include.am index 5bef623aa..0dde86406 100644 --- a/doc/include.am +++ b/doc/include.am @@ -3,3 +3,21 @@ # All paths should be given relative to the root 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) + +dox-html: + echo "Generating HTML" + cd doc && ./generate_documentation.sh -html > ./doxygen_html_warnings || (echo "HTML generation failed $$?"; exit 1) + +dox: dox-html dox-pdf + +clean-local: + -rm -rf doc/build/ + -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 diff --git a/documentation/formats/README b/documentation/formats/README deleted file mode 100644 index 5280e7887..000000000 --- a/documentation/formats/README +++ /dev/null @@ -1,133 +0,0 @@ -wolfSSL with Doxygen 1.8.13 - ----- Generating the HTML ---- - -If you are looking to just generate the html documentation and not interested in -how to add your own just run the GENERATE_HTML.sh script and then open the -html/index.html file with your preferred browser. - ----- Configure ---- - -Doxygen uses a file called "Doxyfile" to hold all its values for configurations. -If needed to generate a fresh Doxfile run the command - - doxygen -g - -Once a Doxyfile is generate there are a few options to keep in mind. -Below are some the the settings that are currently used: - - EXTRACT_ALL - - - this option determines if all API are extracted or just API that is documented. - - OPTIMIZE_OUTPUT_FOR_C - - - changes the look and naming schemes used in generated documentation. - - RECURSIVE - - - allows doxygen to search subdirectories in a library for documenting. - - GENERATE_LATEX - - - tells doxygen whether or not to generate LATEX documentation. - - GENERATE_MAN - - - tells doxygen whether or not to generate MAN pages. - - ENABLE_PREPROCESSING - - - allows doxygen to include items for preprocessing like #ifdef, #endif, etc. - - EXCLUDE - - - allows the user to specify files or directories to ignore when documenting. - - HTML_EXTRA_STYLESHEET - - -allows the user to specify their own css style sheet to use for the doxygen html. - ----- Embedding Documentation ---- - -Doxygen stype API documentation should be placed in the documentation/dox_comments/ -directory. The documentation should be stored in a file in this directory with the -same name of the file in which the API resides in the wolfssl repository. C code -header files (*.h) should be used when writing the API documentation. If API in a -file is documented be sure to add the the top of the original file: -/*! - \file wolfssl/PATH_TO_FILE/FILE_NAME -*/ - -This ensures that the file will be linked to in the doxygen generated html. -When specifying a specific file with the \file command be sure to include part of -the file's path so that it is a unique name. This allows for linking to files even -when multiple files share the same name. - -To ensure that doxygen documents a specific API in to a desired module be sure -to include that module's name in the \ingroup. The current modules to choose from -are as follows but new group can be made: - \ingroup 3DES - \ingroup AES - \ingroup ARC4 - \ingroup BLAKE2 - \ingroup Camellia - \ingroup ChaCha - \ingroup ChaCha20Poly1305 - \ingroup Curve25519 - \ingroup DSA Algorithms - \ingroup Diffie-Hellman - \ingroup ECC - \ingroup ED25519 - \ingroup HC128 - \ingroup HMAC - \ingroup IDEA - \ingroup MD2 - \ingroup MD4 - \ingroup MD5 - \ingroup PKCS7 - \ingroup Password - \ingroup Poly1305 - \ingroup RIPEMD - \ingroup RSA - \ingroup Rabbit - \ingroup SHA - \ingroup SRP - \ingroup wolfCrypt - \ingroup openSSL - \ingroup CertManager - -If one of the above modules/ groups does not fit a desired function then a new -group will need to be created. To do this include the following at the top of -the ssl.h file in wolfssl/wolfssl maintaining the alphabetical order: - - /*! - \defgroup - */ - -The general outline when documenting within the wolfssl library in doxygen should -look like as follows: - - /*! - \ingroup //if API should be in a seperate module - - \brief - - \return // each return will need \return. - - \param // stands for parameter, each parameter will need \param. - - _Example_ - \code - // any example code here - \endcode - - \sa // stands for see also. Each API reference here should have its own \sa - */ - -Be careful when including extra line breaks. This can throw off the formatting doxygen generates -and may cause undesired misaligned sections in the doxygen generated documentation. It is a good -idea to check how your documentation looks as you work so that mistakes are not repeatedly being made -throughout the documentation process. - -