[Asterisk-cvs] asterisk/include/asterisk channel.h,1.112,1.113

[kpfleming]

Update of /usr/cvsroot/asterisk/include/asterisk
In directory mongoose.digium.com:/tmp/cvs-serv23383/include/asterisk

Modified Files:
	channel.h 
Log Message:
add some doxygen docs


Index: channel.h
===================================================================
RCS file: /usr/cvsroot/asterisk/include/asterisk/channel.h,v
retrieving revision 1.112
retrieving revision 1.113
diff -u -d -r1.112 -r1.113
--- channel.h	1 Nov 2005 21:11:57 -0000	1.112
+++ channel.h	2 Nov 2005 18:08:33 -0000	1.113
@@ -1101,8 +1101,36 @@
  */
 void ast_channel_spy_trigger_wait(struct ast_channel_spy *spy);
 
+/*!
+  \brief An opaque 'object' structure use by silence generators on channels.
+ */
 struct ast_silence_generator;
+
+/*!
+  \brief Starts a silence generator on the given channel.
+  \param chan The channel to generate silence on
+  \return An ast_silence_generator pointer, or NULL if an error occurs
+
+  This function will cause SLINEAR silence to be generated on the supplied
+  channel until it is disabled; if the channel cannot be put into SLINEAR
+  mode then the function will fail.
+
+  The pointer returned by this function must be preserved and passed to
+  ast_channel_stop_silence_generator when you wish to stop the silence
+  generation.
+ */
 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
+
+/*!
+  \brief Stops a previously-started silence generator on the given channel.
+  \param chan The channel to operate on
+  \param state The ast_silence_generator pointer return by a previous call to
+  ast_channel_start_silence_generator.
+  \return nothing
+
+  This function will stop the operating silence generator and return the channel
+  to its previous write format.
+ */
 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
 
 /* Misc. functions below */