Document the util_md5.h file using ScanDoc. Also add package directives

to util_xml and util_uri headers


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@86024 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 37 insertions, 0 deletions

diff --git a/include/util_md5.h b/include/util_md5.h
index 94721e86f9..71a87a99a2 100644
--- a/include/util_md5.h
+++ b/include/util_md5.h
@@ -63,12 +63,49 @@
 extern "C" {
 #endif
 
+/**
+ * @package Apache MD5 library
+ */
+
 #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
+ * @return The checksum
+ * @deffunc char *ap_md5(apr_pool_t *a, const unsigned char *string)
+ */
 API_EXPORT(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
+ * @return The checksum
+ * @deffunc char *ap_md5_binary(apr_pool_t *a, const unsigned char *buf, int len)
+ */
 API_EXPORT(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
+ * @return The converted encoding
+ * @deffunc char *ap_md5contextTo64(apr_pool_t *p, apr_md5_ctx_t *context)
+ */
 API_EXPORT(char *) ap_md5contextTo64(apr_pool_t *p, apr_md5_ctx_t *context);
+
 #ifdef APACHE_XLATE
+/**
+ * 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
+ * @param xlate The translation header to use.
+ * @warning The xlate parameter is only available if APACHE_XLATE is defined
+ * @deffunc char *ap_md5digest(apr_pool_t *p, apr_file_t *infile, apr_xlate_t *xlate)
+ */
 API_EXPORT(char *) ap_md5digest(apr_pool_t *p, apr_file_t *infile,
                                 apr_xlate_t *xlate);
 #else