Add missing files.
[awesomized/libmemcached] / docs / memcached_create.rst
index 31f4af9abafa6577afae01800e54fa5d48b283b7..c63bd7614fa616d69c89055fd13dd00341efd7a4 100644 (file)
@@ -1,45 +1,38 @@
-.. highlight:: perl
+======================================
+Creating and destroying a memcached_st
+======================================
 
 
-****
-NAME
-****
+Create a memcached_st structure
 
 
-memcached_create, memcached_free, memcached_clone, memcached_servers_reset- Create a memcached_st structure
-
-
-*******
+-------
 LIBRARY
-*******
+-------
 
 
 C Client Library for memcached (libmemcached, -lmemcached)
 
 
-********
+--------
 SYNOPSIS
-********
-
+--------
 
-
-.. code-block:: perl
-
-   #include <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);
 
 
 
-***********
+-----------
 DESCRIPTION
-***********
+-----------
 
 
 memcached_create() is used to create a \ ``memcached_st``\  structure that will then
@@ -65,9 +58,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
@@ -77,27 +70,26 @@ 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>
 
 
-********
+--------
 SEE ALSO
-********
-
+--------
 
-memcached(1) libmemcached(3) memcached_strerror(3)
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`