From 99ae937d8b4edb0de58edf5ae28b4728eda08aab Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Sun, 11 Dec 2016 06:56:52 -0500 Subject: Updated documentation (Issue 121) --- Doxyfile | 2 +- config.h | 2 +- cryptlib.h | 2 +- eccrypto.h | 5 ++++- gfpcrypt.h | 5 +++-- 5 files changed, 10 insertions(+), 6 deletions(-) diff --git a/Doxyfile b/Doxyfile index 2da79690..97f728ce 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 = 5.7.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 04748ce3..47c227ee 100644 --- a/config.h +++ b/config.h @@ -63,7 +63,7 @@ // ***************** Less Important Settings *************** // Library version -#define CRYPTOPP_VERSION 570 +#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 b3330544..fbff0064 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 5.7 API Reference +/*! \mainpage Crypto++ Library 5.6.5 API Reference
Abstract Base Classes
cryptlib.h diff --git a/eccrypto.h b/eccrypto.h index ebfda2a8..caa85037 100644 --- a/eccrypto.h +++ b/eccrypto.h @@ -345,8 +345,11 @@ public: }; //! \class DL_Algorithm_ECDSA_RFC6979 -//! \brief Elliptic Curve DSA (ECDSA) signature algorithm +//! \brief Elliptic Curve DSA (ECDSA) signature algorithm based on RFC 6979 //! \tparam EC elliptic curve field +//! \sa RFC 6979, Deterministic Usage of the +//! Digital Signature Algorithm (DSA) and Elliptic Curve Digital Signature Algorithm (ECDSA) +//! \since Crypto++ 5.7 template class DL_Algorithm_ECDSA_RFC6979 : public DL_Algorithm_DSA_RFC6979 { diff --git a/gfpcrypt.h b/gfpcrypt.h index 681bc1d2..00514d35 100644 --- a/gfpcrypt.h +++ b/gfpcrypt.h @@ -226,11 +226,12 @@ public: }; //! \class DL_Algorithm_DSA_RFC6979 -//! \brief GDSA algorithm +//! \brief DSA signature algorithm based on RFC 6979 //! \tparam T FieldElement type or class //! \tparam H HashTransformation derived class -//! \sa Deterministic Usage of the +//! \sa RFC 6979, Deterministic Usage of the //! Digital Signature Algorithm (DSA) and Elliptic Curve Digital Signature Algorithm (ECDSA) +//! \since Crypto++ 5.7 template class DL_Algorithm_DSA_RFC6979 : public DL_Algorithm_GDSA, public DeterministicSignatureAlgorithm { -- cgit v1.2.1