[27277] in CVS-changelog-for-Kerberos-V5
krb5 commit: Reword krb5_unparse_name_ext doxygen markup
daemon@ATHENA.MIT.EDU (Greg Hudson)
Tue Nov 20 12:36:43 2012
Date: Tue, 20 Nov 2012 12:36:40 -0500
From: Greg Hudson <ghudson@mit.edu>
Message-Id: <201211201736.qAKHae5b018499@drugstore.mit.edu>
To: cvs-krb5@mit.edu
Reply-To: krbdev@mit.edu
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: cvs-krb5-bounces@mit.edu
https://github.com/krb5/krb5/commit/8ca5a84d3af27283ca6ef309e9e634bfb4ce52da
commit 8ca5a84d3af27283ca6ef309e9e634bfb4ce52da
Author: Greg Hudson <ghudson@mit.edu>
Date: Tue Nov 20 12:33:14 2012 -0500
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
src/include/krb5/krb5.hin | 11 ++++++-----
1 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 8c56afd..865785e 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().
*
_______________________________________________
cvs-krb5 mailing list
cvs-krb5@mit.edu
https://mailman.mit.edu/mailman/listinfo/cvs-krb5
