X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_strerror.rst;h=a848f541f5900f8ceca1d3ac0954005231e20872;hb=18123e31581b266b7c079cf5f8301ba5b20c3d64;hp=32b0b7b2e6750e9610b622f40f4fa1a6847e3018;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_strerror.rst b/docs/source/libmemcached/memcached_strerror.rst index 32b0b7b2..a848f541 100644 --- a/docs/source/libmemcached/memcached_strerror.rst +++ b/docs/source/libmemcached/memcached_strerror.rst @@ -9,6 +9,10 @@ SYNOPSIS .. function:: const char *memcached_strerror(memcached_st *ptr, memcached_return_t rc) + :param ptr: pointer to initialized `memcached_st` struct + :param rc: `memcached_return_t` value to query the string representation for + :returns: the string representation of `rc` + DESCRIPTION ----------- @@ -23,8 +27,8 @@ functions. `memcached_return_t` values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values. -RETURN ------- +RETURN VALUE +------------ `memcached_strerror` returns a string describing a `memcached_return_t` value. @@ -35,9 +39,10 @@ SEE ALSO :manpage:`memcached(1)` :manpage:`libmemcached(3)` + :manpage:`memcached_return_t` .. only:: html * :manpage:`memcached(1)` * :doc:`../libmemcached` - + * :doc:`memcached_return_t`