Fix some Doxygen warnings

This commit is contained in:
Nicolas Williams
2016-12-14 22:00:04 -06:00
parent a1c505309c
commit 2ebec2e4ec
7 changed files with 23 additions and 6 deletions

View File

@@ -124,8 +124,10 @@
* one mechanism. In GSS-API some function return MN and some * one mechanism. In GSS-API some function return MN and some
* require MN as input. Each of these function is marked up as such. * require MN as input. Each of these function is marked up as such.
* *
* @TODO Describe relationship between import_name, canonicalize_name, * @FIXME Describe relationship between import_name, canonicalize_name,
* export_name and friends. * export_name and friends. Also, update for RFC2743 language
* ("contiguous" and "flat" are gone, leaving just "exported name
* token", "internal", and "MN").
*/ */
/** @defgroup gssapi Heimdal GSS-API functions */ /** @defgroup gssapi Heimdal GSS-API functions */

View File

@@ -206,6 +206,8 @@ RAND_set_rand_method(const RAND_METHOD *meth)
/** /**
* Get the default random method. * Get the default random method.
* *
* @return Returns a RAND_METHOD
*
* @ingroup hcrypto_rand * @ingroup hcrypto_rand
*/ */
@@ -262,6 +264,8 @@ RAND_set_rand_engine(ENGINE *engine)
* @param filename name of file to read. * @param filename name of file to read.
* @param size minimum size to read. * @param size minimum size to read.
* *
* @return Returns the number of seed bytes loaded (0 indicates failure)
*
* @ingroup hcrypto_rand * @ingroup hcrypto_rand
*/ */

View File

@@ -344,6 +344,8 @@ find_CMSIdentifier(hx509_context context,
* @param contentType output type oid, should be freed with der_free_oid(). * @param contentType output type oid, should be freed with der_free_oid().
* @param content the data, free with der_free_octet_string(). * @param content the data, free with der_free_octet_string().
* *
* @return an hx509 error code.
*
* @ingroup hx509_cms * @ingroup hx509_cms
*/ */
@@ -548,6 +550,8 @@ out:
* @param content the output of the function, * @param content the output of the function,
* free with der_free_octet_string(). * free with der_free_octet_string().
* *
* @return an hx509 error code.
*
* @ingroup hx509_cms * @ingroup hx509_cms
*/ */
@@ -780,6 +784,8 @@ find_attribute(const CMSAttributes *attr, const heim_oid *oid)
* @param signer_certs list of the cerficates used to sign this * @param signer_certs list of the cerficates used to sign this
* request, free with hx509_certs_free(). * request, free with hx509_certs_free().
* *
* @return an hx509 error code.
*
* @ingroup hx509_cms * @ingroup hx509_cms
*/ */
@@ -1147,6 +1153,8 @@ add_one_attribute(Attribute **attr,
* @param signed_data the output of the function, free with * @param signed_data the output of the function, free with
* der_free_octet_string(). * der_free_octet_string().
* *
* @return Returns an hx509 error code.
*
* @ingroup hx509_cms * @ingroup hx509_cms
*/ */

View File

@@ -107,6 +107,8 @@ _hx509_ks_register(hx509_context context, struct hx509_keyset_ops *ops)
* select no password/certifictes/prompt lock (see @ref page_lock). * select no password/certifictes/prompt lock (see @ref page_lock).
* @param certs return pointer, free with hx509_certs_free(). * @param certs return pointer, free with hx509_certs_free().
* *
* @return Returns an hx509 error code.
*
* @ingroup hx509_keyset * @ingroup hx509_keyset
*/ */

View File

@@ -488,7 +488,8 @@ krb5_set_error_string(krb5_context context, const char *fmt, ...)
* Deprecated: use krb5_vset_error_message() * Deprecated: use krb5_vset_error_message()
* *
* @param context Kerberos context * @param context Kerberos context
* @param msg error message to free * @param fmt error message to free
* @param args variable argument list vector
* *
* @return Return an error code or 0. * @return Return an error code or 0.
* *

View File

@@ -39,7 +39,7 @@
* As described in SP800-108 5.1 (for HMAC) * As described in SP800-108 5.1 (for HMAC)
* *
* @param context Kerberos 5 context * @param context Kerberos 5 context
* @param kdc_K1 Base key material. * @param kdf_K1 Base key material.
* @param kdf_label A string that identifies the purpose for the derived key. * @param kdf_label A string that identifies the purpose for the derived key.
* @param kdf_context A binary string containing parties, nonce, etc. * @param kdf_context A binary string containing parties, nonce, etc.
* @param md Message digest function to use for PRF. * @param md Message digest function to use for PRF.

View File

@@ -307,8 +307,8 @@ krb5_vabortx(krb5_context context, const char *fmt, va_list ap)
* Log a warning to the log, default stderr, and then abort. * Log a warning to the log, default stderr, and then abort.
* *
* @param context A Kerberos 5 context * @param context A Kerberos 5 context
* @param code error code of the last error * @param fmt printf format string of message to print
* @param fmt message to print * @param ... arguments for format string
* *
* @ingroup krb5_error * @ingroup krb5_error
*/ */