Minor documentation update for ast_event_queue().
authorRussell Bryant <russell@russellbryant.com>
Sat, 9 May 2009 11:33:09 +0000 (11:33 +0000)
committerRussell Bryant <russell@russellbryant.com>
Sat, 9 May 2009 11:33:09 +0000 (11:33 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@193461 65c4cc65-6c06-0410-ace0-fbb531ad65f3

include/asterisk/event.h

index b9de22d..c2afc57 100644 (file)
@@ -358,12 +358,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);