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

@@ -231,7 +231,7 @@ $(function(){initNavTree('optical_8c_source.html','',''); });
</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span></div>
<div class="foldopen" id="foldopen00281" data-start="{" data-end="}">
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"><a class="line" href="decls_8h.html#a2ce65757ca5209f17d467c51ba7d445d"> 281</a></span>int32_t <a class="code hl_function" href="optical_8c.html#a2ce65757ca5209f17d467c51ba7d445d">aaruf_get_tracks</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, uint8_t *buffer, <span class="keywordtype">size_t</span> *length)</div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"><a class="line" href="decls_8h.html#a2ce65757ca5209f17d467c51ba7d445d"> 281</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="optical_8c.html#a2ce65757ca5209f17d467c51ba7d445d">aaruf_get_tracks</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, uint8_t *buffer, <span class="keywordtype">size_t</span> *length)</div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span>{</div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_get_tracks(%p, %p, %zu)&quot;</span>, context, buffer, (length ? *length : 0));</div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno"> 284</span> </div>
@@ -283,7 +283,7 @@ $(function(){initNavTree('optical_8c_source.html','',''); });
</div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span></div>
<div class="foldopen" id="foldopen00392" data-start="{" data-end="}">
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno"><a class="line" href="decls_8h.html#a518d8d68debf1b9a24af3eb6bc2f9e49"> 392</a></span>int32_t <a class="code hl_function" href="optical_8c.html#a518d8d68debf1b9a24af3eb6bc2f9e49">aaruf_set_tracks</a>(<span class="keywordtype">void</span> *context, <a class="code hl_struct" href="structTrackEntry.html">TrackEntry</a> *tracks, <span class="keyword">const</span> <span class="keywordtype">int</span> count)</div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno"><a class="line" href="decls_8h.html#a518d8d68debf1b9a24af3eb6bc2f9e49"> 392</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="optical_8c.html#a518d8d68debf1b9a24af3eb6bc2f9e49">aaruf_set_tracks</a>(<span class="keywordtype">void</span> *context, <a class="code hl_struct" href="structTrackEntry.html">TrackEntry</a> *tracks, <span class="keyword">const</span> <span class="keywordtype">int</span> count)</div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno"> 393</span>{</div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno"> 394</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_set_tracks(%p, %p, %d)&quot;</span>, context, tracks, count);</div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno"> 395</span> </div>
@@ -386,7 +386,9 @@ $(function(){initNavTree('optical_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="aconsts_8h_html_ac837e146bff4d0f3603e4a9e444358c6"><div class="ttname"><a href="consts_8h.html#ac837e146bff4d0f3603e4a9e444358c6">AARUF_VERSION_V1</a></div><div class="ttdeci">#define AARUF_VERSION_V1</div><div class="ttdoc">First ondisk version (C# implementation).</div><div class="ttdef"><b>Definition</b> <a href="consts_8h_source.html#l00071">consts.h:71</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_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="aendian_8h_html_a0c0b427a2547aa727e2c5262a174e26b"><div class="ttname"><a href="endian_8h.html#a0c0b427a2547aa727e2c5262a174e26b">bswap_64</a></div><div class="ttdeci">#define bswap_64(x)</div><div class="ttdef"><b>Definition</b> <a href="endian_8h_source.html#l00081">endian.h:81</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3ae550bdf57660fcbf3500155c29d4637e"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3ae550bdf57660fcbf3500155c29d4637e">TracksBlock</a></div><div class="ttdeci">@ TracksBlock</div><div class="ttdoc">Block containing optical disc tracks.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00150">enums.h:150</a></div></div>
<div class="ttc" id="aerrors_8h_html_a1d6e49f7e8a1fa489efa0a582e90b5de"><div class="ttname"><a href="errors_8h.html#a1d6e49f7e8a1fa489efa0a582e90b5de">AARUF_STATUS_OK</a></div><div class="ttdeci">#define AARUF_STATUS_OK</div><div class="ttdoc">Sector present and read without uncorrectable errors.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00075">errors.h:75</a></div></div>