Minor docs updates

eriknyquist · Jan 5, 2024 · a91052d · a91052d
1 parent b429b6e
commit a91052d
Show file tree

Hide file tree

Showing 36 changed files with 215 additions and 201 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -53,7 +53,7 @@ PROJECT_NUMBER         =
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "A lightweight separate-chaining hashtable in C"
+PROJECT_BRIEF          = "A lightweight separate-chaining arena-backed hashtable in C"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55

diff --git a/docs/annotated.html b/docs/annotated.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/classes.html b/docs/classes.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/files.html b/docs/files.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/functions.html b/docs/functions.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/functions_vars.html b/docs/functions_vars.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/globals.html b/docs/globals.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>
@@ -107,6 +107,9 @@
 <li>hashtable_retrieve()
 : <a class="el" href="hashtable__api_8h.html#a45f3fe6d72ed5382addf276378966678">hashtable_api.h</a>
 </li>
+<li>hashtable_size_t
+: <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_api.h</a>
+</li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->

diff --git a/docs/globals_defs.html b/docs/globals_defs.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/globals_func.html b/docs/globals_func.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/globals_type.html b/docs/globals_type.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>
@@ -68,6 +68,9 @@
 <li>hashtable_hashfunc_t
 : <a class="el" href="hashtable__api_8h.html#aaff1f8de1b5e4a9ddbdf88a9549e8907">hashtable_api.h</a>
 </li>
+<li>hashtable_size_t
+: <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_api.h</a>
+</li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->

diff --git a/docs/hashtable__api_8h.html b/docs/hashtable__api_8h.html
@@ -25,7 +25,7 @@
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">hashtable v0.1.1
    </div>
-   <div id="projectbrief">A lightweight separate-chaining hashtable in C</div>
+   <div id="projectbrief">A lightweight separate-chaining arena-backed hashtable in C</div>
   </td>
  </tr>
  </tbody>
@@ -102,26 +102,27 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 Typedefs</h2></td></tr>
 <tr class="memitem:acab608df8c32a0ef8e8c6fe0cfab1208"><td class="memItemLeft" align="right" valign="top"><a id="acab608df8c32a0ef8e8c6fe0cfab1208"></a>
-typedef size_t&#160;</td><td class="memItemRight" valign="bottom"><b>hashtable_size_t</b></td></tr>
+typedef size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a></td></tr>
+<tr class="memdesc:acab608df8c32a0ef8e8c6fe0cfab1208"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the type used to represent the size of keys and values stored in the hashtable. <br /></td></tr>
 <tr class="separator:acab608df8c32a0ef8e8c6fe0cfab1208"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aaff1f8de1b5e4a9ddbdf88a9549e8907"><td class="memItemLeft" align="right" valign="top">typedef uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#aaff1f8de1b5e4a9ddbdf88a9549e8907">hashtable_hashfunc_t</a>) (const char *data, const hashtable_size_t size)</td></tr>
+<tr class="memitem:aaff1f8de1b5e4a9ddbdf88a9549e8907"><td class="memItemLeft" align="right" valign="top">typedef uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#aaff1f8de1b5e4a9ddbdf88a9549e8907">hashtable_hashfunc_t</a>) (const char *data, const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> size)</td></tr>
 <tr class="separator:aaff1f8de1b5e4a9ddbdf88a9549e8907"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
 <tr class="memitem:a15986e05c7f0cd9f2cdc8c5b17696b61"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a15986e05c7f0cd9f2cdc8c5b17696b61">hashtable_create</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, const <a class="el" href="structhashtable__config__t.html">hashtable_config_t</a> *config, void *buffer, size_t buffer_size)</td></tr>
 <tr class="separator:a15986e05c7f0cd9f2cdc8c5b17696b61"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a7ecf50cf685ca98768a69b328f81e582"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a7ecf50cf685ca98768a69b328f81e582">hashtable_insert</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, const char *key, const hashtable_size_t key_size, const char *value, const hashtable_size_t value_size)</td></tr>
+<tr class="memitem:a7ecf50cf685ca98768a69b328f81e582"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a7ecf50cf685ca98768a69b328f81e582">hashtable_insert</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, const char *key, const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> key_size, const char *value, const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> value_size)</td></tr>
 <tr class="separator:a7ecf50cf685ca98768a69b328f81e582"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a3a97aa30723003954d795a7a8dd4612b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a3a97aa30723003954d795a7a8dd4612b">hashtable_remove</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, const char *key, const hashtable_size_t key_size)</td></tr>
+<tr class="memitem:a3a97aa30723003954d795a7a8dd4612b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a3a97aa30723003954d795a7a8dd4612b">hashtable_remove</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, const char *key, const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> key_size)</td></tr>
 <tr class="separator:a3a97aa30723003954d795a7a8dd4612b"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a45f3fe6d72ed5382addf276378966678"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a45f3fe6d72ed5382addf276378966678">hashtable_retrieve</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, const char *key, const hashtable_size_t key_size, char **value, hashtable_size_t *value_size)</td></tr>
+<tr class="memitem:a45f3fe6d72ed5382addf276378966678"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a45f3fe6d72ed5382addf276378966678">hashtable_retrieve</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, const char *key, const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> key_size, char **value, <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> *value_size)</td></tr>
 <tr class="separator:a45f3fe6d72ed5382addf276378966678"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae33a0f5ea3aca2454d641bf3fe5357fb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#ae33a0f5ea3aca2454d641bf3fe5357fb">hashtable_has_key</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, const char *key, const hashtable_size_t key_size)</td></tr>
+<tr class="memitem:ae33a0f5ea3aca2454d641bf3fe5357fb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#ae33a0f5ea3aca2454d641bf3fe5357fb">hashtable_has_key</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, const char *key, const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> key_size)</td></tr>
 <tr class="separator:ae33a0f5ea3aca2454d641bf3fe5357fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3c093157186aa6d372cb406b3c2c1158"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a3c093157186aa6d372cb406b3c2c1158">hashtable_bytes_remaining</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, size_t *bytes_remaining)</td></tr>
 <tr class="separator:a3c093157186aa6d372cb406b3c2c1158"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a1af5b79bf710f1a8dbe6c54ac0c544fc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a1af5b79bf710f1a8dbe6c54ac0c544fc">hashtable_next_item</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, char **key, hashtable_size_t *key_size, char **value, hashtable_size_t *value_size)</td></tr>
+<tr class="memitem:a1af5b79bf710f1a8dbe6c54ac0c544fc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a1af5b79bf710f1a8dbe6c54ac0c544fc">hashtable_next_item</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table, char **key, <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> *key_size, char **value, <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> *value_size)</td></tr>
 <tr class="separator:a1af5b79bf710f1a8dbe6c54ac0c544fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4e04af9382451a2c86c8e4e84f0a8224"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="hashtable__api_8h.html#a4e04af9382451a2c86c8e4e84f0a8224">hashtable_reset_cursor</a> (<a class="el" href="structhashtable__t.html">hashtable_t</a> *table)</td></tr>
 <tr class="separator:a4e04af9382451a2c86c8e4e84f0a8224"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -167,7 +168,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aaff1f8de1b5e4a9ddbdf88a9
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">typedef uint32_t(* hashtable_hashfunc_t) (const char *data, const hashtable_size_t size)</td>
+          <td class="memname">typedef uint32_t(* hashtable_hashfunc_t) (const char *data, const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> size)</td>
         </tr>
       </table>
 </div><div class="memdoc">
@@ -376,7 +377,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae33a0f5ea3aca2454d641bf3
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const hashtable_size_t&#160;</td>
+          <td class="paramtype">const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a>&#160;</td>
           <td class="paramname"><em>key_size</em>&#160;</td>
         </tr>
         <tr>
@@ -420,7 +421,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7ecf50cf685ca98768a69b32
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const hashtable_size_t&#160;</td>
+          <td class="paramtype">const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a>&#160;</td>
           <td class="paramname"><em>key_size</em>, </td>
         </tr>
         <tr>
@@ -432,7 +433,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7ecf50cf685ca98768a69b32
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const hashtable_size_t&#160;</td>
+          <td class="paramtype">const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a>&#160;</td>
           <td class="paramname"><em>value_size</em>&#160;</td>
         </tr>
         <tr>
@@ -478,7 +479,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1af5b79bf710f1a8dbe6c54a
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">hashtable_size_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> *&#160;</td>
           <td class="paramname"><em>key_size</em>, </td>
         </tr>
         <tr>
@@ -490,7 +491,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1af5b79bf710f1a8dbe6c54a
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">hashtable_size_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> *&#160;</td>
           <td class="paramname"><em>value_size</em>&#160;</td>
         </tr>
         <tr>
@@ -536,7 +537,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3a97aa30723003954d795a7a
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const hashtable_size_t&#160;</td>
+          <td class="paramtype">const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a>&#160;</td>
           <td class="paramname"><em>key_size</em>&#160;</td>
         </tr>
         <tr>
@@ -606,7 +607,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a45f3fe6d72ed5382addf2763
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const hashtable_size_t&#160;</td>
+          <td class="paramtype">const <a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a>&#160;</td>
           <td class="paramname"><em>key_size</em>, </td>
         </tr>
         <tr>
@@ -618,7 +619,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a45f3fe6d72ed5382addf2763
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">hashtable_size_t *&#160;</td>
+          <td class="paramtype"><a class="el" href="hashtable__api_8h.html#acab608df8c32a0ef8e8c6fe0cfab1208">hashtable_size_t</a> *&#160;</td>
           <td class="paramname"><em>value_size</em>&#160;</td>
         </tr>
         <tr>