From 89ae6f4bc2ff25dc5625875e0cb57b78b28a0b6e Mon Sep 17 00:00:00 2001 From: lloyd Date: Mon, 21 Jun 2010 19:27:20 +0000 Subject: Doxygen --- src/pk_pad/hash_id/hash_id.cpp | 10 ++++------ src/pk_pad/hash_id/hash_id.h | 18 ++++++++++++++---- 2 files changed, 18 insertions(+), 10 deletions(-) (limited to 'src/pk_pad/hash_id') diff --git a/src/pk_pad/hash_id/hash_id.cpp b/src/pk_pad/hash_id/hash_id.cpp index 203c27f14..173f02a6d 100644 --- a/src/pk_pad/hash_id/hash_id.cpp +++ b/src/pk_pad/hash_id/hash_id.cpp @@ -54,10 +54,8 @@ const byte TIGER_PKCS_ID[] = { } -/** -* @return HashID as specified by PKCS -* For details see RFC 3447 section 9.2 -* http://tools.ietf.org/html/rfc3447#section-9.2 +/* +* HashID as specified by PKCS */ MemoryVector pkcs_hash_id(const std::string& name) { @@ -94,8 +92,8 @@ MemoryVector pkcs_hash_id(const std::string& name) throw Invalid_Argument("No PKCS #1 identifier for " + name); } -/** -* @return HashID as specified by IEEE 1363/X9.31 +/* +* HashID as specified by IEEE 1363/X9.31 */ byte ieee1363_hash_id(const std::string& name) { diff --git a/src/pk_pad/hash_id/hash_id.h b/src/pk_pad/hash_id/hash_id.h index 847d9106c..909cc6b19 100644 --- a/src/pk_pad/hash_id/hash_id.h +++ b/src/pk_pad/hash_id/hash_id.h @@ -13,11 +13,21 @@ namespace Botan { -/* -* Return the values of various defined HashIDs +/** +* Return the PKCS #1 hash identifier +* @see RFC 3447 section 9.2 +* @param hash_name the name of the hash function +* @return byte sequence identifying the hash +* @throw Invalid_Argument if the hash has no known PKCS #1 hash id +*/ +BOTAN_DLL MemoryVector pkcs_hash_id(const std::string& hash_name); + +/** +* Return the IEEE 1363 hash identifier +* @param hash_name the name of the hash function +* @return byte code identifying the hash, or 0 if not known */ -BOTAN_DLL MemoryVector pkcs_hash_id(const std::string&); -BOTAN_DLL byte ieee1363_hash_id(const std::string&); +BOTAN_DLL byte ieee1363_hash_id(const std::string& hash_name); } -- cgit v1.2.3