KBDocs3
[awesomized/libmemcached] / docs / memcached_flush.rst
index c38ad499896b7087c2249322a04c84af30132eb9..fe251b4a0af5352c196a099ad684714cd0093bd6 100644 (file)
@@ -24,8 +24,8 @@ DESCRIPTION
 -----------
 
 
-memcached_flush() is used to wipe clean the contents of memcached(1) servers.
-It will either do this immediately or expire the content based on the
+:c:func:`memcached_flush()` is used to wipe clean the contents of memcached(1) 
+servers. It will either do this immediately or expire the content based on the
 expiration time passed to the method (a value of zero causes an immediate
 flush). The operation is not atomic to multiple servers, just atomic to a
 single server. That is, it will flush the servers in the order that they were
@@ -37,9 +37,10 @@ RETURN
 ------
 
 
-A value of type \ ``memcached_return_t``\  is returned
-On success that value will be \ ``MEMCACHED_SUCCESS``\ .
-Use memcached_strerror() to translate this value to a printable string.
+A value of type :c:type:`memcached_return_t` is returned 
+On success that value will be :c:type:`MEMCACHED_SUCCESS`.
+Use :c:func:`memcached_strerror()` to translate this value to a printable 
+string.
 
 
 ----