krb5 commit: Add documentation for krb5_error_code

[Greg Hudson]

https://github.com/krb5/krb5/commit/4d02def02a172bdfc5c5c2c9059cef559d8c1feb
commit 4d02def02a172bdfc5c5c2c9059cef559d8c1feb
Author: Sarah Day <sarahday at mit.edu>
Date:   Fri Dec 11 11:46:04 2015 -0500

    Add documentation for krb5_error_code
    
    ticket: 8387 (new)
    target_version: 1.14-next
    tags: pullup

 src/include/krb5/krb5.hin |    8 +++++++-
 1 files changed, 7 insertions(+), 1 deletions(-)

diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 9e91a60..c045ee3 100644
--- 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 {