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().

........


git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.6.2@193462 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 4 insertions, 3 deletions

diff --git a/include/asterisk/event.h b/include/asterisk/event.h
index ac42e5942..e7d0f7e2f 100644
--- a/include/asterisk/event.h
+++ b/include/asterisk/event.h
@@ -344,12 +344,13 @@ void ast_event_destroy(struct ast_event *event);
  * \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);