main: Fix for Doxygen.

ASTERISK-29763

Change-Id: Ib8359e3590a9109eb04a5376559d040e5e21867e

main/bridge.c

@@ -182,8 +182,6 @@ struct ao2_container *ast_bridges(void)
  * \since 12.0.0
  *
  * \param bridge Requesting service.
- *
- * \return Nothing
  */
 static void bridge_manager_service_req(struct ast_bridge *bridge)
 {
@@ -290,8 +288,6 @@ int ast_bridge_technology_unregister(struct ast_bridge_technology *technology)
  *
  * \param bridge What to queue the action on.
  * \param action What to do.
- *
- * \return Nothing
  */
 static void bridge_queue_action_nodup(struct ast_bridge *bridge, struct ast_frame *action)
 {
@@ -355,8 +351,6 @@ void bridge_dissolve(struct ast_bridge *bridge, int cause)
  * \param bridge_channel Stolen channel causing the check.  It is not in the bridge to check and may be in another bridge.
  *
  * \note On entry, bridge and bridge_channel->bridge are already locked.
- *
- * \return Nothing
  */
 static void bridge_dissolve_check_stolen(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel)
 {
@@ -387,8 +381,6 @@ static void bridge_dissolve_check_stolen(struct ast_bridge *bridge, struct ast_b
  * \brief Update connected line information after a bridge has been reconfigured.
  *
  * \param bridge The bridge itself.
- *
- * \return Nothing
  */
 static void bridge_reconfigured_connected_line_update(struct ast_bridge *bridge)
 {
@@ -437,8 +429,6 @@ static void bridge_reconfigured_connected_line_update(struct ast_bridge *bridge)
  * \param bridge_channel What is joining the bridge technology.
  *
  * \note On entry, bridge is already locked.
- *
- * \return Nothing
  */
 static void bridge_channel_complete_join(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel)
 {
@@ -480,8 +470,6 @@ static void bridge_channel_complete_join(struct ast_bridge *bridge, struct ast_b
  * \param bridge Check for new channels on this bridge.
  *
  * \note On entry, bridge is already locked.
- *
- * \return Nothing
  */
 static void bridge_complete_join(struct ast_bridge *bridge)
 {
@@ -568,8 +556,6 @@ struct tech_deferred_destroy {
  * \param action Deferred bridge tech destruction.
  *
  * \note On entry, bridge must not be locked.
- *
- * \return Nothing
  */
 static void bridge_tech_deferred_destroy(struct ast_bridge *bridge, struct ast_frame *action)
 {
@@ -597,9 +583,7 @@ static void bridge_tech_deferred_destroy(struct ast_bridge *bridge, struct ast_f
  * \param action What to do.
  *
  * \note On entry, bridge is already locked.
- * \note Can be called by the bridge destructor.
- *
- * \return Nothing
+ * \note Can be called by the bridge destructor
  */
 static void bridge_action_bridge(struct ast_bridge *bridge, struct ast_frame *action)
 {
@@ -634,8 +618,6 @@ static void bridge_action_bridge(struct ast_bridge *bridge, struct ast_frame *ac
  *
  * \note On entry, bridge is already locked.
  * \note Can be called by the bridge destructor.
- *
- * \return Nothing
  */
 static void bridge_handle_actions(struct ast_bridge *bridge)
 {
@@ -835,8 +817,6 @@ struct ast_bridge *bridge_base_init(struct ast_bridge *self, uint32_t capabiliti
  * \param self Bridge to operate upon.
  *
  * \note Stub because of nothing to do.
- *
- * \return Nothing
  */
 static void bridge_base_destroy(struct ast_bridge *self)
 {
@@ -848,8 +828,6 @@ static void bridge_base_destroy(struct ast_bridge *self)
  * \since 12.0.0
  *
  * \param self Bridge to operate upon.
- *
- * \return Nothing
  */
 static void bridge_base_dissolving(struct ast_bridge *self)
 {
@@ -885,8 +863,6 @@ static int bridge_base_push(struct ast_bridge *self, struct ast_bridge_channel *
  * \param bridge_channel Bridge channel to pull.
  *
  * \note On entry, self is already locked.
- *
- * \return Nothing
  */
 static void bridge_base_pull(struct ast_bridge *self, struct ast_bridge_channel *bridge_channel)
 {
@@ -902,8 +878,6 @@ static void bridge_base_pull(struct ast_bridge *self, struct ast_bridge_channel
  * \param bridge_channel Bridge channel that was masqueraded.
  *
  * \note On entry, self is already locked.
- *
- * \return Nothing
  */
 static void bridge_base_notify_masquerade(struct ast_bridge *self, struct ast_bridge_channel *bridge_channel)
 {
@@ -1197,8 +1171,6 @@ static int smart_bridge_operation(struct ast_bridge *bridge)
  * \since 12.0.0
  *
  * \param bridge_channel What to check.
- *
- * \return Nothing
  */
 static void check_bridge_play_sound(struct ast_bridge_channel *bridge_channel)
 {
@@ -1227,8 +1199,6 @@ static void check_bridge_play_sound(struct ast_bridge_channel *bridge_channel)
  * \param bridge What to operate on.
  *
  * \note On entry, the bridge is already locked.
- *
- * \return Nothing
  */
 static void check_bridge_play_sounds(struct ast_bridge *bridge)
 {
@@ -1257,8 +1227,6 @@ void ast_bridge_vars_set(struct ast_channel *chan, const char *name, const char
  *
  * \note On entry, the bridge is already locked.
  * \note The bridge is expected to have exactly two parties.
- *
- * \return Nothing
  */
 static void set_bridge_peer_vars_2party(struct ast_channel *c0, struct ast_channel *c1)
 {
@@ -1297,8 +1265,6 @@ static void set_bridge_peer_vars_2party(struct ast_channel *c0, struct ast_chann
  * \param cur_idx Which index into names[] to skip.
  * \param names Channel names to put in the buffer.
  * \param num_names Number of names in the array.
- *
- * \return Nothing
  */
 static void fill_bridgepeer_buf(char *buf, unsigned int cur_idx, const char *names[], unsigned int num_names)
 {
@@ -1336,8 +1302,6 @@ static void fill_bridgepeer_buf(char *buf, unsigned int cur_idx, const char *nam
  *
  * \note On entry, the bridge is already locked.
  * \note The bridge is expected to have more than two parties.
- *
- * \return Nothing
  */
 static void set_bridge_peer_vars_multiparty(struct ast_bridge *bridge)
 {
@@ -1398,8 +1362,6 @@ static void set_bridge_peer_vars_multiparty(struct ast_bridge *bridge)
  * \param bridge What to operate on.
  *
  * \note On entry, the bridge is already locked.
- *
- * \return Nothing
  */
 static void set_bridge_peer_vars_holding(struct ast_bridge *bridge)
 {
@@ -1420,8 +1382,6 @@ static void set_bridge_peer_vars_holding(struct ast_bridge *bridge)
  * \param bridge What to operate on.
  *
  * \note On entry, the bridge is already locked.
- *
- * \return Nothing
  */
 static void set_bridge_peer_vars(struct ast_bridge *bridge)
 {
@@ -1530,8 +1490,6 @@ AST_LIST_HEAD_NOLOCK(bridge_channel_impart_ds_head, bridge_channel_impart_cond);
  * \since 13.9.0
  *
  * \param ds_head List of imparting threads to wake up.
- *
- * \return Nothing
  */
 static void bridge_channel_impart_ds_head_signal(struct bridge_channel_impart_ds_head *ds_head)
 {
@@ -1561,8 +1519,6 @@ static void bridge_channel_impart_ds_head_dtor(void *doomed)
  * \param data Bridge impart datastore data to fixup from old_chan.
  * \param old_chan The datastore is moving from this channel.
  * \param new_chan The datastore is moving to this channel.
- *
- * \return Nothing
  */
 static void bridge_channel_impart_ds_head_fixup(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan)
 {
@@ -1641,8 +1597,6 @@ void bridge_channel_impart_signal(struct ast_channel *chan)
  * \since 13.9.0
  *
  * \param cond Imparting conditional to wait for.
- *
- * \return Nothing
  */
 static void bridge_channel_impart_wait(struct bridge_channel_impart_cond *cond)
 {
@@ -2049,8 +2003,6 @@ int ast_bridge_kick(struct ast_bridge *bridge, struct ast_channel *chan)
  *
  * \param bridge_channel What is to point to a new bridge.
  * \param new_bridge Where the bridge channel should point.
- *
- * \return Nothing
  */
 static void bridge_channel_change_bridge(struct ast_bridge_channel *bridge_channel, struct ast_bridge *new_bridge)
 {
@@ -2621,7 +2573,7 @@ static int bridge_allows_optimization(struct ast_bridge *bridge)
  *
  * \note It is assumed that chan is already locked.
  *
- * \retval bridge on success with bridge and bridge_channel locked.
+ * \return bridge on success with bridge and bridge_channel locked.
  * \retval NULL if cannot do optimization now.
  */
 static struct ast_bridge *optimize_lock_chan_stack(struct ast_channel *chan)
@@ -2666,7 +2618,7 @@ static struct ast_bridge *optimize_lock_chan_stack(struct ast_channel *chan)
  *
  * \param peer Other unreal channel in the pair.
  *
- * \retval bridge on success with bridge, bridge_channel, and peer locked.
+ * \return bridge on success with bridge, bridge_channel, and peer locked.
  * \retval NULL if cannot do optimization now.
  */
 static struct ast_bridge *optimize_lock_peer_stack(struct ast_channel *peer)
@@ -3036,19 +2988,6 @@ enum ast_bridge_optimization ast_bridges_allow_optimization(struct ast_bridge *c
 	}
 }
 
-/*!
- * \internal
- * \brief Adjust the bridge merge inhibit request count.
- * \since 12.0.0
- *
- * \param bridge What to operate on.
- * \param request Inhibit request increment.
- *     (Positive to add requests.  Negative to remove requests.)
- *
- * \note This function assumes bridge is locked.
- *
- * \return Nothing
- */
 void bridge_merge_inhibit_nolock(struct ast_bridge *bridge, int request)
 {
 	int new_request;
@@ -3196,8 +3135,6 @@ int ast_bridge_interval_unregister(enum ast_bridge_builtin_interval interval)
  * \since 12.0.0
  *
  * \param vhook Object to destroy.
- *
- * \return Nothing
  */
 static void bridge_hook_destroy(void *vhook)
 {
@@ -3219,7 +3156,7 @@ static void bridge_hook_destroy(void *vhook)
  * \param destructor Optional destructor callback for hook_pvt data
  * \param remove_flags Dictates what situations the hook should be removed.
  *
- * \retval hook on success.
+ * \return hook on success.
  * \retval NULL on error.
  */
 static struct ast_bridge_hook *bridge_hook_generic(size_t size,
@@ -3524,8 +3461,6 @@ static int hook_remove_match(void *obj, void *arg, int flags)
  *
  * \param hooks Hooks container to work on.
  * \param remove_flags Determinator for whether hook is removed
- *
- * \return Nothing
  */
 static void hooks_remove_container(struct ao2_container *hooks, enum ast_bridge_hook_remove_flags remove_flags)
 {
@@ -3540,8 +3475,6 @@ static void hooks_remove_container(struct ao2_container *hooks, enum ast_bridge_
  *
  * \param hooks Hooks heap to work on.
  * \param remove_flags Determinator for whether hook is removed
- *
- * \return Nothing
  */
 static void hooks_remove_heap(struct ast_heap *hooks, enum ast_bridge_hook_remove_flags remove_flags)
 {
@@ -4273,7 +4206,7 @@ static struct ast_channel *get_transferee(struct ao2_container *channels, struct
  * \param chan2 Other transferer channel. May or may not be bridged.
  * \param bridge1 Bridge that chan1 is in. Guaranteed to be non-NULL.
  * \param bridge2 Bridge that chan2 is in. If NULL, then chan2 is not bridged.
- * \param publication Data to publish for a stasis attended transfer message.
+ * \param transfer_msg Data to publish for a stasis attended transfer message.
  * \retval AST_BRIDGE_TRANSFER_FAIL Internal error occurred
  * \retval AST_BRIDGE_TRANSFER_SUCCESS Succesfully transferred the bridge
  */
@@ -4613,7 +4546,7 @@ publish:
  * \note dest_bridge and source_bridge_channel's bridge MUST be locked before calling this function.
  *
  * \param dest_bridge The final bridge for the attended transfer
- * \param source_channel Channel who is bridged to the channel that will move
+ * \param source_bridge_channel Channel who is bridged to the channel that will move
  * \param swap_channel Channel to be swapped out of the dest_bridge
  * \return The success or failure of the swap attempt
  */
@@ -4657,7 +4590,7 @@ static enum ast_transfer_result bridge_swap_attended_transfer(struct ast_bridge
  * \param to_target_bridge_channel to_transfer_target's bridge_channel
  * \param to_transferee_bridge The bridge between to_transferee and the transferee
  * \param to_target_bridge The bridge between to_transfer_target and the transfer_target
- * \param publication Data to publish for a stasis attended transfer message
+ * \param transfer_msg Data to publish for a stasis attended transfer message
  * \return The success or failure of the attended transfer
  */
 static enum ast_transfer_result two_bridge_attended_transfer(struct ast_channel *to_transferee,
@@ -4917,8 +4850,6 @@ end:
  * \since 12.0.0
  *
  * \param bridge requesting service.
- *
- * \return Nothing
  */
 static void bridge_manager_service(struct ast_bridge *bridge)
 {
@@ -4936,8 +4867,6 @@ static void bridge_manager_service(struct ast_bridge *bridge)
  * \internal
  * \brief Bridge manager service thread.
  * \since 12.0.0
- *
- * \return Nothing
  */
 static void *bridge_manager_thread(void *data)
 {
@@ -4971,8 +4900,6 @@ static void *bridge_manager_thread(void *data)
  * \since 12.0.0
  *
  * \param obj Bridge manager to destroy.
- *
- * \return Nothing
  */
 static void bridge_manager_destroy(void *obj)
 {
@@ -5003,7 +4930,7 @@ static void bridge_manager_destroy(void *obj)
  * \brief Create the bridge manager controller.
  * \since 12.0.0
  *
- * \retval manager on success.
+ * \return manager on success.
  * \retval NULL on error.
  */
 static struct bridge_manager_controller *bridge_manager_create(void)
@@ -5567,8 +5494,6 @@ static int manager_bridge_tech_list(struct mansession *s, const struct message *
  * \param v_obj A pointer to the object we want the key printed.
  * \param where User data needed by prnt to determine where to put output.
  * \param prnt Print output callback function to use.
- *
- * \return Nothing
  */
 static void bridge_prnt_obj(void *v_obj, void *where, ao2_prnt_fn *prnt)
 {
@@ -5585,8 +5510,6 @@ static void bridge_prnt_obj(void *v_obj, void *where, ao2_prnt_fn *prnt)
  * \internal
  * \brief Shutdown the bridging system.  Stuff to do on graceful shutdown.
  * \since 13.3.0
- *
- * \return Nothing
  */
 static void bridge_cleanup(void)
 {