Document util_ebcdic.h with ScanDoc

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

diff --git a/include/util_ebcdic.h b/include/util_ebcdic.h
index 71589c551243e1f03ac5db7bdf31d113babd39e3..6086fc33af2896524f035906748f85ab881fe897 100644 (file)
--- a/include/util_ebcdic.h
+++ b/include/util_ebcdic.h
@@ -66,11 +66,25 @@ extern "C" {
 #endif
 
 #include "apr_xlate.h"
+#include "httpd.h"
 #include "util_charset.h"
 
-apr_status_t ap_init_ebcdic(apr_pool_t *);
+/**
+ * @package Utilities for EBCDIC conversion
+ */
+
+/**
+ * Setup all of the global translation handlers
+ * @param pool pool to allocate out of
+ */
+apr_status_t ap_init_ebcdic(apr_pool_t *pool);
 
-apr_xlate_t *ap_checkconv(struct request_rec *);
+/**
+ * Check the Content-Type to decide if conversion is needed 
+ * @param r The current request
+ * @return The translation handle to use for the conversion if one is needed
+ */
+apr_xlate_t *ap_checkconv(request_rec *r);
 
 #ifdef __cplusplus
 }