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

@@ -182,7 +182,7 @@ Data Fields</h2></td></tr>
</ul>
<p><b><a class="el" href="group__MediaTypes.html#ga1499e9f8a76cb81b43b7a4b0dbe7e44a" title="Enumerates every recognized media / cartridge / optical / tape / card / disk format.">MediaType</a></b> (uint32_t):</p><ul>
<li>Numeric identifier from the <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enumeration representing the physical/logical media.</li>
<li>Value 0 (<a class="el" href="group__MediaTypes.html#gga1499e9f8a76cb81b43b7a4b0dbe7e44aa4e81c184ac3ad48a389cd4454c4a05bb">Unknown</a>) when automatic detection failed or media is unrecognized/exotic.</li>
<li>Value 0 (Unknown) when automatic detection failed or media is unrecognized/exotic.</li>
<li>Stable across versions; safe to persist and compare.</li>
<li>Usage: Cast to <code><a class="el" href="group__MediaTypes.html#ga1499e9f8a76cb81b43b7a4b0dbe7e44a" title="Enumerates every recognized media / cartridge / optical / tape / card / disk format.">MediaType</a></code> enum for switch/case logic; always include default/Unknown handling.</li>
</ul>
@@ -367,7 +367,7 @@ Data Fields</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00881">881</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00815">aaruf_read_sector_long()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00532">aaruf_write_sector_long()</a>, and <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00532">aaruf_write_sector_long()</a>, and <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>.</p>
</div>
</div>
@@ -387,7 +387,7 @@ Data Fields</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00882">882</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00815">aaruf_read_sector_long()</a>, <a class="el" href="read_8c_source.html#l01463">aaruf_read_sector_tag()</a>, <a class="el" href="read_8c_source.html#l00663">aaruf_read_track_sector()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00532">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02048">aaruf_write_sector_tag()</a>, and <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>, <a class="el" href="read_8c_source.html#l01474">aaruf_read_sector_tag()</a>, <a class="el" href="read_8c_source.html#l00670">aaruf_read_track_sector()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00532">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02059">aaruf_write_sector_tag()</a>, and <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>.</p>
</div>
</div>
@@ -407,7 +407,7 @@ Data Fields</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00874">874</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00250">aaruf_read_sector()</a>, <a class="el" href="read_8c_source.html#l00815">aaruf_read_sector_long()</a>, <a class="el" href="read_8c_source.html#l01463">aaruf_read_sector_tag()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00532">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02048">aaruf_write_sector_tag()</a>, <a class="el" href="ddt__v1_8c_source.html#l00085">process_ddt_v1()</a>, <a class="el" href="ddt__v2_8c_source.html#l00096">process_ddt_v2()</a>, <a class="el" href="close_8c_source.html#l01808">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02245">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l00850">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l01206">write_sector_prefix_ddt()</a>, <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01350">write_sector_suffix_ddt()</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>, <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>, <a class="el" href="read_8c_source.html#l01474">aaruf_read_sector_tag()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00532">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02059">aaruf_write_sector_tag()</a>, <a class="el" href="ddt__v1_8c_source.html#l00085">process_ddt_v1()</a>, <a class="el" href="ddt__v2_8c_source.html#l00096">process_ddt_v2()</a>, <a class="el" href="close_8c_source.html#l01808">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02245">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l00850">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l01206">write_sector_prefix_ddt()</a>, <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01350">write_sector_suffix_ddt()</a>.</p>
</div>
</div>
@@ -427,7 +427,7 @@ Data Fields</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00875">875</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00250">aaruf_read_sector()</a>, and <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>, and <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>.</p>
</div>
</div>