From 40503120251d8e88eccb3f6cd9102eba71f112ab Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Fri, 19 Jan 2018 08:03:40 -0500 Subject: [PATCH] Update documentation --- Doxyfile | 2 +- config.h | 2 +- cryptlib.h | 2 +- nacl.h | 6 +++--- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Doxyfile b/Doxyfile index 7300daa0..4dcbf7fe 100644 --- a/Doxyfile +++ b/Doxyfile @@ -41,7 +41,7 @@ PROJECT_NAME = Crypto++ # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 6.0 +PROJECT_NUMBER = 5.6.5 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/config.h b/config.h index 9ad864f8..ace6930d 100644 --- a/config.h +++ b/config.h @@ -74,7 +74,7 @@ // the version of the library the headers came from. It is not // necessarily the version of the library built as a shared object if // versions are inadvertently mixed and matched. -#define CRYPTOPP_VERSION 600 +#define CRYPTOPP_VERSION 565 // Define this if you want to set a prefix for TestData/ and TestVectors/ // Be mindful of the trailing slash since its simple concatenation. diff --git a/cryptlib.h b/cryptlib.h index 6050525e..6fd939f4 100644 --- a/cryptlib.h +++ b/cryptlib.h @@ -3,7 +3,7 @@ /// \file cryptlib.h /// \brief Abstract base classes that provide a uniform interface to this library. -/*! \mainpage Crypto++ Library 6.0 API Reference +/*! \mainpage Crypto++ Library 5.6.5 API Reference
Abstract Base Classes
cryptlib.h diff --git a/nacl.h b/nacl.h index 4dd909c4..10a0a487 100644 --- a/nacl.h +++ b/nacl.h @@ -361,7 +361,7 @@ int crypto_sign(uint8_t *sm,uint64_t *smlen,const uint8_t *m,uint64_t n,const ui /// \param m output byte buffer /// \param mlen size of the output byte buffer /// \param sm input byte buffer -/// \param smlen size of the input byte buffer +/// \param n size of the input byte buffer /// \param pk public key /// \returns 0 on success, non-0 otherwise /// \sa NaCl crypto_sign documentation @@ -369,8 +369,8 @@ int crypto_sign(uint8_t *sm,uint64_t *smlen,const uint8_t *m,uint64_t n,const ui int crypto_sign_open(uint8_t *m,uint64_t *mlen,const uint8_t *sm,uint64_t n,const uint8_t *pk); /// \brief Generate a keypair for signing -/// \param y public key byte buffer -/// \param x private key byte buffer +/// \param pk public key byte buffer +/// \param sk private key byte buffer /// \details crypto_sign_keypair() creates an ed25519 keypair. /// \returns 0 on success, non-0 otherwise /// \sa NaCl crypto_sign documentation