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_errno.h doxygen data and status checker
Date Wed, 24 Dec 2003 06:41:29 GMT
APR HEAD's make dox target complains about a duplicate group closing tag in
apr_errno.h:

> /Volumes/Files/projects/asf/apr/apr/include/apr_errno.h:1242: Warning: end of
group without matching begin.

Browsing through the file, I found /** @} */ comments at lines 797 and 1150.
I decided to get rid of the latter one, since the lines between the tags do
not contain any doxygen data anyway.

I got rid of an additional warning:

> /Volumes/Files/projects/asf/apr/apr/include/apr_errno.h:311: Warning: Member
APR_ENOTENOUGHENTROPY of group APR_Error is not documented.

by adding a simple status checker and referring to that in the
ENOTENOUGHENTROPY comment. I modified test/testrand2.c to use the new status
checker instead of directly asserting APR_ENOTENOUGHENTROPY:

Index: include/apr_errno.h
===================================================================
RCS file: /home/cvspublic/apr/include/apr_errno.h,v
retrieving revision 1.114
diff -u -r1.114 apr_errno.h
--- include/apr_errno.h 3 Nov 2003 13:25:00 -0000       1.114
+++ include/apr_errno.h 24 Dec 2003 06:36:00 -0000
@@ -308,6 +308,7 @@
 /** @see APR_STATUS_IS_EPROC_UNKNOWN */
 #define APR_EPROC_UNKNOWN  (APR_OS_START_ERROR + 27)
 
+/** @see APR_STATUS_IS_ENOTENOUGHENTROPY */
 #define APR_ENOTENOUGHENTROPY (APR_OS_START_ERROR + 28)
 /** @} */
 
@@ -397,6 +398,9 @@
 /** The given process was not recognized by APR. */
 #define APR_STATUS_IS_EPROC_UNKNOWN(s)  ((s) == APR_EPROC_UNKNOWN)
 
+/** APR could not gather enough entropy to continue. */
+#define APR_STATUS_IS_ENOTENOUGHENTROPY(s) ((s) == APR_ENOTENOUGHENTROPY)
+
 /** @} */
 
 /** 
@@ -1147,7 +1151,6 @@
  */
 #define apr_get_netos_error() (errno)
 #define apr_set_netos_error(e) (errno = (e))
-/** @} */
 
 /** 
  * @addtogroup APR_STATUS_IS
Index: test/testrand2.c
===================================================================
RCS file: /home/cvspublic/apr/test/testrand2.c,v
retrieving revision 1.5
diff -u -r1.5 testrand2.c
--- test/testrand2.c    16 Nov 2003 23:49:15 -0000      1.5
+++ test/testrand2.c    24 Dec 2003 06:36:00 -0000
@@ -134,7 +134,7 @@
     for(i=0 ; i < count ; ++i)
         rand_add_zeroes(r);
     rv=f(r,c,1);
-    CuAssertIntEquals(tc,rv,APR_ENOTENOUGHENTROPY);
+    CuAssertIntEquals(tc,1,APR_STATUS_IS_ENOTENOUGHENTROPY(rv));
     }
 
 static void rand_seed_short(CuTest *tc)

The above compiles and runs on my Panther laptop.

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