diff options
author | Jack Lloyd <[email protected]> | 2016-10-20 20:11:59 -0400 |
---|---|---|
committer | Jack Lloyd <[email protected]> | 2016-10-20 20:11:59 -0400 |
commit | bad4cafce3c592cddbbecd7c99b5f99a53815ff8 (patch) | |
tree | 50eeffe155deb4e873fff35b09a3acb20cc00cd9 /src/lib/pubkey/pk_keys.h | |
parent | d1817c9960f619b130388a570ed09ccbed568e2e (diff) | |
parent | d2fd41d1ea1ac6211705ba88de6828693a10c0b4 (diff) |
Merge GH #670 Improve Doxygen coverage
Diffstat (limited to 'src/lib/pubkey/pk_keys.h')
-rw-r--r-- | src/lib/pubkey/pk_keys.h | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/lib/pubkey/pk_keys.h b/src/lib/pubkey/pk_keys.h index 5521f5b2c..abba9062d 100644 --- a/src/lib/pubkey/pk_keys.h +++ b/src/lib/pubkey/pk_keys.h @@ -109,6 +109,8 @@ class BOTAN_DLL Public_Key * @param rng a random number generator. The PK_Op may maintain a * reference to the RNG and use it many times. The rng must outlive * any operations which reference it. + * @param params additional parameters + * @param provider the provider to use */ virtual std::unique_ptr<PK_Ops::Encryption> create_encryption_op(RandomNumberGenerator& rng, @@ -124,6 +126,8 @@ class BOTAN_DLL Public_Key * @param rng a random number generator. The PK_Op may maintain a * reference to the RNG and use it many times. The rng must outlive * any operations which reference it. + * @param params additional parameters + * @param provider the provider to use */ virtual std::unique_ptr<PK_Ops::KEM_Encryption> create_kem_encryption_op(RandomNumberGenerator& rng, @@ -135,6 +139,8 @@ class BOTAN_DLL Public_Key * In almost all cases applications should use wrappers in pubkey.h * * Return a verification operation for this key/params or throw + * @param params additional parameters + * @param provider the provider to use */ virtual std::unique_ptr<PK_Ops::Verification> create_verification_op(const std::string& params, @@ -182,6 +188,9 @@ class BOTAN_DLL Private_Key : public virtual Public_Key * @param rng a random number generator. The PK_Op may maintain a * reference to the RNG and use it many times. The rng must outlive * any operations which reference it. + * @param params additional parameters + * @param provider the provider to use + * */ virtual std::unique_ptr<PK_Ops::Decryption> create_decryption_op(RandomNumberGenerator& rng, @@ -197,6 +206,8 @@ class BOTAN_DLL Private_Key : public virtual Public_Key * @param rng a random number generator. The PK_Op may maintain a * reference to the RNG and use it many times. The rng must outlive * any operations which reference it. + * @param params additional parameters + * @param provider the provider to use */ virtual std::unique_ptr<PK_Ops::KEM_Decryption> create_kem_decryption_op(RandomNumberGenerator& rng, @@ -212,6 +223,8 @@ class BOTAN_DLL Private_Key : public virtual Public_Key * @param rng a random number generator. The PK_Op may maintain a * reference to the RNG and use it many times. The rng must outlive * any operations which reference it. + * @param params additional parameters + * @param provider the provider to use */ virtual std::unique_ptr<PK_Ops::Signature> create_signature_op(RandomNumberGenerator& rng, @@ -227,6 +240,8 @@ class BOTAN_DLL Private_Key : public virtual Public_Key * @param rng a random number generator. The PK_Op may maintain a * reference to the RNG and use it many times. The rng must outlive * any operations which reference it. + * @param params additional parameters + * @param provider the provider to use */ virtual std::unique_ptr<PK_Ops::Key_Agreement> create_key_agreement_op(RandomNumberGenerator& rng, |