Doxygen documentation update

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@226490 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Olle Johansson
2009-10-29 12:20:16 +00:00
parent 5bd895b24b
commit 64e8fb465b

View File

@@ -98,18 +98,25 @@ static const struct ast_channel_tech local_tech = {
.bridged_channel = local_bridgedchannel, .bridged_channel = local_bridgedchannel,
}; };
/*! \brief the local pvt structure for all channels
The local channel pvt has two ast_chan objects - the "owner" and the "next channel", the outbound channel
ast_chan owner -> local_pvt -> ast_chan chan -> yet-another-pvt-depending-on-channel-type
*/
struct local_pvt { struct local_pvt {
ast_mutex_t lock; /* Channel private lock */ ast_mutex_t lock; /*!< Channel private lock */
unsigned int flags; /* Private flags */ unsigned int flags; /*!< Private flags */
char context[AST_MAX_CONTEXT]; /* Context to call */ char context[AST_MAX_CONTEXT]; /*!< Context to call */
char exten[AST_MAX_EXTENSION]; /* Extension to call */ char exten[AST_MAX_EXTENSION]; /*!< Extension to call */
int reqformat; /* Requested format */ int reqformat; /*!< Requested format */
struct ast_jb_conf jb_conf; /*!< jitterbuffer configuration for this local channel */ struct ast_jb_conf jb_conf; /*!< jitterbuffer configuration for this local channel */
struct ast_channel *owner; /* Master Channel - Bridging happens here */ struct ast_channel *owner; /*!< Master Channel - Bridging happens here */
struct ast_channel *chan; /* Outbound channel - PBX is run here */ struct ast_channel *chan; /*!< Outbound channel - PBX is run here */
struct ast_module_user *u_owner; /*! reference to keep the module loaded while in use */ struct ast_module_user *u_owner; /*!< reference to keep the module loaded while in use */
struct ast_module_user *u_chan; /*! reference to keep the module loaded while in use */ struct ast_module_user *u_chan; /*!< reference to keep the module loaded while in use */
AST_LIST_ENTRY(local_pvt) list; /* Next entity */ AST_LIST_ENTRY(local_pvt) list; /*!< Next entity */
}; };
#define LOCAL_GLARE_DETECT (1 << 0) /*!< Detect glare on hangup */ #define LOCAL_GLARE_DETECT (1 << 0) /*!< Detect glare on hangup */