krb5 commit [krb5-1.11]: Reword krb5_unparse_name_ext doxygen markup

Tom Yu tlyu at MIT.EDU
Tue Nov 20 15:44:12 EST 2012


https://github.com/krb5/krb5/commit/53981dc2d4a6e657e4bcbe7f78ffb16d16bcef4c
commit 53981dc2d4a6e657e4bcbe7f78ffb16d16bcef4c
Author: Greg Hudson <ghudson at 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.
    
    (cherry picked from commit 8ca5a84d3af27283ca6ef309e9e634bfb4ce52da)
    
    ticket: 7452
    version_fixed: 1.11
    status: resolved

 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 7db3787..755b160 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().
  *


More information about the cvs-krb5 mailing list