docs: flush libmemcached progress

[awesomized/libmemcached] / docs / source / libmemcached / memcached_create.rst

diff --git a/docs/source/libmemcached/memcached_create.rst b/docs/source/libmemcached/memcached_create.rst
index 1189fdf07577d2eca6578e99038fdfabd7f41e56..4b1fc8ced9e7b238c1b4f7a438a374ae25f88bbb 100644 (file)
--- a/docs/source/libmemcached/memcached_create.rst
+++ b/docs/source/libmemcached/memcached_create.rst
@@ -5,62 +5,75 @@ SYNOPSIS
 --------
 
 #include <libmemcached/memcached.h>
+  Compile and link with -lmemcached
 
-.. type:: memcached_st
+.. type:: struct memcached_st memcached_st
 
 .. function:: memcached_st* memcached_create(memcached_st *ptr)
 
+    :param ptr: pointer to user-allocated `memcached_st` struct or null pointer
+    :returns: pointer to initialized `memcached_st` struct
+
 .. function:: void memcached_free(memcached_st *ptr)
 
+    :param ptr: pointer to initialized `memcached_st` struct to destroy and possibly free
+
 .. function:: memcached_st* memcached_clone(memcached_st *destination, memcached_st *source)
 
-.. function:: void memcached_servers_reset(memcached_st)
+    :param destination: pointer to user-allocated `memcached_st` struct or null pointer
+    :param source: pointer to initialized `memcached_st` struct to copy from
+    :returns: pointer to newly initialized `destination`, copied from `source`
+
+.. function:: void memcached_servers_reset(memcached_st *ptr)
 
-Compile and link with -lmemcached
+    :param ptr: pointer to initialized `memcached_st` struct
 
 DESCRIPTION
 -----------
 
-:func:`memcached_create` is used to create a :type:`memcached_st`
-structure that will then be used by other libmemcached(3) functions to 
-communicate with the server. You should either pass a statically declared 
-:type:`memcached_st` to :func:`memcached_create` or
+`memcached_create` is used to create a `memcached_st` structure that will then
+be used by other `libmemcached` functions to communicate with the server. You
+should either pass a statically declared `memcached_st` to `memcached_create` or
 a NULL. If a NULL passed in then a structure is allocated for you.
 
-Please note, when you write new application use
-:func:`memcached` over :func:`memcached_create`.
+Please note, when you write new application use `memcached` over
+`memcached_create`.
 
-:func:`memcached_clone` is similar to :func:`memcached_create` but
-it copies the defaults and list of servers from the source 
-:type:`memcached_st`. If you pass a null as the argument for the source 
-to clone, it is the same as a call to :func:`memcached_create`.
-If the destination argument is NULL a :type:`memcached_st` will be allocated 
-for you.
+`memcached_clone` is similar to `memcached_create` but it copies the defaults
+and list of servers from the source `memcached_st` pointer. If you pass a null
+as the argument for the source to clone, it is the same as a call to
+`memcached_create`. If the destination argument is NULL a `memcached_st` will be
+allocated for you.
 
-:func:`memcached_servers_reset` allows you to zero out the list of
-servers that the :type:`memcached_st` has.
+`memcached_servers_reset` allows you to zero out the list of servers that the
+`memcached_st` has.
 
-To clean up memory associated with a :type:`memcached_st` structure you
-should pass it to :func:`memcached_free` when you are finished using it. 
-:func:`memcached_free` is the only way to make sure all memory is 
-deallocated when you finish using the structure.
+To clean up memory associated with a `memcached_st` structure you should pass it
+to `memcached_free` when you are finished using it. `memcached_free` is the only
+way to make sure all memory is deallocated when you finish using the structure.
 
-You may wish to avoid using memcached_create(3) or memcached_clone(3) with a
-stack based allocation. The most common issues related to ABI safety involve
-heap allocated structures.
+You may wish to avoid using `memcached_create` or `memcached_clone` with a stack
+based allocation. The most common issues related to ABI safety involve heap
+allocated structures.
 
-RETURN
-------
+RETURN VALUE
+------------
 
-:func:`memcached_create` returns a pointer to the :type:`memcached_st`
-that was created (or initialized). On an allocation failure, it returns NULL.
+`memcached_create` returns a pointer to the `memcached_st` that was created (or
+initialized). On an allocation failure, it returns NULL.
 
-:func:`memcached_clone` returns a pointer to the :type:`memcached_st`
-that was created (or initialized). On an allocation failure, it returns NULL.
+`memcached_clone` returns a pointer to the `memcached_st` that was created (or
+initialized). On an allocation failure, it returns NULL.
 
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+
+.. only:: html
+
+    * :manpage:`memcached(1)`
+    * :doc:`../libmemcached`