[Asterisk-code-review] bridge_channel: Fix for Doxygen. (asterisk[18])
Friendly Automation
asteriskteam at digium.com
Thu Nov 18 09:19:20 CST 2021
Friendly Automation has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/17356 )
Change subject: bridge_channel: Fix for Doxygen.
......................................................................
bridge_channel: Fix for Doxygen.
ASTERISK-29736
Change-Id: Ia5370289e6526001a6b52754b533bcea1a9d7e5c
---
M include/asterisk/bridge_channel.h
M include/asterisk/bridge_channel_internal.h
M main/bridge_channel.c
3 files changed, 14 insertions(+), 84 deletions(-)
Approvals:
Kevin Harwell: Looks good to me, but someone else must approve
George Joseph: Looks good to me, approved
Friendly Automation: Approved for Submit
diff --git a/include/asterisk/bridge_channel.h b/include/asterisk/bridge_channel.h
index fb2fd4f..21090ec 100644
--- a/include/asterisk/bridge_channel.h
+++ b/include/asterisk/bridge_channel.h
@@ -33,9 +33,9 @@
* In general, anywhere else it is unsafe to use this API. Care should be
* taken when using this API to ensure that the locking order remains
* correct. The locking order must be:
- * \arg The \ref \c ast_bridge
- * \arg The \ref \c ast_bridge_channel
- * \arg The \ref \c ast_channel
+ * \arg The \ref ast_bridge "\c ast_bridge"
+ * \arg The \ref ast_bridge_channel "\c ast_bridge_channel"
+ * \arg The \ref ast_channel "\c ast_channel"
*
* \author Joshua Colp <jcolp at digium.com>
* \author Richard Mudgett <rmudgett at digium.com>
@@ -225,8 +225,6 @@
* \brief Lock the bridge_channel.
*
* \param bridge_channel What to lock
- *
- * \return Nothing
*/
#define ast_bridge_channel_lock(bridge_channel) _ast_bridge_channel_lock(bridge_channel, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge_channel)
static inline void _ast_bridge_channel_lock(struct ast_bridge_channel *bridge_channel, const char *file, const char *function, int line, const char *var)
@@ -238,8 +236,6 @@
* \brief Unlock the bridge_channel.
*
* \param bridge_channel What to unlock
- *
- * \return Nothing
*/
#define ast_bridge_channel_unlock(bridge_channel) _ast_bridge_channel_unlock(bridge_channel, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge_channel)
static inline void _ast_bridge_channel_unlock(struct ast_bridge_channel *bridge_channel, const char *file, const char *function, int line, const char *var)
@@ -261,8 +257,6 @@
*
* \note The bridge_channel->bridge pointer changes because of a
* bridge-merge/channel-move operation between bridges.
- *
- * \return Nothing
*/
void ast_bridge_channel_lock_bridge(struct ast_bridge_channel *bridge_channel);
@@ -472,8 +466,6 @@
* Empty if default MOH class.
*
* \note This is intended to be called by bridge hooks.
- *
- * \return Nothing
*/
void ast_bridge_channel_run_app(struct ast_bridge_channel *bridge_channel, const char *app_name, const char *app_args, const char *moh_class);
@@ -518,8 +510,6 @@
*
* \param bridge_channel Which channel to play the file on
* \param playfile Sound filename to play.
- *
- * \return Nothing
*/
typedef void (*ast_bridge_custom_play_fn)(struct ast_bridge_channel *bridge_channel, const char *playfile);
@@ -535,8 +525,6 @@
* Empty if default MOH class.
*
* \note This is intended to be called by bridge hooks.
- *
- * \return Nothing
*/
void ast_bridge_channel_playfile(struct ast_bridge_channel *bridge_channel, ast_bridge_custom_play_fn custom_play, const char *playfile, const char *moh_class);
@@ -606,8 +594,6 @@
* \param payload_size Size of the payload if payload is non-NULL. A number otherwise.
*
* \note The payload MUST NOT have any resources that need to be freed.
- *
- * \return Nothing
*/
typedef void (*ast_bridge_custom_callback_fn)(struct ast_bridge_channel *bridge_channel, const void *payload, size_t payload_size);
@@ -685,8 +671,6 @@
*
* \note This is intended to be called by bridge hooks and the
* bridge channel thread.
- *
- * \return Nothing
*/
void ast_bridge_channel_kick(struct ast_bridge_channel *bridge_channel, int cause);
@@ -710,7 +694,6 @@
*
* \param bridge_channel Channel that received a DTMF digit.
* \param digit DTMF digit to add to collected digits or 0 for timeout event.
- * \param clear_digits clear the digits array prior to calling hooks
*
* \note Neither the bridge nor the bridge_channel locks should be held
* when entering this function.
@@ -721,8 +704,6 @@
* \note This is intended to be called by non-DTMF bridge hooks and the bridge
* channel thread. Calling from a DTMF bridge hook can potentially cause
* unbounded recursion.
- *
- * \return Nothing
*/
void ast_bridge_channel_feature_digit(struct ast_bridge_channel *bridge_channel, int digit);
@@ -747,8 +728,6 @@
* \param bridge_channel Channel to map
*
* \note The bridge_channel's bridge must be locked prior to calling this function.
- *
- * \return Nothing
*/
void ast_bridge_channel_stream_map(struct ast_bridge_channel *bridge_channel);
diff --git a/include/asterisk/bridge_channel_internal.h b/include/asterisk/bridge_channel_internal.h
index ba71e9f..082ed1e 100644
--- a/include/asterisk/bridge_channel_internal.h
+++ b/include/asterisk/bridge_channel_internal.h
@@ -30,8 +30,8 @@
* by other members of the Bridging API.
*
* See Also:
+ * \arg \ref AstBridging
* \arg \ref AstCREDITS
- * \arg \ref Ast
*/
/*!
@@ -91,8 +91,6 @@
* \param bridge_channel Channel that owes events to the original bridge.
*
* \note On entry, the orig_bridge is already locked.
- *
- * \return Nothing
*/
void bridge_channel_settle_owed_events(struct ast_bridge *orig_bridge, struct ast_bridge_channel *bridge_channel);
@@ -102,8 +100,6 @@
* \since 13.17.0
*
* \param bridge_channel Channel that the deferred frames should be pulled from and queued to.
- *
- * \return Nothing
*/
void bridge_channel_queue_deferred_frames(struct ast_bridge_channel *bridge_channel);
@@ -156,18 +152,15 @@
* \param bridge_channel Channel to pull.
*
* \note On entry, bridge_channel->bridge is already locked.
- *
- * \return Nothing
*/
void bridge_channel_internal_pull(struct ast_bridge_channel *bridge_channel);
/*!
+ * \internal
* \brief Signal imparting threads to wake up.
* \since 13.9.0
*
* \param chan Channel imparted that we need to signal.
- *
- * \return Nothing
*/
void bridge_channel_impart_signal(struct ast_channel *chan);
diff --git a/main/bridge_channel.c b/main/bridge_channel.c
index 608db61..71739b7 100644
--- a/main/bridge_channel.c
+++ b/main/bridge_channel.c
@@ -113,7 +113,7 @@
static AST_RWLIST_HEAD_STATIC(sync_structs, bridge_sync);
/*!
- * \brief initialize a synchronous bridge object.
+ * \brief Initialize a synchronous bridge object.
*
* This both initializes the structure and adds it to the list of
* synchronization structures.
@@ -414,8 +414,6 @@
* \param src Channel to get accountcode from.
*
* \note Both channels are already locked.
- *
- * \return Nothing
*/
static void channel_fill_empty_peeraccount(struct ast_channel *dest, struct ast_channel *src)
{
@@ -437,8 +435,6 @@
* \param src Channel to get peeraccount from.
*
* \note Both channels are already locked.
- *
- * \return Nothing
*/
static void channel_fill_empty_accountcode(struct ast_channel *dest, struct ast_channel *src)
{
@@ -460,8 +456,6 @@
* \param c1 Second bridge channel to update.
*
* \note Both channels are already locked.
- *
- * \return Nothing
*/
static void channel_set_empty_accountcodes(struct ast_channel *c0, struct ast_channel *c1)
{
@@ -483,8 +477,6 @@
* \param src Channel to get accountcode from.
*
* \note Both channels are already locked.
- *
- * \return Nothing
*/
static void channel_update_peeraccount(struct ast_channel *dest, struct ast_channel *src)
{
@@ -505,8 +497,6 @@
* \param c1 Second channel to update.
*
* \note Both channels are already locked.
- *
- * \return Nothing
*/
static void channel_update_peeraccounts(struct ast_channel *c0, struct ast_channel *c1)
{
@@ -523,8 +513,6 @@
* \param swap Channel being replaced by the joining channel. May be NULL.
*
* \note The bridge must be locked prior to calling this function.
- *
- * \return Nothing
*/
static void bridge_channel_update_accountcodes_joining(struct ast_bridge_channel *joining, struct ast_bridge_channel *swap)
{
@@ -570,8 +558,6 @@
* \param leaving Channel leaving the bridge. (Has already been removed actually)
*
* \note The bridge must be locked prior to calling this function.
- *
- * \return Nothing
*/
static void bridge_channel_update_accountcodes_leaving(struct ast_bridge_channel *leaving)
{
@@ -780,8 +766,6 @@
* \param bridge_channel Channel that owes events to the bridge.
*
* \note On entry, the bridge_channel->bridge is already locked.
- *
- * \return Nothing
*/
static void bridge_channel_cancel_owed_events(struct ast_bridge_channel *bridge_channel)
{
@@ -848,8 +832,6 @@
* \param bridge_channel Channel to suspend.
*
* \note This function assumes bridge_channel->bridge is locked.
- *
- * \return Nothing
*/
void bridge_channel_internal_suspend_nolock(struct ast_bridge_channel *bridge_channel)
{
@@ -869,8 +851,6 @@
* \brief Suspend a channel from a bridge.
*
* \param bridge_channel Channel to suspend.
- *
- * \return Nothing
*/
static void bridge_channel_suspend(struct ast_bridge_channel *bridge_channel)
{
@@ -886,8 +866,6 @@
* \param bridge_channel Channel to unsuspend.
*
* \note This function assumes bridge_channel->bridge is locked.
- *
- * \return Nothing
*/
void bridge_channel_internal_unsuspend_nolock(struct ast_bridge_channel *bridge_channel)
{
@@ -912,8 +890,6 @@
* \brief Unsuspend a channel from a bridge.
*
* \param bridge_channel Channel to unsuspend.
- *
- * \return Nothing
*/
static void bridge_channel_unsuspend(struct ast_bridge_channel *bridge_channel)
{
@@ -1268,8 +1244,6 @@
*
* \param bridge_channel Which channel to run the application on.
* \param data Action frame data to run the application.
- *
- * \return Nothing
*/
static void bridge_channel_run_app(struct ast_bridge_channel *bridge_channel, struct bridge_run_app *data)
{
@@ -1362,8 +1336,6 @@
*
* \param bridge_channel Which channel to play a file on.
* \param payload Action frame payload to play a file.
- *
- * \return Nothing
*/
static void bridge_channel_playfile(struct ast_bridge_channel *bridge_channel, struct bridge_playfile *payload)
{
@@ -1434,8 +1406,6 @@
*
* \param bridge_channel Which channel to call the callback on.
* \param data Action frame data to call the callback.
- *
- * \return Nothing
*/
static void bridge_channel_do_callback(struct ast_bridge_channel *bridge_channel, struct bridge_custom_callback *data)
{
@@ -1564,8 +1534,6 @@
* \since 12.0.0
*
* \param bridge_channel Channel to run expired intervals on.
- *
- * \return Nothing
*/
static void bridge_channel_handle_interval(struct ast_bridge_channel *bridge_channel)
{
@@ -1877,8 +1845,6 @@
* \since 12.8.0
*
* \param bridge_channel Channel to check expired interdigit timer on.
- *
- * \return Nothing
*/
static void bridge_channel_handle_feature_timeout(struct ast_bridge_channel *bridge_channel)
{
@@ -1922,7 +1888,10 @@
ao2_iterator_destroy(&iter);
}
-/*! \brief Internal function that plays back DTMF on a bridge channel */
+/*!
+ * \internal
+ * \brief Play back DTMF on a bridge channel
+ */
static void bridge_channel_dtmf_stream(struct ast_bridge_channel *bridge_channel, const char *dtmf)
{
ast_debug(1, "Playing DTMF stream '%s' out to %p(%s)\n",
@@ -2061,8 +2030,6 @@
* \param bridge_channel Channel to execute the action on.
* \param action What to do.
* \param data data from the action.
- *
- * \return Nothing
*/
static void bridge_channel_handle_action(struct ast_bridge_channel *bridge_channel,
enum bridge_channel_action_type action, void *data)
@@ -2130,8 +2097,6 @@
* \param bridge_channel Channel causing the check.
*
* \note On entry, bridge_channel->bridge is already locked.
- *
- * \return Nothing
*/
static void bridge_channel_dissolve_check(struct ast_bridge_channel *bridge_channel)
{
@@ -2324,8 +2289,6 @@
*
* \param bridge_channel Channel to execute the control frame action on.
* \param fr Control frame to handle.
- *
- * \return Nothing
*/
static void bridge_channel_handle_control(struct ast_bridge_channel *bridge_channel, struct ast_frame *fr)
{
@@ -2403,8 +2366,6 @@
*
* \param chan Channel to send text to
* \param f The frame containing the text data to send
- *
- * \return Nothing
*/
static void sendtext_safe(struct ast_channel *chan, const struct ast_frame *f)
{
@@ -2438,8 +2399,6 @@
* \since 12.0.0
*
* \param bridge_channel Channel to write outgoing frame.
- *
- * \return Nothing
*/
static void bridge_channel_handle_write(struct ast_bridge_channel *bridge_channel)
{
@@ -2544,7 +2503,10 @@
bridge_frame_free(fr);
}
-/*! \brief Internal function to handle DTMF from a channel */
+/*!
+ * \internal
+ * \brief Handle DTMF from a channel
+ */
static struct ast_frame *bridge_handle_dtmf(struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
{
struct ast_bridge_features *features = bridge_channel->features;
@@ -2802,8 +2764,6 @@
* \param bridge_channel Channel to wait.
*
* \note Each channel does writing/reading in their own thread.
- *
- * \return Nothing
*/
static void bridge_channel_wait(struct ast_bridge_channel *bridge_channel)
{
@@ -2866,8 +2826,6 @@
*
* \param bridge_channel Which channel is involved.
* \param type Specified join/leave event.
- *
- * \return Nothing
*/
static void bridge_channel_event_join_leave(struct ast_bridge_channel *bridge_channel, enum ast_bridge_hook_type type)
{
--
To view, visit https://gerrit.asterisk.org/c/asterisk/+/17356
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings
Gerrit-Project: asterisk
Gerrit-Branch: 18
Gerrit-Change-Id: Ia5370289e6526001a6b52754b533bcea1a9d7e5c
Gerrit-Change-Number: 17356
Gerrit-PatchSet: 2
Gerrit-Owner: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20211118/560e8dcc/attachment-0001.html>
More information about the asterisk-code-review
mailing list