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

View File

@@ -56,9 +56,11 @@
/*!
* \brief Parameter parsing callback for /channels.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_list_cb(
@@ -167,9 +169,11 @@ int ast_ari_channels_originate_parse_body(
/*!
* \brief Parameter parsing callback for /channels.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_originate_cb(
@@ -300,9 +304,11 @@ int ast_ari_channels_create_parse_body(
/*!
* \brief Parameter parsing callback for /channels/create.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_create_cb(
@@ -377,9 +383,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_get_cb(
@@ -492,9 +500,11 @@ int ast_ari_channels_originate_with_id_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_originate_with_id_cb(
@@ -608,9 +618,11 @@ int ast_ari_channels_hangup_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_hangup_cb(
@@ -705,9 +717,11 @@ int ast_ari_channels_continue_in_dialplan_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/continue.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_continue_in_dialplan_cb(
@@ -801,9 +815,11 @@ int ast_ari_channels_move_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/move.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_move_cb(
@@ -886,9 +902,11 @@ int ast_ari_channels_redirect_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/redirect.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_redirect_cb(
@@ -958,9 +976,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/answer.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_answer_cb(
@@ -1018,9 +1038,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/ring.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_ring_cb(
@@ -1078,9 +1100,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/ring.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_ring_stop_cb(
@@ -1167,9 +1191,11 @@ int ast_ari_channels_send_dtmf_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/dtmf.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_send_dtmf_cb(
@@ -1263,9 +1289,11 @@ int ast_ari_channels_mute_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/mute.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_mute_cb(
@@ -1346,9 +1374,11 @@ int ast_ari_channels_unmute_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/mute.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_unmute_cb(
@@ -1416,9 +1446,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/hold.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_hold_cb(
@@ -1476,9 +1508,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/hold.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_unhold_cb(
@@ -1549,9 +1583,11 @@ int ast_ari_channels_start_moh_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/moh.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_start_moh_cb(
@@ -1619,9 +1655,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/moh.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_stop_moh_cb(
@@ -1679,9 +1717,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/silence.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_start_silence_cb(
@@ -1739,9 +1779,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/silence.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_stop_silence_cb(
@@ -1853,9 +1895,11 @@ int ast_ari_channels_play_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/play.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_play_cb(
@@ -2027,9 +2071,11 @@ int ast_ari_channels_play_with_id_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/play/{playbackId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_play_with_id_cb(
@@ -2188,9 +2234,11 @@ int ast_ari_channels_record_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/record.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_record_cb(
@@ -2290,9 +2338,11 @@ int ast_ari_channels_get_channel_var_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/variable.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_get_channel_var_cb(
@@ -2377,9 +2427,11 @@ int ast_ari_channels_set_channel_var_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/variable.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_set_channel_var_cb(
@@ -2479,9 +2531,11 @@ int ast_ari_channels_snoop_channel_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/snoop.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_snoop_channel_cb(
@@ -2585,9 +2639,11 @@ int ast_ari_channels_snoop_channel_with_id_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/snoop/{snoopId}.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_snoop_channel_with_id_cb(
@@ -2683,9 +2739,11 @@ int ast_ari_channels_dial_parse_body(
/*!
* \brief Parameter parsing callback for /channels/{channelId}/dial.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_dial_cb(
@@ -2755,9 +2813,11 @@ fin: __attribute__((unused))
}
/*!
* \brief Parameter parsing callback for /channels/{channelId}/rtp_statistics.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_rtpstatistics_cb(
@@ -2858,9 +2918,11 @@ int ast_ari_channels_external_media_parse_body(
/*!
* \brief Parameter parsing callback for /channels/externalMedia.
* \param ser TCP/TLS session object
* \param get_params GET parameters in the HTTP request.
* \param path_vars Path variables extracted from the request.
* \param headers HTTP headers.
* \param body
* \param[out] response Response to the HTTP request.
*/
static void ast_ari_channels_external_media_cb(