[svn-commits] russell: branch 1.6.2 r193462 - in /branches/1.6.2: ./ include/asterisk/event.h

[SVN commits to the Digium repositories]

Author: russell
Date: Sat May  9 06:33:30 2009
New Revision: 193462

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=193462
Log:
Merged revisions 193461 via svnmerge from 
https://origsvn.digium.com/svn/asterisk/trunk

........
r193461 | russell | 2009-05-09 06:33:09 -0500 (Sat, 09 May 2009) | 2 lines

Minor documentation update for ast_event_queue().

........

Modified:
    branches/1.6.2/   (props changed)
    branches/1.6.2/include/asterisk/event.h

Propchange: branches/1.6.2/
------------------------------------------------------------------------------
Binary property 'trunk-merged' - no diff available.

Modified: branches/1.6.2/include/asterisk/event.h
URL: http://svn.asterisk.org/svn-view/asterisk/branches/1.6.2/include/asterisk/event.h?view=diff&rev=193462&r1=193461&r2=193462
==============================================================================
--- branches/1.6.2/include/asterisk/event.h (original)
+++ branches/1.6.2/include/asterisk/event.h Sat May  9 06:33:30 2009
@@ -344,12 +344,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);