httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jaillet...@apache.org
Subject svn commit: r1611203 - /httpd/httpd/branches/2.4.x/include/util_md5.h
Date Wed, 16 Jul 2014 22:11:34 GMT
Author: jailletc36
Date: Wed Jul 16 22:11:33 2014
New Revision: 1611203

URL: http://svn.apache.org/r1611203
Log:
Improve doxygen comment.

Improve layout, add trailing '.' in function description, remove unneeded @fn.

Modified:
    httpd/httpd/branches/2.4.x/include/util_md5.h

Modified: httpd/httpd/branches/2.4.x/include/util_md5.h
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/include/util_md5.h?rev=1611203&r1=1611202&r2=1611203&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/include/util_md5.h (original)
+++ httpd/httpd/branches/2.4.x/include/util_md5.h Wed Jul 16 22:11:33 2014
@@ -33,38 +33,34 @@ extern "C" {
 #include "apr_md5.h"
 
 /**
- * Create an MD5 checksum of a given string
- * @param a Pool to allocate out of
- * @param string String to get the checksum of
+ * Create an MD5 checksum of a given string.
+ * @param   a       Pool to allocate out of
+ * @param   string  String to get the checksum of
  * @return The checksum
- * @fn char *ap_md5(apr_pool_t *a, const unsigned char *string)
  */
 AP_DECLARE(char *) ap_md5(apr_pool_t *a, const unsigned char *string);
 
 /**
- * Create an MD5 checksum of a string of binary data
- * @param a Pool to allocate out of
- * @param buf Buffer to generate checksum for
- * @param len The length of the buffer
+ * Create an MD5 checksum of a string of binary data.
+ * @param   a       Pool to allocate out of
+ * @param   buf     Buffer to generate checksum for
+ * @param   len     The length of the buffer
  * @return The checksum
- * @fn char *ap_md5_binary(apr_pool_t *a, const unsigned char *buf, int len)
  */
 AP_DECLARE(char *) ap_md5_binary(apr_pool_t *a, const unsigned char *buf, int len);
 
 /**
- * Convert an MD5 checksum into a base64 encoding
- * @param p The pool to allocate out of
- * @param context The context to convert
+ * Convert an MD5 checksum into a base64 encoding.
+ * @param   p       The pool to allocate out of
+ * @param   context The context to convert
  * @return The converted encoding
- * @fn char *ap_md5contextTo64(apr_pool_t *p, apr_md5_ctx_t *context)
  */
 AP_DECLARE(char *) ap_md5contextTo64(apr_pool_t *p, apr_md5_ctx_t *context);
 
 /**
- * Create an MD5 Digest for a given file
- * @param p The pool to allocate out of
- * @param infile The file to create the digest for
- * @fn char *ap_md5digest(apr_pool_t *p, apr_file_t *infile)
+ * Create an MD5 Digest for a given file.
+ * @param   p       The pool to allocate out of
+ * @param   infile  The file to create the digest for
  */
 AP_DECLARE(char *) ap_md5digest(apr_pool_t *p, apr_file_t *infile);
 



Mime
View raw message