X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_dump.rst;h=3ef1c43c0ec97decceaf425563678e4b9d1ef165;hb=a18c65b0ee1a4721a4f1298f52f8b3446cf7c600;hp=08c21c464d50f8434aa206bb0eb603ea3a5c6ae1;hpb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;p=m6w6%2Flibmemcached diff --git a/docs/memcached_dump.rst b/docs/memcached_dump.rst index 08c21c46..3ef1c43c 100644 --- a/docs/memcached_dump.rst +++ b/docs/memcached_dump.rst @@ -28,9 +28,9 @@ DESCRIPTION ----------- -memcached_dump() is used to get a list of keys found in memcached(1) servers. -Because memcached(1) does not guarentee to dump all keys you can not assume -you have fetched all keys from the server. The function takes an array +:c:func:`memcached_dump()` is used to get a list of keys found in memcached(1) +servers. Because memcached(1) does not guarentee to dump all keys you can not +assume you have fetched all keys from the server. The function takes an array of callbacks that it will use to execute on keys as they are found. Currently the binary protocol is not testsed. @@ -41,9 +41,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. ----