X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=libhashkit%2Fhashkit_value.html;h=3beb9d5b14cbfe4c1a2ead2e10c99d662de221ac;hb=7a6ebf3a611e2e43aa496885f301c6826a49d25c;hp=96d4db70841844c94b6ab0186e8aafe9b1771184;hpb=357fb245dde952b47f190c7eff413fc5017c2049;p=awesomized%2Flibmemcached

diff --git a/libhashkit/hashkit_value.html b/libhashkit/hashkit_value.html
index 96d4db70..3beb9d5b 100644
--- a/libhashkit/hashkit_value.html
+++ b/libhashkit/hashkit_value.html
@@ -21,10 +21,10 @@
   
     
       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
-        <script src="../_static/jquery.js"></script>
-        <script src="../_static/underscore.js"></script>
-        <script src="../_static/doctools.js"></script>
-        <script src="../_static/language_data.js"></script>
+        <script type="text/javascript" src="../_static/jquery.js"></script>
+        <script type="text/javascript" src="../_static/underscore.js"></script>
+        <script type="text/javascript" src="../_static/doctools.js"></script>
+        <script type="text/javascript" src="../_static/language_data.js"></script>
     
     <script type="text/javascript" src="../_static/js/theme.js"></script>
 
@@ -85,20 +85,10 @@
               
             
             
-              <p class="caption"><span class="caption-text">libmemcached</span></p>
-<ul>
+              <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a></li>
-</ul>
-<p class="caption"><span class="caption-text">libmemcachedutil</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">libhashkit</span></p>
-<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libhashkit API</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html">Creating a hashkit structure</a></li>
 <li class="toctree-l2"><a class="reference internal" href="hashkit_function.html">Set Hash Function</a></li>
@@ -106,13 +96,11 @@
 <li class="toctree-l2 current"><a class="current reference internal" href="#">Generate hash value</a></li>
 </ul>
 </li>
-</ul>
-<p class="caption"><span class="caption-text">Client Applications</span></p>
-<ul>
 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Miscellaneous</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Copyright</span></p>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 </ul>
 
@@ -159,7 +147,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="index.html">libhashkit API</a> &raquo;</li>
+          <li><a href="index.html">libhashkit - C/C++ hashing library</a> &raquo;</li>
         
       <li>Generate hash value</li>
     
@@ -167,6 +155,10 @@
       <li class="wy-breadcrumbs-aside">
         
             
+            
+              <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libhashkit/hashkit_value.rst" class="fa fa-github"> Edit on GitHub</a>
+            
+          
         
       </li>
     
@@ -180,25 +172,37 @@
             
   <div class="section" id="generate-hash-value">
 <h1>Generate hash value<a class="headerlink" href="#generate-hash-value" title="Permalink to this headline">¶</a></h1>
-<p id="index-0">Generate a value for the given key</p>
 <div class="section" id="synopsis">
 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<dl class="simple">
-<dt>#include &lt;libhashkit-1.0/hashkit.h&gt;</dt><dd><p>Compile and link with -lhashkit</p>
-</dd>
+<dl class="docutils">
+<dt>#include &lt;libhashkit-1/hashkit.h&gt;</dt>
+<dd>Compile and link with -lhashkit</dd>
 </dl>
 <dl class="function">
 <dt id="_CPPv413hashkit_valueP10hashkit_stPKc6size_t">
-<span id="_CPPv313hashkit_valueP10hashkit_stPKc6size_t"></span><span id="_CPPv213hashkit_valueP10hashkit_stPKc6size_t"></span><span id="hashkit_value__hashkit_stP.cCP.s"></span>uint32_t <code class="sig-name descname">hashkit_value</code><span class="sig-paren">(</span><a class="reference internal" href="hashkit_create.html#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv313hashkit_valueP10hashkit_stPKc6size_t"></span><span id="_CPPv213hashkit_valueP10hashkit_stPKc6size_t"></span><span id="hashkit_value__hashkit_stP.cCP.s"></span>uint32_t <code class="descname">hashkit_value</code><span class="sig-paren">(</span><a class="reference internal" href="hashkit_create.html#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em>, <em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>hash</strong> -- pointer to an initialized <a class="reference internal" href="hashkit_create.html#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct</li>
+<li><strong>key</strong> -- the key to genereate a hash of</li>
+<li><strong>key_length</strong> -- the length of the <a class="reference internal" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="hashkit_value::key"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">key</span></code></a> without any terminating zero byte</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 </div>
 <div class="section" id="description">
 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
-<p>The <a class="reference internal" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="hashkit_value"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_value()</span></code></a> function generates a 32-bit hash value from the
-given key and key_length. The hash argument is an initialized hashkit
-object, and distribution type and hash function is used from this
-object while generating the value.</p>
+<p>The <a class="reference internal" href="#_CPPv413hashkit_valueP10hashkit_stPKc6size_t" title="hashkit_value"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_value()</span></code></a> function generates a 32-bit hash value from the given key
+and key_length. The hash argument is an initialized hashkit object, and
+distribution type and hash function is used from this object while generating
+the value.</p>
 </div>
 <div class="section" id="return-value">
 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
@@ -207,10 +211,10 @@ object while generating the value.</p>
 <div class="section" id="see-also">
 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
-<li><p><a class="reference internal" href="../libhashkit.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></p></li>
-<li><p><a class="reference internal" href="hashkit_create.html"><span class="doc">Creating a hashkit structure</span></a></p></li>
-<li><p><a class="reference internal" href="hashkit_function.html"><span class="doc">Set Hash Function</span></a></p></li>
-<li><p><a class="reference internal" href="hashkit_functions.html"><span class="doc">Available Hashes</span></a></p></li>
+<li><a class="reference internal" href="index.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></li>
+<li><a class="reference internal" href="hashkit_create.html"><span class="doc">Creating a hashkit structure</span></a></li>
+<li><a class="reference internal" href="hashkit_function.html"><span class="doc">Set Hash Function</span></a></li>
+<li><a class="reference internal" href="hashkit_functions.html"><span class="doc">Available Hashes</span></a></li>
 </ul>
 </div>
 </div>