diff options
author | Mark Michelson <mmichelson@digium.com> | 2009-09-08 20:06:15 +0000 |
---|---|---|
committer | Mark Michelson <mmichelson@digium.com> | 2009-09-08 20:06:15 +0000 |
commit | 29b72bc34328799e9807622c5437704caf88d2da (patch) | |
tree | 316b228a810c05765cd540978eb3e54319790d0e | |
parent | cea6ee41432e67ebffb510f60281dfb30acb873b (diff) |
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
-rw-r--r-- | include/asterisk/event.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/asterisk/event.h b/include/asterisk/event.h index 8c23c949c..d0b912c2a 100644 --- 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, ...); |