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

Add doxygen documentation

Browse Source
This commit is contained in:
Natalia Portillo
2025-10-11 01:35:43 +01:00
parent 61850a9520
commit 697b755b1e
646 changed files with 124953 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

139
docs/html/dir_6387aeb6e475a334d8dc12d69f21999e.html Normal file
View File

@@ -0,0 +1,139 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: include/aaruformat/structs Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libaaruformat<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('dir_6387aeb6e475a334d8dc12d69f21999e.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">structs Directory Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-files" class="groupheader"><a id="files" name="files"></a>
Files</h2></td></tr>
<tr class="memitem:checksum_2Eh" id="r_checksum_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="checksum_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="checksum_8h.html">checksum.h</a></td></tr>
<tr class="memdesc:checksum_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">On-disk layout definitions for the checksum block (BlockType::ChecksumBlock). <br /></td></tr>
<tr class="memitem:data_2Eh" id="r_data_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="data_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="data_8h.html">data.h</a></td></tr>
<tr class="memdesc:data_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">On-disk layout structures for data-bearing and geometry blocks. <br /></td></tr>
<tr class="memitem:ddt_2Eh" id="r_ddt_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="ddt_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ddt_8h.html">ddt.h</a></td></tr>
<tr class="memdesc:ddt_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">On-disk headers for Deduplication Data Tables (DDT) versions 1 and 2. <br /></td></tr>
<tr class="memitem:dump_2Eh" id="r_dump_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="dump_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="dump_8h.html">dump.h</a></td></tr>
<tr class="memdesc:dump_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packed on-disk structures describing hardware and software used during image acquisition. <br /></td></tr>
<tr class="memitem:header_2Eh" id="r_header_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="header_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="header_8h.html">header.h</a></td></tr>
<tr class="memdesc:header_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">On-disk container header structures (v1 and v2) for Aaru images. <br /></td></tr>
<tr class="memitem:index_2Eh" id="r_index_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="index_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="index_8h.html">index.h</a></td></tr>
<tr class="memdesc:index_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">On‑disk index block header and entry structures (versions 1, 2 and 3). <br /></td></tr>
<tr class="memitem:lisa_5Ftag_2Eh" id="r_lisa_5Ftag_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="lisa__tag_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lisa__tag_8h.html">lisa_tag.h</a></td></tr>
<tr class="memdesc:lisa__tag_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure definitions and conversion/serialization function declarations for Lisa family disk tags. <br /></td></tr>
<tr class="memitem:metadata_2Eh" id="r_metadata_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="metadata_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="metadata_8h.html">metadata.h</a></td></tr>
<tr class="memdesc:metadata_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packed on-disk metadata block headers for descriptive strings and CICM XML (if present). <br /></td></tr>
<tr class="memitem:optical_2Eh" id="r_optical_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="optical_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="optical_8h.html">optical.h</a></td></tr>
<tr class="memdesc:optical_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">On-disk structures describing optical disc tracks (Track list block). <br /></td></tr>
<tr class="memitem:options_2Eh" id="r_options_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="options_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="options_8h.html">options.h</a></td></tr>
<tr class="memdesc:options_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">&lt; For bool type used in <a class="el" href="structaaru__options.html" title="Parsed user-specified tunables controlling compression, deduplication, hashing and DDT geometry.">aaru_options</a>. <br /></td></tr>
<tr class="memitem:tape_2Eh" id="r_tape_2Eh"><td class="memItemLeft" align="right" valign="top"><a href="tape_8h_source.html"><span class="icondoc"><div class="doc-icon"></div></span></a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="tape_8h.html">tape.h</a></td></tr>
<tr class="memdesc:tape_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structures for tape media support in Aaru disk images. <br /></td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="dir_6387aeb6e475a334d8dc12d69f21999e.html">structs</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>