stasis: Fix for Doxygen.

ASTERISK-29750

Change-Id: Iea50173e785b2e9d49bc24c0af7111cfd96d44a9

res/res_stasis_snoop.c

@@ -107,7 +107,7 @@ static void snoop_destroy(void *obj)
 /*! \internal
  * \brief Publish the chanspy message over Stasis-Core
  * \param snoop The snoop structure
- * \start start If non-zero, the spying is starting. Otherwise, the spyer is
+ * \param start If non-zero, the spying is starting. Otherwise, the spyer is
  * finishing
  */
 static void publish_chanspy_message(struct stasis_app_snoop *snoop, int start)

res/stasis/app.c

@@ -1030,11 +1030,6 @@ struct stasis_topic *ast_app_get_topic(struct stasis_app *app)
 	return app->topic;
 }
 
-/*!
- * \brief Send a message to the given application.
- * \param app App to send the message to.
- * \param message Message to send.
- */
 void app_send(struct stasis_app *app, struct ast_json *message)
 {
 	stasis_app_cb handler;

res/stasis/app.h

@@ -55,8 +55,9 @@ enum stasis_app_subscription_model {
  * \param name Name of the application.
  * \param handler Callback for messages sent to the application.
  * \param data Data pointer provided to the callback.
+ * \param subscription_model
  * \return New \c res_stasis application.
- * \return \c NULL on error.
+ * \retval NULL on error.
  */
 struct stasis_app *app_create(const char *name, stasis_app_cb handler, void *data, enum stasis_app_subscription_model subscription_model);
 
@@ -83,8 +84,8 @@ void app_deactivate(struct stasis_app *app);
  * \brief Checks whether an app is active.
  *
  * \param app Application to check.
- * \return True (non-zero) if app is active.
- * \return False (zero) if app has been deactivated.
+ * \retval True (non-zero) if app is active.
+ * \retval False (zero) if app has been deactivated.
  */
 int app_is_active(struct stasis_app *app);
 
@@ -92,8 +93,8 @@ int app_is_active(struct stasis_app *app);
  * \brief Checks whether a deactivated app has no channels.
  *
  * \param app Application to check.
- * \param True (non-zero) if app is deactivated, and has no associated channels.
- * \param False (zero) otherwise.
+ * \retval True (non-zero) if app is deactivated, and has no associated channels.
+ * \retval False (zero) otherwise.
  */
 int app_is_finished(struct stasis_app *app);
 
@@ -111,7 +112,7 @@ void app_update(struct stasis_app *app, stasis_app_cb handler, void *data);
 /*!
  * \brief Send a message to an application.
  *
- * \param app Application.
+ * \param app App to send the message to.
  * \param message Message to send.
  */
 void app_send(struct stasis_app *app, struct ast_json *message);
@@ -123,8 +124,8 @@ struct app_forwards;
  *
  * \param app The application
  *
- * \return \c JSON blob on success
- * \return \c NULL on error
+ * \return JSON blob on success
+ * \retval NULL on error
  */
 struct ast_json *app_to_json(const struct stasis_app *app);
 
@@ -133,8 +134,8 @@ struct ast_json *app_to_json(const struct stasis_app *app);
  *
  * \param app Application.
  * \param chan Channel to subscribe to.
- * \return 0 on success.
- * \return Non-zero on error.
+ * \retval 0 on success.
+ * \retval Non-zero on error.
  */
 int app_subscribe_channel(struct stasis_app *app, struct ast_channel *chan);
 
@@ -143,8 +144,8 @@ int app_subscribe_channel(struct stasis_app *app, struct ast_channel *chan);
  *
  * \param app Subscribing application.
  * \param chan Channel to unsubscribe from.
- * \return 0 on success.
- * \return Non-zero on error.
+ * \retval 0 on success.
+ * \retval Non-zero on error.
  */
 int app_unsubscribe_channel(struct stasis_app *app, struct ast_channel *chan);
 
@@ -153,8 +154,8 @@ int app_unsubscribe_channel(struct stasis_app *app, struct ast_channel *chan);
  *
  * \param app Subscribing application.
  * \param channel_id Id of channel to unsubscribe from.
- * \return 0 on success.
- * \return Non-zero on error.
+ * \retval 0 on success.
+ * \retval Non-zero on error.
  */
 int app_unsubscribe_channel_id(struct stasis_app *app, const char *channel_id);
 
@@ -163,8 +164,8 @@ int app_unsubscribe_channel_id(struct stasis_app *app, const char *channel_id);
  *
  * \param app Subscribing application.
  * \param channel_id Id of channel to check.
- * \return True (non-zero) if channel is subscribed to \a app.
- * \return False (zero) if channel is not subscribed.
+ * \retval True (non-zero) if channel is subscribed to \a app.
+ * \retval False (zero) if channel is not subscribed.
  */
 int app_is_subscribed_channel_id(struct stasis_app *app, const char *channel_id);
 
@@ -173,18 +174,18 @@ int app_is_subscribed_channel_id(struct stasis_app *app, const char *channel_id)
  *
  * \param app Application.
  * \param bridge Bridge to subscribe to.
- * \return 0 on success.
- * \return Non-zero on error.
+ * \retval 0 on success.
+ * \retval Non-zero on error.
  */
 int app_subscribe_bridge(struct stasis_app *app, struct ast_bridge *bridge);
 
 /*!
  * \brief Cancel the bridge subscription for an application.
  *
- * \param forwards Return from app_subscribe_channel().
+ * \param app Subscribing application.
  * \param bridge Bridge to subscribe to.
- * \return 0 on success.
- * \return Non-zero on error.
+ * \retval 0 on success.
+ * \retval Non-zero on error.
  */
 int app_unsubscribe_bridge(struct stasis_app *app, struct ast_bridge *bridge);
 
@@ -193,8 +194,8 @@ int app_unsubscribe_bridge(struct stasis_app *app, struct ast_bridge *bridge);
  *
  * \param app Subscribing application.
  * \param bridge_id Id of bridge to unsubscribe from.
- * \return 0 on success.
- * \return Non-zero on error.
+ * \retval 0 on success.
+ * \retval Non-zero on error.
  */
 int app_unsubscribe_bridge_id(struct stasis_app *app, const char *bridge_id);
 
@@ -203,8 +204,8 @@ int app_unsubscribe_bridge_id(struct stasis_app *app, const char *bridge_id);
  *
  * \param app Subscribing application.
  * \param bridge_id Id of bridge to check.
- * \return True (non-zero) if bridge is subscribed to \a app.
- * \return False (zero) if bridge is not subscribed.
+ * \retval True (non-zero) if bridge is subscribed to \a app.
+ * \retval False (zero) if bridge is not subscribed.
  */
 int app_is_subscribed_bridge_id(struct stasis_app *app, const char *bridge_id);
 
@@ -212,9 +213,9 @@ int app_is_subscribed_bridge_id(struct stasis_app *app, const char *bridge_id);
  * \brief Subscribes an application to a endpoint.
  *
  * \param app Application.
- * \param chan Endpoint to subscribe to.
- * \return 0 on success.
- * \return Non-zero on error.
+ * \param endpoint Endpoint to subscribe to.
+ * \retval 0 on success.
+ * \retval Non-zero on error.
  */
 int app_subscribe_endpoint(struct stasis_app *app, struct ast_endpoint *endpoint);
 
@@ -223,8 +224,8 @@ int app_subscribe_endpoint(struct stasis_app *app, struct ast_endpoint *endpoint
  *
  * \param app Subscribing application.
  * \param endpoint_id Id of endpoint to unsubscribe from.
- * \return 0 on success.
- * \return Non-zero on error.
+ * \retval 0 on success.
+ * \retval Non-zero on error.
  */
 int app_unsubscribe_endpoint_id(struct stasis_app *app, const char *endpoint_id);
 
@@ -233,15 +234,15 @@ int app_unsubscribe_endpoint_id(struct stasis_app *app, const char *endpoint_id)
  *
  * \param app Subscribing application.
  * \param endpoint_id Id of endpoint to check.
- * \return True (non-zero) if endpoint is subscribed to \a app.
- * \return False (zero) if endpoint is not subscribed.
+ * \retval True (non-zero) if endpoint is subscribed to \a app.
+ * \retval False (zero) if endpoint is not subscribed.
  */
 int app_is_subscribed_endpoint_id(struct stasis_app *app, const char *endpoint_id);
 
 /*!
  * \brief Set the snapshot of the channel that this channel will replace
  *
- * \param channel The channel on which this will be set
+ * \param chan The channel on which this will be set
  * \param replace_snapshot The snapshot of the channel that is being replaced
  *
  * \retval zero success
@@ -252,7 +253,7 @@ int app_set_replace_channel_snapshot(struct ast_channel *chan, struct ast_channe
 /*!
  * \brief Set the app that the replacement channel will be controlled by
  *
- * \param channel The channel on which this will be set
+ * \param chan The channel on which this will be set
  * \param replace_app The app that will be controlling this channel
  *
  * \retval zero success
@@ -263,7 +264,7 @@ int app_set_replace_channel_app(struct ast_channel *chan, const char *replace_ap
 /*!
  * \brief Get the app that the replacement channel will be controlled by
  *
- * \param channel The channel on which this will be set
+ * \param chan The channel on which this will be set
  *
  * \retval NULL on error
  * \return the name of the controlling app (must be ast_free()d)

res/stasis/control.h

@@ -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);
 

res/stasis/messaging.h

@@ -45,9 +45,6 @@ typedef int (* message_received_cb)(const char *endpoint_id, struct ast_json *js
  *
  * \param app_name Name of the stasis application to unsubscribe from messaging
  * \param endpoint_id The ID of the endpoint we no longer care about
- *
- * \retval 0 success
- * \retval -1 error
  */
 void messaging_app_unsubscribe_endpoint(const char *app_name, const char *endpoint_id);
 
@@ -56,7 +53,7 @@ void messaging_app_unsubscribe_endpoint(const char *app_name, const char *endpoi
  *
  * \param app_name The name of the \ref stasis application to subscribe to \c endpoint
  * \param endpoint The endpoint object to subscribe to
- * \param message_received_cb The callback to call when a message is received
+ * \param callback The callback to call when a message is received
  * \param pvt An ao2 ref counted object that will be passed to the callback.
  *
  * \retval 0 subscription was successful

res/stasis/stasis_bridge.c

@@ -278,8 +278,6 @@ static int bridge_stasis_moving(struct ast_bridge_channel *bridge_channel, void
  * \param bridge_channel Bridge channel to pull.
  *
  * \note On entry, self is already locked.
- *
- * \return Nothing
  */
 static void bridge_stasis_pull(struct ast_bridge *self, struct ast_bridge_channel *bridge_channel)
 {

res/stasis/stasis_bridge.h

@@ -61,8 +61,6 @@ struct ast_bridge *bridge_stasis_new(uint32_t capabilities, unsigned int flags,
  * \internal
  * \brief Initialize the Stasis bridge subclass.
  * \since 12.5.0
- *
- * \return Nothing
  */
 void bridge_stasis_init(void);
 

res/stasis_recording/stored.c

@@ -85,7 +85,7 @@ const char *stasis_app_stored_recording_get_extension(
  *
  * \param path Path to split.
  * \param[out] dir Output parameter for directory portion.
- * \param[out] fail Output parameter for the file portion.
+ * \param[out] file Output parameter for the file portion.
  * \return 0 on success.
  * \return Non-zero on error.
  */