X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_flush_buffers.rst;h=888c9254420ed6d1072d4a3faa095e9e87311229;hb=728ae479bcecf3530430c4a2e62479ba7586484e;hp=c09165e85196369d84040a464b1bb3a0fe4ae15f;hpb=86be0943416087ba738c28ddbde8cdcbd62ad777;p=awesomized%2Flibmemcached diff --git a/docs/memcached_flush_buffers.rst b/docs/memcached_flush_buffers.rst index c09165e8..888c9254 100644 --- a/docs/memcached_flush_buffers.rst +++ b/docs/memcached_flush_buffers.rst @@ -3,16 +3,9 @@ Flushing client buffers ======================= -Flush buffers and send buffered commands - - -------- -LIBRARY -------- - - -C Client Library for memcached (libmemcached, -lmemcached) +.. index:: object: memcached_st +Flush and senf buffered commands -------- SYNOPSIS @@ -20,8 +13,9 @@ SYNOPSIS #include -.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr); +.. c:function:: memcached_return_t memcached_flush_buffers (memcached_st *ptr) +Compile and link with -lmemcached ----------- @@ -29,9 +23,8 @@ DESCRIPTION ----------- -memcached_flush_buffers() is used in conjunction with -MEMCACHED_BEHAVIOR_BUFFER_REQUESTS (see memcached_behavior(3)) to flush -all buffers by sending the buffered commands to the server for processing. +:c:func:`memcached_flush_buffers` is used in conjunction with +:c:type:`MEMCACHED_BEHAVIOR_BUFFER_REQUESTS` (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing. ------ @@ -39,9 +32,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. ----