httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jaillet...@apache.org
Subject svn commit: r1635905 - in /httpd/httpd/branches/2.4.x: STATUS include/util_charset.h include/util_ebcdic.h server/util_charset.c
Date Sat, 01 Nov 2014 09:19:18 GMT
Author: jailletc36
Date: Sat Nov  1 09:19:17 2014
New Revision: 1635905

URL: http://svn.apache.org/r1635905
Log:
Merge r1611858, r1611908, r1611916 from trunk

doc: improve doxygen output for util_ebcdic.h and util_charset.h.

Submitted by: jailletc36
Reviewed by: jailletc36, rjung, ylavic
Backported by: jailletc36

Modified:
    httpd/httpd/branches/2.4.x/STATUS
    httpd/httpd/branches/2.4.x/include/util_charset.h
    httpd/httpd/branches/2.4.x/include/util_ebcdic.h
    httpd/httpd/branches/2.4.x/server/util_charset.c

Modified: httpd/httpd/branches/2.4.x/STATUS
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/STATUS?rev=1635905&r1=1635904&r2=1635905&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/STATUS (original)
+++ httpd/httpd/branches/2.4.x/STATUS Sat Nov  1 09:19:17 2014
@@ -102,14 +102,6 @@ RELEASE SHOWSTOPPERS:
 PATCHES ACCEPTED TO BACKPORT FROM TRUNK:
   [ start all new proposals below, under PATCHES PROPOSED. ]
 
-   * doc: improve doxygen output for util_ebcdic.h and util_charset.h.
-     I propose it for vote because of the #if defined(DOXYGEN)
-     trunk patch: http://svn.apache.org/r1611858
-                  http://svn.apache.org/r1611908
-                  http://svn.apache.org/r1611916
-     2.4.x patch: trunk patch works
-     +1: jailletc36, rjung, ylavic
-
    * style fix
      trunk patch: http://svn.apache.org/r1633031
                   http://svn.apache.org/r1633522
@@ -220,7 +212,7 @@ PATCHES PROPOSED TO BACKPORT FROM TRUNK:
      2.4.x patch: trunk works
      +1 jkaluza
  
-    *core: Support custom ErrorDocuments for HTTP 501 and 414 status codes.
+   * core: Support custom ErrorDocuments for HTTP 501 and 414 status codes.
      PR 57167 
      trunk patch: http://svn.apache.org/r1635762
      2.4.x patch: trunk works

Modified: httpd/httpd/branches/2.4.x/include/util_charset.h
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/include/util_charset.h?rev=1635905&r1=1635904&r2=1635905&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/include/util_charset.h (original)
+++ httpd/httpd/branches/2.4.x/include/util_charset.h Sat Nov  1 09:19:17 2014
@@ -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()
  * @{
  */
 
@@ -32,17 +42,24 @@ extern "C" {
 
 #include "apr.h"
 
-#if APR_CHARSET_EBCDIC
+#if APR_CHARSET_EBCDIC || defined(DOXYGEN)
 
 #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 NULL */
+/**
+ * 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 NULL */
+
+/**
+ * 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 */

Modified: httpd/httpd/branches/2.4.x/include/util_ebcdic.h
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/include/util_ebcdic.h?rev=1635905&r1=1635904&r2=1635905&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/include/util_ebcdic.h (original)
+++ httpd/httpd/branches/2.4.x/include/util_ebcdic.h Sat Nov  1 09:19:17 2014
@@ -35,35 +35,43 @@ extern "C" {
 #include "httpd.h"
 #include "util_charset.h"
 
-#if APR_CHARSET_EBCDIC
+#if APR_CHARSET_EBCDIC || defined(DOXYGEN)
 
 /**
- * Setup all of the global translation handlers
- * @param pool pool to allocate out of
+ * Setup all of the global translation handlers.
+ * @param   pool    The pool to allocate out of.
+ * @note On non-EBCDIC system, this function does <b>not</b> exist.
+ * So, its use should be guarded by \#if APR_CHARSET_EBCDIC.
  */
 apr_status_t ap_init_ebcdic(apr_pool_t *pool);
 
 /**
  * Convert protocol data from the implementation character
  * set to ASCII.
- * @param buffer buffer to translate
- * @param len number of bytes to translate
+ * @param   buffer  Buffer to translate.
+ * @param   len     Number of bytes to translate.
+ * @note On non-EBCDIC system, this function is replaced by an 
+ * empty macro.
  */
 void ap_xlate_proto_to_ascii(char *buffer, apr_size_t len);
 
 /**
  * Convert protocol data to the implementation character
  * set from ASCII.
- * @param buffer buffer to translate
- * @param len number of bytes to translate
+ * @param   buffer  Buffer to translate.
+ * @param   len     Number of bytes to translate.
+ * @note On non-EBCDIC system, this function is replaced by an 
+ * empty macro.
  */
 void ap_xlate_proto_from_ascii(char *buffer, apr_size_t len);
 
 /**
- * Convert protocol data from the implementation charater
+ * Convert protocol data from the implementation character
  * set to ASCII, then send it.
- * @param r   the current request
- * @param ... the strings to write, followed by a NULL pointer
+ * @param   r       The current request.
+ * @param   ...     The strings to write, followed by a NULL pointer.
+ * @note On non-EBCDIC system, this function is replaced by a call to
+ * #ap_rvputs.
  */
 int ap_rvputs_proto_in_ascii(request_rec *r, ...);
 

Modified: httpd/httpd/branches/2.4.x/server/util_charset.c
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/server/util_charset.c?rev=1635905&r1=1635904&r2=1635905&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/server/util_charset.c (original)
+++ httpd/httpd/branches/2.4.x/server/util_charset.c Sat Nov  1 09:19:17 2014
@@ -23,20 +23,6 @@
 #include "http_core.h"
 #include "util_charset.h"
 
-/* ap_hdrs_to_ascii, ap_hdrs_from_ascii
- *
- * 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.
- *
- * For an ASCII machine, these remain NULL so that when they are stored
- * in the BUFF via ap_bsetop(BO_RXLATE) it ensures that no translation is
- * performed.
- */
-
 apr_xlate_t *ap_hdrs_to_ascii, *ap_hdrs_from_ascii;
 
 #endif /*APR_CHARSET_EBCDIC */



Mime
View raw message