Add documentation for krb5_error_code

ticket: 8387 (new)
target_version: 1.14-next
tags: pullup

diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 9e91a60d2c0d460a704c0181f96a11774851adb0..c045ee3770a09595965c28cd160ad0288b96c3a0 100644 (file)
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -182,9 +182,15 @@ typedef krb5_int32 krb5_cryptotype;
 typedef krb5_int32      krb5_preauthtype; /* This may change, later on */
 typedef krb5_int32      krb5_flags;
 typedef krb5_int32      krb5_timestamp;
-typedef krb5_int32      krb5_error_code;
 typedef krb5_int32      krb5_deltat;
 
+/**
+ * Used to convey an operation status.  The value 0 indicates success; any
+ * other values are com_err codes.  Use krb5_get_error_message() to obtain a
+ * string describing the error.
+ */
+typedef krb5_int32      krb5_error_code;
+
 typedef krb5_error_code krb5_magic;
 
 typedef struct _krb5_data {