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/06 07:17:54 UTC
cvs commit: apache-2.0/src/include util_charset.h
rbb 00/08/05 22:17:53
Modified: src/include util_charset.h
Log:
Document util_charset.h using ScanDoc
Revision Changes Path
1.4 +25 -4 apache-2.0/src/include/util_charset.h
Index: util_charset.h
===================================================================
RCS file: /home/cvs/apache-2.0/src/include/util_charset.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- util_charset.h 2000/08/02 05:25:29 1.3
+++ util_charset.h 2000/08/06 05:17:52 1.4
@@ -65,10 +65,27 @@
extern "C" {
#endif
+/**
+ * @package charset conversion
+ */
#include "apr_xlate.h"
-extern apr_xlate_t *ap_hdrs_to_ascii, *ap_hdrs_from_ascii;
-extern apr_xlate_t *ap_locale_to_ascii, *ap_locale_from_ascii;
+/** On EBCDIC machine this is a translation handle used to translate the
+ * headers from the local machine format to ASCII for network transmission.
+ * On an ASCII machine this is NULL */
+extern apr_xlate_t *ap_hdrs_to_ascii;
+/** On EBCDIC machine this is a translation handle used to translate the
+ * headers from ASCII to the local machine format after network transmission.
+ * On an ASCII machine this is NULL */
+extern apr_xlate_t *ap_hdrs_from_ascii;
+/** On EBCDIC machine this is a translation handle used to translate the
+ * content from the local machine format to ASCII for network transmission.
+ * On an ASCII machine this is NULL */
+extern apr_xlate_t *ap_locale_to_ascii;
+/** On EBCDIC machine this is a translation handle used to translate the
+ * content from ASCII to the local machine format after network transmission.
+ * On an ASCII machine this is NULL */
+extern apr_xlate_t *ap_locale_from_ascii;
/* Save & Restore the current conversion settings
*
@@ -100,8 +117,12 @@
#define AP_POP_OUTPUTCONVERSION_STATE(_buff) \
ap_bsetopt(_buff, BO_WXLATE, &saved_output_xlate)
-/* ap_set_content_xlate() is called by Apache core or a module to set
- * up character set translation (a.k.a. recoding) for content.
+/**
+ * set up character set translation (a.k.a. recoding) for content.
+ * @param r The current request
+ * @param output Is this content outgoing or incoming
+ * @param The translation handle to use for the actual work
+ * @deffunc apr_status_t ap_set_content_xlate(request_rec *r, int output, apr_xlate_t *xlate)
*/
API_EXPORT(apr_status_t) ap_set_content_xlate(request_rec *r, int output,
apr_xlate_t *xlate);