Update documentation.

[m6w6/libmemcached] / docs / memcached_create.rst

diff --git a/docs/memcached_create.rst b/docs/memcached_create.rst
index 36a36bd7bb7c3a5a0c5a76aed3f4f226fa87a0ff..12bf92c5e5afdb8485ec75b2e9d4e428f50d6dbe 100644 (file)
--- a/docs/memcached_create.rst
+++ b/docs/memcached_create.rst
@@ -2,48 +2,36 @@
 Creating and destroying a memcached_st
 ======================================
 
-
-Create a memcached_st structure
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
+.. index:: object: memcached_st
 
 --------
 SYNOPSIS
 --------
 
-
-
-.. code-block:: perl
-
-   #include <libmemcached/memcached.h>
+#include <libmemcached/memcached.h>
  
-   memcached_st *memcached_create (memcached_st *ptr);
+.. c:function:: memcached_st *memcached_create (memcached_st *ptr);
  
-   void memcached_free (memcached_st *ptr);
+.. c:function:: void memcached_free (memcached_st *ptr);
  
-   memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
+.. c:function:: memcached_st *memcached_clone (memcached_st *destination, memcached_st *source);
  
-   void memcached_servers_reset(memcached_st);
+.. c:function:: void memcached_servers_reset(memcached_st);
 
+Compile and link with -lmemcached
 
 
 -----------
 DESCRIPTION
 -----------
 
-
 memcached_create() is used to create a \ ``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 \ ``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 memcached_create_with_options() over memcached_create().
+
 memcached_clone() is similar to memcached_create(3) but it copies the
 defaults and list of servers from the source \ ``memcached_st``\ . If you pass a null as
 the argument for the source to clone, it is the same as a call to memcached_create().
@@ -62,9 +50,9 @@ stack based allocation. The most common issues related to ABI safety involve
 heap allocated structures.
 
 
-******
+------
 RETURN
-******
+------
 
 
 memcached_create() returns a pointer to the memcached_st that was created
@@ -74,21 +62,13 @@ memcached_clone() returns a pointer to the memcached_st that was created
 (or initialized). On an allocation failure, it returns NULL.
 
 
-****
+----
 HOME
-****
+----
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
-
-******
-AUTHOR
-******
-
-
-Brian Aker, <brian@tangent.org>
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
 --------