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
@@ -115,7 +115,7 @@ struct certificate_t {
* not returned by get_subject (e.g. subjectAltNames) * not returned by get_subject (e.g. subjectAltNames)
* *
* @param subject subject identity * @param subject subject identity
* @return matching value of best match * @return matching value of best match
*/ */
id_match_t (*has_subject)(certificate_t *this, identification_t *subject); id_match_t (*has_subject)(certificate_t *this, identification_t *subject);
@@ -132,8 +132,8 @@ struct certificate_t {
* A certificate may contain additional issuer identifiers, which are * A certificate may contain additional issuer identifiers, which are
* not returned by get_issuer (e.g. issuerAltNames) * not returned by get_issuer (e.g. issuerAltNames)
* *
* @param subject isser identity * @param subject issuer identity
* @return matching value of best match * @return matching value of best match
*/ */
id_match_t (*has_issuer)(certificate_t *this, identification_t *issuer); id_match_t (*has_issuer)(certificate_t *this, identification_t *issuer);
@@ -141,7 +141,7 @@ struct certificate_t {
* Check if this certificate is issued and signed by a specific issuer. * Check if this certificate is issued and signed by a specific issuer.
* *
* @param issuer issuer's certificate * @param issuer issuer's certificate
* @return TRUE if certificate issued by issuer and trusted * @return TRUE if certificate issued by issuer and trusted
*/ */
bool (*issued_by)(certificate_t *this, certificate_t *issuer); bool (*issued_by)(certificate_t *this, certificate_t *issuer);
@@ -197,9 +197,10 @@ struct certificate_t {
/** /**
* Generic check if a given certificate is newer than another. * Generic check if a given certificate is newer than another.
* *
* @param cert certificate
* @param other certificate to compare to * @param other certificate to compare to
* @return TRUE if this newer than other * @return TRUE if this newer than other
*/ */
bool certificate_is_newer(certificate_t *this, certificate_t *other); bool certificate_is_newer(certificate_t *cert, certificate_t *other);
#endif /** CERTIFICATE_H_ @}*/ #endif /** CERTIFICATE_H_ @}*/
@@ -100,9 +100,10 @@ struct crl_t {
/** /**
* Generic check if a given CRL is newer than another. * Generic check if a given CRL is newer than another.
* *
* @param crl CRL
* @param other CRL to compare to * @param other CRL to compare to
* @return TRUE if this newer than other * @return TRUE if this newer than other
*/ */
bool crl_is_newer(crl_t *this, crl_t *other); bool crl_is_newer(crl_t *crl, crl_t *other);
#endif /** CRL_H_ @}*/ #endif /** CRL_H_ @}*/
@@ -133,10 +133,11 @@ struct private_key_t {
/** /**
* Generic private key equals() implementation, usable by implementors. * Generic private key equals() implementation, usable by implementors.
* *
* @param private private key to check
* @param other key to compare * @param other key to compare
* @return TRUE if this is equal to other * @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. * 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. * Generic private key has_fingerprint() implementation, usable by implementors.
* *
* @param private private key to check
* @param fingerprint fingerprint to check * @param fingerprint fingerprint to check
* @return TRUE if key has given fingerprint * @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_ @}*/ #endif /** PRIVATE_KEY_H_ @}*/
@@ -151,7 +151,7 @@ struct public_key_t {
* @param scheme encryption scheme to use * @param scheme encryption scheme to use
* @param plain chunk containing plaintext data * @param plain chunk containing plaintext data
* @param crypto where to allocate encrypted 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, bool (*encrypt)(public_key_t *this, encryption_scheme_t scheme,
chunk_t plain, chunk_t *crypto); chunk_t plain, chunk_t *crypto);
@@ -215,18 +215,20 @@ struct public_key_t {
/** /**
* Generic public key equals() implementation, usable by implementors. * Generic public key equals() implementation, usable by implementors.
* *
* @param public public key to check
* @param other key to compare * @param other key to compare
* @return TRUE if this is equal to other * @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. * Generic public key has_fingerprint() implementation, usable by implementors.
* *
* @param public public key to check
* @param fingerprint fingerprint to check * @param fingerprint fingerprint to check
* @return TRUE if key has given fingerprint * @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. * Conversion of ASN.1 signature or hash OID to signature scheme.