From df7386847f19d2ac9164e3f94344c6c2a36042d6 Mon Sep 17 00:00:00 2001 From: hasufell Date: Mon, 9 Jun 2014 02:17:21 +0200 Subject: [PATCH] DOC: improve doxygen intro pages --- include/doxygen.dox | 1 + src/doxygen.dox | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/include/doxygen.dox b/include/doxygen.dox index faf8f00..0483ef7 100644 --- a/include/doxygen.dox +++ b/include/doxygen.dox @@ -39,6 +39,7 @@ This library was written for Linux systems. Support for windows will not be adde \section usage Usage 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 See Performance Analysis on github. diff --git a/src/doxygen.dox b/src/doxygen.dox index fb98d4a..986e439 100644 --- a/src/doxygen.dox +++ b/src/doxygen.dox @@ -8,7 +8,6 @@ \section intro_sec Introduction Highly optimized C implementation of the NTRUEncrypt algorithm, using the FLINT library. -This is only the internal API. \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 Efficient NTRU Implementations by Colleen Marie O'Rourke. @@ -29,7 +28,8 @@ This library was written for Linux systems. Support for windows will not be adde \* make install \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 See Performance Analysis on github.