Readded docs for some arguments to global functions.

Those were overzealously removed in 28623fc538.
This commit is contained in:
Tobias Brunner
2011-07-21 18:38:43 +02:00
parent 92032fd4d6
commit cbf5c2c61c
4 changed files with 17 additions and 11 deletions
@@ -133,10 +133,11 @@ struct private_key_t {
/**
* Generic private key equals() implementation, usable by implementors.
*
* @param private private key to check
* @param other key to compare
* @return TRUE if this is equal to other
*/
bool private_key_equals(private_key_t *this, private_key_t *other);
bool private_key_equals(private_key_t *private, private_key_t *other);
/**
* Generic private key belongs_to() implementation, usable by implementors.
@@ -150,9 +151,10 @@ bool private_key_belongs_to(private_key_t *private, public_key_t *public);
/**
* Generic private key has_fingerprint() implementation, usable by implementors.
*
* @param private private key to check
* @param fingerprint fingerprint to check
* @return TRUE if key has given fingerprint
*/
bool private_key_has_fingerprint(private_key_t *this, chunk_t fingerprint);
bool private_key_has_fingerprint(private_key_t *private, chunk_t fingerprint);
#endif /** PRIVATE_KEY_H_ @}*/
@@ -151,7 +151,7 @@ struct public_key_t {
* @param scheme encryption scheme to use
* @param plain chunk containing plaintext data
* @param crypto where to allocate encrypted data
* @return TRUE if data successfully encrypted
* @return TRUE if data successfully encrypted
*/
bool (*encrypt)(public_key_t *this, encryption_scheme_t scheme,
chunk_t plain, chunk_t *crypto);
@@ -215,18 +215,20 @@ struct public_key_t {
/**
* Generic public key equals() implementation, usable by implementors.
*
* @param public public key to check
* @param other key to compare
* @return TRUE if this is equal to other
*/
bool public_key_equals(public_key_t *this, public_key_t *other);
bool public_key_equals(public_key_t *public, public_key_t *other);
/**
* Generic public key has_fingerprint() implementation, usable by implementors.
*
* @param public public key to check
* @param fingerprint fingerprint to check
* @return TRUE if key has given fingerprint
*/
bool public_key_has_fingerprint(public_key_t *this, chunk_t fingerprint);
bool public_key_has_fingerprint(public_key_t *public, chunk_t fingerprint);
/**
* Conversion of ASN.1 signature or hash OID to signature scheme.