]> granicus.if.org Git - libevent/commitdiff
Clarify EVLOOP_* documentation to be more precise.
authorNick Mathewson <nickm@torproject.org>
Mon, 15 Nov 2010 00:34:49 +0000 (19:34 -0500)
committerNick Mathewson <nickm@torproject.org>
Mon, 15 Nov 2010 00:34:49 +0000 (19:34 -0500)
include/event2/event.h

index fa0f625d3e30e354786694cc9e9026d67ccdbf48..1cba7708bd87c1fc519cc07ce2e43a0022b52cdd 100644 (file)
@@ -301,8 +301,12 @@ int event_base_set(struct event_base *, struct event *);
  event_loop() flags
  */
 /*@{*/
-#define EVLOOP_ONCE    0x01    /**< Block at most once. */
-#define EVLOOP_NONBLOCK        0x02    /**< Do not block. */
+/** Block until we have an active event, then exit once all active events
+ * have had their callbacks run. */
+#define EVLOOP_ONCE    0x01
+/** Do not block: see which events are ready now, run the callbacks
+ * highest-priority ones, then exit. */
+#define EVLOOP_NONBLOCK        0x02
 /*@}*/
 
 /**