From 8c3b703068dfe372443c5033f42ae5f216e1801a Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Mon, 29 Aug 2016 17:11:32 +0200 Subject: krb5_wrap: Fix documentation of smb_krb5_principal_get_realm() Create a valid doxygen documentation. Signed-off-by: Andreas Schneider Reviewed-by: Andrew Bartlett --- lib/krb5_wrap/krb5_samba.c | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) (limited to 'lib/krb5_wrap') diff --git a/lib/krb5_wrap/krb5_samba.c b/lib/krb5_wrap/krb5_samba.c index b797989ebb2..0de12c63d25 100644 --- a/lib/krb5_wrap/krb5_samba.c +++ b/lib/krb5_wrap/krb5_samba.c @@ -2510,19 +2510,17 @@ krb5_error_code smb_krb5_make_pac_checksum(TALLOC_CTX *mem_ctx, } -/* - * smb_krb5_principal_get_realm - * +/** * @brief Get realm of a principal * - * @param[in] context The krb5_context - * @param[in] principal The principal - * @return pointer to the realm + * @param[in] context The library context + * + * @param[in] principal The principal to get the realm from. * - * Caller must free if the return value is not NULL. + * @return An allocated string with the realm or NULL if an error occured. * + * The caller must free the realm string with free() if not needed anymore. */ - char *smb_krb5_principal_get_realm(krb5_context context, krb5_const_principal principal) { -- cgit v1.2.1