From 17b21065e22f6e831aaf10a87cc51cbe2290cbce Mon Sep 17 00:00:00 2001 From: Padraig O'Sullivan Date: Tue, 20 Oct 2009 14:08:40 -0400 Subject: [PATCH] Added some doxygen comments for the getStats() method. --- libmemcached/memcached.hpp | 8 ++++++++ 1 file changed, 8 insertions(+) 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 > &stats_map) { -- 2.30.2