Updated doxygen documentation.

This commit is contained in:
2025-12-13 12:00:17 +00:00
parent ced56fad6c
commit 5a23b357d7
67 changed files with 1114 additions and 1081 deletions

View File

@@ -506,7 +506,7 @@ $(function(){initNavTree('dump_8c_source.html','',''); });
<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>
<div class="ttc" id="adump_8c_html_ad98012dc12a51d9eadbd79a25aab8299"><div class="ttname"><a href="dump_8c.html#ad98012dc12a51d9eadbd79a25aab8299">aaruf_set_dumphw</a></div><div class="ttdeci">int32_t aaruf_set_dumphw(void *context, uint8_t *data, size_t length)</div><div class="ttdoc">Sets the dump hardware block for the image during creation.</div><div class="ttdef"><b>Definition</b> <a href="#l00531">dump.c:531</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3ad33812deb344562478c4e0d208a114db"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3ad33812deb344562478c4e0d208a114db">DumpHardwareBlock</a></div><div class="ttdeci">@ DumpHardwareBlock</div><div class="ttdoc">Block containing an array of hardware used to create the image.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00156">enums.h:156</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3ad33812deb344562478c4e0d208a114db"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3ad33812deb344562478c4e0d208a114db">DumpHardwareBlock</a></div><div class="ttdeci">@ DumpHardwareBlock</div><div class="ttdoc">Block containing an array of hardware used to create the 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_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>
<div class="ttc" id="aerrors_8h_html_a1df49eaa19eaa14891b6aaab966a9bc6"><div class="ttname"><a href="errors_8h.html#a1df49eaa19eaa14891b6aaab966a9bc6">AARUF_READ_ONLY</a></div><div class="ttdeci">#define AARUF_READ_ONLY</div><div class="ttdoc">Operation requires write mode but context is read-only.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00061">errors.h:61</a></div></div>
<div class="ttc" id="aerrors_8h_html_a35a771e3648bf971a004d4b2be9b5ec4"><div class="ttname"><a href="errors_8h.html#a35a771e3648bf971a004d4b2be9b5ec4">AARUF_ERROR_NOT_ENOUGH_MEMORY</a></div><div class="ttdeci">#define AARUF_ERROR_NOT_ENOUGH_MEMORY</div><div class="ttdoc">Memory allocation failure (critical).</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00048">errors.h:48</a></div></div>
@@ -516,7 +516,7 @@ $(function(){initNavTree('dump_8c_source.html','',''); });
<div class="ttc" id="aerrors_8h_html_abb63e240b11d790da83bd34507b57851"><div class="ttname"><a href="errors_8h.html#abb63e240b11d790da83bd34507b57851">AARUF_ERROR_NOT_AARUFORMAT</a></div><div class="ttdeci">#define AARUF_ERROR_NOT_AARUFORMAT</div><div class="ttdoc">Input file/stream failed magic or structural validation.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00040">errors.h:40</a></div></div>
<div class="ttc" id="aerrors_8h_html_ae7eea5936a22100db46aac3e4312cdae"><div class="ttname"><a href="errors_8h.html#ae7eea5936a22100db46aac3e4312cdae">AARUF_ERROR_BUFFER_TOO_SMALL</a></div><div class="ttdeci">#define AARUF_ERROR_BUFFER_TOO_SMALL</div><div class="ttdoc">Caller-supplied buffer insufficient for data.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00049">errors.h:49</a></div></div>
<div class="ttc" id="ainternal_8h_html"><div class="ttname"><a href="internal_8h.html">internal.h</a></div></div>
<div class="ttc" id="ainternal_8h_html_ac93ebc6d918745be56b680e19bf7e8d5"><div class="ttname"><a href="internal_8h.html#ac93ebc6d918745be56b680e19bf7e8d5">compare_extents</a></div><div class="ttdeci">int compare_extents(const void *a, const void *b)</div><div class="ttdoc">Comparison function for sorting DumpExtent arrays by start sector.</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00459">helpers.c:459</a></div></div>
<div class="ttc" id="ainternal_8h_html_ac93ebc6d918745be56b680e19bf7e8d5"><div class="ttname"><a href="internal_8h.html#ac93ebc6d918745be56b680e19bf7e8d5">compare_extents</a></div><div class="ttdeci">int compare_extents(const void *a, const void *b)</div><div class="ttdoc">Comparison function for sorting DumpExtent arrays by start sector.</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00463">helpers.c:463</a></div></div>
<div class="ttc" id="alog_8h_html"><div class="ttname"><a href="log_8h.html">log.h</a></div></div>
<div class="ttc" id="alog_8h_html_a053d6037d543b84ce59308ce71d15cd1"><div class="ttname"><a href="log_8h.html#a053d6037d543b84ce59308ce71d15cd1">FATAL</a></div><div class="ttdeci">#define FATAL(fmt,...)</div><div class="ttdef"><b>Definition</b> <a href="log_8h_source.html#l00040">log.h:40</a></div></div>
<div class="ttc" id="alog_8h_html_a21cc0459b78d5f2d7bd737e5aae1278a"><div class="ttname"><a href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a></div><div class="ttdeci">#define TRACE(fmt,...)</div><div class="ttdef"><b>Definition</b> <a href="log_8h_source.html#l00025">log.h:25</a></div></div>