[asterisk-commits] dlee: trunk r388896 - in /trunk/res/stasis: app.c app.h

[SVN commits to the Asterisk project]

Author: dlee
Date: Wed May 15 16:13:29 2013
New Revision: 388896

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=388896
Log:
Fixed inverted logic in app_add_channel().

Also added some missing doc comments for stasis/app.h.

Modified:
    trunk/res/stasis/app.c
    trunk/res/stasis/app.h

Modified: trunk/res/stasis/app.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/stasis/app.c?view=diff&rev=388896&r1=388895&r2=388896
==============================================================================
--- trunk/res/stasis/app.c (original)
+++ trunk/res/stasis/app.c Wed May 15 16:13:29 2013
@@ -95,10 +95,7 @@
 	ast_assert(app != NULL);
 
 	uniqueid = ast_channel_uniqueid(chan);
-	if (!ast_str_container_add(app->channels, uniqueid)) {
-		return -1;
-	}
-	return 0;
+	return ast_str_container_add(app->channels, uniqueid) ? -1 : 0;
 }
 
 void app_remove_channel(struct app* app, const struct ast_channel *chan)

Modified: trunk/res/stasis/app.h
URL: http://svnview.digium.com/svn/asterisk/trunk/res/stasis/app.h?view=diff&rev=388896&r1=388895&r2=388896
==============================================================================
--- trunk/res/stasis/app.h (original)
+++ trunk/res/stasis/app.h Wed May 15 16:13:29 2013
@@ -56,22 +56,83 @@
  */
 void app_update(struct app *app, stasis_app_cb handler, void *data);
 
+/*!
+ * \brief Return an application's name.
+ *
+ * \param app Application.
+ * \return Name of the application.
+ * \return \c NULL is \a app is \c NULL.
+ */
 const char *app_name(const struct app *app);
 
+/*!
+ * \brief Subscribe an application to a topic.
+ *
+ * \param app Application.
+ * \param topic Topic to subscribe to.
+ * \return New subscription.
+ * \return \c NULL on error.
+ */
 struct stasis_subscription *app_subscribe(struct app *app,
 	struct stasis_topic *topic);
 
+/*!
+ * \brief Send a message to an application.
+ *
+ * \param app Application.
+ * \param message Message to send.
+ */
 void app_send(struct app *app, struct ast_json *message);
 
+/*!
+ * \brief Send the start message to an application.
+ *
+ * \param app Application.
+ * \param chan The channel entering the application.
+ * \param argc The number of arguments for the application.
+ * \param argv The arguments for the application.
+ * \return 0 on success.
+ * \return Non-zero on error.
+ */
 int app_send_start_msg(struct app *app, struct ast_channel *chan, int argc,
 	char *argv[]);
 
+/*!
+ * \brief Send the end message to an application.
+ *
+ * \param app Application.
+ * \param chan The channel leaving the application.
+ * \return 0 on success.
+ * \return Non-zero on error.
+ */
 int app_send_end_msg(struct app *app, struct ast_channel *chan);
 
+/*!
+ * \brief Checks if an application is watching a given channel.
+ *
+ * \param app Application.
+ * \param uniqueid Uniqueid of the channel to check about.
+ * \return True (non-zero) if \a app is watching channel with given \a uniqueid
+ * \return False (zero) if \a app isn't.
+ */
 int app_is_watching_channel(struct app *app, const char *uniqueid);
 
-int app_add_channel(struct app* app, const struct ast_channel *chan);
+/*!
+ * \brief Add a channel to an application's watch list.
+ *
+ * \param app Application.
+ * \param chan Channel to watch.
+ * \return 0 on success.
+ * \return Non-zero on error.
+ */
+int app_add_channel(struct app *app, const struct ast_channel *chan);
 
+/*!
+ * \brief Remove a channel from an application's watch list.
+ *
+ * \param app Application.
+ * \param chan Channel to watch.
+ */
 void app_remove_channel(struct app *app, const struct ast_channel *chan);
 
 #endif /* _ASTERISK_RES_STASIS_APP_H */