Skip to content

Commit 8fa8ec9

Browse files
committed
Update documentation
1 parent db6d6b3 commit 8fa8ec9

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

elgamal.h

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ class ElGamalObjectImpl :
129129
/// \details DL_PublicKey_ElGamal provides an override for GetAlgorithmID()
130130
/// to utilize 1.3.14.7.2.1.1. Prior to DL_PublicKey_ElGamal, the ElGamal
131131
/// keys [mistakenly] used the OID from DSA due to DL_GroupParmaters_GFP().
132-
/// \details If you need to <tt>Load</tt> an ElGamal key with the wrong OID
133-
/// then see <A HREF="https://www.cryptopp.com/wiki/ElGamal">ElGamal</A> on
132+
/// If you need to <tt>Load</tt> an ElGamal key with the wrong OID then
133+
/// see <A HREF="https://www.cryptopp.com/wiki/ElGamal">ElGamal</A> on
134134
/// the Crypto++ wiki.
135135
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/876">Issue 876</A>,
136136
/// <A HREF="https://github.com/weidai11/cryptopp/issues/567">Issue 567</A>
@@ -149,8 +149,8 @@ struct DL_PublicKey_ElGamal : public BASE
149149
/// \details DL_PrivateKey_ElGamal provides an override for GetAlgorithmID()
150150
/// to utilize 1.3.14.7.2.1.1. Prior to DL_PrivateKey_ElGamal, the ElGamal
151151
/// keys [mistakenly] used the OID from DSA due to DL_GroupParmaters_GFP().
152-
/// \details If you need to <tt>Load</tt> an ElGamal key with the wrong OID
153-
/// then see <A HREF="https://www.cryptopp.com/wiki/ElGamal">ElGamal</A> on
152+
/// If you need to <tt>Load</tt> an ElGamal key with the wrong OID then
153+
/// see <A HREF="https://www.cryptopp.com/wiki/ElGamal">ElGamal</A> on
154154
/// the Crypto++ wiki.
155155
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/876">Issue 876</A>,
156156
/// <A HREF="https://github.com/weidai11/cryptopp/issues/567">Issue 567</A>
@@ -175,16 +175,19 @@ struct DL_PrivateKey_ElGamal : public BASE
175175
/// \details The ElGamalKeys class [mistakenly] used the OID for DSA from
176176
/// about Crypto++ 1.0 through Crypto++ 8.2. At Crypto++ 8.3 the OID was
177177
/// fixed and now uses ElGamal encryption, which is 1.3.14.7.2.1.1.
178-
/// \details If you need to <tt>Load</tt> an ElGamal key with the wrong OID
179-
/// then see <A HREF="https://www.cryptopp.com/wiki/ElGamal">ElGamal</A> on
178+
/// If you need to <tt>Load</tt> an ElGamal key with the wrong OID then
179+
/// see <A HREF="https://www.cryptopp.com/wiki/ElGamal">ElGamal</A> on
180180
/// the Crypto++ wiki.
181181
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/876">Issue 876</A>,
182182
/// <A HREF="https://github.com/weidai11/cryptopp/issues/567">Issue 567</A>
183183
/// \since Crypto++ 1.0
184184
struct ElGamalKeys
185185
{
186+
/// \brief Implements DL_GroupParameters interface
186187
typedef DL_CryptoKeys_GFP::GroupParameters GroupParameters;
188+
/// \brief Implements DL_PrivateKey interface
187189
typedef DL_PrivateKey_ElGamal<DL_CryptoKeys_GFP::PrivateKey> PrivateKey;
190+
/// \brief Implements DL_PublicKey interface
188191
typedef DL_PublicKey_ElGamal<DL_CryptoKeys_GFP::PublicKey> PublicKey;
189192
};
190193

@@ -194,8 +197,8 @@ struct ElGamalKeys
194197
/// \details The ElGamal class [mistakenly] used the OID for DSA from about
195198
/// Crypto++ 1.0 through Crypto++ 8.2. At Crypto++ 8.3 the OID was fixed
196199
/// and now uses ElGamal encryption, which is 1.3.14.7.2.1.1.
197-
/// \details If you need to <tt>Load</tt> an ElGamal key with the wrong OID
198-
/// then see <A HREF="https://www.cryptopp.com/wiki/ElGamal">ElGamal</A> on
200+
/// If you need to <tt>Load</tt> an ElGamal key with the wrong OID then
201+
/// see <A HREF="https://www.cryptopp.com/wiki/ElGamal">ElGamal</A> on
199202
/// the Crypto++ wiki.
200203
/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/876">Issue 876</A>,
201204
/// <A HREF="https://github.com/weidai11/cryptopp/issues/567">Issue 567</A>

0 commit comments

Comments
 (0)