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-10-11 12:43:39 +01:00
parent dde81f6773
commit 1f33de2ccf
96 changed files with 5966 additions and 5877 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/html/close_8c_source.html
View File

@@ -2536,7 +2536,7 @@ $(function(){initNavTree('close_8c_source.html','',''); });
</div>
<div class="line"><a id="l03958" name="l03958"></a><span class="lineno"> 3958</span></div>
<div class="foldopen" id="foldopen03995" data-start="{" data-end="}">
<div class="line"><a id="l03995" name="l03995"></a><span class="lineno"><a class="line" href="decls_8h.html#a6823e139f81a9dfd08efcb0e9b213a49"> 3995</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="close_8c.html#a6823e139f81a9dfd08efcb0e9b213a49">aaruf_close</a>(<span class="keywordtype">void</span> *context)</div>
<div class="line"><a id="l03995" name="l03995"></a><span class="lineno"><a class="line" href="decls_8h.html#a6823e139f81a9dfd08efcb0e9b213a49"> 3995</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> <span class="keywordtype">int</span> <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="close_8c.html#a6823e139f81a9dfd08efcb0e9b213a49">aaruf_close</a>(<span class="keywordtype">void</span> *context)</div>
<div class="line"><a id="l03996" name="l03996"></a><span class="lineno"> 3996</span>{</div>
<div class="line"><a id="l03997" name="l03997"></a><span class="lineno"> 3997</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_close(%p)&quot;</span>, context);</div>
<div class="line"><a id="l03998" name="l03998"></a><span class="lineno"> 3998</span> </div>
@@ -2813,6 +2813,7 @@ $(function(){initNavTree('close_8c_source.html','',''); });
<div class="ttc" id="aconsts_8h_html_a3c3ba66fe2b547655c9e4b16a1ba519a"><div class="ttname"><a href="consts_8h.html#a3c3ba66fe2b547655c9e4b16a1ba519a">AARU_MAGIC</a></div><div class="ttdeci">#define AARU_MAGIC</div><div class="ttdoc">Magic identifier for AaruFormat container (ASCII &quot;AARUFRMT&quot;).</div><div class="ttdef"><b>Definition</b> <a href="consts_8h_source.html#l00064">consts.h:64</a></div></div>
<div class="ttc" id="acontext_8h_html_a09a4f4b2f28cbe522d9b80153666029c"><div class="ttname"><a href="context_8h.html#a09a4f4b2f28cbe522d9b80153666029c">MD5_DIGEST_LENGTH</a></div><div class="ttdeci">#define MD5_DIGEST_LENGTH</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00069">context.h:69</a></div></div>
<div class="ttc" id="acontext_8h_html_a5ba965cb003bc2d68a9f9e1c11225494"><div class="ttname"><a href="context_8h.html#a5ba965cb003bc2d68a9f9e1c11225494">tapeFileHashEntry</a></div><div class="ttdeci">struct TapeFileHashEntry tapeFileHashEntry</div></div>
<div class="ttc" id="adecls_8h_html_a018e0da1c1f7e4f6187a982c0e40e056"><div class="ttname"><a href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a></div><div class="ttdeci">#define AARU_CALL</div><div class="ttdef"><b>Definition</b> <a href="decls_8h_source.html#l00045">decls.h:45</a></div></div>
<div class="ttc" id="adecls_8h_html_a0396232d1020b16b2cb4bf0b1aa2b021"><div class="ttname"><a href="decls_8h.html#a0396232d1020b16b2cb4bf0b1aa2b021">aaruf_sha1_final</a></div><div class="ttdeci">void aaruf_sha1_final(sha1_ctx *ctx, unsigned char *result)</div><div class="ttdef"><b>Definition</b> <a href="sha1_8c_source.html#l00124">sha1.c:124</a></div></div>
<div class="ttc" id="adecls_8h_html_a0b29337ce6fedc79bf7d1a84d92173d6"><div class="ttname"><a href="decls_8h.html#a0b29337ce6fedc79bf7d1a84d92173d6">aaruf_cst_transform</a></div><div class="ttdeci">int32_t aaruf_cst_transform(const uint8_t *interleaved, uint8_t *sequential, size_t length)</div><div class="ttdoc">Transforms interleaved subchannel data to sequential format.</div><div class="ttdef"><b>Definition</b> <a href="cst_8c_source.html#l00035">cst.c:35</a></div></div>
<div class="ttc" id="adecls_8h_html_a0e69fad529047d6fe9440b1fc66c3f85"><div class="ttname"><a href="decls_8h.html#a0e69fad529047d6fe9440b1fc66c3f85">aaruf_lzma_encode_buffer</a></div><div class="ttdeci">int32_t aaruf_lzma_encode_buffer(uint8_t *dst_buffer, size_t *dst_size, const uint8_t *src_buffer, size_t src_size, uint8_t *out_props, size_t *out_props_size, int32_t level, uint32_t dict_size, int32_t lc, int32_t lp, int32_t pb, int32_t fb, int32_t num_threads)</div><div class="ttdoc">Encodes a buffer using LZMA compression.</div><div class="ttdef"><b>Definition</b> <a href="lzma_8c_source.html#l00065">lzma.c:65</a></div></div>
@@ -2820,9 +2821,10 @@ $(function(){initNavTree('close_8c_source.html','',''); });
<div class="ttc" id="adecls_8h_html_a1fb4423a841ccd728e3ad0d028cbc9b4"><div class="ttname"><a href="decls_8h.html#a1fb4423a841ccd728e3ad0d028cbc9b4">aaruf_crc64_update</a></div><div class="ttdeci">int aaruf_crc64_update(crc64_ctx *ctx, const uint8_t *data, uint32_t len)</div><div class="ttdoc">Updates the CRC64 context with new data.</div><div class="ttdef"><b>Definition</b> <a href="crc64_8c_source.html#l00055">crc64.c:55</a></div></div>
<div class="ttc" id="adecls_8h_html_a6456150dad701ca7f071940ef169c4cf"><div class="ttname"><a href="decls_8h.html#a6456150dad701ca7f071940ef169c4cf">aaruf_sha256_final</a></div><div class="ttdeci">void aaruf_sha256_final(sha256_ctx *ctx, unsigned char *result)</div><div class="ttdef"><b>Definition</b> <a href="sha256_8c_source.html#l00115">sha256.c:115</a></div></div>
<div class="ttc" id="adecls_8h_html_a66567ca64e31a687d4982cb254b45196"><div class="ttname"><a href="decls_8h.html#a66567ca64e31a687d4982cb254b45196">aaruf_crc64_init</a></div><div class="ttdeci">crc64_ctx * aaruf_crc64_init()</div><div class="ttdoc">Initializes a CRC64 context.</div><div class="ttdef"><b>Definition</b> <a href="crc64_8c_source.html#l00032">crc64.c:32</a></div></div>
<div class="ttc" id="adecls_8h_html_a6b98055d07ba51f0daef5b03ce2fe725"><div class="ttname"><a href="decls_8h.html#a6b98055d07ba51f0daef5b03ce2fe725">aaruf_md5_final</a></div><div class="ttdeci">void aaruf_md5_final(md5_ctx *ctx, unsigned char *result)</div><div class="ttdef"><b>Definition</b> <a href="md5_8c_source.html#l00475">md5.c:475</a></div></div>
<div class="ttc" id="adecls_8h_html_a6b98055d07ba51f0daef5b03ce2fe725"><div class="ttname"><a href="decls_8h.html#a6b98055d07ba51f0daef5b03ce2fe725">aaruf_md5_final</a></div><div class="ttdeci">void aaruf_md5_final(md5_ctx *ctx, unsigned char *result)</div><div class="ttdef"><b>Definition</b> <a href="md5_8c_source.html#l00485">md5.c:485</a></div></div>
<div class="ttc" id="adecls_8h_html_a6fe74704e44be7adfaa2ce676f3c3de4"><div class="ttname"><a href="decls_8h.html#a6fe74704e44be7adfaa2ce676f3c3de4">aaruf_spamsum_free</a></div><div class="ttdeci">void aaruf_spamsum_free(spamsum_ctx *ctx)</div><div class="ttdoc">Frees a spamsum (fuzzy hash) context.</div><div class="ttdef"><b>Definition</b> <a href="spamsum_8c_source.html#l00075">spamsum.c:75</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#l00189">helpers.c:189</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="decls_8h_source.html#l00054">decls.h:54</a></div></div>
<div class="ttc" id="adecls_8h_html_ab1f4894af1962e933767248c4fb0e2e8"><div class="ttname"><a href="decls_8h.html#ab1f4894af1962e933767248c4fb0e2e8">aaruf_spamsum_final</a></div><div class="ttdeci">int aaruf_spamsum_final(spamsum_ctx *ctx, uint8_t *result)</div><div class="ttdef"><b>Definition</b> <a href="spamsum_8c_source.html#l00191">spamsum.c:191</a></div></div>
<div class="ttc" id="adecls_8h_html_ae48cfb59c6585e9ffd4cd1a97044891f"><div class="ttname"><a href="decls_8h.html#ae48cfb59c6585e9ffd4cd1a97044891f">aaruf_crc64_final</a></div><div class="ttdeci">int aaruf_crc64_final(crc64_ctx *ctx, uint64_t *crc)</div><div class="ttdoc">Computes the final CRC64 value from the context.</div><div class="ttdef"><b>Definition</b> <a href="crc64_8c_source.html#l00141">crc64.c:141</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a318acaf230a8ad091ef405caf7e4f411"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a318acaf230a8ad091ef405caf7e4f411">IndexBlock3</a></div><div class="ttdeci">@ IndexBlock3</div><div class="ttdoc">Block containing the index v3.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00147">enums.h:147</a></div></div>
@@ -2873,7 +2875,7 @@ $(function(){initNavTree('close_8c_source.html','',''); });
<div class="ttc" id="agroup__MediaTypes_html_gga1499e9f8a76cb81b43b7a4b0dbe7e44aae809315e2cd79c3fd74d1604c38f3ae6"><div class="ttname"><a href="group__MediaTypes.html#gga1499e9f8a76cb81b43b7a4b0dbe7e44aae809315e2cd79c3fd74d1604c38f3ae6">AppleSonyDS</a></div><div class="ttdeci">@ AppleSonyDS</div><div class="ttdoc">3.5&quot;, DS, DD, 80 tracks, 8 to 12 spt, 512 bytes/sector, GCR</div><div class="ttdef"><b>Definition</b> <a href="aaru_8h_source.html#l00248">aaru.h:248</a></div></div>
<div class="ttc" id="ahash__map_8h_html_ab885e8c5bedaf6f3cca1877e378fd04f"><div class="ttname"><a href="hash__map_8h.html#ab885e8c5bedaf6f3cca1877e378fd04f">free_map</a></div><div class="ttdeci">void free_map(hash_map_t *map)</div><div class="ttdoc">Frees all memory associated with a hash map.</div><div class="ttdef"><b>Definition</b> <a href="hash__map_8c_source.html#l00073">hash_map.c:73</a></div></div>
<div class="ttc" id="ainternal_8h_html"><div class="ttname"><a href="internal_8h.html">internal.h</a></div></div>
<div class="ttc" id="ainternal_8h_html_a2402812f5e04ba16765208c0b70fa6c5"><div class="ttname"><a href="internal_8h.html#a2402812f5e04ba16765208c0b70fa6c5">aaruf_close_current_block</a></div><div class="ttdeci">int32_t aaruf_close_current_block(aaruformat_context *ctx)</div><div class="ttdoc">Finalizes and writes the current data block to the AaruFormat image file.</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l01383">write.c:1383</a></div></div>
<div class="ttc" id="ainternal_8h_html_a2402812f5e04ba16765208c0b70fa6c5"><div class="ttname"><a href="internal_8h.html#a2402812f5e04ba16765208c0b70fa6c5">aaruf_close_current_block</a></div><div class="ttdeci">int32_t aaruf_close_current_block(aaruformat_context *ctx)</div><div class="ttdoc">Finalizes and writes the current data block to the AaruFormat image file.</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l01393">write.c:1393</a></div></div>
<div class="ttc" id="alog_8h_html"><div class="ttname"><a href="log_8h.html">log.h</a></div></div>
<div class="ttc" id="alog_8h_html_a053d6037d543b84ce59308ce71d15cd1"><div class="ttname"><a href="log_8h.html#a053d6037d543b84ce59308ce71d15cd1">FATAL</a></div><div class="ttdeci">#define FATAL(fmt,...)</div><div class="ttdef"><b>Definition</b> <a href="log_8h_source.html#l00040">log.h:40</a></div></div>
<div class="ttc" id="alog_8h_html_a21cc0459b78d5f2d7bd737e5aae1278a"><div class="ttname"><a href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a></div><div class="ttdeci">#define TRACE(fmt,...)</div><div class="ttdef"><b>Definition</b> <a href="log_8h_source.html#l00025">log.h:25</a></div></div>