summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Williams <nico@cryptonector.com>2016-12-14 22:00:04 -0600
committerViktor Dukhovni <viktor@twosigma.com>2016-12-15 04:31:49 -0500
commite0c956f059eab124600039dbed35f503b682bb81 (patch)
treefbeefcd9067ba14d1587476a5509b05c44be0eac
parentad8af1fd0c76f9fe1ec8867a283233a400a9818c (diff)
Fix some Doxygen warnings
-rw-r--r--lib/gssapi/mech/doxygen.c6
-rw-r--r--lib/hcrypto/rand.c4
-rw-r--r--lib/hx509/cms.c8
-rw-r--r--lib/hx509/keyset.c2
-rw-r--r--lib/krb5/deprecated.c3
-rwxr-xr-xlib/krb5/sp800-108-kdf.c2
-rw-r--r--lib/krb5/warn.c4
7 files changed, 23 insertions, 6 deletions
diff --git a/lib/gssapi/mech/doxygen.c b/lib/gssapi/mech/doxygen.c
index e20681a80..4ead9f17e 100644
--- a/lib/gssapi/mech/doxygen.c
+++ b/lib/gssapi/mech/doxygen.c
@@ -124,8 +124,10 @@
* one mechanism. In GSS-API some function return MN and some
* require MN as input. Each of these function is marked up as such.
*
- * @TODO Describe relationship between import_name, canonicalize_name,
- * export_name and friends.
+ * @FIXME Describe relationship between import_name, canonicalize_name,
+ * 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 */
diff --git a/lib/hcrypto/rand.c b/lib/hcrypto/rand.c
index b3b7ea09c..98432e75e 100644
--- a/lib/hcrypto/rand.c
+++ b/lib/hcrypto/rand.c
@@ -206,6 +206,8 @@ RAND_set_rand_method(const RAND_METHOD *meth)
/**
* Get the default random method.
*
+ * @return Returns a RAND_METHOD
+ *
* @ingroup hcrypto_rand
*/
@@ -262,6 +264,8 @@ RAND_set_rand_engine(ENGINE *engine)
* @param filename name of file to read.
* @param size minimum size to read.
*
+ * @return Returns the number of seed bytes loaded (0 indicates failure)
+ *
* @ingroup hcrypto_rand
*/
diff --git a/lib/hx509/cms.c b/lib/hx509/cms.c
index 9f745afee..7aa159cbb 100644
--- a/lib/hx509/cms.c
+++ b/lib/hx509/cms.c
@@ -344,6 +344,8 @@ find_CMSIdentifier(hx509_context context,
* @param contentType output type oid, should be freed with der_free_oid().
* @param content the data, free with der_free_octet_string().
*
+ * @return an hx509 error code.
+ *
* @ingroup hx509_cms
*/
@@ -548,6 +550,8 @@ out:
* @param content the output of the function,
* free with der_free_octet_string().
*
+ * @return an hx509 error code.
+ *
* @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
* request, free with hx509_certs_free().
*
+ * @return an hx509 error code.
+ *
* @ingroup hx509_cms
*/
@@ -1147,6 +1153,8 @@ add_one_attribute(Attribute **attr,
* @param signed_data the output of the function, free with
* der_free_octet_string().
*
+ * @return Returns an hx509 error code.
+ *
* @ingroup hx509_cms
*/
diff --git a/lib/hx509/keyset.c b/lib/hx509/keyset.c
index fcfc0b3b7..82edec3d0 100644
--- a/lib/hx509/keyset.c
+++ b/lib/hx509/keyset.c
@@ -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).
* @param certs return pointer, free with hx509_certs_free().
*
+ * @return Returns an hx509 error code.
+ *
* @ingroup hx509_keyset
*/
diff --git a/lib/krb5/deprecated.c b/lib/krb5/deprecated.c
index 96fd16656..59bae55d3 100644
--- a/lib/krb5/deprecated.c
+++ b/lib/krb5/deprecated.c
@@ -488,7 +488,8 @@ krb5_set_error_string(krb5_context context, const char *fmt, ...)
* Deprecated: use krb5_vset_error_message()
*
* @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.
*
diff --git a/lib/krb5/sp800-108-kdf.c b/lib/krb5/sp800-108-kdf.c
index fea49700e..37e06dec3 100755
--- a/lib/krb5/sp800-108-kdf.c
+++ b/lib/krb5/sp800-108-kdf.c
@@ -39,7 +39,7 @@
* As described in SP800-108 5.1 (for HMAC)
*
* @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_context A binary string containing parties, nonce, etc.
* @param md Message digest function to use for PRF.
diff --git a/lib/krb5/warn.c b/lib/krb5/warn.c
index 34a2f726c..3e29ea82a 100644
--- a/lib/krb5/warn.c
+++ b/lib/krb5/warn.c
@@ -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.
*
* @param context A Kerberos 5 context
- * @param code error code of the last error
- * @param fmt message to print
+ * @param fmt printf format string of message to print
+ * @param ... arguments for format string
*
* @ingroup krb5_error
*/