projects
/
awesomized
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
p9y: fix TCP constants
[awesomized/libmemcached]
/
docs
/
source
/
libmemcached
/
memcached_strerror.rst
diff --git
a/docs/source/libmemcached/memcached_strerror.rst
b/docs/source/libmemcached/memcached_strerror.rst
index 32b0b7b2e6750e9610b622f40f4fa1a6847e3018..a848f541f5900f8ceca1d3ac0954005231e20872 100644
(file)
--- 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)
.. 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
-----------
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.
`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.
`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(1)`
:manpage:`libmemcached(3)`
+ :manpage:`memcached_return_t`
.. only:: html
* :manpage:`memcached(1)`
* :doc:`../libmemcached`
.. only:: html
* :manpage:`memcached(1)`
* :doc:`../libmemcached`
-
+ * :doc:`memcached_return_t`