From 4e7d0c36df75a6f3eae009c48fce4639b3156eb1 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Thu, 26 Sep 2019 11:57:08 -0400 Subject: Update documentation --- dsa.h | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'dsa.h') diff --git a/dsa.h b/dsa.h index cd3f0ae7..32ccc8b2 100644 --- a/dsa.h +++ b/dsa.h @@ -13,11 +13,14 @@ NAMESPACE_BEGIN(CryptoPP) /// \brief DSA Signature Format /// \details The DSA signature format used by Crypto++ is as defined by IEEE P1363. -/// Java and .Net use the DER format, and OpenPGP uses the OpenPGP format. +/// OpenSSL, Java and .Net use the DER format, and OpenPGP uses the OpenPGP format. +/// \sa DSAConvertSignatureFormat +/// on the Crypto++ wiki. +/// \since Crypto++ 1.0 enum DSASignatureFormat { /// \brief Crypto++ native signature encoding format DSA_P1363, - /// \brief signature encoding format used by Java and .Net + /// \brief signature encoding format used by OpenSSL, Java and .Net DSA_DER, /// \brief OpenPGP signature encoding format DSA_OPENPGP @@ -31,12 +34,15 @@ enum DSASignatureFormat { /// \param signatureLen the length of the existing signature encoding buffer /// \param fromFormat the source signature format /// \details This function converts between these formats, and returns length -/// of signature in the target format. If toFormat == DSA_P1363, then -/// bufferSize must equal publicKey.SignatureLength() +/// of signature in the target format. If toFormat == DSA_P1363, then +/// bufferSize must equal publicKey.SignatureLength() +/// \sa DSAConvertSignatureFormat +/// on the Crypto++ wiki. /// \since Crypto++ 1.0 size_t DSAConvertSignatureFormat(byte *buffer, size_t bufferSize, DSASignatureFormat toFormat, const byte *signature, size_t signatureLen, DSASignatureFormat fromFormat); NAMESPACE_END -#endif +#endif // CRYPTOPP_DSA_H + -- cgit v1.2.1