[asterisk-commits] file: branch file/bridging r111854 - /team/file/bridging/include/asterisk/
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Fri Mar 28 16:06:33 CDT 2008
Author: file
Date: Fri Mar 28 16:06:32 2008
New Revision: 111854
URL: http://svn.digium.com/view/asterisk?view=rev&rev=111854
Log:
Use \retval instead of \return
Modified:
team/file/bridging/include/asterisk/bridging.h
Modified: team/file/bridging/include/asterisk/bridging.h
URL: http://svn.digium.com/view/asterisk/team/file/bridging/include/asterisk/bridging.h?view=diff&rev=111854&r1=111853&r2=111854
==============================================================================
--- team/file/bridging/include/asterisk/bridging.h (original)
+++ team/file/bridging/include/asterisk/bridging.h Fri Mar 28 16:06:32 2008
@@ -149,7 +149,8 @@
/*! \brief Register a bridge technology for use
* \param technology The bridge technology to register
* \param module The module that is registering the bridge technology
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
#define ast_bridge_technology_register(technology) __ast_bridge_technology_register(technology, ast_module_info->self)
@@ -157,19 +158,22 @@
/*! \brief Unregister a bridge technology from use
* \param technology The bridge technology to unregister
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_technology_unregister(struct ast_bridge_technology *technology);
/*! \brief Create a new bridge
* \param capabilities The capabilities that we require to be used on the bridge
- * \return Returns bridge on success, NULL on failure
+ * \retval a pointer to a new bridge on success
+ * \retval NULL on failure
*/
struct ast_bridge *ast_bridge_new(int capabilities, int flags);
/*! \brief Destroy a bridge
* \param bridge Bridge to destroy
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_destroy(struct ast_bridge *bridge);
@@ -178,7 +182,7 @@
* \param chan Channel to join
* \param swap Channel to swap out if swapping
* \param features Bridge features structure
- * \return Returns state that channel exited bridge on
+ * \retval state that channel exited the bridge with
*/
enum ast_bridge_channel_state ast_bridge_join(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features);
@@ -187,55 +191,63 @@
* \param chan Channel to impart
* \param swap Channel to swap out if swapping
* \param features Bridge features structure
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_impart(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features);
/*! \brief Depart a channel from a bridge
* \param bridge Bridge to depart from
* \param chan Channel to depart
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_depart(struct ast_bridge *bridge, struct ast_channel *chan);
/*! \brief Remove a channel from a bridge
* \param bridge Bridge that the channel is to be removed from
* \param chan Channel to remove
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_remove(struct ast_bridge *bridge, struct ast_channel *chan);
/*! \brief Change the state of a bridge channel
* \param bridge_channel Bridge channel
* \param new_state State to change to
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_change_state(struct ast_bridge_channel *bridge_channel, enum ast_bridge_channel_state new_state);
/*! \brief Request that the bridge rebuild itself
* \param bridge Bridge in question
- * \ return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_rebuild(struct ast_bridge *bridge);
/*! \brief Merge two bridges together
* \param bridge0 First bridge
* \param bridge1 Second bridge
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_merge(struct ast_bridge *bridge0, struct ast_bridge *bridge1);
/*! \brief Suspend a channel temporarily from a bridge. Control will be given to the current thread.
* \param bridge Bridge to suspend the channel from
* \param chan Channel to suspend
- * \param Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_suspend(struct ast_bridge *bridge, struct ast_channel *chan);
/*! \brief Unsuspend a channel from a bridge.
* \param bridge Bridge to unsuspend the channel from
* \param chan Channel to unsuspend
- * \param Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_unsuspend(struct ast_bridge *bridge, struct ast_channel *chan);
@@ -254,7 +266,8 @@
* \param dtmf DTMF string to be activated upon
* \param callback Function to execute upon activation
* \param hook_pvt Unique data
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_features_hook(struct ast_bridge_features *features, const char *dtmf, ast_bridge_features_hook_callback callback, void *hook_pvt);
@@ -262,26 +275,30 @@
* \param features Bridge features structure
* \param feature Feature to enable
* \param dtmf Optionally the DTMF stream to trigger the feature, if not specified it will be the default
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_features_enable(struct ast_bridge_features *features, enum ast_bridge_builtin_feature feature, const char *dtmf);
/*! \brief Set a flag on a bridge features structure
* \param features Bridge features structure
* \param flag Flag to enable
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_features_set_flag(struct ast_bridge_features *features, int flag);
/*! \brief Initialize bridge features structure
* \param features Bridge featues structure
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_features_init(struct ast_bridge_features *features);
/*! \brief Clean up the contents of a bridge features structure
* \param features Bridge features structure
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_features_cleanup(struct ast_bridge_features *features);
@@ -289,7 +306,8 @@
* \param bridge Bridge to play stream into
* \param dtmf DTMF to play
* \param chan Channel to optionally not play to
- * \return Returns 0 on success, -1 on failure
+ * \retval 0 on success
+ * \retval -1 on failure
*/
int ast_bridge_dtmf_stream(struct ast_bridge *bridge, const char *dtmf, struct ast_channel *chan);
More information about the asterisk-commits
mailing list