aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update doxygen documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2025-12-12 12:25:02 +00:00
parent 03c091fdee
commit 2daf7a6a48
172 changed files with 12502 additions and 10684 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/html/structImageInfo.html
View File

@@ -209,7 +209,7 @@ Data Fields</h2></td></tr>
</ul>
</dd></dl>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00869">869</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00921">921</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="aaea8b3a14fc03f9a4b045318160b7f54" name="aaea8b3a14fc03f9a4b045318160b7f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaea8b3a14fc03f9a4b045318160b7f54">&#9670;&#160;</a></span>Application</h2>
@@ -225,7 +225,7 @@ Data Fields</h2></td></tr>
<p>Name of application that created the image (NUL-terminated) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00877">877</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00929">929</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>, and <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>.</p>
@@ -245,7 +245,7 @@ Data Fields</h2></td></tr>
<p>Version of the creating application (NUL-terminated) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00878">878</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00930">930</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>, and <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>.</p>
@@ -265,7 +265,7 @@ Data Fields</h2></td></tr>
<p>Image creation timestamp (Windows FILETIME: 100ns since 1601-01-01 UTC) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00879">879</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00931">931</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>, and <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>.</p>
@@ -285,7 +285,7 @@ Data Fields</h2></td></tr>
<p>Image contains partitions (or tracks for optical media); 0=no, non-zero=yes. </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00871">871</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00923">923</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="optical_8c_source.html#l00392">aaruf_set_tracks()</a>, and <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>.</p>
@@ -305,7 +305,7 @@ Data Fields</h2></td></tr>
<p>Image contains multiple sessions (optical media); 0=single/none, non-zero=multi. </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00872">872</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00924">924</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="optical_8c_source.html#l00392">aaruf_set_tracks()</a>, and <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>.</p>
@@ -325,9 +325,9 @@ Data Fields</h2></td></tr>
<p>Size of the image payload in bytes (excludes headers/metadata) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00873">873</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00925">925</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#l00223">aaruf_open()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00470">process_aaru_metadata_json_block()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00306">process_cicm_block()</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="blocks_2metadata_8c_source.html#l00246">process_geometry_block()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00035">process_metadata_block()</a>, <a class="el" href="tape_8c_source.html#l00126">process_tape_files_block()</a>, <a class="el" href="tape_8c_source.html#l00346">process_tape_partitions_block()</a>, and <a class="el" href="optical_8c_source.html#l00111">process_tracks_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#l00223">aaruf_open()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00475">process_aaru_metadata_json_block()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00311">process_cicm_block()</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="blocks_2metadata_8c_source.html#l00251">process_geometry_block()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00035">process_metadata_block()</a>, <a class="el" href="tape_8c_source.html#l00126">process_tape_files_block()</a>, <a class="el" href="tape_8c_source.html#l00347">process_tape_partitions_block()</a>, and <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>.</p>
</div>
</div>
@@ -345,7 +345,7 @@ Data Fields</h2></td></tr>
<p>Last modification timestamp (Windows FILETIME format) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00880">880</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00932">932</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>, and <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>.</p>
@@ -365,9 +365,9 @@ Data Fields</h2></td></tr>
<p>Media type identifier (see <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enum; 0=Unknown) </p>
<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="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00933">933</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#l00223">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#l00537">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#l00223">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#l00544">aaruf_write_sector_long()</a>, and <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>.</p>
</div>
</div>
@@ -385,9 +385,9 @@ Data Fields</h2></td></tr>
<p>Media type for sidecar generation (internal archival use) </p>
<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="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00934">934</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#l00223">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#l00537">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02069">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#l00223">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#l00544">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02095">aaruf_write_sector_tag()</a>, and <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>.</p>
</div>
</div>
@@ -405,9 +405,9 @@ Data Fields</h2></td></tr>
<p>Total count of addressable logical sectors/blocks. </p>
<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="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00926">926</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#l00223">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#l00537">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02069">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#l01810">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02247">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#l00223">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#l00544">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02095">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#l01851">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02296">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l00879">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l01241">write_sector_prefix_ddt()</a>, <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01387">write_sector_suffix_ddt()</a>.</p>
</div>
</div>
@@ -425,7 +425,7 @@ Data Fields</h2></td></tr>
<p>Size of each logical sector in bytes (512, 2048, 2352, 4096, etc.) </p>
<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="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00927">927</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#l00223">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>
@@ -445,7 +445,7 @@ Data Fields</h2></td></tr>
<p>Image format version string (NUL-terminated, e.g., "6.0") </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00876">876</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00928">928</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>, and <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>.</p>