apr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Sander Temme <san...@temme.net>
Subject [PATCH] apr_{file,network}_io.h doxygen data
Date Wed, 24 Dec 2003 23:18:21 GMT
Silence two make dox warnings with this small patch:

* Doxygen thinks a backslash precedes a command, so the backslash in the
  documentation for apr_file_gets() needs to be escaped.
* Unlike its brethren APR_INET and APR_UNSPEC, APR_INET6 did not have any
  documentation. I added a documentation line, and verified (by building
  Apache with --disable-ipv6) that neither #define nor its documentation
  are absent in this case.

Index: include/apr_file_io.h
===================================================================
RCS file: /home/cvspublic/apr/include/apr_file_io.h,v
retrieving revision 1.146
diff -u -r1.146 apr_file_io.h
--- include/apr_file_io.h       3 Sep 2003 18:37:38 -0000       1.146
+++ include/apr_file_io.h       24 Dec 2003 22:15:38 -0000
@@ -455,7 +455,7 @@
  * @param str The buffer to store the string in.
  * @param len The length of the string
  * @param thefile The file descriptor to read from
- * @remark The buffer will be '\0'-terminated if any characters are stored.
+ * @remark The buffer will be '\\0'-terminated if any characters are
stored.
  */
 APR_DECLARE(apr_status_t) apr_file_gets(char *str, int len, apr_file_t
*thefile);
 
Index: include/apr_network_io.h
===================================================================
RCS file: /home/cvspublic/apr/include/apr_network_io.h,v
retrieving revision 1.151
diff -u -r1.151 apr_network_io.h
--- include/apr_network_io.h    5 Dec 2003 01:02:31 -0000       1.151
+++ include/apr_network_io.h    24 Dec 2003 22:15:38 -0000
@@ -181,6 +181,9 @@
 #define APR_UNSPEC   0
 #endif
 #if APR_HAVE_IPV6
+/** @def APR_INET6
+ * IPv6 Address Family. Not all platforms may have this defined.
+ */
 #define APR_INET6    AF_INET6
 #endif

S.

-- 
sander@temme.net              http://www.temme.net/sander/
PGP FP: 51B4 8727 466A 0BC3 69F4  B7B8 B2BE BC40 1529 24AF


Mime
View raw message