[Levent-commits] SF.net SVN: levent:[1249] trunk/libevent/include/event2/event.h

[<ni...@us...>]

Revision: 1249
          http://levent.svn.sourceforge.net/levent/?rev=1249&view=rev
Author:   nickm
Date:     2009-04-29 20:48:21 +0000 (Wed, 29 Apr 2009)

Log Message:
-----------
Clarify semantics on event_pending()

Modified Paths:
--------------
    trunk/libevent/include/event2/event.h

Modified: trunk/libevent/include/event2/event.h
===================================================================
--- trunk/libevent/include/event2/event.h	2009-04-28 19:08:36 UTC (rev 1248)
+++ trunk/libevent/include/event2/event.h	2009-04-29 20:48:21 UTC (rev 1249)
@@ -505,14 +505,14 @@
   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 *);


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.