bison: fix warnings

[awesomized/libmemcached] / docs / source / hashkit_create.rst

diff --git a/docs/source/hashkit_create.rst b/docs/source/hashkit_create.rst
index a46729a9729cd38f7eb372a4ee1f96c475df9800..47371ecadf02aca36630f415b7e465e0e67a504f 100644 (file)
--- a/docs/source/hashkit_create.rst
+++ b/docs/source/hashkit_create.rst
@@ -1,34 +1,31 @@
-============================
 Creating a hashkit structure
 ============================
 
-.. highlightlang:: c
-
 .. index:: object: hashkit_st
 
---------
+Create, copy and free a hashkit structure
+
 SYNOPSIS
 --------
 
-#include <libhashkit/hashkit.h>
- 
-.. c:type:: hashkit_st
+#include <libhashkit-|libhashkit_version|/hashkit.h>
+  Compile and link with -lhashkit
+
+.. c:type:: struct hashkit_st
+
+   typedef struct hashkit_st hashkit_st;
 
 .. c:function:: hashkit_st *hashkit_create(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 -lhashkit
-
------------
 DESCRIPTION
 -----------
 
-
 The :c:func:`hashkit_create` function initializes a hashkit object for use. If
 you pass a NULL argument for hash, then the memory for the object is
 allocated. If you specify a pre-allocated piece of memory, that is
@@ -44,12 +41,9 @@ objects that were initialized with :c:func:`hashkit_create` or :c:func:`hashkit_
 The :c:func:`hashkit_is_allocated` reports where the memory was allocated 
 for a hashkit object.
 
-
-------------
 RETURN VALUE
 ------------
 
-
 :c:func:`hashkit_create` and :c:func:`hashkit_clone` will return NULL on 
 failure or non-NULL on success.
 
@@ -57,21 +51,17 @@ failure or non-NULL on success.
 object was allocated inside of :c:func:`hashkit_create` or 
 :c:func:`hashkit_clone`, otherwise it is false and was user-supplied memory.
 
-
-----
-HOME
-----
-
-
-To find out more information please check:
-`http://libmemcached.org/ <http://libmemcached.org/>`_
-
-
-
---------
 SEE ALSO
 --------
 
+.. only:: man
+
+    :manpage:`libhashkit(3)`
+    :manpage:`hashkit_value(3)`
+    :manpage:`hashkit_function3)`
 
-:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)`
+.. only:: html
 
+    * :doc:`libhashkit`
+    * :doc:`hashkit_value`
+    * :doc:`hashkit_function`