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_{atomic,portable}.h doxygen stuff
Date Sat, 27 Dec 2003 05:41:27 GMT
The following (and attached) patch quelches three warnings. Documenting the
parameter in apr_atomic.h looks straightforward enough. As for the
apr_os_proc_mutex structure, I (but who am I) would expect that to be opaque
to the user, but os/unix/unixd.c in Apache directly accesses the crossproc
parameter. Anyway I don't see any commands in doxygen to define opaque
members, other than to wrap the members into an ifdef that does not affect
compilation but does cause doxygen to look the other way. For now I opted
for some benign prose.

Let me know if opaquization (is that a word?) would be a better option.

S.

Index: include/apr_atomic.h
===================================================================
RCS file: /home/cvspublic/apr/include/apr_atomic.h,v
retrieving revision 1.66
diff -u -r1.66 apr_atomic.h
--- include/apr_atomic.h        4 Dec 2003 20:06:03 -0000       1.66
+++ include/apr_atomic.h        27 Dec 2003 05:34:43 -0000
@@ -100,6 +100,7 @@
 /**
  * atomically set an apr_uint32_t in memory
  * @param mem pointer to the object
+ * @param val value that the object will assume
  */
 APR_DECLARE(void) apr_atomic_set32(volatile apr_uint32_t *mem, apr_uint32_t
val);
 
Index: include/apr_portable.h
===================================================================
RCS file: /home/cvspublic/apr/include/apr_portable.h,v
retrieving revision 1.89
diff -u -r1.89 apr_portable.h
--- include/apr_portable.h      26 Oct 2003 23:22:16 -0000      1.89
+++ include/apr_portable.h      27 Dec 2003 05:34:43 -0000
@@ -164,15 +164,21 @@
 /** Basic OS process mutex structure. */
 struct apr_os_proc_mutex_t {
 #if APR_HAS_SYSVSEM_SERIALIZE || APR_HAS_FCNTL_SERIALIZE ||
APR_HAS_FLOCK_SERIALIZE
-    int crossproc;
+    int crossproc; /**< Value used for SYS V Semaphore, FCNTL and FLOCK
+                    * serialization
+                    */
 #endif
 #if APR_HAS_PROC_PTHREAD_SERIALIZE
-    pthread_mutex_t *pthread_interproc;
+    pthread_mutex_t *pthread_interproc; /**< Value used for PTHREAD process
+                                         * serialization
+                                         */
 #endif
 #if APR_HAS_THREADS
     /* If no threads, no need for thread locks */
 #if APR_USE_PTHREAD_SERIALIZE
-    pthread_mutex_t *intraproc;
+    pthread_mutex_t *intraproc; /**< This value is currently unused within
+                                 * APR and Apache
+                                 */
 #endif
 #endif
 };


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


Mime
View raw message