From: David M. Lee <dlee@digium.com>
Date: Wed, 5 Jun 2013 21:14:46 +0000 (+0000)
Subject: Corrected comment on stasis_cache_get
X-Git-Tag: 13.0.0-beta1~1728
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4cea90202090bf2db056de74b2ea4b5cacd40509;p=thirdparty%2Fasterisk.git

Corrected comment on stasis_cache_get

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@390585 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/include/asterisk/stasis.h b/include/asterisk/stasis.h
index edb38ad1dd..fdc629324d 100644
--- a/include/asterisk/stasis.h
+++ b/include/asterisk/stasis.h
@@ -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
  */