[asterisk-commits] russell: trunk r193461 - /trunk/include/asterisk/event.h

[SVN commits to the Asterisk project]

Author: russell
Date: Sat May  9 06:33:09 2009
New Revision: 193461

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=193461
Log:
Minor documentation update for ast_event_queue().

Modified:
    trunk/include/asterisk/event.h

Modified: trunk/include/asterisk/event.h
URL: http://svn.asterisk.org/svn-view/asterisk/trunk/include/asterisk/event.h?view=diff&rev=193461&r1=193460&r2=193461
==============================================================================
--- trunk/include/asterisk/event.h (original)
+++ trunk/include/asterisk/event.h Sat May  9 06:33:09 2009
@@ -358,12 +358,13 @@
  * \param event the event to be queued
  *
  * \retval zero success
- * \retval non-zero failure
+ * \retval non-zero failure.  Note that the caller of this function is
+ *         responsible for destroying the event in the case of a failure.
  *
  * This function queues an event to be dispatched to all of the appropriate
  * subscribers.  This function will not block while the event is being
- * dispatched because a pool of event dispatching threads handle the event
- * queue.
+ * dispatched because the event is queued up for a dispatching thread 
+ * to handle.
  */
 int ast_event_queue(struct ast_event *event);