apr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ian Holsman <i...@cnet.com>
Subject [PATCHDOX] apr_portable.h
Date Sat, 11 Aug 2001 17:10:14 GMT
Fixing the ones that complain the most first
Index: apr_portable.h
===================================================================
RCS file: /home/cvspublic/apr/include/apr_portable.h,v
retrieving revision 1.66
diff -u -r1.66 apr_portable.h
--- apr_portable.h      2001/08/06 21:11:15     1.66
+++ apr_portable.h      2001/08/11 17:05:15
@@ -58,9 +58,14 @@
  */
 #ifndef APR_PORTABLE_H
 #define APR_PORTABLE_H
-
+/*
+ * @file apr_portable.h
+ * @brief APR Portability Routines
+ */
 /**
- * @package APR portability Routines
+ * @defgroup APR_portability Portability Routines
+ * @ingroup APR
+ * @{
  */

 #include "apr.h"
@@ -202,15 +207,19 @@
 #endif

 /**
+ * @typedef apr_os_sock_t
+ * @brief alias for local OS socket
+ */
+/**
  * everything APR needs to know about an active socket to construct
  * an APR socket from it; currently, this is platform-independent
  */
 struct apr_os_sock_info_t {
-    apr_os_sock_t *os_sock; /* always required */
-    struct sockaddr *local; /* NULL if not yet bound */
-    struct sockaddr *remote; /* NULL if not connected */
-    int family;             /* always required (APR_INET, APR_INET6, 
etc. */
-    int type;               /* always required (SOCK_STREAM, 
SOCK_DGRAM, etc. */
+    apr_os_sock_t *os_sock; /**< always required */
+    struct sockaddr *local; /**< NULL if not yet bound */
+    struct sockaddr *remote; /**< NULL if not connected */
+    int family;             /**< always required (APR_INET, APR_INET6, 
etc. */
+    int type;               /**< always required (SOCK_STREAM, 
SOCK_DGRAM, etc. */
 };

 typedef struct apr_os_sock_info_t apr_os_sock_info_t;
@@ -460,5 +469,5 @@
 #ifdef __cplusplus
 }
 #endif
-
+/** @} */


Mime
View raw message