[svn-commits] oej: trunk r226490 - /trunk/channels/chan_local.c

[SVN commits to the Digium repositories]

Author: oej
Date: Thu Oct 29 07:20:16 2009
New Revision: 226490

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=226490
Log:
Doxygen documentation update

Modified:
    trunk/channels/chan_local.c

Modified: trunk/channels/chan_local.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_local.c?view=diff&rev=226490&r1=226489&r2=226490
==============================================================================
--- trunk/channels/chan_local.c (original)
+++ trunk/channels/chan_local.c Thu Oct 29 07:20:16 2009
@@ -98,18 +98,25 @@
 	.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 {
-	ast_mutex_t lock;			/* Channel private lock */
-	unsigned int flags;                     /* Private flags */
-	char context[AST_MAX_CONTEXT];		/* Context to call */
-	char exten[AST_MAX_EXTENSION];		/* Extension to call */
-	int reqformat;				/* Requested format */
+	ast_mutex_t lock;			/*!< Channel private lock */
+	unsigned int flags;                     /*!< Private flags */
+	char context[AST_MAX_CONTEXT];		/*!< Context to call */
+	char exten[AST_MAX_EXTENSION];		/*!< Extension to call */
+	int reqformat;				/*!< Requested format */
 	struct ast_jb_conf jb_conf;		/*!< jitterbuffer configuration for this local channel */
-	struct ast_channel *owner;		/* Master Channel - Bridging happens 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_chan;		/*! reference to keep the module loaded while in use */
-	AST_LIST_ENTRY(local_pvt) list;		/* Next entity */
+	struct ast_channel *owner;		/*!< Master Channel - Bridging happens 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_chan;		/*!< reference to keep the module loaded while in use */
+	AST_LIST_ENTRY(local_pvt) list;		/*!< Next entity */
 };
 
 #define LOCAL_GLARE_DETECT    (1 << 0) /*!< Detect glare on hangup */