Version 0.1.10 from FTP

git-svn-id: http://svn.digium.com/svn/asterisk/trunk@380 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 24 insertions, 21 deletions

diff --git a/include/asterisk/channel_pvt.h b/include/asterisk/channel_pvt.h
index 643115954..0085762fd 100755
--- a/include/asterisk/channel_pvt.h
+++ b/include/asterisk/channel_pvt.h
@@ -22,51 +22,54 @@ extern "C" {
 
 
 struct ast_channel_pvt {
-	/* Private data used by channel backend */
+	/*! Private data used by channel backend */
 	void *pvt;
-	/* Write translation path */
+	/*! Write translation path */
 	struct ast_trans_pvt *writetrans;
-	/* Read translation path */
+	/*! Read translation path */
 	struct ast_trans_pvt *readtrans;
-	/* Raw read format */
+	/*! Raw read format */
 	int rawreadformat;
-	/* Raw write format */
+	/*! Raw write format */
 	int rawwriteformat;
-	/* Send a literal DTMF digit */
+	/*! Send a literal DTMF digit */
 	int (*send_digit)(struct ast_channel *chan, char digit);
-	/* Call a given phone number (address, etc), but don't
+	/*! Call a given phone number (address, etc), but don't
 	   take longer than timeout seconds to do so.  */
 	int (*call)(struct ast_channel *chan, char *addr, int timeout);
-	/* Hangup (and possibly destroy) the channel */
+	/*! Hangup (and possibly destroy) the channel */
 	int (*hangup)(struct ast_channel *chan);
-	/* Answer the line */
+	/*! Answer the line */
 	int (*answer)(struct ast_channel *chan);
-	/* Read a frame, in standard format */
+	/*! Read a frame, in standard format */
 	struct ast_frame * (*read)(struct ast_channel *chan);
-	/* Write a frame, in standard format */
+	/*! Write a frame, in standard format */
 	int (*write)(struct ast_channel *chan, struct ast_frame *frame);
-	/* Display or transmit text */
+	/*! Display or transmit text */
 	int (*send_text)(struct ast_channel *chan, char *text);
-	/* Display or send an image */
+	/*! Display or send an image */
 	int (*send_image)(struct ast_channel *chan, struct ast_frame *frame);
-	/* Send HTML data */
+	/*! Send HTML data */
 	int (*send_html)(struct ast_channel *chan, int subclass, char *data, int len);
-	/* Handle an exception, reading a frame */
+	/*! Handle an exception, reading a frame */
 	struct ast_frame * (*exception)(struct ast_channel *chan);
-	/* Bridge two channels of the same type together */
+	/*! Bridge two channels of the same type together */
 	int (*bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc);
-	/* Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
+	/*! Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
 	int (*indicate)(struct ast_channel *c, int condition);
-	/* Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
+	/*! Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
 	int (*fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
-	/* Set a given option */
+	/*! Set a given option */
 	int (*setoption)(struct ast_channel *chan, int option, void *data, int datalen);
-	/* Query a given option */
+	/*! Query a given option */
 	int (*queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
 };
 
-/* Create a channel structure */
+//! Create a channel structure
+/*! Returns NULL on failure to allocate */
 struct ast_channel *ast_channel_alloc(void);
+
+//! Free a channel structure
 void  ast_channel_free(struct ast_channel *);
 
 #if defined(__cplusplus) || defined(c_plusplus)