Return-Path: Delivered-To: apmail-apache-cvs-archive@apache.org Received: (qmail 63590 invoked by uid 500); 23 Jul 2000 17:00:45 -0000 Mailing-List: contact apache-cvs-help@apache.org; run by ezmlm Precedence: bulk X-No-Archive: yes Reply-To: new-httpd@apache.org list-help: list-unsubscribe: list-post: Delivered-To: mailing list apache-cvs@apache.org Received: (qmail 63579 invoked by uid 500); 23 Jul 2000 17:00:44 -0000 Delivered-To: apmail-apache-2.0-cvs@apache.org Date: 23 Jul 2000 17:00:44 -0000 Message-ID: <20000723170044.63575.qmail@locus.apache.org> From: rbb@locus.apache.org To: apache-2.0-cvs@apache.org Subject: cvs commit: apache-2.0/src/lib/apr/include apr_portable.h rbb 00/07/23 10:00:44 Modified: src/lib/apr/include apr_portable.h Log: Update apr_portable.h to use ScanDoc. Revision Changes Path 1.37 +88 -181 apache-2.0/src/lib/apr/include/apr_portable.h Index: apr_portable.h =================================================================== RCS file: /home/cvs/apache-2.0/src/lib/apr/include/apr_portable.h,v retrieving revision 1.36 retrieving revision 1.37 diff -u -r1.36 -r1.37 --- apr_portable.h 2000/07/11 15:29:37 1.36 +++ apr_portable.h 2000/07/23 17:00:44 1.37 @@ -59,6 +59,10 @@ #ifndef APR_PORTABLE_H #define APR_PORTABLE_H +/** + * @package APR portability Routines + */ + #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ @@ -178,233 +182,136 @@ typedef struct timeval ap_os_imp_time_t; typedef struct tm ap_os_exp_time_t; #endif - -/* - -=head1 ap_status_t ap_get_os_file(ap_os_file_t *thefile, ap_file_t *file) - -B - arg 1) The os specific file we are converting to - arg 2) The apr file to convert. - -B: On Unix, it is only possible to get a file descriptor from - an apr file type. - -=cut +/** + * convert the file from apr type to os specific type. + * @param thefile The os specific file we are converting to + * @param file The apr file to convert. + * @tip On Unix, it is only possible to get a file descriptor from + * an apr file type. */ ap_status_t ap_get_os_file(ap_os_file_t *thefile, ap_file_t *file); - -/* - -=head1 ap_status_t ap_get_os_dir(ap_os_dir_t **thedir, ap_dir_t *dir) -B - - arg 1) The os specific dir we are converting to - arg 2) The apr dir to convert. - -=cut +/** + * convert the dir from apr type to os specific type. + * @param thedir The os specific dir we are converting to + * @param dir The apr dir to convert. */ ap_status_t ap_get_os_dir(ap_os_dir_t **thedir, ap_dir_t *dir); - -/* - -=head1 ap_status_t ap_get_os_sock(ap_os_sock_t *thesock, ap_socket_t *sock) - -B - arg 1) The socket to convert. - arg 2) The os specifc equivelant of the apr socket.. - -=cut +/** + * Convert the socket from an apr type to an OS specific socket + * @param thesock The socket to convert. + * @param sock The os specifc equivelant of the apr socket.. */ ap_status_t ap_get_os_sock(ap_os_sock_t *thesock, ap_socket_t *sock); - -/* - -=head1 ap_status_t ap_get_os_lock(ap_os_lock_t *oslock, ap_lock_t *lock) - -B - arg 1) The os specific lock we are converting to. - arg 2) The apr lock to convert. - -=cut +/** + * Convert the lock from os specific type to apr type + * @param oslock The os specific lock we are converting to. + * @param lock The apr lock to convert. */ ap_status_t ap_get_os_lock(ap_os_lock_t *oslock, ap_lock_t *lock); - -/* - -=head1 ap_status_t ap_get_os_exp_time(ap_os_exp_time_t **ostime, ap_exploded_time_t *aprtime) - -B - - arg 1) the native time format - arg 2) the time to convert -=cut +/** + * Get the exploded time in the platforms native format. + * @param ostime the native time format + * @param aprtime the time to convert + */ +ap_status_t ap_get_os_exp_time(ap_os_exp_time_t **ostime, ap_exploded_time_t *aprtime); + +/** + * Get the imploded time in the platforms native format. + * @param ostime the native time format + * @param aprtimethe time to convert */ -ap_status_t ap_get_os_exp_time(ap_os_exp_time_t **, ap_exploded_time_t *); - -/* - -=head1 ap_status_t ap_get_os_imp_time(ap_os_imp_time_t **ostime, ap_time_t *aprtime) - -B - - arg 1) the native time format - arg 2) the time to convert +ap_status_t ap_get_os_imp_time(ap_os_imp_time_t **ostime, ap_time_t *aprtime); -=cut - */ -ap_status_t ap_get_os_imp_time(ap_os_imp_time_t **, ap_time_t *); #if APR_HAS_THREADS -/* - -=head1 ap_status_t ap_get_os_thread(ap_thread_t **thethd, ap_os_thread_t *thd) - -B - - arg 1) The apr thread to convert - arg 2) The os specific thread we are converting to - -=cut +/** + * convert the thread to os specific type from apr type. + * @param thethd The apr thread to convert + * @param thd The os specific thread we are converting to */ ap_status_t ap_get_os_thread(ap_os_thread_t **thethd, ap_thread_t *thd); - -/* - -=head1 ap_status_t ap_get_os_threadkey(ap_threadkey_t *thekey, ap_os_threadkey_t *key) - -B - - arg 1) The apr handle we are converting from. - arg 2) The os specific handle we are converting to. -=cut +/** + * convert the thread private memory key to os specific type from an apr type. + * @param thekey The apr handle we are converting from. + * @param key The os specific handle we are converting to. */ ap_status_t ap_get_os_threadkey(ap_os_threadkey_t *thekey, ap_threadkey_t *key); #endif -/* - -=head1 ap_status_t ap_put_os_file(ap_file_t **file, ap_os_file_t *thefile, ap_pool_t *cont) - -B - - arg 1) The apr file we are converting to. - arg 2) The os specific file to convert - arg 3) The pool to use if it is needed. - -B: On Unix, it is only possible to put a file descriptor into - an apr file type. - -=cut +/** + * convert the file from os specific type to apr type. + * @param file The apr file we are converting to. + * @param thefile The os specific file to convert + * @param cont The pool to use if it is needed. + * @tip On Unix, it is only possible to put a file descriptor into + * an apr file type. */ ap_status_t ap_put_os_file(ap_file_t **file, ap_os_file_t *thefile, ap_pool_t *cont); - -/* - -=head1 ap_status_t ap_put_os_dir(ap_dir_t **dir, ap_os_dir_t *thedir, ap_pool_t *cont) - -B - - arg 1) The apr dir we are converting to. - arg 2) The os specific dir to convert - arg 3) The pool to use when creating to apr directory. -=cut +/** + * convert the dir from os specific type to apr type. + * @param dir The apr dir we are converting to. + * @param thedir The os specific dir to convert + * @param cont The pool to use when creating to apr directory. */ ap_status_t ap_put_os_dir(ap_dir_t **dir, ap_os_dir_t *thedir, ap_pool_t *cont); -/* - -=head1 ap_status_t ap_put_os_sock(ap_socket_t **sock, ap_os_socket_t *thesock, ap_pool_t *cont) - -B - - arg 1) The pool to use. - arg 2) The socket to convert to. - arg 3) The socket we are converting to an apr type. - -=cut +/** + * Convert a socket from the os specific type to the apr type + * @param sock The pool to use. + * @param thesock The socket to convert to. + * @param cont The socket we are converting to an apr type. */ ap_status_t ap_put_os_sock(ap_socket_t **sock, ap_os_sock_t *thesock, ap_pool_t *cont); - -/* -=head1 ap_status_t ap_put_os_lock(ap_lock_t **lock, ap_os_lock_t *, ap_pool_t *cont) - -B - - arg 1) The apr lock we are converting to. - arg 2) The os specific lock to convert. - arg 3) The pool to use if it is needed. - -=cut +/** + * Convert the lock from os specific type to apr type + * @param lock The apr lock we are converting to. + * @param thelock The os specific lock to convert. + * @param cont The pool to use if it is needed. */ ap_status_t ap_put_os_lock(ap_lock_t **lock, ap_os_lock_t *thelock, ap_pool_t *cont); - -/* -=head1 ap_status_t ap_put_os_imp_time(ap_time_t *aprtime, ap_os_imp_time_t **ostime, ap_pool_t, *cont) - -B - - arg 1) the APR time format - arg 2) the time to convert - arg 3) the pool to use if necessary - -=cut - */ -ap_status_t ap_put_os_imp_time(ap_time_t *, ap_os_imp_time_t **, ap_pool_t *); - -/* - -=head1 ap_status_t ap_put_os_exp_time(ap_exploded_time_t *aprtime, ap_os_exp_time_t **ostime, ap_pool_t, *cont) - -B - - arg 1) the APR time format - arg 2) the time to convert - arg 3) the pool to use if necessary - -=cut +/** + * Put the imploded time in the APR format. + * @param aprtime the APR time format + * @param ostime the time to convert + * @param cont the pool to use if necessary + */ +ap_status_t ap_put_os_imp_time(ap_time_t *aprtime, ap_os_imp_time_t **ostime, ap_pool_t *cont); + +/** + * Put the exploded time in the APR format. + * @param aprtime the APR time format + * @param ostime the time to convert + * @param cont the pool to use if necessary */ -ap_status_t ap_put_os_exp_time(ap_exploded_time_t *, ap_os_exp_time_t **, ap_pool_t *); +ap_status_t ap_put_os_exp_time(ap_exploded_time_t *aprtime, ap_os_exp_time_t **ostime, ap_pool_t *cont); #if APR_HAS_THREADS -/* - -=head1 ap_status_t ap_put_os_thread(ap_thread_t *thd, ap_os_thread_t *thethd, ap_pool_t *cont) - -B - - arg 1) The apr thread we are converting to. - arg 2) The os specific thread to convert - arg 3) The pool to use if it is needed. - -=cut +/** + * convert the thread from os specific type to apr type. + * @param thd The apr thread we are converting to. + * @param thethd The os specific thread to convert + * @param cont The pool to use if it is needed. */ ap_status_t ap_put_os_thread(ap_thread_t **thd, ap_os_thread_t *thethd, ap_pool_t *cont); - -/* - -=head1 ap_status_t ap_put_os_threadkey(ap_threadkey_t *key, ap_os_threadkey_t *thekey, ap_pool_t *cont) - -B - - arg 1) The apr handle we are converting to. - arg 2) The os specific handle to convert - arg 3) The pool to use if it is needed. -=cut +/** + * convert the thread private memory key from os specific type to apr type. + * @param key The apr handle we are converting to. + * @param thekey The os specific handle to convert + * @param cont The pool to use if it is needed. */ ap_status_t ap_put_os_threadkey(ap_threadkey_t **key, ap_os_threadkey_t *thekey, ap_pool_t *cont);