You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by rb...@locus.apache.org on 2000/08/08 07:57:14 UTC
cvs commit: apache-2.0/src/include util_md5.h util_uri.h util_xml.h
rbb 00/08/07 22:57:14
Modified: src/include util_md5.h util_uri.h util_xml.h
Log:
Document the util_md5.h file using ScanDoc. Also add package directives
to util_xml and util_uri headers
Revision Changes Path
1.15 +37 -0 apache-2.0/src/include/util_md5.h
Index: util_md5.h
===================================================================
RCS file: /home/cvs/apache-2.0/src/include/util_md5.h,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- util_md5.h 2000/08/06 06:07:01 1.14
+++ util_md5.h 2000/08/08 05:57:13 1.15
@@ -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
1.9 +11 -2 apache-2.0/src/include/util_uri.h
Index: util_uri.h
===================================================================
RCS file: /home/cvs/apache-2.0/src/include/util_uri.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- util_uri.h 2000/08/08 04:59:31 1.8
+++ util_uri.h 2000/08/08 05:57:13 1.9
@@ -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
1.4 +3 -0 apache-2.0/src/include/util_xml.h
Index: util_xml.h
===================================================================
RCS file: /home/cvs/apache-2.0/src/include/util_xml.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- util_xml.h 2000/08/08 05:39:09 1.3
+++ util_xml.h 2000/08/08 05:57:14 1.4
@@ -62,6 +62,9 @@
#include "httpd.h"
#include "apr_lib.h"
+/**
+ * @package Apache XML library
+ */
/* -------------------------------------------------------------------- */