Merge bzr://10.0.3.21 Build: jenkins-Libmemcached-469

[awesomized/libmemcached] / docs / memcached_version.rst

diff --git a/docs/memcached_version.rst b/docs/memcached_version.rst
index 022dbec17d788442f9bddb140b64ab72900c7c52..20b8b25a20150943bcf2e0f7f238ab5d0476ae1c 100644 (file)
--- a/docs/memcached_version.rst
+++ b/docs/memcached_version.rst
@@ -2,34 +2,19 @@
 Getting version information about the client and server
 =======================================================
 
-
-Get library version
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
+ 
 --------
 SYNOPSIS
 --------
 
+#include <libmemcached/memcached.h>
 
+.. c:function:: const char * memcached_lib_version (void) 
 
-.. code-block:: perl
+.. c:function:: memcached_return_t memcached_version (memcached_st *ptr)
 
-   #include <libmemcached/memcached.h>
- 
-   const char *
-     memcached_lib_version (void) 
- 
- 
-   memcached_return_t
-     memcached_version (memcached_st *ptr)
+
+Compile and link with -lmemcached
 
 
 
@@ -38,44 +23,35 @@ DESCRIPTION
 -----------
 
 
-memcached_lib_version() is used to return a simple version string representing
-the libmemcached version (version of the client library, not server)
+: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.
 
 
-******
+------
 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 printable string.
+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`. 
 
-****
-HOME
-****
-
+If called with the :c:func:`MEMCACHED_BEHAVIOR_USE_UDP` behavior set, the value :c:type:`MEMCACHED_NOT_SUPPORTED` will be returned. 
 
-To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
+Use :c:func:`memcached_strerror` to translate this value to 
+a printable string.
 
 
-******
-AUTHOR
-******
+----
+HOME
+----
 
 
-Brian Aker, <brian@tangent.org>
+To find out more information please check:
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------
@@ -83,5 +59,5 @@ SEE ALSO
 --------
 
 
-memcached(1) libmemcached(3) memcached_strerror(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`