diff options
| author | Andreas Schneider <asn@samba.org> | 2016-08-29 17:11:32 +0200 |
|---|---|---|
| committer | Andrew Bartlett <abartlet@samba.org> | 2016-08-31 20:59:16 +0200 |
| commit | 8c3b703068dfe372443c5033f42ae5f216e1801a (patch) | |
| tree | c5a0c6afbafce618e72c885b3b4615c30b6bc600 /lib/krb5_wrap | |
| parent | e8c2525e5578172d8f1fd1e86c571ed491fd2c11 (diff) | |
| download | samba-8c3b703068dfe372443c5033f42ae5f216e1801a.tar.gz | |
krb5_wrap: Fix documentation of smb_krb5_principal_get_realm()
Create a valid doxygen documentation.
Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Diffstat (limited to 'lib/krb5_wrap')
| -rw-r--r-- | lib/krb5_wrap/krb5_samba.c | 14 |
1 files changed, 6 insertions, 8 deletions
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) { |