Corrected comment on stasis_cache_get
authorDavid M. Lee <dlee@digium.com>
Wed, 5 Jun 2013 21:14:46 +0000 (21:14 +0000)
committerDavid M. Lee <dlee@digium.com>
Wed, 5 Jun 2013 21:14:46 +0000 (21:14 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@390585 65c4cc65-6c06-0410-ace0-fbb531ad65f3

include/asterisk/stasis.h

index edb38ad..fdc6293 100644 (file)
@@ -605,11 +605,13 @@ struct stasis_topic *stasis_caching_get_topic(struct stasis_caching_topic *cachi
 
 /*!
  * \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
  */