aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/pubkey
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2017-07-28 10:57:11 -0400
committerJack Lloyd <[email protected]>2017-07-28 10:57:11 -0400
commit3fb7767a3866ce9ae7fd50f2f43fd35d0f4273a8 (patch)
tree93b1a93eeba7761879b906725378758592855776 /src/lib/pubkey
parent40f399c920c3516d66cbea977f1d38e55a1f7fb1 (diff)
Fix warnings from clangs -Wdocumentation flag
Diffstat (limited to 'src/lib/pubkey')
-rw-r--r--src/lib/pubkey/pubkey.h2
-rw-r--r--src/lib/pubkey/xmss/xmss_address.h2
-rw-r--r--src/lib/pubkey/xmss/xmss_index_registry.h2
-rw-r--r--src/lib/pubkey/xmss/xmss_publickey.h2
-rw-r--r--src/lib/pubkey/xmss/xmss_verification_operation.h4
5 files changed, 4 insertions, 8 deletions
diff --git a/src/lib/pubkey/pubkey.h b/src/lib/pubkey/pubkey.h
index bfe444829..93eb07894 100644
--- a/src/lib/pubkey/pubkey.h
+++ b/src/lib/pubkey/pubkey.h
@@ -571,7 +571,7 @@ class BOTAN_DLL PK_Decryptor_EME final : public PK_Decryptor
/**
* Construct an instance.
* @param key the key to use inside the decryptor
- * @param padding the message encoding scheme to use (eg "OAEP(SHA-256)")
+ * @param eme the message encoding scheme to use (eg "OAEP(SHA-256)")
*/
BOTAN_DEPRECATED("Use constructor taking a RNG object")
PK_Decryptor_EME(const Private_Key& key,
diff --git a/src/lib/pubkey/xmss/xmss_address.h b/src/lib/pubkey/xmss/xmss_address.h
index 4ad30c3d9..8a53d4e80 100644
--- a/src/lib/pubkey/xmss/xmss_address.h
+++ b/src/lib/pubkey/xmss/xmss_address.h
@@ -218,8 +218,6 @@ class XMSS_Address
/**
* Set the chain address. A call to this method is only valid, if
* the address type is set to Type::OTS_Hash_Address.
- *
- * @return chain address.
**/
void set_chain_address(uint32_t value)
{
diff --git a/src/lib/pubkey/xmss/xmss_index_registry.h b/src/lib/pubkey/xmss/xmss_index_registry.h
index 28701353d..176eae7b7 100644
--- a/src/lib/pubkey/xmss/xmss_index_registry.h
+++ b/src/lib/pubkey/xmss/xmss_index_registry.h
@@ -76,7 +76,7 @@ class XMSS_Index_Registry
* Retrieves the index position of a key within the registry or
* max(size_t) if key has not been found.
*
- * @param unique id of the XMSS private key (see make_key_id()).
+ * @param id unique id of the XMSS private key (see make_key_id()).
*
* @return index position of key or max(size_t) if key not found.
**/
diff --git a/src/lib/pubkey/xmss/xmss_publickey.h b/src/lib/pubkey/xmss/xmss_publickey.h
index 9186b16a4..39e20b4cf 100644
--- a/src/lib/pubkey/xmss/xmss_publickey.h
+++ b/src/lib/pubkey/xmss/xmss_publickey.h
@@ -104,8 +104,6 @@ class BOTAN_DLL XMSS_PublicKey : public virtual Public_Key
/**
* Sets the chosen XMSS signature method
- *
- * @return XMSS signature method identifier.
**/
void set_xmss_oid(XMSS_Parameters::xmss_algorithm_t xmss_oid)
{
diff --git a/src/lib/pubkey/xmss/xmss_verification_operation.h b/src/lib/pubkey/xmss/xmss_verification_operation.h
index a967fd0ea..e5b11d809 100644
--- a/src/lib/pubkey/xmss/xmss_verification_operation.h
+++ b/src/lib/pubkey/xmss/xmss_verification_operation.h
@@ -47,7 +47,7 @@ namespace Botan {
*
* @param msg A message.
* @param sig The XMSS signature for msg.
- * @param adrs A XMSS tree address.
+ * @param ards A XMSS tree address.
* @param seed A seed.
*
* @return An n-byte string holding the value of the root of a tree
@@ -65,7 +65,7 @@ namespace Botan {
*
* @param sig A XMSS signature.
* @param msg The message signed with sig.
- * @paeam pub_key
+ * @param pub_key the public key
*
* @return true if signature sig is valid for msg, false otherwise.
**/