From 8757ea7ba8a18177a3b440e169df4dafb6a63d43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Love=20H=C3=B6rnquist=20=C3=85strand?= Date: Sat, 10 Nov 2007 10:36:37 +0000 Subject: [PATCH] Doxygen documentation. git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@22026 ec53bebd-3082-4978-b11e-865c3cabbd6b --- lib/krb5/error_string.c | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/lib/krb5/error_string.c b/lib/krb5/error_string.c index b5cea21ad..211f07c85 100644 --- a/lib/krb5/error_string.c +++ b/lib/krb5/error_string.c @@ -108,6 +108,19 @@ krb5_have_error_string(krb5_context context) return str != NULL; } +/** + * Return the error message for `code' in context. On error the + * function returns NULL. + * + * @param context Kerberos 5 context + * @param code Error code related to the error + * + * @return an error string, needs to be freed with krb5_xfree(). The + * functions return NULL on error. + * + * @ingroup krb5_error + */ + char * KRB5_LIB_FUNCTION krb5_get_error_message(krb5_context context, krb5_error_code code) {