Clarify semantics on event_pending()

svn:r1249

diff --git a/include/event2/event.h b/include/event2/event.h
index eb84eda08f42fd07b5324f15145e634622e8241a..5a0028a970d34db798500ec4a4cf617d8859562b 100644 (file)
--- a/include/event2/event.h
+++ b/include/event2/event.h
@@ -505,14 +505,14 @@ void event_active(struct event *, int, short);
   Checks if a specific event is pending or scheduled.
 
   @param ev an event struct previously passed to event_add()
-  @param event the requested event type; any of EV_TIMEOUT|EV_READ|
+  @param what the requested event type; any of EV_TIMEOUT|EV_READ|
          EV_WRITE|EV_SIGNAL
   @param tv if this field is not NULL, and the event has a timeout,
          this field is set to hold the time at which the timeout will
         expire.
 
-  @return 1 if the event is pending (that is to say, it has been added), or 0
-  if the event is not added.
+  @return true if the event is pending on any of the events in 'what', (that
+  is to say, it has been added), or 0 if the event is not added.
 
  */
 int event_pending(struct event *, short, struct timeval *);