X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_version.rst;h=6d81f5ea16158e10c40b0fe980fd1b9c45c9d654;hb=11621e78bab29c7535bcdd52c3d8b3f10a150001;hp=ae983f4c49d81adbb2abeec9dbbf0ef9506bbf09;hpb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;p=m6w6%2Flibmemcached diff --git a/docs/memcached_version.rst b/docs/memcached_version.rst index ae983f4c..6d81f5ea 100644 --- a/docs/memcached_version.rst +++ b/docs/memcached_version.rst @@ -23,12 +23,9 @@ DESCRIPTION ----------- -memcached_lib_version() is used to return a simple version string representing -the libmemcached version (client library version, not server version) +:c:func:`memcached_lib_version()` is used to return a simple version string representing the libmemcached version (client library version, not server version) -memcached_version() is used to set the major, minor, and micro versions of each -memcached server being used by the memcached_st connection structure. It returns the -memcached server return code. +:c:func:`memcached_version()` is used to set the major, minor, and micro versions of each memcached server being used by the memcached_st connection structure. It returns the memcached server return code. ------ @@ -36,13 +33,15 @@ RETURN ------ -A string with the version of libmemcached driver is returned from -memcached_lib_version() +:c:func:`memcached_lib_version()` returns a string with the version of the libmemcached driver. -A value of type \ ``memcached_return_t``\ is returned from memcached_version() -On success that value will be \ ``MEMCACHED_SUCCESS``\ . If called with the -\ ``MEMCACHED_BEHAVIOR_USE_UDP``\ behavior set, the value \ ``MEMCACHED_NOT_SUPPORTED``\ -will be returned. Use memcached_strerror() to translate this value to +A value of :c:type:`memcached_return_t` is returned from :c:func:'memcached_version()' + +On success that value will be :c:type:`MEMCACHED_SUCCESS`. + +If called with the :c:func:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value :c:type:`MEMCACHED_NOT_SUPPORTED` will be returned. + +Use :c:func:`memcached_strerror()` to translate this value to a printable string. @@ -60,5 +59,5 @@ SEE ALSO -------- -memcached(1) libmemcached(3) memcached_strerror(3) +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`