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

@@ -140,7 +140,7 @@ $(function(){initNavTree('dump_8c_source.html','',''); });
</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span></div>
<div class="foldopen" id="foldopen00186" data-start="{" data-end="}">
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="decls_8h.html#a36af83897e131ba792c51ae8caec9984"> 186</a></span>int32_t <a class="code hl_function" href="dump_8c.html#a36af83897e131ba792c51ae8caec9984">aaruf_get_dumphw</a>(<span class="keywordtype">void</span> *context, uint8_t *buffer, <span class="keywordtype">size_t</span> *length)</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="decls_8h.html#a36af83897e131ba792c51ae8caec9984"> 186</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="dump_8c.html#a36af83897e131ba792c51ae8caec9984">aaruf_get_dumphw</a>(<span class="keywordtype">void</span> *context, uint8_t *buffer, <span class="keywordtype">size_t</span> *length)</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span>{</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="keywordtype">size_t</span> length_value = 0;</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> <span class="keywordflow">if</span>(length != NULL) length_value = *length;</div>
@@ -327,7 +327,7 @@ $(function(){initNavTree('dump_8c_source.html','',''); });
</div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno"> 370</span></div>
<div class="foldopen" id="foldopen00531" data-start="{" data-end="}">
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno"><a class="line" href="decls_8h.html#ad98012dc12a51d9eadbd79a25aab8299"> 531</a></span>int32_t <a class="code hl_function" href="dump_8c.html#ad98012dc12a51d9eadbd79a25aab8299">aaruf_set_dumphw</a>(<span class="keywordtype">void</span> *context, uint8_t *data, <span class="keywordtype">size_t</span> length)</div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno"><a class="line" href="decls_8h.html#ad98012dc12a51d9eadbd79a25aab8299"> 531</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="dump_8c.html#ad98012dc12a51d9eadbd79a25aab8299">aaruf_set_dumphw</a>(<span class="keywordtype">void</span> *context, uint8_t *data, <span class="keywordtype">size_t</span> length)</div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno"> 532</span>{</div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno"> 533</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_set_dumphw(%p, %p, %zu)&quot;</span>, context, data, length);</div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno"> 534</span> </div>
@@ -494,7 +494,9 @@ $(function(){initNavTree('dump_8c_source.html','',''); });
</div>
<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="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="adump_8c_html_a36af83897e131ba792c51ae8caec9984"><div class="ttname"><a href="dump_8c.html#a36af83897e131ba792c51ae8caec9984">aaruf_get_dumphw</a></div><div class="ttdeci">int32_t aaruf_get_dumphw(void *context, uint8_t *buffer, size_t *length)</div><div class="ttdoc">Retrieves the dump hardware block containing acquisition environment information.</div><div class="ttdef"><b>Definition</b> <a href="#l00186">dump.c:186</a></div></div>
<div class="ttc" id="adump_8c_html_a6b41f4a00a255e6704583614ef33571f"><div class="ttname"><a href="dump_8c.html#a6b41f4a00a255e6704583614ef33571f">COPY_STRING_FIELD</a></div><div class="ttdeci">#define COPY_STRING_FIELD(field)</div></div>
<div class="ttc" id="adump_8c_html_ab98a236ef7ac4de15fb37a2e3c3ce633"><div class="ttname"><a href="dump_8c.html#ab98a236ef7ac4de15fb37a2e3c3ce633">free_dump_hardware_entries</a></div><div class="ttdeci">static void free_dump_hardware_entries(DumpHardwareEntriesWithData *entries, uint32_t count)</div><div class="ttdef"><b>Definition</b> <a href="#l00026">dump.c:26</a></div></div>