sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
This commit is contained in:
Mark Michelson 2009-09-08 20:06:15 +00:00
parent cea6ee4143
commit 29b72bc343
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
include/asterisk/event.h
View File

@ -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, ...);