Updated documentation.

This commit is contained in:
2025-10-13 14:26:33 +01:00
parent 556537c79e
commit 4f2e0f05c1
51 changed files with 4177 additions and 1384 deletions

View File

@@ -523,7 +523,7 @@ $(function(){initNavTree('open_8c_source.html','',''); });
<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="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#l00347">helpers.c:347</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>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a3e451c2577a6c790f33f99c2da189d46"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a3e451c2577a6c790f33f99c2da189d46">ChecksumBlock</a></div><div class="ttdeci">@ ChecksumBlock</div><div class="ttdoc">Block containing contents checksums.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00152">enums.h:152</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a5a0811c5ee97536aef900cecb8787713"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a5a0811c5ee97536aef900cecb8787713">DataBlock</a></div><div class="ttdeci">@ DataBlock</div><div class="ttdoc">Block containing data.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00141">enums.h:141</a></div></div>
@@ -570,7 +570,7 @@ $(function(){initNavTree('open_8c_source.html','',''); });
<div class="ttc" id="aopen_8c_html_a356a7467b41a2929a27a6639cd3a2b50"><div class="ttname"><a href="open_8c.html#a356a7467b41a2929a27a6639cd3a2b50">cleanup_open_failure</a></div><div class="ttdeci">static void cleanup_open_failure(aaruformat_context *ctx)</div><div class="ttdef"><b>Definition</b> <a href="#l00031">open.c:31</a></div></div>
<div class="ttc" id="aopen_8c_html_afc4932cdc795ffb2ef3a33d5b8c57656"><div class="ttname"><a href="open_8c.html#afc4932cdc795ffb2ef3a33d5b8c57656">aaruf_open</a></div><div class="ttdeci">void * aaruf_open(const char *filepath)</div><div class="ttdoc">Opens an existing AaruFormat image file.</div><div class="ttdef"><b>Definition</b> <a href="#l00125">open.c:125</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html"><div class="ttname"><a href="structAaruHeaderV2.html">AaruHeaderV2</a></div><div class="ttdoc">Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps.</div><div class="ttdef"><b>Definition</b> <a href="header_8h_source.html#l00106">header.h:107</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a0afcf9a5f565a9053351f44234c90dc3"><div class="ttname"><a href="structAaruHeaderV2.html#a0afcf9a5f565a9053351f44234c90dc3">AaruHeaderV2::application</a></div><div class="ttdeci">uint8_t application[64]</div><div class="ttdoc">UTF-16LE creator application name (fixed 64 bytes).</div><div class="ttdef"><b>Definition</b> <a href="header_8h_source.html#l00109">header.h:109</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a0afcf9a5f565a9053351f44234c90dc3"><div class="ttname"><a href="structAaruHeaderV2.html#a0afcf9a5f565a9053351f44234c90dc3">AaruHeaderV2::application</a></div><div class="ttdeci">uint8_t application[64]</div><div class="ttdoc">UTF-8 creator application name (fixed 64 bytes).</div><div class="ttdef"><b>Definition</b> <a href="header_8h_source.html#l00109">header.h:109</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a1c26feafd945328f8f1854b523a0f03c"><div class="ttname"><a href="structAaruHeaderV2.html#a1c26feafd945328f8f1854b523a0f03c">AaruHeaderV2::applicationMajorVersion</a></div><div class="ttdeci">uint8_t applicationMajorVersion</div><div class="ttdoc">Creator application major version.</div><div class="ttdef"><b>Definition</b> <a href="header_8h_source.html#l00112">header.h:112</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a27af1bfabbc7650471a6010475116697"><div class="ttname"><a href="structAaruHeaderV2.html#a27af1bfabbc7650471a6010475116697">AaruHeaderV2::identifier</a></div><div class="ttdeci">uint64_t identifier</div><div class="ttdoc">File magic (AARU_MAGIC).</div><div class="ttdef"><b>Definition</b> <a href="header_8h_source.html#l00108">header.h:108</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a45bc7e2afc9008ce6f4ae1dba93bdac3"><div class="ttname"><a href="structAaruHeaderV2.html#a45bc7e2afc9008ce6f4ae1dba93bdac3">AaruHeaderV2::lastWrittenTime</a></div><div class="ttdeci">int64_t lastWrittenTime</div><div class="ttdoc">Last modification FILETIME (100 ns since 1601-01-01 UTC).</div><div class="ttdef"><b>Definition</b> <a href="header_8h_source.html#l00117">header.h:117</a></div></div>