res_ari: Fix for Doxygen.

ASTERISK-29756

Change-Id: I2f1c1eea1c902492b77b74de9950f20ebbb7e758
This commit is contained in:
Alexander Traud
2021-11-17 13:18:32 +01:00
committed by Kevin Harwell
parent c30ed45c94
commit 634e3ebdb8
20 changed files with 405 additions and 353 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -52,7 +52,7 @@
* \param bridge_id ID of the bridge to lookup.
*
* \return Bridget.
* \return \c NULL if bridge does not exist.
* \retval NULL if bridge does not exist.
*/
static struct ast_bridge *find_bridge(
struct ast_ari_response *response,
@@ -87,7 +87,7 @@ static struct ast_bridge *find_bridge(
* \param[out] response Response to fill with an error if control is not found.
* \param channel_id ID of the channel to lookup.
* \return Channel control object.
* \return \c NULL if control object does not exist.
* \retval NULL if control object does not exist.
*/
static struct stasis_app_control *find_channel_control(
struct ast_ari_response *response,
@@ -343,6 +343,7 @@ static struct ast_channel *prepare_bridge_media_channel(const char *type)
* \param args_media_count number of media items in \c media
* \param args_lang language string split from arguments
* \param args_offset_ms milliseconds offset split from arguments
* \param args_skipms
* \param args_playback_id string to use for playback split from
* arguments (null valid)
* \param response ARI response being built
@@ -352,7 +353,7 @@ static struct ast_channel *prepare_bridge_media_channel(const char *type)
* \param playback_url stores playback URL for use with response
*
* \retval -1 operation failed
* \retval operation was successful
* \return operation was successful
*/
static int ari_bridges_play_helper(const char **args_media,
size_t args_media_count,
@@ -514,6 +515,7 @@ enum play_found_result {
* \param args_media_count number of media items in \c media
* \param args_lang language string split from arguments
* \param args_offset_ms milliseconds offset split from arguments
* \param args_skipms
* \param args_playback_id string to use for playback split from
* arguments (null valid)
* \param response ARI response being built

View File

@@ -147,7 +147,7 @@ static int channel_state_invalid(struct stasis_app_control *control,
* \param[out] response Response to fill with an error if control is not found.
* \param channel_id ID of the channel to lookup.
* \return Channel control object.
* \return \c NULL if control object does not exist.
* \retval NULL if control object does not exist.
*/
static struct stasis_app_control *find_control(
struct ast_ari_response *response,
@@ -1726,8 +1726,8 @@ struct ast_datastore_info dialstring_info = {
*
* \param chan The channel on which to save the dialstring
* \param dialstring The dialstring to save
* \retval 0 SUCCESS!
* \reval -1 Failure :(
* \retval 0 on success.
* \retval -1 on error.
*/
static int save_dialstring(struct ast_channel *chan, const char *dialstring)
{

View File

@@ -61,8 +61,6 @@ int ast_ari_websocket_events_event_websocket_init(void);
/*!
* \brief WebSocket connection for events.
*
* \return Nothing
*/
void ast_ari_websocket_events_event_websocket_dtor(void);
@@ -86,7 +84,6 @@ int ast_ari_websocket_events_event_websocket_attempted(struct ast_tcptls_session
* \param session ARI WebSocket.
* \param headers HTTP headers.
* \param args Swagger parameters.
* \param session_id The id of the current session.
*/
void ast_ari_websocket_events_event_websocket_established(struct ast_ari_websocket_session *session,
struct ast_variable *headers, struct ast_ari_events_event_websocket_args *args);