projects
/
awesomized
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
Update changelog
[awesomized/libmemcached]
/
docs
/
hashkit_create.rst
diff --git
a/docs/hashkit_create.rst
b/docs/hashkit_create.rst
index 4fa5974600ae5c03c34d107744395ab79ee971d3..e0c9c71c0fd48c06cae541faad9347fad45def16 100644
(file)
--- a/
docs/hashkit_create.rst
+++ b/
docs/hashkit_create.rst
@@
-1,46
+1,31
@@
-.. highlight:: perl
+============================
+Creating a hashkit structure
+============================
-****
-NAME
-****
-
-
-hashkit_create, hashkit_clone, hashkit_free, hashkit_is_allocated -
-Create and destroy hashkit objects
-
-
-*******
-LIBRARY
-*******
-
-
-C Library for hashing algorithms (libhashkit, -lhashkit)
-
-
-********
+--------
SYNOPSIS
SYNOPSIS
-********
-
+--------
+C Library for hashing algorithms (libmemcached, -lhashkit)
-.. code-block:: perl
-
#include <libhashkit/hashkit.h>
+#include <libhashkit/hashkit.h>
-
hashkit_st *hashkit_create(hashkit_st *hash);
+
.. c:function::
hashkit_st *hashkit_create(hashkit_st *hash);
- hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
-
- void hashkit_free(hashkit_st *hash);
-
- bool hashkit_is_allocated(const hashkit_st *hash);
+.. c:function:: hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+
+.. c:function:: void hashkit_free(hashkit_st *hash);
+.. c:function:: bool hashkit_is_allocated(const hashkit_st *hash);
+Compile and link with -lmemcached
-***********
+
+-----------
DESCRIPTION
DESCRIPTION
-***********
+-----------
The hashkit_create() function initializes a hashkit object for use. If
The hashkit_create() function initializes a hashkit object for use. If
@@
-59,9
+44,9
@@
The hashkit_is_allocated() reports where the memory was allocated
for a hashkit object.
for a hashkit object.
-************
+------------
RETURN VALUE
RETURN VALUE
-************
+------------
hashkit_create() and hashkit_clone() will return NULL on failure or
hashkit_create() and hashkit_clone() will return NULL on failure or
@@
-72,19
+57,10
@@
object was allocated inside of hashkit_create() or hashkit_clone(),
otherwise it is false and was user-supplied memory.
otherwise it is false and was user-supplied memory.
-****
+----
HOME
HOME
-****
+----
To find out more information please check:
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/>`_