krb5_wrap: Fix documentation of smb_krb5_principal_get_realm()

Create a valid doxygen documentation. Signed-off-by: Andreas Schneider <[email protected]> Reviewed-by: Andrew Bartlett <[email protected]>
whyshan · Aug 31, 2016 · 8c3b703 · 8c3b703
1 parent e8c2525
commit 8c3b703
Showing 1 changed file with 6 additions and 8 deletions.
diff --git 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)
 {