docs: sanitize

[m6w6/libmemcached] / docs / source / hashkit_functions.rst

diff --git a/docs/source/hashkit_functions.rst b/docs/source/hashkit_functions.rst
index 0c9e2cc17c0129a28e94a941d4b24ae13af1bc44..d6225d4edcb8a06783610205c49450abcf084441 100644 (file)
--- a/docs/source/hashkit_functions.rst
+++ b/docs/source/hashkit_functions.rst
@@ -1,4 +1,3 @@
-================
 Available Hashes
 ================
 
@@ -6,13 +5,12 @@ Available Hashes
 
 Various hash functions to use for calculating values for keys
 
-
---------
 SYNOPSIS
 --------
 
-#include <libhashkit/hashkit.h>
- 
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit
+
 .. c:function:: uint32_t hashkit_default(const char *key, size_t key_length)
 
 .. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
@@ -29,39 +27,39 @@ SYNOPSIS
 
 .. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
 
+.. c:function:: uint32_t hashkit_murmur3(const char *key, size_t key_length)
+
 .. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
 
 .. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length)
 
-Compile and link with -lhashkit
-
-
------------
 DESCRIPTION
 -----------
 
-
 These functions generate hash values from a key using a variety of
 algorithms. These functions can be used standalone, or as arguments
-to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
+to :c:func:`hashkit_set_hash_fn` or :c:func:`hashkit_set_continuum_hash_fn`.
 
-The hashkit_hsieh is only available if the library is built with
+The :c:func:`hashkit_hsieh` is only available if the library is built with
 the appropriate flag enabled.
 
-
-------------
 RETURN VALUE
 ------------
 
-
 A 32-bit hash value.
 
-
-
---------
 SEE ALSO
 --------
 
+.. only:: man
+
+    :manpage:`libhashkit(3)`
+    :manpage:`hashkit_create(3)`
+    :manpage:`hashkit_function(3)`
+
+.. only:: html
 
-:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)`
+    * :doc:`libhashkit`
+    * :doc:`hashkit_create`
+    * :doc:`hashkit_function`