krb5_wrap: Document smb_krb5_free_addresses()

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 26a4cae4d319eac57bbb4d0b9ebd466c7c8f503a..995ba5b357b6c640e140b6fa6ae984fa40d8c3b5 100644 (file)
--- a/lib/krb5_wrap/krb5_samba.c
+++ b/lib/krb5_wrap/krb5_samba.c
@@ -758,7 +758,17 @@ done:
        return ret;
 }
 
- krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr)
+/**
+ * @brief Free the data stored in an smb_krb5_addresses structure.
+ *
+ * @param[in]  context  The library context
+ *
+ * @param[in]  addr     The address structure to free.
+ *
+ * @return 0 on success, a Kerberos error code otherwise.
+ */
+krb5_error_code smb_krb5_free_addresses(krb5_context context,
+                                       smb_krb5_addresses *addr)
 {
        krb5_error_code ret = 0;
        if (addr == NULL) {