From 907c0b92b783a3516ad93fb6861abb3f9a0fe0ee Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Tue, 30 Aug 2016 14:17:19 +0200 Subject: [PATCH] krb5_wrap: Improve smb_krb5_unparse_name() documentation Signed-off-by: Andreas Schneider Reviewed-by: Andrew Bartlett --- lib/krb5_wrap/krb5_samba.c | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/lib/krb5_wrap/krb5_samba.c b/lib/krb5_wrap/krb5_samba.c index 0cd20e7d008..02eb3ac9447 100644 --- a/lib/krb5_wrap/krb5_samba.c +++ b/lib/krb5_wrap/krb5_samba.c @@ -466,11 +466,26 @@ krb5_error_code smb_krb5_parse_name(krb5_context context, return ret; } -/************************************************************** - krb5_parse_name that returns a UNIX charset name. Must - be freed with talloc_free() call. -**************************************************************/ - +/** + * @brief Convert a Kerberos principal structure to a string representation. + * + * The resulting string representation will be a unix charset name and is + * talloc'ed. + * + * @param[in] mem_ctx The talloc context to allocate memory on. + * + * @param[in] context The library context. + * + * @param[in] principal The principal. + * + * @param[out] unix_name A string representation of the princpial name as with + * unix charset. + * + * Use talloc_free() to free the string representation if it is no longer + * needed. + * + * @return 0 on success, a Kerberos error code otherwise. + */ krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx, krb5_context context, krb5_const_principal principal, -- 2.11.4.GIT