Update doxygen documentation.

This commit is contained in:
2025-12-31 10:59:13 +00:00
parent 48259087f8
commit e962e3443e
467 changed files with 14662 additions and 13929 deletions

View File

@@ -104,6 +104,8 @@ Data Fields</h2></td></tr>
<tr class="memdesc:ad3b962f8ce6c6115143cf581c7936e55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hard limit for number of entries (policy: enforce/ignore depends on implementation). <br /></td></tr>
<tr class="memitem:a44229bb929d8949f3c2700d07123d224" id="r_a44229bb929d8949f3c2700d07123d224"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structCacheEntry.html">CacheEntry</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a44229bb929d8949f3c2700d07123d224">cache</a></td></tr>
<tr class="memdesc:a44229bb929d8949f3c2700d07123d224"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hash root (uthash). NULL when empty. <br /></td></tr>
<tr class="memitem:afeac54c794f8fece845e49954fd89f1a" id="r_afeac54c794f8fece845e49954fd89f1a"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afeac54c794f8fece845e49954fd89f1a">free_func</a> )(void *)</td></tr>
<tr class="memdesc:afeac54c794f8fece845e49954fd89f1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional callback to free cached values. NULL if values don't need freeing. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Cache top-level descriptor encapsulating the hash table root and capacity limit. </p>
@@ -131,7 +133,27 @@ Data Fields</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00048">48</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>, <a class="el" href="lru_8c_source.html#l00047">add_to_cache()</a>, and <a class="el" href="lru_8c_source.html#l00024">find_in_cache()</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>, <a class="el" href="lru_8c_source.html#l00047">add_to_cache()</a>, <a class="el" href="lru_8c_source.html#l00024">find_in_cache()</a>, and <a class="el" href="lru_8c_source.html#l00130">free_cache()</a>.</p>
</div>
</div>
<a id="afeac54c794f8fece845e49954fd89f1a" name="afeac54c794f8fece845e49954fd89f1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afeac54c794f8fece845e49954fd89f1a">&#9670;&#160;</a></span>free_func</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* CacheHeader::free_func) (void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Optional callback to free cached values. NULL if values don't need freeing. </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00049">49</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>, <a class="el" href="lru_8c_source.html#l00047">add_to_cache()</a>, and <a class="el" href="lru_8c_source.html#l00130">free_cache()</a>.</p>
</div>
</div>