Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

ARI: Remove unnecessary \briefs from automatically generated documentation

Browse Source 
Review: https://reviewboard.asterisk.org/r/3440/
........

Merged revisions 412653 from http://svn.asterisk.org/svn/asterisk/branches/12


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@417770 65c4cc65-6c06-0410-ace0-fbb531ad65f3
changes/97/197/1
Jonathan Rose 11 years ago
parent 56a6cd0fa8
commit a69e0cd32a
12 changed files with 248 additions and 248 deletions
Show Stats Download Patch File Download Diff File

26
res/ari/resource_applications.h
Unescape View File

@ -39,7 +39,7 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_applications_list() */
/*! Argument struct for ast_ari_applications_list() */
struct ast_ari_applications_list_args {
};
/*!
@ -50,9 +50,9 @@ struct ast_ari_applications_list_args {
* \param[out] response HTTP response
*/
void ast_ari_applications_list(struct ast_variable *headers, struct ast_ari_applications_list_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_applications_get() */
/*! Argument struct for ast_ari_applications_get() */
struct ast_ari_applications_get_args {
/*! \brief Application's name */
/*! Application's name */
const char *application_name;
};
/*!
@ -63,15 +63,15 @@ struct ast_ari_applications_get_args {
* \param[out] response HTTP response
*/
void ast_ari_applications_get(struct ast_variable *headers, struct ast_ari_applications_get_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_applications_subscribe() */
/*! Argument struct for ast_ari_applications_subscribe() */
struct ast_ari_applications_subscribe_args {
/*! \brief Application's name */
/*! Application's name */
const char *application_name;
/*! \brief Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName} */
/*! Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName} */
const char **event_source;
/*! \brief Length of event_source array. */
/*! Length of event_source array. */
size_t event_source_count;
/*! \brief Parsing context for event_source. */
/*! Parsing context for event_source. */
char *event_source_parse;
};
/*!
@ -95,15 +95,15 @@ int ast_ari_applications_subscribe_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_applications_subscribe(struct ast_variable *headers, struct ast_ari_applications_subscribe_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_applications_unsubscribe() */
/*! Argument struct for ast_ari_applications_unsubscribe() */
struct ast_ari_applications_unsubscribe_args {
/*! \brief Application's name */
/*! Application's name */
const char *application_name;
/*! \brief Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName} */
/*! Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName} */
const char **event_source;
/*! \brief Length of event_source array. */
/*! Length of event_source array. */
size_t event_source_count;
/*! \brief Parsing context for event_source. */
/*! Parsing context for event_source. */
char *event_source_parse;
};
/*!

18
res/ari/resource_asterisk.h
Unescape View File

@ -39,13 +39,13 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_asterisk_get_info() */
/*! Argument struct for ast_ari_asterisk_get_info() */
struct ast_ari_asterisk_get_info_args {
/*! \brief Array of Filter information returned */
/*! Array of Filter information returned */
const char **only;
/*! \brief Length of only array. */
/*! Length of only array. */
size_t only_count;
/*! \brief Parsing context for only. */
/*! Parsing context for only. */
char *only_parse;
};
/*!
@ -67,9 +67,9 @@ int ast_ari_asterisk_get_info_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_asterisk_get_info(struct ast_variable *headers, struct ast_ari_asterisk_get_info_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_asterisk_get_global_var() */
/*! Argument struct for ast_ari_asterisk_get_global_var() */
struct ast_ari_asterisk_get_global_var_args {
/*! \brief The variable to get */
/*! The variable to get */
const char *variable;
};
/*!
@ -91,11 +91,11 @@ int ast_ari_asterisk_get_global_var_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_asterisk_get_global_var(struct ast_variable *headers, struct ast_ari_asterisk_get_global_var_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_asterisk_set_global_var() */
/*! Argument struct for ast_ari_asterisk_set_global_var() */
struct ast_ari_asterisk_set_global_var_args {
/*! \brief The variable to set */
/*! The variable to set */
const char *variable;
/*! \brief The value to set the variable to */
/*! The value to set the variable to */
const char *value;
};
/*!

104
res/ari/resource_bridges.h
Unescape View File

@ -39,7 +39,7 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_bridges_list() */
/*! Argument struct for ast_ari_bridges_list() */
struct ast_ari_bridges_list_args {
};
/*!
@ -50,13 +50,13 @@ struct ast_ari_bridges_list_args {
* \param[out] response HTTP response
*/
void ast_ari_bridges_list(struct ast_variable *headers, struct ast_ari_bridges_list_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_create() */
/*! Argument struct for ast_ari_bridges_create() */
struct ast_ari_bridges_create_args {
/*! \brief Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media). */
/*! Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media). */
const char *type;
/*! \brief Unique ID to give to the bridge being created. */
/*! Unique ID to give to the bridge being created. */
const char *bridge_id;
/*! \brief Name to give to the bridge being created. */
/*! Name to give to the bridge being created. */
const char *name;
};
/*!
@ -80,13 +80,13 @@ int ast_ari_bridges_create_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_bridges_create(struct ast_variable *headers, struct ast_ari_bridges_create_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_create_or_update_with_id() */
/*! Argument struct for ast_ari_bridges_create_or_update_with_id() */
struct ast_ari_bridges_create_or_update_with_id_args {
/*! \brief Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set. */
/*! Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set. */
const char *type;
/*! \brief Unique ID to give to the bridge being created. */
/*! Unique ID to give to the bridge being created. */
const char *bridge_id;
/*! \brief Set the name of the bridge. */
/*! Set the name of the bridge. */
const char *name;
};
/*!
@ -110,9 +110,9 @@ int ast_ari_bridges_create_or_update_with_id_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_bridges_create_or_update_with_id(struct ast_variable *headers, struct ast_ari_bridges_create_or_update_with_id_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_get() */
/*! Argument struct for ast_ari_bridges_get() */
struct ast_ari_bridges_get_args {
/*! \brief Bridge's id */
/*! Bridge's id */
const char *bridge_id;
};
/*!
@ -123,9 +123,9 @@ struct ast_ari_bridges_get_args {
* \param[out] response HTTP response
*/
void ast_ari_bridges_get(struct ast_variable *headers, struct ast_ari_bridges_get_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_destroy() */
/*! Argument struct for ast_ari_bridges_destroy() */
struct ast_ari_bridges_destroy_args {
/*! \brief Bridge's id */
/*! Bridge's id */
const char *bridge_id;
};
/*!
@ -138,17 +138,17 @@ struct ast_ari_bridges_destroy_args {
* \param[out] response HTTP response
*/
void ast_ari_bridges_destroy(struct ast_variable *headers, struct ast_ari_bridges_destroy_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_add_channel() */
/*! Argument struct for ast_ari_bridges_add_channel() */
struct ast_ari_bridges_add_channel_args {
/*! \brief Bridge's id */
/*! Bridge's id */
const char *bridge_id;
/*! \brief Array of Ids of channels to add to bridge */
/*! Array of Ids of channels to add to bridge */
const char **channel;
/*! \brief Length of channel array. */
/*! Length of channel array. */
size_t channel_count;
/*! \brief Parsing context for channel. */
/*! Parsing context for channel. */
char *channel_parse;
/*! \brief Channel's role in the bridge */
/*! Channel's role in the bridge */
const char *role;
};
/*!
@ -170,15 +170,15 @@ int ast_ari_bridges_add_channel_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_bridges_add_channel(struct ast_variable *headers, struct ast_ari_bridges_add_channel_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_remove_channel() */
/*! Argument struct for ast_ari_bridges_remove_channel() */
struct ast_ari_bridges_remove_channel_args {
/*! \brief Bridge's id */
/*! Bridge's id */
const char *bridge_id;
/*! \brief Array of Ids of channels to remove from bridge */
/*! Array of Ids of channels to remove from bridge */
const char **channel;
/*! \brief Length of channel array. */
/*! Length of channel array. */
size_t channel_count;
/*! \brief Parsing context for channel. */
/*! Parsing context for channel. */
char *channel_parse;
};
/*!
@ -200,11 +200,11 @@ int ast_ari_bridges_remove_channel_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_bridges_remove_channel(struct ast_variable *headers, struct ast_ari_bridges_remove_channel_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_start_moh() */
/*! Argument struct for ast_ari_bridges_start_moh() */
struct ast_ari_bridges_start_moh_args {
/*! \brief Bridge's id */
/*! Bridge's id */
const char *bridge_id;
/*! \brief Channel's id */
/*! Channel's id */
const char *moh_class;
};
/*!
@ -226,9 +226,9 @@ int ast_ari_bridges_start_moh_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_bridges_start_moh(struct ast_variable *headers, struct ast_ari_bridges_start_moh_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_stop_moh() */
/*! Argument struct for ast_ari_bridges_stop_moh() */
struct ast_ari_bridges_stop_moh_args {
/*! \brief Bridge's id */
/*! Bridge's id */
const char *bridge_id;
};
/*!
@ -241,19 +241,19 @@ struct ast_ari_bridges_stop_moh_args {
* \param[out] response HTTP response
*/
void ast_ari_bridges_stop_moh(struct ast_variable *headers, struct ast_ari_bridges_stop_moh_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_play() */
/*! Argument struct for ast_ari_bridges_play() */
struct ast_ari_bridges_play_args {
/*! \brief Bridge's id */
/*! Bridge's id */
const char *bridge_id;
/*! \brief Media's URI to play. */
/*! Media's URI to play. */
const char *media;
/*! \brief For sounds, selects language for sound. */
/*! For sounds, selects language for sound. */
const char *lang;
/*! \brief Number of media to skip before playing. */
/*! Number of media to skip before playing. */
int offsetms;
/*! \brief Number of milliseconds to skip for forward/reverse operations. */
/*! Number of milliseconds to skip for forward/reverse operations. */
int skipms;
/*! \brief Playback Id. */
/*! Playback Id. */
const char *playback_id;
};
/*!
@ -277,19 +277,19 @@ int ast_ari_bridges_play_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_bridges_play(struct ast_variable *headers, struct ast_ari_bridges_play_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_play_with_id() */
/*! Argument struct for ast_ari_bridges_play_with_id() */
struct ast_ari_bridges_play_with_id_args {
/*! \brief Bridge's id */
/*! Bridge's id */
const char *bridge_id;
/*! \brief Playback ID. */
/*! Playback ID. */
const char *playback_id;
/*! \brief Media's URI to play. */
/*! Media's URI to play. */
const char *media;
/*! \brief For sounds, selects language for sound. */
/*! For sounds, selects language for sound. */
const char *lang;
/*! \brief Number of media to skip before playing. */
/*! Number of media to skip before playing. */
int offsetms;
/*! \brief Number of milliseconds to skip for forward/reverse operations. */
/*! Number of milliseconds to skip for forward/reverse operations. */
int skipms;
};
/*!
@ -313,23 +313,23 @@ int ast_ari_bridges_play_with_id_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_bridges_play_with_id(struct ast_variable *headers, struct ast_ari_bridges_play_with_id_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_bridges_record() */
/*! Argument struct for ast_ari_bridges_record() */
struct ast_ari_bridges_record_args {
/*! \brief Bridge's id */
/*! Bridge's id */
const char *bridge_id;
/*! \brief Recording's filename */
/*! Recording's filename */
const char *name;
/*! \brief Format to encode audio in */
/*! Format to encode audio in */
const char *format;
/*! \brief Maximum duration of the recording, in seconds. 0 for no limit. */
/*! Maximum duration of the recording, in seconds. 0 for no limit. */
int max_duration_seconds;
/*! \brief Maximum duration of silence, in seconds. 0 for no limit. */
/*! Maximum duration of silence, in seconds. 0 for no limit. */
int max_silence_seconds;
/*! \brief Action to take if a recording with the same name already exists. */
/*! Action to take if a recording with the same name already exists. */
const char *if_exists;
/*! \brief Play beep when recording begins */
/*! Play beep when recording begins */
int beep;
/*! \brief DTMF input to terminate recording. */
/*! DTMF input to terminate recording. */
const char *terminate_on;
};
/*!

222
res/ari/resource_channels.h
Unescape View File

@ -39,7 +39,7 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_channels_list() */
/*! Argument struct for ast_ari_channels_list() */
struct ast_ari_channels_list_args {
};
/*!
@ -50,29 +50,29 @@ struct ast_ari_channels_list_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_list(struct ast_variable *headers, struct ast_ari_channels_list_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_originate() */
/*! Argument struct for ast_ari_channels_originate() */
struct ast_ari_channels_originate_args {
/*! \brief Endpoint to call. */
/*! Endpoint to call. */
const char *endpoint;
/*! \brief The extension to dial after the endpoint answers */
/*! The extension to dial after the endpoint answers */
const char *extension;
/*! \brief The context to dial after the endpoint answers. If omitted, uses 'default' */
/*! The context to dial after the endpoint answers. If omitted, uses 'default' */
const char *context;
/*! \brief The priority to dial after the endpoint answers. If omitted, uses 1 */
/*! The priority to dial after the endpoint answers. If omitted, uses 1 */
long priority;
/*! \brief The application that is subscribed to the originated channel, and passed to the Stasis application. */
/*! The application that is subscribed to the originated channel, and passed to the Stasis application. */
const char *app;
/*! \brief The application arguments to pass to the Stasis application. */
/*! The application arguments to pass to the Stasis application. */
const char *app_args;
/*! \brief CallerID to use when dialing the endpoint or extension. */
/*! CallerID to use when dialing the endpoint or extension. */
const char *caller_id;
/*! \brief Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
/*! Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
int timeout;
/*! \brief The 'variables' key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { 'endpoint': 'SIP/Alice', 'variables': { 'CALLERID(name)': 'Alice' } } */
/*! The 'variables' key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { 'endpoint': 'SIP/Alice', 'variables': { 'CALLERID(name)': 'Alice' } } */
struct ast_json *variables;
/*! \brief The unique id to assign the channel on creation. */
/*! The unique id to assign the channel on creation. */
const char *channel_id;
/*! \brief The unique id to assign the second channel when using local channels. */
/*! The unique id to assign the second channel when using local channels. */
const char *other_channel_id;
};
/*!
@ -96,9 +96,9 @@ int ast_ari_channels_originate_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_originate(struct ast_variable *headers, struct ast_ari_channels_originate_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_get() */
/*! Argument struct for ast_ari_channels_get() */
struct ast_ari_channels_get_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
};
/*!
@ -109,29 +109,29 @@ struct ast_ari_channels_get_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_get(struct ast_variable *headers, struct ast_ari_channels_get_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_originate_with_id() */
/*! Argument struct for ast_ari_channels_originate_with_id() */
struct ast_ari_channels_originate_with_id_args {
/*! \brief The unique id to assign the channel on creation. */
/*! The unique id to assign the channel on creation. */
const char *channel_id;
/*! \brief Endpoint to call. */
/*! Endpoint to call. */
const char *endpoint;
/*! \brief The extension to dial after the endpoint answers */
/*! The extension to dial after the endpoint answers */
const char *extension;
/*! \brief The context to dial after the endpoint answers. If omitted, uses 'default' */
/*! The context to dial after the endpoint answers. If omitted, uses 'default' */
const char *context;
/*! \brief The priority to dial after the endpoint answers. If omitted, uses 1 */
/*! The priority to dial after the endpoint answers. If omitted, uses 1 */
long priority;
/*! \brief The application that is subscribed to the originated channel, and passed to the Stasis application. */
/*! The application that is subscribed to the originated channel, and passed to the Stasis application. */
const char *app;
/*! \brief The application arguments to pass to the Stasis application. */
/*! The application arguments to pass to the Stasis application. */
const char *app_args;
/*! \brief CallerID to use when dialing the endpoint or extension. */
/*! CallerID to use when dialing the endpoint or extension. */
const char *caller_id;
/*! \brief Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
/*! Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
int timeout;
/*! \brief The 'variables' key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { 'endpoint': 'SIP/Alice', 'variables': { 'CALLERID(name)': 'Alice' } } */
/*! The 'variables' key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { 'endpoint': 'SIP/Alice', 'variables': { 'CALLERID(name)': 'Alice' } } */
struct ast_json *variables;
/*! \brief The unique id to assign the second channel when using local channels. */
/*! The unique id to assign the second channel when using local channels. */
const char *other_channel_id;
};
/*!
@ -155,11 +155,11 @@ int ast_ari_channels_originate_with_id_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_originate_with_id(struct ast_variable *headers, struct ast_ari_channels_originate_with_id_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_hangup() */
/*! Argument struct for ast_ari_channels_hangup() */
struct ast_ari_channels_hangup_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief Reason for hanging up the channel */
/*! Reason for hanging up the channel */
const char *reason;
};
/*!
@ -181,15 +181,15 @@ int ast_ari_channels_hangup_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_hangup(struct ast_variable *headers, struct ast_ari_channels_hangup_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_continue_in_dialplan() */
/*! Argument struct for ast_ari_channels_continue_in_dialplan() */
struct ast_ari_channels_continue_in_dialplan_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief The context to continue to. */
/*! The context to continue to. */
const char *context;
/*! \brief The extension to continue to. */
/*! The extension to continue to. */
const char *extension;
/*! \brief The priority to continue to. */
/*! The priority to continue to. */
int priority;
};
/*!
@ -211,9 +211,9 @@ int ast_ari_channels_continue_in_dialplan_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_continue_in_dialplan(struct ast_variable *headers, struct ast_ari_channels_continue_in_dialplan_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_answer() */
/*! Argument struct for ast_ari_channels_answer() */
struct ast_ari_channels_answer_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
};
/*!
@ -224,9 +224,9 @@ struct ast_ari_channels_answer_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_answer(struct ast_variable *headers, struct ast_ari_channels_answer_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_ring() */
/*! Argument struct for ast_ari_channels_ring() */
struct ast_ari_channels_ring_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
};
/*!
@ -237,9 +237,9 @@ struct ast_ari_channels_ring_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_ring(struct ast_variable *headers, struct ast_ari_channels_ring_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_ring_stop() */
/*! Argument struct for ast_ari_channels_ring_stop() */
struct ast_ari_channels_ring_stop_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
};
/*!
@ -250,19 +250,19 @@ struct ast_ari_channels_ring_stop_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_ring_stop(struct ast_variable *headers, struct ast_ari_channels_ring_stop_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_send_dtmf() */
/*! Argument struct for ast_ari_channels_send_dtmf() */
struct ast_ari_channels_send_dtmf_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief DTMF To send. */
/*! DTMF To send. */
const char *dtmf;
/*! \brief Amount of time to wait before DTMF digits (specified in milliseconds) start. */
/*! Amount of time to wait before DTMF digits (specified in milliseconds) start. */
int before;
/*! \brief Amount of time in between DTMF digits (specified in milliseconds). */
/*! Amount of time in between DTMF digits (specified in milliseconds). */
int between;
/*! \brief Length of each DTMF digit (specified in milliseconds). */
/*! Length of each DTMF digit (specified in milliseconds). */
int duration;
/*! \brief Amount of time to wait after DTMF digits (specified in milliseconds) end. */
/*! Amount of time to wait after DTMF digits (specified in milliseconds) end. */
int after;
};
/*!
@ -284,11 +284,11 @@ int ast_ari_channels_send_dtmf_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_send_dtmf(struct ast_variable *headers, struct ast_ari_channels_send_dtmf_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_mute() */
/*! Argument struct for ast_ari_channels_mute() */
struct ast_ari_channels_mute_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief Direction in which to mute audio */
/*! Direction in which to mute audio */
const char *direction;
};
/*!
@ -310,11 +310,11 @@ int ast_ari_channels_mute_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_mute(struct ast_variable *headers, struct ast_ari_channels_mute_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_unmute() */
/*! Argument struct for ast_ari_channels_unmute() */
struct ast_ari_channels_unmute_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief Direction in which to unmute audio */
/*! Direction in which to unmute audio */
const char *direction;
};
/*!
@ -336,9 +336,9 @@ int ast_ari_channels_unmute_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_unmute(struct ast_variable *headers, struct ast_ari_channels_unmute_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_hold() */
/*! Argument struct for ast_ari_channels_hold() */
struct ast_ari_channels_hold_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
};
/*!
@ -349,9 +349,9 @@ struct ast_ari_channels_hold_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_hold(struct ast_variable *headers, struct ast_ari_channels_hold_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_unhold() */
/*! Argument struct for ast_ari_channels_unhold() */
struct ast_ari_channels_unhold_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
};
/*!
@ -362,11 +362,11 @@ struct ast_ari_channels_unhold_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_unhold(struct ast_variable *headers, struct ast_ari_channels_unhold_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_start_moh() */
/*! Argument struct for ast_ari_channels_start_moh() */
struct ast_ari_channels_start_moh_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief Music on hold class to use */
/*! Music on hold class to use */
const char *moh_class;
};
/*!
@ -390,9 +390,9 @@ int ast_ari_channels_start_moh_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_start_moh(struct ast_variable *headers, struct ast_ari_channels_start_moh_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_stop_moh() */
/*! Argument struct for ast_ari_channels_stop_moh() */
struct ast_ari_channels_stop_moh_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
};
/*!
@ -403,9 +403,9 @@ struct ast_ari_channels_stop_moh_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_stop_moh(struct ast_variable *headers, struct ast_ari_channels_stop_moh_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_start_silence() */
/*! Argument struct for ast_ari_channels_start_silence() */
struct ast_ari_channels_start_silence_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
};
/*!
@ -418,9 +418,9 @@ struct ast_ari_channels_start_silence_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_start_silence(struct ast_variable *headers, struct ast_ari_channels_start_silence_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_stop_silence() */
/*! Argument struct for ast_ari_channels_stop_silence() */
struct ast_ari_channels_stop_silence_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
};
/*!
@ -431,19 +431,19 @@ struct ast_ari_channels_stop_silence_args {
* \param[out] response HTTP response
*/
void ast_ari_channels_stop_silence(struct ast_variable *headers, struct ast_ari_channels_stop_silence_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_play() */
/*! Argument struct for ast_ari_channels_play() */
struct ast_ari_channels_play_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief Media's URI to play. */
/*! Media's URI to play. */
const char *media;
/*! \brief For sounds, selects language for sound. */
/*! For sounds, selects language for sound. */
const char *lang;
/*! \brief Number of media to skip before playing. */
/*! Number of media to skip before playing. */
int offsetms;
/*! \brief Number of milliseconds to skip for forward/reverse operations. */
/*! Number of milliseconds to skip for forward/reverse operations. */
int skipms;
/*! \brief Playback ID. */
/*! Playback ID. */
const char *playback_id;
};
/*!
@ -467,19 +467,19 @@ int ast_ari_channels_play_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_play(struct ast_variable *headers, struct ast_ari_channels_play_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_play_with_id() */
/*! Argument struct for ast_ari_channels_play_with_id() */
struct ast_ari_channels_play_with_id_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief Playback ID. */
/*! Playback ID. */
const char *playback_id;
/*! \brief Media's URI to play. */
/*! Media's URI to play. */
const char *media;
/*! \brief For sounds, selects language for sound. */
/*! For sounds, selects language for sound. */
const char *lang;
/*! \brief Number of media to skip before playing. */
/*! Number of media to skip before playing. */
int offsetms;
/*! \brief Number of milliseconds to skip for forward/reverse operations. */
/*! Number of milliseconds to skip for forward/reverse operations. */
int skipms;
};
/*!
@ -503,23 +503,23 @@ int ast_ari_channels_play_with_id_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_play_with_id(struct ast_variable *headers, struct ast_ari_channels_play_with_id_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_record() */
/*! Argument struct for ast_ari_channels_record() */
struct ast_ari_channels_record_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief Recording's filename */
/*! Recording's filename */
const char *name;
/*! \brief Format to encode audio in */
/*! Format to encode audio in */
const char *format;
/*! \brief Maximum duration of the recording, in seconds. 0 for no limit */
/*! Maximum duration of the recording, in seconds. 0 for no limit */
int max_duration_seconds;
/*! \brief Maximum duration of silence, in seconds. 0 for no limit */
/*! Maximum duration of silence, in seconds. 0 for no limit */
int max_silence_seconds;
/*! \brief Action to take if a recording with the same name already exists. */
/*! Action to take if a recording with the same name already exists. */
const char *if_exists;
/*! \brief Play beep when recording begins */
/*! Play beep when recording begins */
int beep;
/*! \brief DTMF input to terminate recording */
/*! DTMF input to terminate recording */
const char *terminate_on;
};
/*!
@ -543,11 +543,11 @@ int ast_ari_channels_record_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_record(struct ast_variable *headers, struct ast_ari_channels_record_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_get_channel_var() */
/*! Argument struct for ast_ari_channels_get_channel_var() */
struct ast_ari_channels_get_channel_var_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief The channel variable or function to get */
/*! The channel variable or function to get */
const char *variable;
};
/*!
@ -569,13 +569,13 @@ int ast_ari_channels_get_channel_var_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_get_channel_var(struct ast_variable *headers, struct ast_ari_channels_get_channel_var_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_set_channel_var() */
/*! Argument struct for ast_ari_channels_set_channel_var() */
struct ast_ari_channels_set_channel_var_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief The channel variable or function to set */
/*! The channel variable or function to set */
const char *variable;
/*! \brief The value to set the variable to */
/*! The value to set the variable to */
const char *value;
};
/*!
@ -597,19 +597,19 @@ int ast_ari_channels_set_channel_var_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_set_channel_var(struct ast_variable *headers, struct ast_ari_channels_set_channel_var_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_snoop_channel() */
/*! Argument struct for ast_ari_channels_snoop_channel() */
struct ast_ari_channels_snoop_channel_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief Direction of audio to spy on */
/*! Direction of audio to spy on */
const char *spy;
/*! \brief Direction of audio to whisper into */
/*! Direction of audio to whisper into */
const char *whisper;
/*! \brief Application the snooping channel is placed into */
/*! Application the snooping channel is placed into */
const char *app;
/*! \brief The application arguments to pass to the Stasis application */
/*! The application arguments to pass to the Stasis application */
const char *app_args;
/*! \brief Unique ID to assign to snooping channel */
/*! Unique ID to assign to snooping channel */
const char *snoop_id;
};
/*!
@ -633,19 +633,19 @@ int ast_ari_channels_snoop_channel_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_channels_snoop_channel(struct ast_variable *headers, struct ast_ari_channels_snoop_channel_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_channels_snoop_channel_with_id() */
/*! Argument struct for ast_ari_channels_snoop_channel_with_id() */
struct ast_ari_channels_snoop_channel_with_id_args {
/*! \brief Channel's id */
/*! Channel's id */
const char *channel_id;
/*! \brief Unique ID to assign to snooping channel */
/*! Unique ID to assign to snooping channel */
const char *snoop_id;
/*! \brief Direction of audio to spy on */
/*! Direction of audio to spy on */
const char *spy;
/*! \brief Direction of audio to whisper into */
/*! Direction of audio to whisper into */
const char *whisper;
/*! \brief Application the snooping channel is placed into */
/*! Application the snooping channel is placed into */
const char *app;
/*! \brief The application arguments to pass to the Stasis application */
/*! The application arguments to pass to the Stasis application */
const char *app_args;
};
/*!

16
res/ari/resource_device_states.h
Unescape View File

@ -39,7 +39,7 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_device_states_list() */
/*! Argument struct for ast_ari_device_states_list() */
struct ast_ari_device_states_list_args {
};
/*!
@ -50,9 +50,9 @@ struct ast_ari_device_states_list_args {
* \param[out] response HTTP response
*/
void ast_ari_device_states_list(struct ast_variable *headers, struct ast_ari_device_states_list_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_device_states_get() */
/*! Argument struct for ast_ari_device_states_get() */
struct ast_ari_device_states_get_args {
/*! \brief Name of the device */
/*! Name of the device */
const char *device_name;
};
/*!
@ -63,11 +63,11 @@ struct ast_ari_device_states_get_args {
* \param[out] response HTTP response
*/
void ast_ari_device_states_get(struct ast_variable *headers, struct ast_ari_device_states_get_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_device_states_update() */
/*! Argument struct for ast_ari_device_states_update() */
struct ast_ari_device_states_update_args {
/*! \brief Name of the device */
/*! Name of the device */
const char *device_name;
/*! \brief Device state value */
/*! Device state value */
const char *device_state;
};
/*!
@ -89,9 +89,9 @@ int ast_ari_device_states_update_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_device_states_update(struct ast_variable *headers, struct ast_ari_device_states_update_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_device_states_delete() */
/*! Argument struct for ast_ari_device_states_delete() */
struct ast_ari_device_states_delete_args {
/*! \brief Name of the device */
/*! Name of the device */
const char *device_name;
};
/*!

12
res/ari/resource_endpoints.h
Unescape View File

@ -39,7 +39,7 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_endpoints_list() */
/*! Argument struct for ast_ari_endpoints_list() */
struct ast_ari_endpoints_list_args {
};
/*!
@ -50,9 +50,9 @@ struct ast_ari_endpoints_list_args {
* \param[out] response HTTP response
*/
void ast_ari_endpoints_list(struct ast_variable *headers, struct ast_ari_endpoints_list_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_endpoints_list_by_tech() */
/*! Argument struct for ast_ari_endpoints_list_by_tech() */
struct ast_ari_endpoints_list_by_tech_args {
/*! \brief Technology of the endpoints (sip,iax2,...) */
/*! Technology of the endpoints (sip,iax2,...) */
const char *tech;
};
/*!
@ -63,11 +63,11 @@ struct ast_ari_endpoints_list_by_tech_args {
* \param[out] response HTTP response
*/
void ast_ari_endpoints_list_by_tech(struct ast_variable *headers, struct ast_ari_endpoints_list_by_tech_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_endpoints_get() */
/*! Argument struct for ast_ari_endpoints_get() */
struct ast_ari_endpoints_get_args {
/*! \brief Technology of the endpoint */
/*! Technology of the endpoint */
const char *tech;
/*! \brief ID of the endpoint */
/*! ID of the endpoint */
const char *resource;
};
/*!

8
res/ari/resource_events.h
Unescape View File

@ -39,13 +39,13 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_events_event_websocket() */
/*! Argument struct for ast_ari_events_event_websocket() */
struct ast_ari_events_event_websocket_args {
/*! \brief Array of Applications to subscribe to. */
/*! Array of Applications to subscribe to. */
const char **app;
/*! \brief Length of app array. */
/*! Length of app array. */
size_t app_count;
/*! \brief Parsing context for app. */
/*! Parsing context for app. */
char *app_parse;
};
/*!

18
res/ari/resource_mailboxes.h
Unescape View File

@ -39,7 +39,7 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_mailboxes_list() */
/*! Argument struct for ast_ari_mailboxes_list() */
struct ast_ari_mailboxes_list_args {
};
/*!
@ -50,9 +50,9 @@ struct ast_ari_mailboxes_list_args {
* \param[out] response HTTP response
*/
void ast_ari_mailboxes_list(struct ast_variable *headers, struct ast_ari_mailboxes_list_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_mailboxes_get() */
/*! Argument struct for ast_ari_mailboxes_get() */
struct ast_ari_mailboxes_get_args {
/*! \brief Name of the mailbox */
/*! Name of the mailbox */
const char *mailbox_name;
};
/*!
@ -63,13 +63,13 @@ struct ast_ari_mailboxes_get_args {
* \param[out] response HTTP response
*/
void ast_ari_mailboxes_get(struct ast_variable *headers, struct ast_ari_mailboxes_get_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_mailboxes_update() */
/*! Argument struct for ast_ari_mailboxes_update() */
struct ast_ari_mailboxes_update_args {
/*! \brief Name of the mailbox */
/*! Name of the mailbox */
const char *mailbox_name;
/*! \brief Count of old messages in the mailbox */
/*! Count of old messages in the mailbox */
int old_messages;
/*! \brief Count of new messages in the mailbox */
/*! Count of new messages in the mailbox */
int new_messages;
};
/*!
@ -91,9 +91,9 @@ int ast_ari_mailboxes_update_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_mailboxes_update(struct ast_variable *headers, struct ast_ari_mailboxes_update_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_mailboxes_delete() */
/*! Argument struct for ast_ari_mailboxes_delete() */
struct ast_ari_mailboxes_delete_args {
/*! \brief Name of the mailbox */
/*! Name of the mailbox */
const char *mailbox_name;
};
/*!

14
res/ari/resource_playbacks.h
Unescape View File

@ -39,9 +39,9 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_playbacks_get() */
/*! Argument struct for ast_ari_playbacks_get() */
struct ast_ari_playbacks_get_args {
/*! \brief Playback's id */
/*! Playback's id */
const char *playback_id;
};
/*!
@ -52,9 +52,9 @@ struct ast_ari_playbacks_get_args {
* \param[out] response HTTP response
*/
void ast_ari_playbacks_get(struct ast_variable *headers, struct ast_ari_playbacks_get_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_playbacks_stop() */
/*! Argument struct for ast_ari_playbacks_stop() */
struct ast_ari_playbacks_stop_args {
/*! \brief Playback's id */
/*! Playback's id */
const char *playback_id;
};
/*!
@ -65,11 +65,11 @@ struct ast_ari_playbacks_stop_args {
* \param[out] response HTTP response
*/
void ast_ari_playbacks_stop(struct ast_variable *headers, struct ast_ari_playbacks_stop_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_playbacks_control() */
/*! Argument struct for ast_ari_playbacks_control() */
struct ast_ari_playbacks_control_args {
/*! \brief Playback's id */
/*! Playback's id */
const char *playback_id;
/*! \brief Operation to perform on the playback. */
/*! Operation to perform on the playback. */
const char *operation;
};
/*!

38
res/ari/resource_recordings.h
Unescape View File

@ -39,7 +39,7 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_recordings_list_stored() */
/*! Argument struct for ast_ari_recordings_list_stored() */
struct ast_ari_recordings_list_stored_args {
};
/*!
@ -50,9 +50,9 @@ struct ast_ari_recordings_list_stored_args {
* \param[out] response HTTP response
*/
void ast_ari_recordings_list_stored(struct ast_variable *headers, struct ast_ari_recordings_list_stored_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_recordings_get_stored() */
/*! Argument struct for ast_ari_recordings_get_stored() */
struct ast_ari_recordings_get_stored_args {
/*! \brief The name of the recording */
/*! The name of the recording */
const char *recording_name;
};
/*!
@ -63,9 +63,9 @@ struct ast_ari_recordings_get_stored_args {
* \param[out] response HTTP response
*/
void ast_ari_recordings_get_stored(struct ast_variable *headers, struct ast_ari_recordings_get_stored_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_recordings_delete_stored() */
/*! Argument struct for ast_ari_recordings_delete_stored() */
struct ast_ari_recordings_delete_stored_args {
/*! \brief The name of the recording */
/*! The name of the recording */
const char *recording_name;
};
/*!
@ -76,9 +76,9 @@ struct ast_ari_recordings_delete_stored_args {
* \param[out] response HTTP response
*/
void ast_ari_recordings_delete_stored(struct ast_variable *headers, struct ast_ari_recordings_delete_stored_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_recordings_get_live() */
/*! Argument struct for ast_ari_recordings_get_live() */
struct ast_ari_recordings_get_live_args {
/*! \brief The name of the recording */
/*! The name of the recording */
const char *recording_name;
};
/*!
@ -89,9 +89,9 @@ struct ast_ari_recordings_get_live_args {
* \param[out] response HTTP response
*/
void ast_ari_recordings_get_live(struct ast_variable *headers, struct ast_ari_recordings_get_live_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_recordings_cancel() */
/*! Argument struct for ast_ari_recordings_cancel() */
struct ast_ari_recordings_cancel_args {
/*! \brief The name of the recording */
/*! The name of the recording */
const char *recording_name;
};
/*!
@ -102,9 +102,9 @@ struct ast_ari_recordings_cancel_args {
* \param[out] response HTTP response
*/
void ast_ari_recordings_cancel(struct ast_variable *headers, struct ast_ari_recordings_cancel_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_recordings_stop() */
/*! Argument struct for ast_ari_recordings_stop() */
struct ast_ari_recordings_stop_args {
/*! \brief The name of the recording */
/*! The name of the recording */
const char *recording_name;
};
/*!
@ -115,9 +115,9 @@ struct ast_ari_recordings_stop_args {
* \param[out] response HTTP response
*/
void ast_ari_recordings_stop(struct ast_variable *headers, struct ast_ari_recordings_stop_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_recordings_pause() */
/*! Argument struct for ast_ari_recordings_pause() */
struct ast_ari_recordings_pause_args {
/*! \brief The name of the recording */
/*! The name of the recording */
const char *recording_name;
};
/*!
@ -130,9 +130,9 @@ struct ast_ari_recordings_pause_args {
* \param[out] response HTTP response
*/
void ast_ari_recordings_pause(struct ast_variable *headers, struct ast_ari_recordings_pause_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_recordings_unpause() */
/*! Argument struct for ast_ari_recordings_unpause() */
struct ast_ari_recordings_unpause_args {
/*! \brief The name of the recording */
/*! The name of the recording */
const char *recording_name;
};
/*!
@ -143,9 +143,9 @@ struct ast_ari_recordings_unpause_args {
* \param[out] response HTTP response
*/
void ast_ari_recordings_unpause(struct ast_variable *headers, struct ast_ari_recordings_unpause_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_recordings_mute() */
/*! Argument struct for ast_ari_recordings_mute() */
struct ast_ari_recordings_mute_args {
/*! \brief The name of the recording */
/*! The name of the recording */
const char *recording_name;
};
/*!
@ -158,9 +158,9 @@ struct ast_ari_recordings_mute_args {
* \param[out] response HTTP response
*/
void ast_ari_recordings_mute(struct ast_variable *headers, struct ast_ari_recordings_mute_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_recordings_unmute() */
/*! Argument struct for ast_ari_recordings_unmute() */
struct ast_ari_recordings_unmute_args {
/*! \brief The name of the recording */
/*! The name of the recording */
const char *recording_name;
};
/*!

10
res/ari/resource_sounds.h
Unescape View File

@ -39,11 +39,11 @@
#include "asterisk/ari.h"
/*! \brief Argument struct for ast_ari_sounds_list() */
/*! Argument struct for ast_ari_sounds_list() */
struct ast_ari_sounds_list_args {
/*! \brief Lookup sound for a specific language. */
/*! Lookup sound for a specific language. */
const char *lang;
/*! \brief Lookup sound in a specific format. */
/*! Lookup sound in a specific format. */
const char *format;
};
/*!
@ -65,9 +65,9 @@ int ast_ari_sounds_list_parse_body(
* \param[out] response HTTP response
*/
void ast_ari_sounds_list(struct ast_variable *headers, struct ast_ari_sounds_list_args *args, struct ast_ari_response *response);
/*! \brief Argument struct for ast_ari_sounds_get() */
/*! Argument struct for ast_ari_sounds_get() */
struct ast_ari_sounds_get_args {
/*! \brief Sound's id */
/*! Sound's id */
const char *sound_id;
};
/*!

10
rest-api-templates/ari_resource.h.mustache
Unescape View File

@ -40,23 +40,23 @@
{{#apis}}
{{#operations}}
/*! \brief Argument struct for ast_ari_{{c_name}}_{{c_nickname}}() */
/*! Argument struct for ast_ari_{{c_name}}_{{c_nickname}}() */
struct ast_ari_{{c_name}}_{{c_nickname}}_args {
{{#parameters}}
{{#description}}
{{/description}}
{{^allow_multiple}}
{{#description}}
/*! \brief {{{description}}} */
/*! {{{description}}} */
{{/description}}
{{c_data_type}}{{c_space}}{{c_name}};
{{/allow_multiple}}
{{#allow_multiple}}
/*! \brief Array of {{{description}}} */
/*! Array of {{{description}}} */
{{c_data_type}}{{c_space}}*{{c_name}};
/*! \brief Length of {{c_name}} array. */
/*! Length of {{c_name}} array. */
size_t {{c_name}}_count;
/*! \brief Parsing context for {{c_name}}. */
/*! Parsing context for {{c_name}}. */
char *{{c_name}}_parse;
{{/allow_multiple}}
{{/parameters}}

Write Preview
Loading…
Cancel
Save