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

@@ -141,7 +141,7 @@ $(function(){initNavTree('open_8c_source.html','',''); });
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span></div>
<div class="foldopen" id="foldopen00125" data-start="{" data-end="}">
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="decls_8h.html#afc4932cdc795ffb2ef3a33d5b8c57656"> 125</a></span><span class="keywordtype">void</span> *<a class="code hl_function" href="open_8c.html#afc4932cdc795ffb2ef3a33d5b8c57656">aaruf_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filepath) <span class="comment">// NOLINT(readability-function-size)</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="decls_8h.html#afc4932cdc795ffb2ef3a33d5b8c57656"> 125</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> <span class="keywordtype">void</span> <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> *<a class="code hl_function" href="open_8c.html#afc4932cdc795ffb2ef3a33d5b8c57656">aaruf_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filepath) <span class="comment">// NOLINT(readability-function-size)</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span>{</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <a class="code hl_struct" href="structaaruformat__context.html">aaruformat_context</a> *ctx = NULL;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> <span class="keywordtype">int</span> error_no = 0;</div>
@@ -519,7 +519,9 @@ $(function(){initNavTree('open_8c_source.html','',''); });
<div class="ttc" id="aconsts_8h_html_a6c8469dfe973ac952cf40394bd2c160b"><div class="ttname"><a href="consts_8h.html#a6c8469dfe973ac952cf40394bd2c160b">MAX_CACHE_SIZE</a></div><div class="ttdeci">#define MAX_CACHE_SIZE</div><div class="ttdoc">Maximum read cache size (bytes).</div><div class="ttdef"><b>Definition</b> <a href="consts_8h_source.html#l00079">consts.h:79</a></div></div>
<div class="ttc" id="aconsts_8h_html_ad2fdced5805aa0364f1c5b073f81dd76"><div class="ttname"><a href="consts_8h.html#ad2fdced5805aa0364f1c5b073f81dd76">AARUF_VERSION_V2</a></div><div class="ttdeci">#define AARUF_VERSION_V2</div><div class="ttdoc">Second ondisk version (C implementation).</div><div class="ttdef"><b>Definition</b> <a href="consts_8h_source.html#l00075">consts.h:75</a></div></div>
<div class="ttc" id="aconsts_8h_html_adbbd4387273589f1c76a5f5786607013"><div class="ttname"><a href="consts_8h.html#adbbd4387273589f1c76a5f5786607013">AARUF_VERSION</a></div><div class="ttdeci">#define AARUF_VERSION</div><div class="ttdoc">Current image format major version (incompatible changes bump this).</div><div class="ttdef"><b>Definition</b> <a href="consts_8h_source.html#l00068">consts.h:68</a></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_a6823e139f81a9dfd08efcb0e9b213a49"><div class="ttname"><a href="decls_8h.html#a6823e139f81a9dfd08efcb0e9b213a49">aaruf_close</a></div><div class="ttdeci">int aaruf_close(void *context)</div><div class="ttdoc">Close an Aaru image context, flushing pending data structures and releasing resources.</div><div class="ttdef"><b>Definition</b> <a href="close_8c_source.html#l03995">close.c:3995</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="adecls_8h_html_ac1a30bb251ac148f485c51593c0740c1"><div class="ttname"><a href="decls_8h.html#ac1a30bb251ac148f485c51593c0740c1">aaruf_ecc_cd_init</a></div><div class="ttdeci">void * aaruf_ecc_cd_init()</div><div class="ttdoc">Initializes a Compact Disc ECC context.</div><div class="ttdef"><b>Definition</b> <a href="ecc__cd_8c_source.html#l00035">ecc_cd.c:35</a></div></div>
<div class="ttc" id="adecls_8h_html_ac5f5334a51424028574a5433a0e24b20"><div class="ttname"><a href="decls_8h.html#ac5f5334a51424028574a5433a0e24b20">aaruf_get_xml_mediatype</a></div><div class="ttdeci">int32_t aaruf_get_xml_mediatype(int32_t type)</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00339">helpers.c:339</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a318acaf230a8ad091ef405caf7e4f411"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a318acaf230a8ad091ef405caf7e4f411">IndexBlock3</a></div><div class="ttdeci">@ IndexBlock3</div><div class="ttdoc">Block containing the index v3.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00147">enums.h:147</a></div></div>