From: Andreas Schneider <asn@samba.org>
Date: Mon, 29 Aug 2016 07:32:25 +0000 (+0200)
Subject: krb5_wrap: Document smb_krb5_enctype_to_string()
X-Git-Tag: tevent-0.9.31~568
X-Git-Url: http://git.samba.org/?a=commitdiff_plain;h=8abd9b5f079a87a368372bd5e8092830734059f7;p=samba.git

krb5_wrap: Document smb_krb5_enctype_to_string()

Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
---

diff --git a/lib/krb5_wrap/krb5_samba.c b/lib/krb5_wrap/krb5_samba.c
index 7eeee75cbc9..a3fdee52946 100644
--- a/lib/krb5_wrap/krb5_samba.c
+++ b/lib/krb5_wrap/krb5_samba.c
@@ -937,7 +937,20 @@ krb5_error_code smb_krb5_kt_free_entry(krb5_context context,
 }
 
 
-/* caller needs to free etype_s */
+/**
+ * @brief Convert an encryption type to a string.
+ *
+ * @param[in]  context The library context.
+ *
+ * @param[in]  enctype The encryption type.
+ *
+ * @param[in]  etype_s A pointer to store the allocated encryption type as a
+ *                     string.
+ *
+ * @return 0 on success, a Kerberos error code otherwise.
+ *
+ * The caller needs to free the allocated string etype_s.
+ */
 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
 					   krb5_enctype enctype,
 					   char **etype_s)