svn commit: r1611858 - /httpd/httpd/trunk/include/util_ebcdic.h

[ja...@apache.org]

Author: jailletc36
Date: Sat Jul 19 08:35:51 2014
New Revision: 1611858

URL: http://svn.apache.org/r1611858
Log:
Improve doxygen comment.

Improve layout, fix typo, generate relevant doc even if build on non-EBCDIC system + add note that these functions are mostly noop on non-EBCDIC system.

Modified:
    httpd/httpd/trunk/include/util_ebcdic.h

Modified: httpd/httpd/trunk/include/util_ebcdic.h
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/util_ebcdic.h?rev=1611858&r1=1611857&r2=1611858&view=diff
==============================================================================
--- httpd/httpd/trunk/include/util_ebcdic.h (original)
+++ httpd/httpd/trunk/include/util_ebcdic.h Sat Jul 19 08:35:51 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, ...);