[asterisk-commits] dlee: branch dlee/stasis-vtable r391288 - /team/dlee/stasis-vtable/include/as...

[SVN commits to the Asterisk project]

Author: dlee
Date: Mon Jun 10 11:57:10 2013
New Revision: 391288

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391288
Log:
Review feedback: fixed docs

Modified:
    team/dlee/stasis-vtable/include/asterisk/stasis.h

Modified: team/dlee/stasis-vtable/include/asterisk/stasis.h
URL: http://svnview.digium.com/svn/asterisk/team/dlee/stasis-vtable/include/asterisk/stasis.h?view=diff&rev=391288&r1=391287&r2=391288
==============================================================================
--- team/dlee/stasis-vtable/include/asterisk/stasis.h (original)
+++ team/dlee/stasis-vtable/include/asterisk/stasis.h Mon Jun 10 11:57:10 2013
@@ -181,12 +181,12 @@
 	 * \brief Build the JSON representation of the message.
 	 *
 	 * May be \c NULL, or may return \c NULL, to indicate no representation.
-	 * The returned object should be freed using ast_json_unref().
+	 * The returned object should be ast_json_unref()'ed.
 	 *
 	 * \param message Message to convert to JSON string.
-	 * \return Newly allocated string with JSON message.
+	 * \return Newly allocated JSON message.
 	 * \return \c NULL on error.
-	 * \return \c NULL if JSON format is not support.
+	 * \return \c NULL if JSON format is not supported.
 	 */
 	struct ast_json *(*to_json)(struct stasis_message *message);
 
@@ -194,12 +194,12 @@
 	 * \brief Build the AMI representation of the message.
 	 *
 	 * May be \c NULL, or may return \c NULL, to indicate no representation.
-	 * The returned string is newly allocated, so free using ast_free().
+	 * The returned object should be ao2_cleankup()'ed.
 	 *
 	 * \param message Message to convert to AMI string.
 	 * \return Newly allocated \ref ast_manager_event_blob.
 	 * \return \c NULL on error.
-	 * \return \c NULL if AMI format is not support.
+	 * \return \c NULL if AMI format is not supported.
 	 */
 	struct ast_manager_event_blob *(*to_ami)(
 		struct stasis_message *message);
@@ -275,24 +275,24 @@
  * \brief Build the JSON representation of the message.
  *
  * May return \c NULL, to indicate no representation. The returned object should
- * be freed using ast_json_unref().
+ * be ast_json_unref()'ed.
  *
  * \param message Message to convert to JSON string.
  * \return Newly allocated string with JSON message.
  * \return \c NULL on error.
- * \return \c NULL if JSON format is not support.
+ * \return \c NULL if JSON format is not supported.
  */
 struct ast_json *stasis_message_to_json(struct stasis_message *message);
 
 /*!
  * \brief Build the AMI representation of the message.
  *
- * May return \c NULL, to indicate no representation. The returned string is
- * newly allocated, so free using ast_free().
- *
- * \param message Message to convert to AMI string.
+ * May return \c NULL, to indicate no representation. The returned object should
+ * be ao2_cleanup()'ed.
+ *
+ * \param message Message to convert to AMI.
  * \return \c NULL on error.
- * \return \c NULL if AMI format is not support.
+ * \return \c NULL if AMI format is not supported.
  */
 struct ast_manager_event_blob *stasis_message_to_ami(
 	struct stasis_message *message);