document krb5_clear_error_string

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@23919 ec53bebd-3082-4978-b11e-865c3cabbd6b
2008-10-14 02:57:12 +00:00
parent f537ed70c6
commit 51124e047e
1 changed files with 9 additions and 0 deletions
--- a/lib/krb5/error_string.c
+++ b/lib/krb5/error_string.c
@@ -257,6 +257,15 @@ krb5_vset_error_string(krb5_context context, const char *fmt, va_list args)
    return 0;
 }

+/**
+ * Clar the error message returned by krb5_get_error_string(),
+ * deprecated, use krb5_clear_error_message().
+ *
+ * @param context Kerberos context
+ *
+ * @ingroup krb5_deprecated
+ */
+
 void KRB5_LIB_FUNCTION
 krb5_clear_error_string(krb5_context context)
     __attribute__((deprecated))