hasufell/pqc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

DOC: improve doxygen intro pages

Browse Source
This commit is contained in:
hasufell 2014-06-09 02:17:21 +02:00
parent f76429b24b
commit df7386847f
No known key found for this signature in database
GPG Key ID: 220CD1C5BDEED020
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
include/doxygen.dox
View File

@ -39,6 +39,7 @@ This library was written for Linux systems. Support for windows will not be adde
\section usage Usage \section usage Usage
See this API doc, the public headers are in the include/ subfolder. See this API doc, the public headers are in the include/ subfolder.
This is only the external API. For the internal API please clone the repository, run 'make doc' and check the src/html subfolder.
\section perf Performance \section perf Performance
See <a href="https://github.com/hasufell/pqc/wiki/Performance-analysis">Performance Analysis on github</a>. See <a href="https://github.com/hasufell/pqc/wiki/Performance-analysis">Performance Analysis on github</a>.

4
src/doxygen.dox
View File

@ -8,7 +8,6 @@
\section intro_sec Introduction \section intro_sec Introduction
Highly optimized C implementation of the NTRUEncrypt algorithm, Highly optimized C implementation of the NTRUEncrypt algorithm,
using the FLINT library. using the FLINT library.
This is only the internal API.
\section algos Algorithms \section algos Algorithms
Most of the algorithms in ntru_poly.c, ntru_decrypt.c, ntru_encrypt.c and ntru_keypair.c are based on the pseudo-code from <a href="http://www.crypto.wpi.edu/Publications/Documents/ms_corourke.pdf">Efficient NTRU Implementations by Colleen Marie O'Rourke</a>. Most of the algorithms in ntru_poly.c, ntru_decrypt.c, ntru_encrypt.c and ntru_keypair.c are based on the pseudo-code from <a href="http://www.crypto.wpi.edu/Publications/Documents/ms_corourke.pdf">Efficient NTRU Implementations by Colleen Marie O'Rourke</a>.
@ -29,7 +28,8 @@ This library was written for Linux systems. Support for windows will not be adde
\* make install \* make install
\section usage Usage \section usage Usage
See this API doc, the public headers are in the include/ subfolder. See this API doc. This is only the internal API. For the external API
check the include/html subfolder.
\section perf Performance \section perf Performance
See <a href="https://github.com/hasufell/pqc/wiki/Performance-analysis">Performance Analysis on github</a>. See <a href="https://github.com/hasufell/pqc/wiki/Performance-analysis">Performance Analysis on github</a>.