Adding some doxygen comments to the C++ api.

diff --git a/libmemcached/memcached.hpp b/libmemcached/memcached.hpp
index 3b40304234167f8238c0f0136cf5c277cb31a0cd..dd7d9ff5e8c327534c5e04811cd1196775b3110b 100644 (file)
--- 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);