[asterisk-commits] dlee: trunk r390585 - /trunk/include/asterisk/stasis.h

[SVN commits to the Asterisk project]

Author: dlee
Date: Wed Jun  5 16:14:46 2013
New Revision: 390585

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=390585
Log:
Corrected comment on stasis_cache_get

Modified:
    trunk/include/asterisk/stasis.h

Modified: trunk/include/asterisk/stasis.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/stasis.h?view=diff&rev=390585&r1=390584&r2=390585
==============================================================================
--- trunk/include/asterisk/stasis.h (original)
+++ trunk/include/asterisk/stasis.h Wed Jun  5 16:14:46 2013
@@ -605,11 +605,13 @@
 
 /*!
  * \brief Retrieve an item from the cache.
+ *
+ * The returned item is AO2 managed, so ao2_cleanup() when you're done with it.
+ *
  * \param caching_topic The topic returned from stasis_caching_topic_create().
  * \param type Type of message to retrieve.
  * \param id Identity of the snapshot to retrieve.
- * \return Message from the cache. The cache still owns the message, so
- *         ao2_ref() if you want to keep it.
+ * \return Message from the cache.
  * \return \c NULL if message is not found.
  * \since 12
  */