kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 11:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

doxygen: Fix doxygen errors.

Browse Source 
Change-Id: Ic50e95b4fc10f74ab15416d908e8a87ee8ec2f85
This commit is contained in:
Sean Bright
2023-01-30 16:17:08 -05:00
committed by Friendly Automation
parent 78f5a41d64
commit c85fc1278f
20 changed files with 101 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
res/res_speech_aeap.c
View File

@@ -80,6 +80,7 @@ static struct ast_json *custom_fields_to_params(const struct ast_variable *varia
* receiving a response the returned result is guaranteed to be pass/fail based upon
* a response handler's result.
*
* \param aeap Pointer to an Asterisk external application object
* \param name The name of the request to send
* \param json The core json request data
* \param data Optional user data to associate with request/response
@@ -87,7 +88,7 @@ static struct ast_json *custom_fields_to_params(const struct ast_variable *varia
* \returns 0 on success, -1 on error
*/
static int speech_aeap_send_request(struct ast_aeap *aeap, const char *name,
struct ast_json *json, void *obj)
struct ast_json *json, void *data)
{
/*
* Wait for a response. Also since we're blocking,
@@ -96,7 +97,7 @@ static int speech_aeap_send_request(struct ast_aeap *aeap, const char *name,
struct ast_aeap_tsx_params tsx_params = {
.timeout = 1000,
.wait = 1,
.obj = obj,
.obj = data,
};
/* "steals" the json ref */
@@ -116,7 +117,9 @@ static int speech_aeap_send_request(struct ast_aeap *aeap, const char *name,
*
* Basic structure of the JSON message to send:
*
* { param: [<param>, ...] }
\verbatim
{ param: [<param>, ...] }
\endverbatim
*
* \param speech The speech engine
* \param param The name of the parameter to retrieve
@@ -146,7 +149,9 @@ struct speech_param {
*
* Basic structure of the JSON message to send:
*
* { params: { <name> : <value> } }
\verbatim
{ params: { <name> : <value> } }
\endverbatim
*
* \param speech The speech engine
* \param name The name of the parameter to set
@@ -238,13 +243,15 @@ static int handle_results(struct ast_aeap *aeap, struct ast_json_iter *iter,
*
* Basic structure of the expected JSON message to received:
*
* {
* response: "get"
* "params" : { <name>: <value> | [ <results> ] }
* }
\verbatim
{
response: "get"
"params" : { <name>: <value> | [ <results> ] }
}
\endverbatim
*
* \param speech The speech engine
* \param param The name of the parameter to retrieve
* \param aeap Pointer to an Asterisk external application object
* \param message The received message
* \param data User data passed to the response handler
*
* \returns 0 on success, -1 on error
@@ -351,17 +358,19 @@ static struct ast_aeap_params speech_aeap_params = {
*
* Basic structure of the JSON message to send:
*
* {
* "request": "setup"
* "codecs": [
* {
* "name": <name>,
* "attributes": { <name>: <value>, ..., }
* },
* ...,
* ],
* "params": { <name>: <value>, ..., }
* }
\verbatim
{
"request": "setup"
"codecs": [
{
"name": <name>,
"attributes": { <name>: <value>, ..., }
},
...,
],
"params": { <name>: <value>, ..., }
}
\endverbatim
*
* \param speech The speech engine
* \param format The format codec to use