X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_strerror.rst;h=07023b8d94cedfaac0a4d1ad80f1ca9b43e5f842;hb=92b9f88eef9029d70c4db397da0d7f8d2d06a99c;hp=ce5b1fa0b9bbbd7440b1c1ee76a2ed4c3fecc3a9;hpb=da3714e6dc31ab2f9d115707ab79a838420c7b5a;p=m6w6%2Flibmemcached diff --git a/docs/memcached_strerror.rst b/docs/memcached_strerror.rst index ce5b1fa0..07023b8d 100644 --- a/docs/memcached_strerror.rst +++ b/docs/memcached_strerror.rst @@ -11,7 +11,7 @@ SYNOPSIS #include -.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc); +.. c:function:: const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc) Compile and link with -lmemcached @@ -21,15 +21,13 @@ DESCRIPTION ----------- -memcached_strerror() takes a \ ``memcached_return_t``\ value and returns a string -describing the error. +:c:func:`memcached_strerror` takes a :c:type:`memcached_return_t` value and returns a string describing the error. This string must not be modified by the application. -\ ``memcached_return_t``\ values are returned from nearly all libmemcached(3) functions. +:c:type:`memcached_return_t` values are returned from nearly all libmemcached(3) 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. +:c:type:`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. ------ @@ -37,7 +35,7 @@ RETURN ------ -memcached_strerror() returns a string describing a \ ``memcached_return_t``\ value. +:c:func:`memcached_strerror` returns a string describing a :c:type:`memcached_return_t` value. ---- @@ -55,5 +53,5 @@ SEE ALSO -------- -memcached(1) libmemcached(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)`