Update documentation.

This commit is contained in:
2025-10-21 14:23:35 +01:00
parent f53092c941
commit 55b688c522
109 changed files with 6592 additions and 6502 deletions

View File

@@ -564,8 +564,8 @@ $(function(){initNavTree('create_8c_source.html','',''); });
<div class="ttc" id="astructaaruformat__context_html"><div class="ttname"><a href="structaaruformat__context.html">aaruformat_context</a></div><div class="ttdoc">Master context representing an open or increation Aaru image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00171">context.h:172</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a04c5fb367458a6e9dd0a50b39f6edec2"><div class="ttname"><a href="structaaruformat__context.html#a04c5fb367458a6e9dd0a50b39f6edec2">aaruformat_context::user_data_ddt_header</a></div><div class="ttdeci">DdtHeader2 user_data_ddt_header</div><div class="ttdoc">Active user data DDT v2 header (primary table meta).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00189">context.h:189</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a09177c9e68d054bab844305f2771b77a"><div class="ttname"><a href="structaaruformat__context.html#a09177c9e68d054bab844305f2771b77a">aaruformat_context::library_major_version</a></div><div class="ttdeci">uint8_t library_major_version</div><div class="ttdoc">Linked library major version.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00177">context.h:177</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a0d4e1977913ce67e85bced41c58e5dd2"><div class="ttname"><a href="structaaruformat__context.html#a0d4e1977913ce67e85bced41c58e5dd2">aaruformat_context::deduplicate</a></div><div class="ttdeci">bool deduplicate</div><div class="ttdoc">Storage deduplication active (duplicates coalesce).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00298">context.h:298</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a130daf19dbed426f1c4c6f82691bc054"><div class="ttname"><a href="structaaruformat__context.html#a130daf19dbed426f1c4c6f82691bc054">aaruformat_context::compression_enabled</a></div><div class="ttdeci">bool compression_enabled</div><div class="ttdoc">True if block compression enabled (writing path).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00299">context.h:299</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a0d4e1977913ce67e85bced41c58e5dd2"><div class="ttname"><a href="structaaruformat__context.html#a0d4e1977913ce67e85bced41c58e5dd2">aaruformat_context::deduplicate</a></div><div class="ttdeci">bool deduplicate</div><div class="ttdoc">Storage deduplication active (duplicates coalesce).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00299">context.h:299</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a130daf19dbed426f1c4c6f82691bc054"><div class="ttname"><a href="structaaruformat__context.html#a130daf19dbed426f1c4c6f82691bc054">aaruformat_context::compression_enabled</a></div><div class="ttdeci">bool compression_enabled</div><div class="ttdoc">True if block compression enabled (writing path).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00300">context.h:300</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a1387f95c2da152594f29c5c276e5dbc5"><div class="ttname"><a href="structaaruformat__context.html#a1387f95c2da152594f29c5c276e5dbc5">aaruformat_context::last_written_block</a></div><div class="ttdeci">uint64_t last_written_block</div><div class="ttdoc">Last written block number (write path).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00283">context.h:283</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a18bee1dd72fd1ca4957ff6ddfebce343"><div class="ttname"><a href="structaaruformat__context.html#a18bee1dd72fd1ca4957ff6ddfebce343">aaruformat_context::sector_hash_map</a></div><div class="ttdeci">hash_map_t * sector_hash_map</div><div class="ttdoc">Deduplication hash map (fingerprint-&gt;entry mapping).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00253">context.h:253</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a21dffad51cfb58f5f71f7babee2aaceb"><div class="ttname"><a href="structaaruformat__context.html#a21dffad51cfb58f5f71f7babee2aaceb">aaruformat_context::sha256_context</a></div><div class="ttdeci">sha256_ctx sha256_context</div><div class="ttdoc">Opaque SHA-256 context for streaming updates.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00272">context.h:272</a></div></div>
@@ -574,7 +574,7 @@ $(function(){initNavTree('create_8c_source.html','',''); });
<div class="ttc" id="astructaaruformat__context_html_a3c44b0cbcfb4586ce666dcd97a3dd85a"><div class="ttname"><a href="structaaruformat__context.html#a3c44b0cbcfb4586ce666dcd97a3dd85a">aaruformat_context::md5_context</a></div><div class="ttdeci">md5_ctx md5_context</div><div class="ttdoc">Opaque MD5 context for streaming updates.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00270">context.h:270</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a3c7b902731274622296d04564b193b64"><div class="ttname"><a href="structaaruformat__context.html#a3c7b902731274622296d04564b193b64">aaruformat_context::user_data_ddt2</a></div><div class="ttdeci">uint64_t * user_data_ddt2</div><div class="ttdoc">DDT entries (big variant) primary/secondary current.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00187">context.h:187</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a4023f622bac759754c68ac633c53e3f4"><div class="ttname"><a href="structaaruformat__context.html#a4023f622bac759754c68ac633c53e3f4">aaruformat_context::shift</a></div><div class="ttdeci">uint8_t shift</div><div class="ttdoc">Legacy overall shift (deprecated by data_shift/table_shift).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00195">context.h:195</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a4d514102386b48bd51ac82c27bf9920a"><div class="ttname"><a href="structaaruformat__context.html#a4d514102386b48bd51ac82c27bf9920a">aaruformat_context::is_tape</a></div><div class="ttdeci">bool is_tape</div><div class="ttdoc">True if the image is a tape image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00304">context.h:304</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a4d514102386b48bd51ac82c27bf9920a"><div class="ttname"><a href="structaaruformat__context.html#a4d514102386b48bd51ac82c27bf9920a">aaruformat_context::is_tape</a></div><div class="ttdeci">bool is_tape</div><div class="ttdoc">True if the image is a tape image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00305">context.h:305</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a4e4c12388d90a11cf14266d1215ce13e"><div class="ttname"><a href="structaaruformat__context.html#a4e4c12388d90a11cf14266d1215ce13e">aaruformat_context::calculating_sha1</a></div><div class="ttdeci">bool calculating_sha1</div><div class="ttdoc">True if whole-image SHA-1 being calculated on-the-fly.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00274">context.h:274</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a510b72290e2bd50e02ef8a2387aa829d"><div class="ttname"><a href="structaaruformat__context.html#a510b72290e2bd50e02ef8a2387aa829d">aaruformat_context::ecc_cd_context</a></div><div class="ttdeci">CdEccContext * ecc_cd_context</div><div class="ttdoc">CD ECC/EDC helper tables (allocated on demand).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00248">context.h:248</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_a551d4fb5a3213106d01d369e98bdf3c8"><div class="ttname"><a href="structaaruformat__context.html#a551d4fb5a3213106d01d369e98bdf3c8">aaruformat_context::rewinded</a></div><div class="ttdeci">bool rewinded</div><div class="ttdoc">True if stream has been rewound after open (write path).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00293">context.h:293</a></div></div>
@@ -597,7 +597,7 @@ $(function(){initNavTree('create_8c_source.html','',''); });
<div class="ttc" id="astructaaruformat__context_html_ac970291b3449c04221827b9c2c18ac70"><div class="ttname"><a href="structaaruformat__context.html#ac970291b3449c04221827b9c2c18ac70">aaruformat_context::image_info</a></div><div class="ttdeci">ImageInfo image_info</div><div class="ttdoc">Exposed high-level image info summary.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00260">context.h:260</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_ad1e28bac5a6c9bfdb8d18793686fc755"><div class="ttname"><a href="structaaruformat__context.html#ad1e28bac5a6c9bfdb8d18793686fc755">aaruformat_context::sha1_context</a></div><div class="ttdeci">sha1_ctx sha1_context</div><div class="ttdoc">Opaque SHA-1 context for streaming updates.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00271">context.h:271</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_ad3d5494e23b07418e9fbd22c3771e534"><div class="ttname"><a href="structaaruformat__context.html#ad3d5494e23b07418e9fbd22c3771e534">aaruformat_context::readableSectorTags</a></div><div class="ttdeci">bool * readableSectorTags</div><div class="ttdoc">Per-sector boolean array (optical tags read successfully?).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00263">context.h:263</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_adc67f6a6ef1602648bb064d47eb1fe88"><div class="ttname"><a href="structaaruformat__context.html#adc67f6a6ef1602648bb064d47eb1fe88">aaruformat_context::lzma_dict_size</a></div><div class="ttdeci">uint32_t lzma_dict_size</div><div class="ttdoc">LZMA dictionary size (writing path).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00297">context.h:297</a></div></div>
<div class="ttc" id="astructaaruformat__context_html_adc67f6a6ef1602648bb064d47eb1fe88"><div class="ttname"><a href="structaaruformat__context.html#adc67f6a6ef1602648bb064d47eb1fe88">aaruformat_context::lzma_dict_size</a></div><div class="ttdeci">uint32_t lzma_dict_size</div><div class="ttdoc">LZMA dictionary size (writing path).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00298">context.h:298</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->