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

Updated doxygen documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2025-12-13 12:00:17 +00:00
parent ced56fad6c
commit 5a23b357d7
67 changed files with 1114 additions and 1081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/html/decls_8h_source.html
View File

@@ -453,7 +453,7 @@ $(function(){initNavTree('decls_8h_source.html','',''); });
<div class="ttc" id="adecls_8h_html_a892f09f0b28f1183064eef6eb4d46f42"><div class="ttname"><a href="decls_8h.html#a892f09f0b28f1183064eef6eb4d46f42">aaruf_ecc_cd_write</a></div><div class="ttdeci">void aaruf_ecc_cd_write(void *context, const uint8_t *address, const uint8_t *data, uint32_t major_count, uint32_t minor_count, uint32_t major_mult, uint32_t minor_inc, uint8_t *ecc, int32_t address_offset, int32_t data_offset, int32_t ecc_offset)</div><div class="ttdoc">Writes ECC for a CD sector.</div><div class="ttdef"><b>Definition</b> <a href="ecc__cd_8c_source.html#l00293">ecc_cd.c:293</a></div></div>
<div class="ttc" id="adecls_8h_html_a8a7eac34f7a0caaa0d4a57e9627ba173"><div class="ttname"><a href="decls_8h.html#a8a7eac34f7a0caaa0d4a57e9627ba173">AARU_LOCAL</a></div><div class="ttdeci">#define AARU_LOCAL</div><div class="ttdef"><b>Definition</b> <a href="#l00055">decls.h:55</a></div></div>
<div class="ttc" id="adecls_8h_html_a8cbf4d8059c4b36e8ab5e18fec057b52"><div class="ttname"><a href="decls_8h.html#a8cbf4d8059c4b36e8ab5e18fec057b52">aaruf_verify_image</a></div><div class="ttdeci">int32_t aaruf_verify_image(void *context)</div><div class="ttdoc">Verifies the integrity of an AaruFormat image file.</div><div class="ttdef"><b>Definition</b> <a href="verify_8c_source.html#l00130">verify.c:130</a></div></div>
<div class="ttc" id="adecls_8h_html_a8d042b26980b56b5dd872f21fa33de70"><div class="ttname"><a href="decls_8h.html#a8d042b26980b56b5dd872f21fa33de70">aaruf_get_datatype_for_media_tag_type</a></div><div class="ttdeci">int32_t aaruf_get_datatype_for_media_tag_type(int32_t tag_type)</div><div class="ttdoc">Converts an Aaru media tag type to an image data type.</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00197">helpers.c:197</a></div></div>
<div class="ttc" id="adecls_8h_html_a8d042b26980b56b5dd872f21fa33de70"><div class="ttname"><a href="decls_8h.html#a8d042b26980b56b5dd872f21fa33de70">aaruf_get_datatype_for_media_tag_type</a></div><div class="ttdeci">int32_t aaruf_get_datatype_for_media_tag_type(int32_t tag_type)</div><div class="ttdoc">Converts an Aaru media tag type to an image data type.</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00199">helpers.c:199</a></div></div>
<div class="ttc" id="adecls_8h_html_a8e00d26a8e751fbd412868ac4f92a3c0"><div class="ttname"><a href="decls_8h.html#a8e00d26a8e751fbd412868ac4f92a3c0">aaruf_get_negative_sectors</a></div><div class="ttdeci">int32_t aaruf_get_negative_sectors(const void *context, uint16_t *sectors)</div><div class="ttdoc">Retrieves the number of negative (pre-gap) sectors in the AaruFormat image.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l03423">metadata.c:3423</a></div></div>
<div class="ttc" id="adecls_8h_html_a8eed9fbf0341f48bac755524f4c99ef2"><div class="ttname"><a href="decls_8h.html#a8eed9fbf0341f48bac755524f4c99ef2">aaruf_set_media_model</a></div><div class="ttdeci">int32_t aaruf_set_media_model(void *context, const uint8_t *data, int32_t length)</div><div class="ttdoc">Sets the media model or product designation for the image.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l00943">metadata.c:943</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="#l00054">decls.h:54</a></div></div>
@@ -478,7 +478,7 @@ $(function(){initNavTree('decls_8h_source.html','',''); });
<div class="ttc" id="adecls_8h_html_abead53c8e55f1f99900fdae16d9da70f"><div class="ttname"><a href="decls_8h.html#abead53c8e55f1f99900fdae16d9da70f">aaruf_sha1_update</a></div><div class="ttdeci">void aaruf_sha1_update(sha1_ctx *ctx, const void *data, unsigned long size)</div><div class="ttdef"><b>Definition</b> <a href="sha1_8c_source.html#l00089">sha1.c:89</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_ac20c45113b5e1917fc550d1fb8342ba2"><div class="ttname"><a href="decls_8h.html#ac20c45113b5e1917fc550d1fb8342ba2">aaruf_clear_creator</a></div><div class="ttdeci">int32_t aaruf_clear_creator(void *context)</div><div class="ttdoc">Clears the creator (person/operator) information from the image metadata.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l03877">metadata.c:3877</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="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#l00351">helpers.c:351</a></div></div>
<div class="ttc" id="adecls_8h_html_ad4f8c223fb7c48a03ac4120d12e657b3"><div class="ttname"><a href="decls_8h.html#ad4f8c223fb7c48a03ac4120d12e657b3">aaruf_get_all_tape_files</a></div><div class="ttdeci">int32_t aaruf_get_all_tape_files(const void *context, uint8_t *buffer, size_t *length)</div><div class="ttdoc">Retrieves all tape file entries from the image.</div><div class="ttdef"><b>Definition</b> <a href="tape_8c_source.html#l01318">tape.c:1318</a></div></div>
<div class="ttc" id="adecls_8h_html_ad98012dc12a51d9eadbd79a25aab8299"><div class="ttname"><a href="decls_8h.html#ad98012dc12a51d9eadbd79a25aab8299">aaruf_set_dumphw</a></div><div class="ttdeci">int32_t aaruf_set_dumphw(void *context, uint8_t *data, size_t length)</div><div class="ttdoc">Sets the dump hardware block for the image during creation.</div><div class="ttdef"><b>Definition</b> <a href="dump_8c_source.html#l00531">dump.c:531</a></div></div>
<div class="ttc" id="adecls_8h_html_add7cede9e5544ae12ae2b22eaf48e54c"><div class="ttname"><a href="decls_8h.html#add7cede9e5544ae12ae2b22eaf48e54c">aaruf_set_drive_firmware_revision</a></div><div class="ttdeci">int32_t aaruf_set_drive_firmware_revision(void *context, const uint8_t *data, int32_t length)</div><div class="ttdoc">Sets the drive firmware revision for the image.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l01797">metadata.c:1797</a></div></div>