Update doxygen documentation.

This commit is contained in:
2025-10-11 12:43:39 +01:00
parent dde81f6773
commit 1f33de2ccf
96 changed files with 5966 additions and 5877 deletions

View File

@@ -316,8 +316,8 @@ $(function(){initNavTree('tape_8c_source.html','',''); });
</div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno"> 444</span></div>
<div class="foldopen" id="foldopen00569" data-start="{" data-end="}">
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno"><a class="line" href="decls_8h.html#a1c8d4faf14212a4c46c1fb47bf25ac1e"> 569</a></span>int32_t <a class="code hl_function" href="tape_8c.html#a6221f89b294ca55944944a04edb964e3">aaruf_get_tape_file</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <span class="keyword">const</span> uint8_t partition, <span class="keyword">const</span> uint32_t file, uint64_t *starting_block,</div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno"> 570</span> uint64_t *ending_block)</div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno"><a class="line" href="decls_8h.html#a1c8d4faf14212a4c46c1fb47bf25ac1e"> 569</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="tape_8c.html#a6221f89b294ca55944944a04edb964e3">aaruf_get_tape_file</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <span class="keyword">const</span> uint8_t partition, <span class="keyword">const</span> uint32_t file,</div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno"> 570</span> uint64_t *starting_block, uint64_t *ending_block)</div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno"> 571</span>{</div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno"> 572</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_get_tape_file(%p, %d, %d, %llu, %llu)&quot;</span>, context, partition, file, *starting_block,</div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno"> 573</span> *ending_block);</div>
@@ -363,8 +363,8 @@ $(function(){initNavTree('tape_8c_source.html','',''); });
</div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno"> 613</span></div>
<div class="foldopen" id="foldopen00770" data-start="{" data-end="}">
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno"><a class="line" href="decls_8h.html#a01c915ab49a4b47fd6768a2055208c48"> 770</a></span>int32_t <a class="code hl_function" href="tape_8c.html#a03d080a18e07adc52a654dc31b26eea0">aaruf_set_tape_file</a>(<span class="keywordtype">void</span> *context, <span class="keyword">const</span> uint8_t partition, <span class="keyword">const</span> uint32_t file, <span class="keyword">const</span> uint64_t starting_block,</div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno"> 771</span> <span class="keyword">const</span> uint64_t ending_block)</div>
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno"><a class="line" href="decls_8h.html#a01c915ab49a4b47fd6768a2055208c48"> 770</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="tape_8c.html#a03d080a18e07adc52a654dc31b26eea0">aaruf_set_tape_file</a>(<span class="keywordtype">void</span> *context, <span class="keyword">const</span> uint8_t partition, <span class="keyword">const</span> uint32_t file,</div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno"> 771</span> <span class="keyword">const</span> uint64_t starting_block, <span class="keyword">const</span> uint64_t ending_block)</div>
<div class="line"><a id="l00772" name="l00772"></a><span class="lineno"> 772</span>{</div>
<div class="line"><a id="l00773" name="l00773"></a><span class="lineno"> 773</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_set_tape_file(%p, %d, %d, %llu, %llu)&quot;</span>, context, partition, file, starting_block,</div>
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno"> 774</span> ending_block);</div>
@@ -438,8 +438,8 @@ $(function(){initNavTree('tape_8c_source.html','',''); });
</div>
<div class="line"><a id="l00842" name="l00842"></a><span class="lineno"> 842</span></div>
<div class="foldopen" id="foldopen00982" data-start="{" data-end="}">
<div class="line"><a id="l00982" name="l00982"></a><span class="lineno"><a class="line" href="decls_8h.html#ab1ca1a092699df0f43ea050812f6c6b1"> 982</a></span>int32_t <a class="code hl_function" href="tape_8c.html#a91c40d91fdeb98193d6eeb95f16d8973">aaruf_get_tape_partition</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <span class="keyword">const</span> uint8_t partition, uint64_t *starting_block,</div>
<div class="line"><a id="l00983" name="l00983"></a><span class="lineno"> 983</span> uint64_t *ending_block)</div>
<div class="line"><a id="l00982" name="l00982"></a><span class="lineno"><a class="line" href="decls_8h.html#ab1ca1a092699df0f43ea050812f6c6b1"> 982</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="tape_8c.html#a91c40d91fdeb98193d6eeb95f16d8973">aaruf_get_tape_partition</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, <span class="keyword">const</span> uint8_t partition,</div>
<div class="line"><a id="l00983" name="l00983"></a><span class="lineno"> 983</span> uint64_t *starting_block, uint64_t *ending_block)</div>
<div class="line"><a id="l00984" name="l00984"></a><span class="lineno"> 984</span>{</div>
<div class="line"><a id="l00985" name="l00985"></a><span class="lineno"> 985</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_get_tape_partition(%p, %d, %llu, %llu)&quot;</span>, context, partition, *starting_block, *ending_block);</div>
<div class="line"><a id="l00986" name="l00986"></a><span class="lineno"> 986</span> </div>
@@ -484,8 +484,8 @@ $(function(){initNavTree('tape_8c_source.html','',''); });
</div>
<div class="line"><a id="l01025" name="l01025"></a><span class="lineno"> 1025</span></div>
<div class="foldopen" id="foldopen01196" data-start="{" data-end="}">
<div class="line"><a id="l01196" name="l01196"></a><span class="lineno"><a class="line" href="decls_8h.html#a9daeeb54c74dd2707d95ab47e8ab0a00"> 1196</a></span>int32_t <a class="code hl_function" href="tape_8c.html#aa16d4457093df66246ce5622c3565a17">aaruf_set_tape_partition</a>(<span class="keywordtype">void</span> *context, <span class="keyword">const</span> uint8_t partition, <span class="keyword">const</span> uint64_t starting_block,</div>
<div class="line"><a id="l01197" name="l01197"></a><span class="lineno"> 1197</span> <span class="keyword">const</span> uint64_t ending_block)</div>
<div class="line"><a id="l01196" name="l01196"></a><span class="lineno"><a class="line" href="decls_8h.html#a9daeeb54c74dd2707d95ab47e8ab0a00"> 1196</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="tape_8c.html#aa16d4457093df66246ce5622c3565a17">aaruf_set_tape_partition</a>(<span class="keywordtype">void</span> *context, <span class="keyword">const</span> uint8_t partition,</div>
<div class="line"><a id="l01197" name="l01197"></a><span class="lineno"> 1197</span> <span class="keyword">const</span> uint64_t starting_block, <span class="keyword">const</span> uint64_t ending_block)</div>
<div class="line"><a id="l01198" name="l01198"></a><span class="lineno"> 1198</span>{</div>
<div class="line"><a id="l01199" name="l01199"></a><span class="lineno"> 1199</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_set_tape_partition(%p, %d, %llu, %llu)&quot;</span>, context, partition, starting_block, ending_block);</div>
<div class="line"><a id="l01200" name="l01200"></a><span class="lineno"> 1200</span> </div>
@@ -558,7 +558,9 @@ $(function(){initNavTree('tape_8c_source.html','',''); });
<div class="ttc" id="aaaruformat_8h_html"><div class="ttname"><a href="aaruformat_8h.html">aaruformat.h</a></div></div>
<div class="ttc" id="aconsts_8h_html_a3c3ba66fe2b547655c9e4b16a1ba519a"><div class="ttname"><a href="consts_8h.html#a3c3ba66fe2b547655c9e4b16a1ba519a">AARU_MAGIC</a></div><div class="ttdeci">#define AARU_MAGIC</div><div class="ttdoc">Magic identifier for AaruFormat container (ASCII &quot;AARUFRMT&quot;).</div><div class="ttdef"><b>Definition</b> <a href="consts_8h_source.html#l00064">consts.h:64</a></div></div>
<div class="ttc" id="acontext_8h_html_a5ba965cb003bc2d68a9f9e1c11225494"><div class="ttname"><a href="context_8h.html#a5ba965cb003bc2d68a9f9e1c11225494">tapeFileHashEntry</a></div><div class="ttdeci">struct TapeFileHashEntry tapeFileHashEntry</div></div>
<div class="ttc" id="adecls_8h_html_a018e0da1c1f7e4f6187a982c0e40e056"><div class="ttname"><a href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a></div><div class="ttdeci">#define AARU_CALL</div><div class="ttdef"><b>Definition</b> <a href="decls_8h_source.html#l00045">decls.h:45</a></div></div>
<div class="ttc" id="adecls_8h_html_a0fee4834bf0747bcd933c4e754aa4692"><div class="ttname"><a href="decls_8h.html#a0fee4834bf0747bcd933c4e754aa4692">aaruf_crc64_data</a></div><div class="ttdeci">uint64_t aaruf_crc64_data(const uint8_t *data, uint32_t len)</div><div class="ttdef"><b>Definition</b> <a href="crc64_8c_source.html#l00160">crc64.c:160</a></div></div>
<div class="ttc" id="adecls_8h_html_a9001412c35f3c92d3a9320d27b0d97f9"><div class="ttname"><a href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a></div><div class="ttdeci">#define AARU_EXPORT</div><div class="ttdef"><b>Definition</b> <a href="decls_8h_source.html#l00054">decls.h:54</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a60609bbcd07339a8bf589e66ef4a3041"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a60609bbcd07339a8bf589e66ef4a3041">TapePartitionBlock</a></div><div class="ttdeci">@ TapePartitionBlock</div><div class="ttdoc">Block containing list of partitions for a tape image.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00158">enums.h:158</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3ac3a117f2498bf736a76d5d3a3830540a"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3ac3a117f2498bf736a76d5d3a3830540a">TapeFileBlock</a></div><div class="ttdeci">@ TapeFileBlock</div><div class="ttdoc">Block containing list of files for a tape image.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00157">enums.h:157</a></div></div>
<div class="ttc" id="aerrors_8h_html_a14db41b6e45622397fa6339bc79d2b9f"><div class="ttname"><a href="errors_8h.html#a14db41b6e45622397fa6339bc79d2b9f">AARUF_ERROR_TAPE_PARTITION_NOT_FOUND</a></div><div class="ttdeci">#define AARUF_ERROR_TAPE_PARTITION_NOT_FOUND</div><div class="ttdoc">Requested tape partition not present in image.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00068">errors.h:68</a></div></div>