summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorGreg Hudson <ghudson@mit.edu>2012-11-20 12:33:14 -0500
committerGreg Hudson <ghudson@mit.edu>2012-11-20 12:33:14 -0500
commit8ca5a84d3af27283ca6ef309e9e634bfb4ce52da (patch)
tree82e2bc6eff1428d88bfbaac7588ccdaf376ae518 /src
parent703ee0a74900d9acb8dd48f60149a34e1b7411a8 (diff)
downloadkrb5-8ca5a84d3af27283ca6ef309e9e634bfb4ce52da.tar.gz
krb5-8ca5a84d3af27283ca6ef309e9e634bfb4ce52da.tar.xz
krb5-8ca5a84d3af27283ca6ef309e9e634bfb4ce52da.zip
Reword krb5_unparse_name_ext doxygen markup
Avoid using asterix characters in the documentation for krb5_unparse_ext_name, since they get intepreted as markdown punctuation when translated to RST. ticket: 7452 (new) target_version: 1.11 tags: pullup
Diffstat (limited to 'src')
-rw-r--r--src/include/krb5/krb5.hin11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 8c56afd55..865785eb2 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -3513,11 +3513,12 @@ krb5_unparse_name(krb5_context context, krb5_const_principal principal,
* @param [in,out] size Size of unparsed name
*
* This function is similar to krb5_unparse_name(), but allows the use of an
- * existing buffer for the result. If size is not NULL, then *name must be
- * either NULL or an existing buffer of at least size *size. The buffer will
- * be allocated or resized if necessary, with the new pointer stored into
- * *name. Whether or not the buffer is resized, the necessary space for the
- * result, including null terminator, will be stored into *size.
+ * existing buffer for the result. If size is not NULL, then @a name must
+ * point to either NULL or an existing buffer of at least the size pointed to
+ * by @a size. The buffer will be allocated or resized if necessary, with the
+ * new pointer stored into @a name. Whether or not the buffer is resized, the
+ * necessary space for the result, including null terminator, will be stored
+ * into @a size.
*
* If size is NULL, this function behaves exactly as krb5_unparse_name().
*