stasis: Fix for Doxygen.

ASTERISK-29750

Change-Id: Iea50173e785b2e9d49bc24c0af7111cfd96d44a9
This commit is contained in:
Alexander Traud
2021-11-16 17:26:23 +01:00
committed by Friendly Automation
parent e7d5db1471
commit 6988386234
24 changed files with 232 additions and 263 deletions

View File

@@ -36,7 +36,7 @@
* \param app stasis_app for which this control is being created.
*
* \return New control object.
* \return \c NULL on error.
* \retval NULL on error.
*/
struct stasis_app_control *control_create(struct ast_channel *channel, struct stasis_app *app);
@@ -45,8 +45,6 @@ struct stasis_app_control *control_create(struct ast_channel *channel, struct st
* \since 13.9.0
*
* \param control Control object to flush command queue.
*
* \return Nothing
*/
void control_flush_queue(struct stasis_app_control *control);
@@ -72,7 +70,7 @@ void control_wait(struct stasis_app_control *control);
*
* \param control Control to count commands on
*
* \retval number of commands in the command que
* \return number of commands in the command que
*/
int control_command_count(struct stasis_app_control *control);
@@ -80,8 +78,8 @@ int control_command_count(struct stasis_app_control *control);
* \brief Returns true if control_continue() has been called on this \a control.
*
* \param control Control to query.
* \return True (non-zero) if control_continue() has been called.
* \return False (zero) otherwise.
* \retval True (non-zero) if control_continue() has been called.
* \retval False (zero) otherwise.
*/
int control_is_done(struct stasis_app_control *control);
@@ -91,7 +89,7 @@ void control_mark_done(struct stasis_app_control *control);
* \brief Dispatch all queued prestart commands
*
* \param control The control for chan
* \param channel The channel on which commands should be executed
* \param chan The channel on which commands should be executed
*
* \return The number of commands executed
*/
@@ -103,7 +101,7 @@ int control_prestart_dispatch_all(struct stasis_app_control *control,
*
* \param control Control to query.
*
* \returns A pointer to the associated stasis_app
* \return A pointer to the associated stasis_app
*/
struct stasis_app *control_app(struct stasis_app_control *control);