Move comment from .c to .h in order to make use of it in doxygen.

Fix the comment that states that these vars are NULL on ASCII machine, they seem to be undefined instead.
Rework some comments.

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

1 files changed, 22 insertions, 8 deletions

diff --git a/include/util_charset.h b/include/util_charset.h
index 677b7dce9b..9df000d795 100644
--- a/include/util_charset.h
+++ b/include/util_charset.h
@@ -20,6 +20,16 @@
  *
  * @defgroup APACHE_CORE_CHARSET Charset Conversion
  * @ingroup  APACHE_CORE
+ * 
+ * These are the translation handles used to translate between the network
+ * format of protocol headers and the local machine format.
+ *
+ * For an EBCDIC machine, these are valid handles which are set up at
+ * initialization to translate between ISO-8859-1 and the code page of
+ * the source code.\n
+ * For an ASCII machine, they are undefined.
+ * 
+ * @see ap_init_ebcdic()
  * @{
  */
 
@@ -36,16 +46,20 @@ extern "C" {
 
 #include "apr_xlate.h"
 
-/** 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 not defined. */
+/**
+ * On EBCDIC machine this is a translation handle used to translate the
+ * headers from the local machine format to ASCII for network transmission.
+ * @note On ASCII system, this variable does <b>not</b> exist.
+ * So, its use should be guarded by \#if APR_CHARSET_EBCDIC.
+ */
 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 not defined. */
+/**
+ * On EBCDIC machine this is a translation handle used to translate the
+ * headers from ASCII to the local machine format after network transmission.
+ * @note On ASCII system, this variable does <b>not</b> exist.
+ * So, its use should be guarded by \#if APR_CHARSET_EBCDIC.
+ */
 extern apr_xlate_t *ap_hdrs_from_ascii;
 
 #endif  /* APR_CHARSET_EBCDIC */