Update documentation

This commit is contained in:
Jeffrey Walton 2018-12-25 16:18:01 -05:00
parent afd9c856ea
commit 0311daf7e2
No known key found for this signature in database
GPG Key ID: B36AB348921B1838

View File

@ -320,12 +320,14 @@ protected:
/// prime and binary fields.
/// \details ed25519PrivateKey is also unusual because the
/// class members of interest are byte arrays and not Integers.
/// In addition, the byte byte arrays are "little-endian" meaning
/// In addition, the byte arrays are little-endian meaning
/// LSB is at element 0 and the MSB is at element 31.
/// \details If you call GetPrivateExponent() then the little-endian
/// byte array is converted to a big-endian Integer so it can be
/// returned the way a caller expects. And calling
/// SetPrivateExponent() perfoms a similar internal conversion.
/// If you call \ref ed25519PrivateKey::GetPrivateExponent()
/// "GetPrivateExponent()" then the little-endian byte array is
/// converted to a big-endian Integer() so it can be returned
/// the way a caller expects. And calling
/// \ref ed25519PrivateKey::SetPrivateExponent "SetPrivateExponent()"
/// perfoms a similar internal conversion.
/// \since Crypto++ 8.0
struct ed25519PrivateKey : public PKCS8PrivateKey
{
@ -575,12 +577,14 @@ protected:
/// prime and binary fields.
/// \details ed25519PublicKey is also unusual because the
/// class members of interest are byte arrays and not Integers.
/// In addition, the byte byte arrays are "little-endian" meaning
/// In addition, the byte arrays are little-endian meaning
/// LSB is at element 0 and the MSB is at element 31.
/// \details If you call GetPublicElement() then the little-endian
/// byte array is converted to a big-endian Integer so it can be
/// returned the way a caller expects. And calling
/// SetPublicElement() perfoms a similar internal conversion.
/// If you call \ref ed25519PublicKey::GetPublicElement()
/// "GetPublicElement()" then the little-endian byte array is
/// converted to a big-endian Integer() so it can be returned
/// the way a caller expects. And calling
/// \ref ed25519PublicKey::SetPublicElement "SetPublicElement()"
/// perfoms a similar internal conversion.
/// \since Crypto++ 8.0
struct ed25519PublicKey : public X509PublicKey
{