summaryrefslogtreecommitdiff
path: root/sha3.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2017-07-27 19:15:21 -0400
committerJeffrey Walton <noloader@gmail.com>2017-07-27 19:15:21 -0400
commit2c9a3039e85061ff094e460e7afae1aed934350b (patch)
treed868f186df1474265502750f8a4016b374aa6128 /sha3.h
parentfec712491ec5a002cc46177fb7afe1d2412f0185 (diff)
downloadcryptopp-git-2c9a3039e85061ff094e460e7afae1aed934350b.tar.gz
Update documentation
This cleanup was performed using Clang and -Wdocumentation -Wno-documentation-deprecated-sync
Diffstat (limited to 'sha3.h')
-rw-r--r--sha3.h9
1 files changed, 4 insertions, 5 deletions
diff --git a/sha3.h b/sha3.h
index e551767f..86dfeed6 100644
--- a/sha3.h
+++ b/sha3.h
@@ -52,7 +52,7 @@ protected:
};
//! \class SHA3_224
-//! \tparam DigestSize controls the digest size as a template parameter instead of a per-class constant
+//! \tparam T_DigestSize controls the digest size as a template parameter instead of a per-class constant
//! \brief SHA3-X message digest, template for more fine-grained typedefs
//! \since Crypto++ 6.0.0
template<unsigned int T_DigestSize>
@@ -71,19 +71,18 @@ private:
CRYPTOPP_COMPILE_ASSERT(BLOCKSIZE > (int)T_DigestSize); // this is a general expectation by HMAC
};
-//! \class SHA3_224
//! \brief SHA3-224 message digest
//! \since Crypto++ 5.6.2
typedef SHA3_Final<28> SHA3_224;
-//! \class SHA3_256
+
//! \brief SHA3-256 message digest
//! \since Crypto++ 5.6.2
typedef SHA3_Final<32> SHA3_256;
-//! \class SHA3_384
+
//! \brief SHA3-384 message digest
//! \since Crypto++ 5.6.2
typedef SHA3_Final<48> SHA3_384;
-//! \class SHA3_512
+
//! \brief SHA3-512 message digest
//! \since Crypto++ 5.6.2
typedef SHA3_Final<64> SHA3_512;