From: Leandro Lucarella <llucarella@integratech.com.ar>
Date: Mon, 29 Jan 2007 18:51:36 +0000 (+0000)
Subject: Fix dispatcher::dispatch() return documentation.
X-Git-Tag: 0.2~3
X-Git-Url: https://git.llucax.com/software/eventxx.git/commitdiff_plain/f96e870a834c80bffa69ff1395ff35e263d65861

Fix dispatcher::dispatch() return documentation.
---

diff --git a/eventxx b/eventxx
index 4405fb8..dc0a479 100644
--- a/eventxx
+++ b/eventxx
@@ -920,10 +920,12 @@ struct dispatcher
 	 *              processed, if eventxx::NONBLOCK is specified, then this
 	 *              function returns even if there are no pending events.
 	 *
-	 * @return Not very well specified by @libevent :-/ that's why it
-	 *         doesn't throw an exception either.
+	 * @return 0 if eventxx::NONBLOCK or eventxx::ONCE is set, 1 if there
+	 *         are no more events registered and EINTR if you use the
+	 *         @libevent's  @c event_gotsig and return -1 in your
+	 *         @c event_sigcb callback.
 	 */
-	int dispatch(int flags = 0) throw() // TODO  throw(exception)
+	int dispatch(int flags = 0) throw()
 	{
 		return internal::event_base_loop(_event_base, flags);
 	}