[PATCH] include/apr_poll.h:apr_pollset_poll() doxygen change

[ge...@everythingsucks.co.uk]

Greetings,

A patch to the doxygen for include/apr_poll.h:apr_pollset_poll()
that documents a feature that I slammed into a couple of weeks ago.

Regards
Gerry Calderhead

[gerry@devbox include]$ rcsdiff -u6 apr_poll.h
===================================================================
RCS file: RCS/apr_poll.h,v
retrieving revision 1.1
diff -u6 -r1.1 apr_poll.h
--- apr_poll.h  2006/01/03 08:20:24     1.1
+++ apr_poll.h  2006/01/03 08:35:31
@@ -157,12 +157,17 @@
/**
  * Block for activity on the descriptor(s) in a pollset
  * @param pollset The pollset to use
  * @param timeout Timeout in microseconds
  * @param num Number of signalled descriptors (output parameter)
  * @param descriptors Array of signalled descriptors (output parameter)
+ * @remark In general the descriptors array will hold copies of those
+ *         apr_pollfd_t elements added to the pollset which have raised
+ *         events during the poll.  It is important that in testing
+ *         the rtnevents attributes you do so against the output instances,
+ *         as the rtnevents of any input apr_pollfd_t will be unchanged.
  */
APR_DECLARE(apr_status_t) apr_pollset_poll(apr_pollset_t *pollset,
                                            apr_interval_time_t timeout,
                                            apr_int32_t *num,
                                            const apr_pollfd_t **descriptors);