From: Padraig O'Sullivan <osullivan.padraig@gmail.com>
Date: Tue, 20 Oct 2009 18:08:40 +0000 (-0400)
Subject: Added some doxygen comments for the getStats() method.
X-Git-Tag: 0.35~9^2~1
X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=17b21065e22f6e831aaf10a87cc51cbe2290cbce;p=awesomized%2Flibmemcached

Added some doxygen comments for the getStats() method.
---

diff --git a/libmemcached/memcached.hpp b/libmemcached/memcached.hpp
index c1ca1bd2..92cd9a68 100644
--- a/libmemcached/memcached.hpp
+++ b/libmemcached/memcached.hpp
@@ -920,6 +920,14 @@ public:
     return version;
   }
 
+  /**
+   * Retrieve memcached statistics. Populate a std::map with the retrieved
+   * stats. Each server will map to another std::map of the key:value stats.
+   *
+   * @param[out] stats_map a std::map to be populated with the memcached
+   *                       stats
+   * @return true on success; false otherwise
+   */
   bool getStats(std::map< std::string, std::map<std::string, std::string> >
                 &stats_map)
   {