diff options
| author | rbb <rbb@13f79535-47bb-0310-9956-ffa450edef68> | 2001-08-12 04:39:14 +0000 |
|---|---|---|
| committer | rbb <rbb@13f79535-47bb-0310-9956-ffa450edef68> | 2001-08-12 04:39:14 +0000 |
| commit | cfcf66ee1af8a146d13b19d65765db8695f144f0 (patch) | |
| tree | 275da81e9ddc0f822348452700b88e5a8836af1c /include | |
| parent | 1e0743fcf03aadfa038e210f4299447a0b0339e6 (diff) | |
| download | libapr-cfcf66ee1af8a146d13b19d65765db8695f144f0.tar.gz | |
First pass at making apr_portable.h use doxygen.
Submitted by: Ian Holsman <ianh@cnet.com>
git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@62143 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'include')
| -rw-r--r-- | include/apr_portable.h | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/include/apr_portable.h b/include/apr_portable.h index 8330a4fc5..e0d8e3b81 100644 --- a/include/apr_portable.h +++ b/include/apr_portable.h @@ -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 @@ typedef void * apr_os_dso_handle_t; #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; @@ -461,4 +470,6 @@ APR_DECLARE(apr_status_t) apr_sms_thread_unregister(apr_sms_t *sms, } #endif +/** @} */ + #endif /* ! APR_PORTABLE_H */ |