aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-11-05 03:45:00 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2026-10-08 20:15:08 +01:00
parent d036b284ef
commit e358b1ca0e
514 changed files with 42794 additions and 29088 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
docs/html/structCacheEntry.html
View File

@@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="generator" content="Doxygen 1.18.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: CacheEntry Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="codefolding.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
@@ -35,22 +35,47 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<!-- Generated by Doxygen 1.18.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="application/json" id="doxygen-config">
{
"relPath": "",
"generateTreeView": true,
"searchEngine": true,
"serverBasedSearch": false,
"disableIndex": false,
"dynamicMenus": true,
"fullSidebar": false
}
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<div id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
<ul class="sm sm-dox" id="main-menu">
<li id="searchBoxPos2">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div><!-- main-nav -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
@@ -58,20 +83,16 @@ $(function() {
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
<div id="splitbar" class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('structCacheEntry.html','',''); });
document.addEventListener('DOMContentLoaded',() => { initNavTree('structCacheEntry.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<div id="MSearchSelectWindow">
</div>
<!-- iframe showing the search results (closed by default) -->
@@ -104,6 +125,8 @@ Data Fields</h2></td></tr>
<tr class="memdesc:acee4cc303db10f54cfe2314142f24428"><td class="mdescLeft">&#160;</td><td class="mdescRight">64-bit integer key (unique within the cache). <br /></td></tr>
<tr class="memitem:a7d6d1ed0aab03cffbb34aff16f6f3d56" id="r_a7d6d1ed0aab03cffbb34aff16f6f3d56"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a></td></tr>
<tr class="memdesc:a7d6d1ed0aab03cffbb34aff16f6f3d56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opaque value pointer associated with key. <br /></td></tr>
<tr class="memitem:ab7bea8f5ce4dc7ace006ccabd45a0d1f" id="r_ab7bea8f5ce4dc7ace006ccabd45a0d1f"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#ab7bea8f5ce4dc7ace006ccabd45a0d1f">size</a></td></tr>
<tr class="memdesc:ab7bea8f5ce4dc7ace006ccabd45a0d1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size in bytes of the memory pointed to by value. <br /></td></tr>
<tr class="memitem:ae7e5f03fa52b88d99e27e2433623b4f5" id="r_ae7e5f03fa52b88d99e27e2433623b4f5"><td class="memItemLeft">UT_hash_handle&#160;</td><td class="memItemRight"><a class="el" href="#ae7e5f03fa52b88d99e27e2433623b4f5">hh</a></td></tr>
<tr class="memdesc:ae7e5f03fa52b88d99e27e2433623b4f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">uthash handle (must remain per uthash docs). <br /></td></tr>
</table>
@@ -114,7 +137,7 @@ Data Fields</h2></td></tr>
<li>value is an opaque pointer supplied by caller; the cache does not take ownership unless a free_func is registered on the <a class="el" href="structCacheHeader.html" title="Cache top-level descriptor encapsulating the hash table root and capacity limit.">CacheHeader</a>. </li>
</ul>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00023">23</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00024">24</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="ae7e5f03fa52b88d99e27e2433623b4f5" name="ae7e5f03fa52b88d99e27e2433623b4f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7e5f03fa52b88d99e27e2433623b4f5">&#9670;&#160;</a></span>hh</h2>
@@ -130,9 +153,9 @@ Data Fields</h2></td></tr>
<p>uthash handle (must remain per uthash docs). </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00027">27</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00029">29</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00048">add_to_cache_uint64()</a>, <a class="el" href="lru_8c_source.html#l00024">find_in_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00082">free_cache()</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00068">add_to_cache_uint64()</a>, <a class="el" href="lru_8c_source.html#l00041">find_in_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00118">free_cache()</a>.</p>
</div>
</div>
@@ -150,9 +173,29 @@ Data Fields</h2></td></tr>
<p>64-bit integer key (unique within the cache). </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00025">25</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00026">26</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00048">add_to_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00024">find_in_cache_uint64()</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00068">add_to_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00041">find_in_cache_uint64()</a>.</p>
</div>
</div>
<a id="ab7bea8f5ce4dc7ace006ccabd45a0d1f" name="ab7bea8f5ce4dc7ace006ccabd45a0d1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7bea8f5ce4dc7ace006ccabd45a0d1f">&#9670;&#160;</a></span>size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t CacheEntry::size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size in bytes of the memory pointed to by value. </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00028">28</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00068">add_to_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00020">drop_entry()</a>.</p>
</div>
</div>
@@ -170,9 +213,9 @@ Data Fields</h2></td></tr>
<p>Opaque value pointer associated with key. </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00026">26</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00027">27</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00048">add_to_cache_uint64()</a>, <a class="el" href="lru_8c_source.html#l00024">find_in_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00082">free_cache()</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00068">add_to_cache_uint64()</a>, <a class="el" href="lru_8c_source.html#l00020">drop_entry()</a>, and <a class="el" href="lru_8c_source.html#l00041">find_in_cache_uint64()</a>.</p>
</div>
</div>
@@ -193,7 +236,7 @@ Data Fields</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structCacheEntry.html">CacheEntry</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.18.0 </li>
</ul>
</div>
</body>