projects
/
awesomized
/
libmemcached
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
Merge of all doc fixes.
[awesomized/libmemcached]
/
docs
/
memcached_generate_hash_value.rst
diff --git
a/docs/memcached_generate_hash_value.rst
b/docs/memcached_generate_hash_value.rst
index 8b75a4a84a648ab785eec8fe2b3ec47f7c09ac3f..116bfd2b83ae1583fbd492b1cd8f39c33da8b57d 100644
(file)
--- a/
docs/memcached_generate_hash_value.rst
+++ b/
docs/memcached_generate_hash_value.rst
@@
-1,46
+1,28
@@
-.. highlight:: perl
-
-
-memcached_generate_hash_value
-*****************************
+===============================
+Generating hash values directly
+===============================
Hash a key value
Hash a key value
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcached, -lmemcached)
-
-
-********
-SYNOPSIS
-********
+--------
+SYNOPSIS
+--------
-
-.. code-block:: perl
-
- #include <memcached.h>
-
- uint32_t
- memcached_generate_hash_value (const char *key,
- size_t key_length,
- memcached_hash_t hash_algorithm);
+#include <libmemcached/memcached.h>
- uint32_t
- memcached_generate_hash (memcached_st *ptr,
- const char *key,
- size_t key_length);
+.. c:function:: uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm);
+.. c:function:: uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length);
+Compile and link with -lmemcachedutil -lmemcached
-***********
+
+-----------
DESCRIPTION
DESCRIPTION
-***********
+-----------
memcached_generate_hash_value() allows you to hash a key using one of
memcached_generate_hash_value() allows you to hash a key using one of
@@
-56,12
+38,12
@@
the hash value that would have been generated based on the defaults
of the memcached_st structure.
As of version 0.36 all hash methods have been placed into the library
of the memcached_st structure.
As of version 0.36 all hash methods have been placed into the library
-libhashkit(3) which is linked with libmemcached(3).
+libhashkit(3) which is linked with libmemcached(3).
For more information please see its documentation.
-******
+------
RETURN
RETURN
-******
+------
A 32-bit integer which is the result of hashing the given key.
A 32-bit integer which is the result of hashing the given key.
@@
-69,27
+51,26
@@
For 64-bit hash algorithms, only the least-significant 32 bits are
returned.
returned.
-****
+----
HOME
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
AUTHOR
-******
+------
Brian Aker, <brian@tangent.org>
Brian Aker, <brian@tangent.org>
-********
+--------
SEE ALSO
SEE ALSO
-********
-
+--------
-memcached(1) libmemcached(3) memcached_behavior_set(3) libhashkit(3)
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`