From 4910637da7076794163c55db14328e41076cf16e Mon Sep 17 00:00:00 2001
From: "Kevin P. Fleming" <kpfleming@digium.com>
Date: Sun, 15 May 2005 04:48:30 +0000
Subject: code formatting and comments, plus minor device state fix (bug #4171)

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@5669 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
 include/asterisk/channel.h | 31 +++++++++++++++++++++++++------
 include/asterisk/frame.h   |  4 ----
 2 files changed, 25 insertions(+), 10 deletions(-)

(limited to 'include')

diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h
index d13e0671a..e3dd749cb 100755
--- a/include/asterisk/channel.h
+++ b/include/asterisk/channel.h
@@ -455,16 +455,23 @@ struct outgoing_helper {
 #define AST_DEVICE_INVALID	4
 /*! Device is unavailable */
 #define AST_DEVICE_UNAVAILABLE	5
+/*! Device is ringing */
+#define AST_DEVICE_RINGING	6
 
 /*! Create a channel structure */
-/*! Returns NULL on failure to allocate */
+/*! Returns NULL on failure to allocate. New channels are 
+	by default set to the "default" context and
+	extension "s"
+ */
 struct ast_channel *ast_channel_alloc(int needalertpipe);
 
 /*! Queue an outgoing frame */
 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
 
+/*! Queue a hangup frame */
 int ast_queue_hangup(struct ast_channel *chan);
 
+/*! Queue a control frame */
 int ast_queue_control(struct ast_channel *chan, int control);
 
 /*! Change the state of a channel */
@@ -552,9 +559,12 @@ int ast_hangup(struct ast_channel *chan);
  * \param chan channel to be soft-hung-up
  * Call the protocol layer, but don't destroy the channel structure (use this if you are trying to
  * safely hangup a channel managed by another thread.
+ * \param cause	Ast hangupcause for hangup
  * Returns 0 regardless
  */
 int ast_softhangup(struct ast_channel *chan, int cause);
+/*! Softly hangup up a channel (no channel lock) 
+ * \param cause	Ast hangupcause for hangup */
 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
 
 /*! Check to see if a channel is needing hang up */
@@ -810,11 +820,10 @@ int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,struct ast_
    channel is hung up.  */
 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
 
-/*! Gives the string form of a given state */
+/*! Gives the string form of a given channel state */
 /*! 
  * \param state state to get the name of
  * Give a name to a state 
- * Pretty self explanatory.
  * Returns the text form of the binary state given
  */
 char *ast_state2str(int state);
@@ -845,6 +854,11 @@ char *ast_transfercapability2str(int transfercapability);
  */
 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
 
+/*! Pick the best codec  */
+/* Choose the best codec...  Uhhh...   Yah. */
+extern int ast_best_codec(int fmts);
+
+
 /*! Checks the value of an option */
 /*! 
  * Query the value of an option, optionally blocking until a reply is received
@@ -913,13 +927,18 @@ int ast_autoservice_stop(struct ast_channel *chan);
    timer fd, at which point we call the callback function / data */
 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(void *data), void *data);
 
-/* Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
-   and 1 if supported and requested */
+/*!	\brief Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
+   and 1 if supported and requested 
+	\param chan current channel
+	\param dest destination extension for transfer
+*/
 int ast_transfer(struct ast_channel *chan, char *dest);
 
 int ast_do_masquerade(struct ast_channel *chan);
 
-/* Find bridged channel */
+/*!	\brief Find bridged channel 
+	\param chan Current channel
+*/
 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
 
 /*!
diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h
index d8a715a8f..7cff43ee6 100755
--- a/include/asterisk/frame.h
+++ b/include/asterisk/frame.h
@@ -347,10 +347,6 @@ extern int ast_getformatbyname(char *name);
  */
 extern char *ast_codec2str(int codec);
 
-/*! Pick the best codec  */
-/* Choose the best codec...  Uhhh...   Yah. */
-extern int ast_best_codec(int fmts);
-
 struct ast_smoother;
 
 extern struct ast_format_list *ast_get_format_list_index(int index);
-- 
cgit v1.2.3