Updated documentation (Issue 328)

This commit is contained in:
Jeffrey Walton 2016-12-04 01:05:59 -05:00
parent e6f6db5fdf
commit dc572604e0
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
2 changed files with 11 additions and 10 deletions

17
dh.h
View File

@ -177,7 +177,7 @@ CRYPTOPP_DLL_TEMPLATE_CLASS DH_Domain<DL_GroupParameters_GFP_DefaultSafePrime>;
//! 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.
//! <pre> AutoSeededRandomPool prng;
//! <pre> AutoSeededRandomPool prng;
//! Integer p, q, g;
//! PrimeAndGenerator pg;
//!
@ -192,20 +192,21 @@ CRYPTOPP_DLL_TEMPLATE_CLASS DH_Domain<DL_GroupParameters_GFP_DefaultSafePrime>;
//! 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;
//! </pre>
//! cout << hex << k2 << endl;</pre>
//!
//! \details Output of the program above will be similar to the following.
//! <pre> $ ./cryptest.exe
//! <pre> $ ./cryptest.exe
//! Private key:
//! 72b45a42371545e9d4880f48589aefh
//! Public key:
//! 45fdb13f97b1840626f0250cec1dba4a23b894100b51fb5d2dd13693d789948f8bfc88f9200014b2
//! ba8dd8a6debc471c69ef1e2326c61184a2eca88ec866346bh
//! </pre>
//!\sa <a href="http://www.weidai.com/scan-mirror/ka.html#DH">Diffie-Hellman</a> in GF(p) with key validation
//! ba8dd8a6debc471c69ef1e2326c61184a2eca88ec866346bh</pre>
//! \sa <a href="http://www.cryptopp.com/wiki/Diffie-Hellman">Diffie-Hellman on the Crypto++ wiki</a> and
//! <a href="http://www.weidai.com/scan-mirror/ka.html#DH">Diffie-Hellman</a> in GF(p) with key validation
//! \since Crypto++ 1.0
#if defined(CRYPTOPP_DOXYGEN_PROCESSING)
struct DH : public DH_Domain<DL_GroupParameters_GFP_DefaultSafePrime>
{

4
dh2.h
View File

@ -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.