mirror of
https://github.com/asterisk/asterisk.git
synced 2025-10-06 13:07:21 +00:00
Doxygen documentation update from oej (issue #5505)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6847 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
@@ -16,8 +16,8 @@
|
||||
* at the top of the source tree.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Call Parking and Pickup API
|
||||
/*! \file
|
||||
* \brief Call Parking and Pickup API
|
||||
* Includes code and algorithms from the Zapata library.
|
||||
*/
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
#define FEATURE_SNAME_LEN 32
|
||||
#define FEATURE_EXTEN_LEN 32
|
||||
|
||||
/* main call feature structure */
|
||||
/*! \brief main call feature structure */
|
||||
struct ast_call_feature {
|
||||
int feature_mask;
|
||||
char *fname;
|
||||
@@ -46,8 +46,8 @@ struct ast_call_feature {
|
||||
|
||||
|
||||
|
||||
/*! Park a call and read back parked location */
|
||||
/*! \param chan the channel to actually be parked
|
||||
/*! \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
|
||||
@@ -57,8 +57,9 @@ struct ast_call_feature {
|
||||
\param extout is a parameter to an int that will hold the parked location, or NULL if you want
|
||||
*/
|
||||
extern int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int timeout, int *extout);
|
||||
/*! Park a call via a masqueraded channel */
|
||||
/*! \param rchan the real channel to be parked
|
||||
|
||||
/*! \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
|
||||
@@ -67,25 +68,27 @@ extern int ast_park_call(struct ast_channel *chan, struct ast_channel *host, int
|
||||
*/
|
||||
extern int ast_masq_park_call(struct ast_channel *rchan, struct ast_channel *host, int timeout, int *extout);
|
||||
|
||||
/*! Determine system parking extension */
|
||||
/*! Returns the call parking extension for drivers that provide special
|
||||
/*! \brief Determine system parking extension
|
||||
* Returns the call parking extension for drivers that provide special
|
||||
call parking help */
|
||||
extern char *ast_parking_ext(void);
|
||||
|
||||
/*! \brief Determine system call pickup extension */
|
||||
extern char *ast_pickup_ext(void);
|
||||
|
||||
/*! Bridge a call, optionally allowing redirection */
|
||||
|
||||
/*! \brief Bridge a call, optionally allowing redirection */
|
||||
extern int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config);
|
||||
|
||||
/*! \brief Pickup a call */
|
||||
extern int ast_pickup_call(struct ast_channel *chan);
|
||||
|
||||
/*! register new feature into feature_set
|
||||
/*! \brief register new feature into feature_set
|
||||
\param feature an ast_call_feature object which contains a keysequence
|
||||
and a callback function which is called when this keysequence is pressed
|
||||
during a call. */
|
||||
extern void ast_register_feature(struct ast_call_feature *feature);
|
||||
|
||||
/*! unregister feature from feature_set
|
||||
/*! \brief unregister feature from feature_set
|
||||
\param feature the ast_call_feature object which was registered before*/
|
||||
extern void ast_unregister_feature(struct ast_call_feature *feature);
|
||||
|
||||
|
Reference in New Issue
Block a user