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

@@ -166,7 +166,7 @@ Macros</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="consts_8h_source.html#l00064">64</a> of file <a class="el" href="consts_8h_source.html">consts.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="write_8c_source.html#l01383">aaruf_close_current_block()</a>, <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="metadata_8c_source.html#l02099">aaruf_get_aaru_json_metadata()</a>, <a class="el" href="metadata_8c_source.html#l01944">aaruf_get_cicm_metadata()</a>, <a class="el" href="metadata_8c_source.html#l02476">aaruf_get_comments()</a>, <a class="el" href="metadata_8c_source.html#l02404">aaruf_get_creator()</a>, <a class="el" href="metadata_8c_source.html#l03178">aaruf_get_drive_firmware_revision()</a>, <a class="el" href="metadata_8c_source.html#l02968">aaruf_get_drive_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l03038">aaruf_get_drive_model()</a>, <a class="el" href="metadata_8c_source.html#l03108">aaruf_get_drive_serial_number()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="metadata_8c_source.html#l00094">aaruf_get_geometry()</a>, <a class="el" href="metadata_8c_source.html#l03634">aaruf_get_image_info()</a>, <a class="el" href="metadata_8c_source.html#l02825">aaruf_get_media_barcode()</a>, <a class="el" href="metadata_8c_source.html#l02616">aaruf_get_media_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l02686">aaruf_get_media_model()</a>, <a class="el" href="metadata_8c_source.html#l02896">aaruf_get_media_part_number()</a>, <a class="el" href="metadata_8c_source.html#l02337">aaruf_get_media_sequence()</a>, <a class="el" href="metadata_8c_source.html#l02756">aaruf_get_media_serial_number()</a>, <a class="el" href="metadata_8c_source.html#l02546">aaruf_get_media_title()</a>, <a class="el" href="metadata_8c_source.html#l03417">aaruf_get_negative_sectors()</a>, <a class="el" href="metadata_8c_source.html#l03552">aaruf_get_overflow_sectors()</a>, <a class="el" href="tape_8c_source.html#l00569">aaruf_get_tape_file()</a>, <a class="el" href="tape_8c_source.html#l00982">aaruf_get_tape_partition()</a>, <a class="el" href="optical_8c_source.html#l00281">aaruf_get_tracks()</a>, <a class="el" href="metadata_8c_source.html#l03292">aaruf_get_user_sectors()</a>, <a class="el" href="identify_8c_source.html#l00163">aaruf_identify_stream()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00085">aaruf_read_media_tag()</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="read_8c_source.html#l00663">aaruf_read_track_sector()</a>, <a class="el" href="metadata_8c_source.html#l02258">aaruf_set_aaru_json_metadata()</a>, <a class="el" href="metadata_8c_source.html#l00607">aaruf_set_comments()</a>, <a class="el" href="metadata_8c_source.html#l00493">aaruf_set_creator()</a>, <a class="el" href="metadata_8c_source.html#l01793">aaruf_set_drive_firmware_revision()</a>, <a class="el" href="metadata_8c_source.html#l01412">aaruf_set_drive_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l01534">aaruf_set_drive_model()</a>, <a class="el" href="metadata_8c_source.html#l01658">aaruf_set_drive_serial_number()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="metadata_8c_source.html#l00229">aaruf_set_geometry()</a>, <a class="el" href="metadata_8c_source.html#l01176">aaruf_set_media_barcode()</a>, <a class="el" href="metadata_8c_source.html#l00832">aaruf_set_media_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l00939">aaruf_set_media_model()</a>, <a class="el" href="metadata_8c_source.html#l01297">aaruf_set_media_part_number()</a>, <a class="el" href="metadata_8c_source.html#l00363">aaruf_set_media_sequence()</a>, <a class="el" href="metadata_8c_source.html#l01054">aaruf_set_media_serial_number()</a>, <a class="el" href="metadata_8c_source.html#l00720">aaruf_set_media_title()</a>, <a class="el" href="tape_8c_source.html#l00770">aaruf_set_tape_file()</a>, <a class="el" href="tape_8c_source.html#l01196">aaruf_set_tape_partition()</a>, <a class="el" href="optical_8c_source.html#l00392">aaruf_set_tracks()</a>, <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="write_8c_source.html#l01780">aaruf_write_media_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>, and <a class="el" href="write_8c_source.html#l02048">aaruf_write_sector_tag()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03995">aaruf_close()</a>, <a class="el" href="write_8c_source.html#l01393">aaruf_close_current_block()</a>, <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="metadata_8c_source.html#l02102">aaruf_get_aaru_json_metadata()</a>, <a class="el" href="metadata_8c_source.html#l01947">aaruf_get_cicm_metadata()</a>, <a class="el" href="metadata_8c_source.html#l02479">aaruf_get_comments()</a>, <a class="el" href="metadata_8c_source.html#l02407">aaruf_get_creator()</a>, <a class="el" href="metadata_8c_source.html#l03181">aaruf_get_drive_firmware_revision()</a>, <a class="el" href="metadata_8c_source.html#l02971">aaruf_get_drive_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l03041">aaruf_get_drive_model()</a>, <a class="el" href="metadata_8c_source.html#l03111">aaruf_get_drive_serial_number()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="metadata_8c_source.html#l00094">aaruf_get_geometry()</a>, <a class="el" href="metadata_8c_source.html#l03637">aaruf_get_image_info()</a>, <a class="el" href="metadata_8c_source.html#l02828">aaruf_get_media_barcode()</a>, <a class="el" href="metadata_8c_source.html#l02619">aaruf_get_media_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l02689">aaruf_get_media_model()</a>, <a class="el" href="metadata_8c_source.html#l02899">aaruf_get_media_part_number()</a>, <a class="el" href="metadata_8c_source.html#l02340">aaruf_get_media_sequence()</a>, <a class="el" href="metadata_8c_source.html#l02759">aaruf_get_media_serial_number()</a>, <a class="el" href="metadata_8c_source.html#l02549">aaruf_get_media_title()</a>, <a class="el" href="metadata_8c_source.html#l03420">aaruf_get_negative_sectors()</a>, <a class="el" href="metadata_8c_source.html#l03555">aaruf_get_overflow_sectors()</a>, <a class="el" href="tape_8c_source.html#l00569">aaruf_get_tape_file()</a>, <a class="el" href="tape_8c_source.html#l00982">aaruf_get_tape_partition()</a>, <a class="el" href="optical_8c_source.html#l00281">aaruf_get_tracks()</a>, <a class="el" href="metadata_8c_source.html#l03295">aaruf_get_user_sectors()</a>, <a class="el" href="identify_8c_source.html#l00163">aaruf_identify_stream()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00085">aaruf_read_media_tag()</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="read_8c_source.html#l00670">aaruf_read_track_sector()</a>, <a class="el" href="metadata_8c_source.html#l02261">aaruf_set_aaru_json_metadata()</a>, <a class="el" href="metadata_8c_source.html#l00609">aaruf_set_comments()</a>, <a class="el" href="metadata_8c_source.html#l00495">aaruf_set_creator()</a>, <a class="el" href="metadata_8c_source.html#l01795">aaruf_set_drive_firmware_revision()</a>, <a class="el" href="metadata_8c_source.html#l01414">aaruf_set_drive_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l01536">aaruf_set_drive_model()</a>, <a class="el" href="metadata_8c_source.html#l01660">aaruf_set_drive_serial_number()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="metadata_8c_source.html#l00230">aaruf_set_geometry()</a>, <a class="el" href="metadata_8c_source.html#l01178">aaruf_set_media_barcode()</a>, <a class="el" href="metadata_8c_source.html#l00834">aaruf_set_media_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l00941">aaruf_set_media_model()</a>, <a class="el" href="metadata_8c_source.html#l01299">aaruf_set_media_part_number()</a>, <a class="el" href="metadata_8c_source.html#l00364">aaruf_set_media_sequence()</a>, <a class="el" href="metadata_8c_source.html#l01056">aaruf_set_media_serial_number()</a>, <a class="el" href="metadata_8c_source.html#l00722">aaruf_set_media_title()</a>, <a class="el" href="tape_8c_source.html#l00770">aaruf_set_tape_file()</a>, <a class="el" href="tape_8c_source.html#l01196">aaruf_set_tape_partition()</a>, <a class="el" href="optical_8c_source.html#l00392">aaruf_set_tracks()</a>, <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="write_8c_source.html#l01790">aaruf_write_media_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>, and <a class="el" href="write_8c_source.html#l02059">aaruf_write_sector_tag()</a>.</p>
</div>
</div>
@@ -249,7 +249,7 @@ Macros</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="consts_8h_source.html#l00102">102</a> of file <a class="el" href="consts_8h_source.html">consts.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l00815">aaruf_read_sector_long()</a>.</p>
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>.</p>
</div>
</div>
@@ -270,7 +270,7 @@ Macros</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="consts_8h_source.html#l00100">100</a> of file <a class="el" href="consts_8h_source.html">consts.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l00815">aaruf_read_sector_long()</a>.</p>
<p class="reference">Referenced by <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>.</p>
</div>
</div>
@@ -311,7 +311,7 @@ Macros</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="consts_8h_source.html#l00082">82</a> of file <a class="el" href="consts_8h_source.html">consts.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01383">aaruf_close_current_block()</a>, <a class="el" href="read_8c_source.html#l00250">aaruf_read_sector()</a>, <a class="el" href="ddt__v2_8c_source.html#l00724">decode_ddt_multi_level_v2()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</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="ddt__v2_8c_source.html#l01092">set_ddt_multi_level_v2()</a>, <a class="el" href="close_8c_source.html#l00077">write_cached_secondary_ddt()</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#l02409">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l00850">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00966">write_sector_prefix()</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>, <a class="el" href="close_8c_source.html#l01088">write_sector_suffix()</a>, <a class="el" href="close_8c_source.html#l01350">write_sector_suffix_ddt()</a>, and <a class="el" href="close_8c_source.html#l00369">write_single_level_ddt()</a>.</p>
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01393">aaruf_close_current_block()</a>, <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>, <a class="el" href="ddt__v2_8c_source.html#l00724">decode_ddt_multi_level_v2()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</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="ddt__v2_8c_source.html#l01092">set_ddt_multi_level_v2()</a>, <a class="el" href="close_8c_source.html#l00077">write_cached_secondary_ddt()</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#l02409">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l00850">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00966">write_sector_prefix()</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>, <a class="el" href="close_8c_source.html#l01088">write_sector_suffix()</a>, <a class="el" href="close_8c_source.html#l01350">write_sector_suffix_ddt()</a>, and <a class="el" href="close_8c_source.html#l00369">write_single_level_ddt()</a>.</p>
</div>
</div>
@@ -372,7 +372,7 @@ Macros</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="consts_8h_source.html#l00094">94</a> of file <a class="el" href="consts_8h_source.html">consts.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01383">aaruf_close_current_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01393">aaruf_close_current_block()</a>.</p>
</div>
</div>
@@ -393,7 +393,7 @@ Macros</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="consts_8h_source.html#l00096">96</a> of file <a class="el" href="consts_8h_source.html">consts.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01383">aaruf_close_current_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01393">aaruf_close_current_block()</a>.</p>
</div>
</div>
@@ -413,7 +413,7 @@ Macros</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="consts_8h_source.html#l00090">90</a> of file <a class="el" href="consts_8h_source.html">consts.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01383">aaruf_close_current_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01393">aaruf_close_current_block()</a>.</p>
</div>
</div>