[asterisk-commits] mmichelson: trunk r217158 - /trunk/include/asterisk/event.h

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Tue Sep  8 15:06:15 2009
New Revision: 217158

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=217158
Log:
Add doxygen to ast_event_subscribe for the description.

Most importantly, note that a NULL description will cause a
crash, as I just experienced that firsthand.


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=217158&r1=217157&r2=217158
==============================================================================
--- trunk/include/asterisk/event.h (original)
+++ trunk/include/asterisk/event.h Tue Sep  8 15:06:15 2009
@@ -78,6 +78,7 @@
  *
  * \param event_type The type of events to subscribe to
  * \param cb The function to be called with events
+ * \param description Description of the subscription.
  * \param userdata data to be passed to the event callback
  *
  * The rest of the arguments to this function specify additional parameters for
@@ -109,6 +110,8 @@
  * information element, AST_EVENT_IE_MAILBOX, with the same string value
  * contained in peer->mailbox.  Also, the event callback will be passed a
  * pointer to the peer.
+ *
+ * \note A NULL description will cause this function to crash, so watch out!
  */
 struct ast_event_sub *ast_event_subscribe(enum ast_event_type event_type,
        ast_event_cb_t cb, char *description, void *userdata, ...);