From: Padraig O'Sullivan <osullivan.padraig@gmail.com>
Date: Mon, 27 Jul 2009 00:05:32 +0000 (-0400)
Subject: Adding some doxygen comments to the C++ api.
X-Git-Tag: 0.32~6^2~3
X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=62df6577665057121cfab0e9ff3b0fdecb78976c;p=awesomized%2Flibmemcached

Adding some doxygen comments to the C++ api.
---

diff --git a/libmemcached/memcached.hpp b/libmemcached/memcached.hpp
index 3b403042..dd7d9ff5 100644
--- a/libmemcached/memcached.hpp
+++ b/libmemcached/memcached.hpp
@@ -505,6 +505,13 @@ public:
     return (rc == MEMCACHED_SUCCESS);
   }
 
+  /**
+   * Wipe the contents of memcached servers.
+   *
+   * @param[in] expiration time to wait until wiping contents of
+   *                       memcached servers
+   * @return true on success; false otherwise
+   */
   bool flush(time_t expiration)
   {
     memcached_return rc= memcached_flush(&memc, expiration);