From dc572604e04f62e8c884365ab9a10d65ec06959c Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Sun, 4 Dec 2016 01:05:59 -0500 Subject: [PATCH] Updated documentation (Issue 328) --- dh.h | 17 +++++++++-------- dh2.h | 4 ++-- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/dh.h b/dh.h index ac13ca8c..e1bda011 100644 --- a/dh.h +++ b/dh.h @@ -177,7 +177,7 @@ CRYPTOPP_DLL_TEMPLATE_CLASS DH_Domain; //! time an object is created. //! \details Once a DH() object is created, once can retrieve the ephemeral public key for the other party with code similar to the //! following. -//!
  AutoSeededRandomPool prng;
+//! 
   AutoSeededRandomPool prng;
 //!   Integer p, q, g;
 //!   PrimeAndGenerator pg;
 //!
@@ -192,20 +192,21 @@ CRYPTOPP_DLL_TEMPLATE_CLASS DH_Domain;
 //!   Integer k1(t1, t1.size()), k2(t2, t2.size());
 //!
 //!   cout << "Private key:\n";
-//!   cout << std::hex << k1 << endl;
+//!   cout << hex << k1 << endl;
 //!
 //!   cout << "Public key:\n";
-//!   cout << std::hex << k2 << endl;
-//! 
+//! cout << hex << k2 << endl;
+//! //! \details Output of the program above will be similar to the following. -//!
  $ ./cryptest.exe
+//! 
   $ ./cryptest.exe
 //!   Private key:
 //!   72b45a42371545e9d4880f48589aefh
 //!   Public key:
 //!   45fdb13f97b1840626f0250cec1dba4a23b894100b51fb5d2dd13693d789948f8bfc88f9200014b2
-//!   ba8dd8a6debc471c69ef1e2326c61184a2eca88ec866346bh
-//! 
-//!\sa Diffie-Hellman in GF(p) with key validation +//! ba8dd8a6debc471c69ef1e2326c61184a2eca88ec866346bh
+//! \sa Diffie-Hellman on the Crypto++ wiki and +//! Diffie-Hellman in GF(p) with key validation +//! \since Crypto++ 1.0 #if defined(CRYPTOPP_DOXYGEN_PROCESSING) struct DH : public DH_Domain { diff --git a/dh2.h b/dh2.h index 884cc0b2..70a7b050 100644 --- a/dh2.h +++ b/dh2.h @@ -1,7 +1,7 @@ // dh2.h - written and placed in the public domain by Wei Dai //! \file dh2.h -//! \brief Classes for Diffie-Hellman authenticated key exchange +//! \brief Classes for Unified Diffie-Hellman key exchange #ifndef CRYPTOPP_DH2_H #define CRYPTOPP_DH2_H @@ -11,7 +11,7 @@ NAMESPACE_BEGIN(CryptoPP) //! \class DH2 -//! \brief Unified Diffie-Hellman +//! \brief Unified Diffie-Hellman in GF(p) //! \details A Diffie-Hellman domain is a set of parameters that must be shared //! by two parties in a key agreement protocol, along with the algorithms //! for generating key pairs and deriving agreed values.