Update doxygen documentation.

This commit is contained in:
2026-04-11 23:17:09 +01:00
parent 7af6e613ab
commit a94f388238
658 changed files with 65760 additions and 36437 deletions

View File

@@ -3,7 +3,7 @@
<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.15.0"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: IndexHeader3 Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -35,7 +35,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
@@ -100,13 +100,13 @@ $(function(){initNavTree('structIndexHeader3.html','',''); });
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a482f94fd93019dd2879d984bc8eecf67" id="r_a482f94fd93019dd2879d984bc8eecf67"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a482f94fd93019dd2879d984bc8eecf67">identifier</a></td></tr>
<tr class="memitem:a482f94fd93019dd2879d984bc8eecf67" id="r_a482f94fd93019dd2879d984bc8eecf67"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a482f94fd93019dd2879d984bc8eecf67">identifier</a></td></tr>
<tr class="memdesc:a482f94fd93019dd2879d984bc8eecf67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block identifier (must be BlockType::IndexBlock3). <br /></td></tr>
<tr class="memitem:af05fe8e08e929aa0eab6b74638f22b74" id="r_af05fe8e08e929aa0eab6b74638f22b74"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af05fe8e08e929aa0eab6b74638f22b74">entries</a></td></tr>
<tr class="memdesc:af05fe8e08e929aa0eab6b74638f22b74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <a class="el" href="structIndexEntry.html">IndexEntry</a> records that follow in this (sub)index block. <br /></td></tr>
<tr class="memitem:a7291ac63956c468bf48aa17d24d3f7b2" id="r_a7291ac63956c468bf48aa17d24d3f7b2"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7291ac63956c468bf48aa17d24d3f7b2">crc64</a></td></tr>
<tr class="memitem:af05fe8e08e929aa0eab6b74638f22b74" id="r_af05fe8e08e929aa0eab6b74638f22b74"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#af05fe8e08e929aa0eab6b74638f22b74">entries</a></td></tr>
<tr class="memdesc:af05fe8e08e929aa0eab6b74638f22b74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <a class="el" href="structIndexEntry.html" title="IndexEntry">IndexEntry</a> records that follow in this (sub)index block. <br /></td></tr>
<tr class="memitem:a7291ac63956c468bf48aa17d24d3f7b2" id="r_a7291ac63956c468bf48aa17d24d3f7b2"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#a7291ac63956c468bf48aa17d24d3f7b2">crc64</a></td></tr>
<tr class="memdesc:a7291ac63956c468bf48aa17d24d3f7b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA of the local entries array (does NOT cover subindexes or previous chains). <br /></td></tr>
<tr class="memitem:a33743c206cb10cc1d8ff2c7f9e61ddcf" id="r_a33743c206cb10cc1d8ff2c7f9e61ddcf"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33743c206cb10cc1d8ff2c7f9e61ddcf">previous</a></td></tr>
<tr class="memitem:a33743c206cb10cc1d8ff2c7f9e61ddcf" id="r_a33743c206cb10cc1d8ff2c7f9e61ddcf"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#a33743c206cb10cc1d8ff2c7f9e61ddcf">previous</a></td></tr>
<tr class="memdesc:a33743c206cb10cc1d8ff2c7f9e61ddcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">File offset of a previous IndexBlock3 header (0 if none / root segment). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
@@ -131,7 +131,7 @@ Data Fields</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00096">96</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close_8c_source.html#l04875">write_index_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close__write_8c_source.html#l05145">write_index_block()</a>.</p>
</div>
</div>
@@ -147,11 +147,11 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Number of <a class="el" href="structIndexEntry.html">IndexEntry</a> records that follow in this (sub)index block. </p>
<p>Number of <a class="el" href="structIndexEntry.html" title="IndexEntry">IndexEntry</a> records that follow in this (sub)index block. </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00095">95</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__v3_8c_source.html#l00247">add_subindex_entries()</a>, <a class="el" href="index__v3_8c_source.html#l00098">process_index_v3()</a>, <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close_8c_source.html#l04875">write_index_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__v3_8c_source.html#l00247">add_subindex_entries()</a>, <a class="el" href="erasure_8c_source.html#l00690">ec_finalize()</a>, <a class="el" href="index__v3_8c_source.html#l00098">process_index_v3()</a>, <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close__write_8c_source.html#l05145">write_index_block()</a>.</p>
</div>
</div>
@@ -171,7 +171,7 @@ Data Fields</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00094">94</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__v3_8c_source.html#l00247">add_subindex_entries()</a>, <a class="el" href="index__v3_8c_source.html#l00098">process_index_v3()</a>, <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close_8c_source.html#l04875">write_index_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__v3_8c_source.html#l00247">add_subindex_entries()</a>, <a class="el" href="index__v3_8c_source.html#l00098">process_index_v3()</a>, <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close__write_8c_source.html#l05145">write_index_block()</a>.</p>
</div>
</div>
@@ -191,7 +191,7 @@ Data Fields</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00097">97</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l04875">write_index_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close__write_8c_source.html#l05145">write_index_block()</a>.</p>
</div>
</div>
@@ -212,7 +212,7 @@ Data Fields</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structIndexHeader3.html">IndexHeader3</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.15.0 </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>
</ul>
</div>
</body>