summaryrefslogtreecommitdiff
path: root/dh2.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2017-11-29 10:54:33 -0500
committerJeffrey Walton <noloader@gmail.com>2017-11-29 10:54:33 -0500
commit61ec50dabe14c5d4582ac187706ea27645b3562b (patch)
tree18a2eebb7adc8c9556ce132d7081a105fa058d6b /dh2.h
parent16ebfa72bf130c4725e652e4d3688d97d3feb0ee (diff)
downloadcryptopp-git-61ec50dabe14c5d4582ac187706ea27645b3562b.tar.gz
Change Doxygen comment style from //! to ///
Also see https://groups.google.com/forum/#!topic/cryptopp-users/A7-Xt5Knlzw
Diffstat (limited to 'dh2.h')
-rw-r--r--dh2.h22
1 files changed, 11 insertions, 11 deletions
diff --git a/dh2.h b/dh2.h
index 2163de27..4795387b 100644
--- a/dh2.h
+++ b/dh2.h
@@ -1,7 +1,7 @@
// dh2.h - originally written and placed in the public domain by Wei Dai
-//! \file dh2.h
-//! \brief Classes for Unified Diffie-Hellman key exchange
+/// \file dh2.h
+/// \brief Classes for Unified Diffie-Hellman key exchange
#ifndef CRYPTOPP_DH2_H
#define CRYPTOPP_DH2_H
@@ -10,22 +10,22 @@
NAMESPACE_BEGIN(CryptoPP)
-//! \class DH2
-//! \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.
-//! \sa AuthenticatedKeyAgreementDomain, <a href="http://www.weidai.com/scan-mirror/ka.html#DH2">Unified Diffie-Hellman</a>
-//! \since Crypto++ 1.0
+/// \class DH2
+/// \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.
+/// \sa AuthenticatedKeyAgreementDomain, <a href="http://www.weidai.com/scan-mirror/ka.html#DH2">Unified Diffie-Hellman</a>
+/// \since Crypto++ 1.0
class DH2 : public AuthenticatedKeyAgreementDomain
{
public:
virtual ~DH2() {}
- //! \brief Construct a DH2
+ /// \brief Construct a DH2
DH2(SimpleKeyAgreementDomain &domain)
: d1(domain), d2(domain) {}
- //! \brief Construct a DH2
+ /// \brief Construct a DH2
DH2(SimpleKeyAgreementDomain &staticDomain, SimpleKeyAgreementDomain &ephemeralDomain)
: d1(staticDomain), d2(ephemeralDomain) {}