diff options
author | René Korthaus <[email protected]> | 2016-10-16 14:26:13 +0200 |
---|---|---|
committer | René Korthaus <[email protected]> | 2016-10-19 09:13:27 +0200 |
commit | 6a75d6bd08dead5d9ba030ef5041885b11aa2228 (patch) | |
tree | b602187ebd969a52bf5ecace8fd97ab3b2da35e8 | |
parent | e236572e1d1f68e8dc61f6d18fd30c6fe9135961 (diff) |
Improve pk_pad doxygen [ci skip]
-rw-r--r-- | src/lib/pk_pad/eme_oaep/oaep.h | 2 | ||||
-rw-r--r-- | src/lib/pk_pad/emsa.h | 3 | ||||
-rw-r--r-- | src/lib/pk_pad/emsa_pkcs1/emsa_pkcs1.h | 2 | ||||
-rw-r--r-- | src/lib/pk_pad/emsa_pssr/pssr.h | 4 | ||||
-rw-r--r-- | src/lib/pk_pad/emsa_x931/emsa_x931.h | 2 | ||||
-rw-r--r-- | src/lib/pk_pad/mgf1/mgf1.h | 5 |
6 files changed, 13 insertions, 5 deletions
diff --git a/src/lib/pk_pad/eme_oaep/oaep.h b/src/lib/pk_pad/eme_oaep/oaep.h index 8b21ea81d..2a0f0f28c 100644 --- a/src/lib/pk_pad/eme_oaep/oaep.h +++ b/src/lib/pk_pad/eme_oaep/oaep.h @@ -24,7 +24,7 @@ class BOTAN_DLL OAEP final : public EME static OAEP* make(const Spec& spec); /** - * @param hash object to use for hashing (takes ownership) + * @param hash function to use for hashing (takes ownership) * @param P an optional label. Normally empty. */ OAEP(HashFunction* hash, const std::string& P = ""); diff --git a/src/lib/pk_pad/emsa.h b/src/lib/pk_pad/emsa.h index f4697d100..8e8720a66 100644 --- a/src/lib/pk_pad/emsa.h +++ b/src/lib/pk_pad/emsa.h @@ -60,6 +60,9 @@ class BOTAN_DLL EMSA virtual ~EMSA(); + /** + * @return a new object representing the same encoding method as *this + */ virtual EMSA* clone() = 0; }; diff --git a/src/lib/pk_pad/emsa_pkcs1/emsa_pkcs1.h b/src/lib/pk_pad/emsa_pkcs1/emsa_pkcs1.h index 0773ed2c4..917f03ac8 100644 --- a/src/lib/pk_pad/emsa_pkcs1/emsa_pkcs1.h +++ b/src/lib/pk_pad/emsa_pkcs1/emsa_pkcs1.h @@ -24,7 +24,7 @@ class BOTAN_DLL EMSA_PKCS1v15 final : public EMSA static EMSA* make(const EMSA::Spec& spec); /** - * @param hash the hash object to use + * @param hash the hash function to use */ explicit EMSA_PKCS1v15(HashFunction* hash); diff --git a/src/lib/pk_pad/emsa_pssr/pssr.h b/src/lib/pk_pad/emsa_pssr/pssr.h index 9b39417a5..fa8687fee 100644 --- a/src/lib/pk_pad/emsa_pssr/pssr.h +++ b/src/lib/pk_pad/emsa_pssr/pssr.h @@ -21,12 +21,12 @@ class BOTAN_DLL PSSR final : public EMSA public: /** - * @param hash the hash object to use + * @param hash the hash function to use */ explicit PSSR(HashFunction* hash); /** - * @param hash the hash object to use + * @param hash the hash function to use * @param salt_size the size of the salt to use in bytes */ PSSR(HashFunction* hash, size_t salt_size); diff --git a/src/lib/pk_pad/emsa_x931/emsa_x931.h b/src/lib/pk_pad/emsa_x931/emsa_x931.h index 56754d3b1..fe5866002 100644 --- a/src/lib/pk_pad/emsa_x931/emsa_x931.h +++ b/src/lib/pk_pad/emsa_x931/emsa_x931.h @@ -22,7 +22,7 @@ class BOTAN_DLL EMSA_X931 final : public EMSA { public: /** - * @param hash the hash object to use + * @param hash the hash function to use */ explicit EMSA_X931(HashFunction* hash); diff --git a/src/lib/pk_pad/mgf1/mgf1.h b/src/lib/pk_pad/mgf1/mgf1.h index bddb8bba8..034b0328e 100644 --- a/src/lib/pk_pad/mgf1/mgf1.h +++ b/src/lib/pk_pad/mgf1/mgf1.h @@ -14,6 +14,11 @@ namespace Botan { /** * MGF1 from PKCS #1 v2.0 +* @param hash hash function to use +* @param in input buffer +* @param in_len size of the input buffer in bytes +* @param out output buffer +* @param out_len size of the output buffer in bytes */ void BOTAN_DLL mgf1_mask(HashFunction& hash, const byte in[], size_t in_len, |