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.

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@217158 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/include/asterisk/event.h b/include/asterisk/event.h
index 8c23c94..d0b912c 100644 (file)
--- a/include/asterisk/event.h
+++ b/include/asterisk/event.h
@@ -78,6 +78,7 @@ typedef void (*ast_event_cb_t)(const struct ast_event *event, void *userdata);
  *
  * \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 @@ typedef void (*ast_event_cb_t)(const struct ast_event *event, void *userdata);
  * 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, ...);