Added some doxygen comments for the getStats() method.

diff --git a/libmemcached/memcached.hpp b/libmemcached/memcached.hpp
index c1ca1bd2737040a16328b3908ef329483389765c..92cd9a68826aa09a04e5a74363c09bb6dfc7f590 100644 (file)
--- 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)
   {