diff options
author | Russell Bryant <russell@russellbryant.com> | 2007-08-07 23:04:01 +0000 |
---|---|---|
committer | Russell Bryant <russell@russellbryant.com> | 2007-08-07 23:04:01 +0000 |
commit | 668a334f85dc1df89ff77511890b247196550983 (patch) | |
tree | 0c7204d7e3713b731a0855eca39d8930798cdc6c /include | |
parent | 218241f174a531e77f99697e7d521f56783c03fc (diff) |
Add another big set of doxygen documentation improvements from snuffy.
(closes issue #9892)
(closes issue #10395)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@78541 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include')
-rw-r--r-- | include/asterisk/features.h | 44 |
1 files changed, 25 insertions, 19 deletions
diff --git a/include/asterisk/features.h b/include/asterisk/features.h index 5e9d5f3d2..7d52b6b03 100644 --- a/include/asterisk/features.h +++ b/include/asterisk/features.h @@ -48,31 +48,37 @@ struct ast_call_feature { -/*! \brief Park a call and read back parked location - * \param chan the channel to actually be parked - \param host the channel which will have the parked location read to - Park the channel chan, and read back the parked location to the - host. If the call is not picked up within a specified period of - time, then the call will return to the last step that it was in - (in terms of exten, priority and context) - \param timeout is a timeout in milliseconds - \param extout is a parameter to an int that will hold the parked location, or NULL if you want +/*! + * \brief Park a call and read back parked location + * \param chan the channel to actually be parked + * \param host the channel which will have the parked location read to. + * \param timeout is a timeout in milliseconds + * \param extout is a parameter to an int that will hold the parked location, or NULL if you want + * Park the channel chan, and read back the parked location to the host. + * If the call is not picked up within a specified period of time, + * then the call will return to the last step that it was in + * (in terms of exten, priority and context) + * \retval 0 on success. + * \retval -1 on failure. */ int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout); -/*! \brief Park a call via a masqueraded channel - * \param rchan the real channel to be parked - \param host the channel to have the parking read to - Masquerade the channel rchan into a new, empty channel which is then - parked with ast_park_call - \param timeout is a timeout in milliseconds - \param extout is a parameter to an int that will hold the parked location, or NULL if you want +/*! + * \brief Park a call via a masqueraded channel + * \param rchan the real channel to be parked + * \param host the channel to have the parking read to. + * \param timeout is a timeout in milliseconds + * \param extout is a parameter to an int that will hold the parked location, or NULL if you want + * Masquerade the channel rchan into a new, empty channel which is then parked with ast_park_call + * \retval 0 on success. + * \retval -1 on failure. */ int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout); -/*! \brief Determine system parking extension - * Returns the call parking extension for drivers that provide special - call parking help */ +/*! + * \brief Determine system parking extension + * \returns the call parking extension for drivers that provide special call parking help +*/ const char *ast_parking_ext(void); /*! \brief Determine system call pickup extension */ |