From a843a52c130cedde8f7b5c1eb02491ea5e733297 Mon Sep 17 00:00:00 2001
From: Ryan Bloom <rbb@apache.org>
Date: Tue, 8 Aug 2000 05:57:14 +0000
Subject: [PATCH] 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
---
 include/util_md5.h | 37 +++++++++++++++++++++++++++++++++++++
 include/util_uri.h | 13 +++++++++++--
 include/util_xml.h |  3 +++
 3 files changed, 51 insertions(+), 2 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
diff --git a/include/util_uri.h b/include/util_uri.h
index 47ab91f140..e914ee6c49 100644
--- a/include/util_uri.h
+++ b/include/util_uri.h
@@ -67,10 +67,19 @@
 extern "C" {
 #endif
 
-typedef struct {
+/**
+ * @package Apache URI library
+ */
+
+typedef struct schemes_t;
+
+/** Structure to store various schemes and their default ports */
+struct schemes_t {
+    /** The name of the scheme */
     const char *name;
+    /** The default port for the scheme */
     unsigned short default_port;
-} schemes_t;
+};
 
 #define	DEFAULT_FTP_DATA_PORT	20
 #define	DEFAULT_FTP_PORT	21
diff --git a/include/util_xml.h b/include/util_xml.h
index 6864ffafbf..cdab08e8a2 100644
--- a/include/util_xml.h
+++ b/include/util_xml.h
@@ -62,6 +62,9 @@ extern "C" {
 #include "httpd.h"
 #include "apr_lib.h"
 
+/**
+ * @package Apache XML library
+ */
 
 /* -------------------------------------------------------------------- */
 
-- 
2.40.0