]> git.ipfire.org Git - thirdparty/krb5.git/commitdiff
Reword krb5_unparse_name_ext doxygen markup
authorGreg Hudson <ghudson@mit.edu>
Tue, 20 Nov 2012 17:33:14 +0000 (12:33 -0500)
committerGreg Hudson <ghudson@mit.edu>
Tue, 20 Nov 2012 17:33:14 +0000 (12:33 -0500)
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

src/include/krb5/krb5.hin

index 8c56afd55895dc91880629f87944916e4be6bedf..865785eb25b820d2eb8369ad54dad73bfb5b3162 100644 (file)
@@ -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().
  *