Updating more docs. :-)

git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@59705 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 19 insertions, 14 deletions

diff --git a/network_io/unix/poll.c b/network_io/unix/poll.c
index 697e3291d..2578ea912 100644
--- a/network_io/unix/poll.c
+++ b/network_io/unix/poll.c
@@ -58,11 +58,12 @@
 #ifdef HAVE_POLL    /* We can just use poll to do our socket polling. */
 
 /* ***APRDOC********************************************************
- * ap_status_t ap_setup_poll(ap_pollfd_t **, ap_int32_t, ap_context_t *)
+ * ap_status_t ap_setup_poll(ap_pollfd_t **new, ap_int32_t num, 
+ *                           ap_context_t *cont)
  *    Setup the memory required for poll to operate properly.
- * arg 1) The context to operate on.
+ * arg 1) The poll structure to be used. 
  * arg 2) The number of socket descriptors to be polled.
- * arg 3) The poll structure to be used. 
+ * arg 3) The context to operate on.
  */
 ap_status_t ap_setup_poll(struct pollfd_t **new, ap_int32_t num, ap_context_t *cont)
 {
@@ -120,7 +121,8 @@ ap_int16_t get_revent(ap_int16_t event)
 }
 
 /* ***APRDOC********************************************************
- * ap_status_t ap_add_poll_socket(ap_pollfd_t *, ap_socket_t *, ap_int16_t)
+ * ap_status_t ap_add_poll_socket(ap_pollfd_t *aprset, ap_socket_t *sock, 
+ *                                ap_int16_t event)
  *    Add a socket to the poll structure. 
  * arg 1) The poll structure we will be using. 
  * arg 2) The socket to add to the current poll structure. 
@@ -147,7 +149,8 @@ ap_status_t ap_add_poll_socket(struct pollfd_t *aprset,
 }
 
 /* ***APRDOC********************************************************
- * ap_status_t ap_poll(ap_pollfd_t *, ap_int32_t *, ap_int32_t)
+ * ap_status_t ap_poll(ap_pollfd_t *aprset, ap_int32_t *nsds,
+ *                     ap_int32_t timeout)
  *    Poll the sockets in the poll structure.  This is a blocking call,
  *    and it will not return until either a socket has been signalled, or
  *    the timeout has expired. 
@@ -190,11 +193,10 @@ ap_status_t ap_poll(struct pollfd_t *aprset, ap_int32_t *nsds, ap_int32_t timeou
 }
 
 /* ***APRDOC********************************************************
- * ap_status_t ap_get_revents(ap_int_16_t *, ap_socket_t *, ap_pollfd_t *)
+ * ap_status_t ap_get_revents(ap_int_16_t *event, ap_socket_t *sock,
+ *                            ap_pollfd_t *aprset)
  *    Get the return events for the specified socket. 
- * arg 1) The poll structure we will be using. 
- * arg 2) The socket we wish to get information about. 
- * arg 3) The returned events for the socket.  One of:
+ * arg 1) The returned events for the socket.  One of:
  *            APR_POLLIN    -- Data is available to be read 
  *            APR_POLLPRI   -- Prioirty data is availble to be read
  *            APR_POLLOUT   -- Write will succeed
@@ -202,6 +204,8 @@ ap_status_t ap_poll(struct pollfd_t *aprset, ap_int32_t *nsds, ap_int32_t timeou
  *            APR_POLLHUP   -- The connection has been terminated
  *            APR_POLLNVAL  -- This is an invalid socket to poll on.
  *                             Socket not open.
+ * arg 2) The socket we wish to get information about. 
+ * arg 3) The poll structure we will be using. 
  */
 ap_status_t ap_get_revents(ap_int16_t *event, struct socket_t *sock, struct pollfd_t *aprset)
 {
@@ -218,7 +222,8 @@ ap_status_t ap_get_revents(ap_int16_t *event, struct socket_t *sock, struct poll
 }
 
 /* ***APRDOC********************************************************
- * ap_status_t ap_remove_poll_socket(ap_pollfd_t *, ap_socket_t *, ap_int16_t)
+ * ap_status_t ap_remove_poll_socket(ap_pollfd_t *aprset, ap_socket_t *sock,
+ *                                   ap_int16_t events)
  *    Add a socket to the poll structure. 
  * arg 1) The poll structure we will be using. 
  * arg 2) The socket to remove from the current poll structure. 
@@ -248,10 +253,10 @@ ap_status_t ap_remove_poll_socket(struct pollfd_t *aprset,
 }
 
 /* ***APRDOC********************************************************
- * ap_status_t ap_clear_poll_sockets(ap_pollfd_t *)
+ * ap_status_t ap_clear_poll_sockets(ap_pollfd_t *aprset, ap_int16_t events)
  *    Remove all sockets from the poll structure. 
  * arg 1) The poll structure we will be using. 
- * arg 3) The events to clear from all sockets.  One of:
+ * arg 2) The events to clear from all sockets.  One of:
  *            APR_POLLIN    -- signal if read will not block
  *            APR_POLLPRI   -- signal if prioirty data is availble to be read
  *            APR_POLLOUT   -- signal if write will not block
@@ -417,7 +422,7 @@ ap_status_t ap_clear_poll_sockets(struct pollfd_t *aprset, ap_int16_t event)
 #endif 
 
 /* ***APRDOC********************************************************
- * ap_status_t ap_get_polldata(ap_pollfd_t *, char *, void *)
+ * ap_status_t ap_get_polldata(ap_pollfd_t *pollfd, char *key, void *data)
  *    Return the context associated with the current poll.
  * arg 1) The currently open pollfd.
  * arg 2) The key to use for retreiving data associated with a poll struct.
@@ -435,7 +440,7 @@ ap_status_t ap_get_polldata(struct pollfd_t *pollfd, char *key, void *data)
 }
 
 /* ***APRDOC********************************************************
- * ap_status_t ap_set_polldata(ap_pollfd_t *, void *, char *,
+ * ap_status_t ap_set_polldata(ap_pollfd_t *pollfd, void *data, char *key,
                                ap_status_t (*cleanup) (void *))
  *    Return the context associated with the current poll.
  * arg 1) The currently open pollfd.