rbb 01/08/11 21:39:14
Modified: include apr_portable.h
Log:
First pass at making apr_portable.h use doxygen.
Submitted by: Ian Holsman <[EMAIL PROTECTED]>
Revision Changes Path
1.67 +18 -7 apr/include/apr_portable.h
Index: apr_portable.h
===================================================================
RCS file: /home/cvs/apr/include/apr_portable.h,v
retrieving revision 1.66
retrieving revision 1.67
diff -u -r1.66 -r1.67
--- apr_portable.h 2001/08/06 21:11:15 1.66
+++ apr_portable.h 2001/08/12 04:39:14 1.67
@@ -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,7 @@
#ifdef __cplusplus
}
#endif
+
+/** @} */
#endif /* ! APR_PORTABLE_H */
