Add doxygen documentation

This commit is contained in:
2025-10-11 01:35:43 +01:00
parent 61850a9520
commit 697b755b1e
646 changed files with 124953 additions and 0 deletions

119
docs/html/functions_i.html Normal file
View File

@@ -0,0 +1,119 @@
<!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: Data Fields</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('functions_i.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="contents">
<div class="textblock">Here is a list of all struct and union fields with links to the structures/unions they belong to:</div>
<h3 class="doxsection"><a id="index_i" name="index_i"></a>- i -</h3><ul>
<li>identifier&#160;:&#160;<a class="el" href="structAaruHeader.html#ac127379f3983bae7bb74e0449b0ea8bd">AaruHeader</a>, <a class="el" href="structAaruHeaderV2.html#a27af1bfabbc7650471a6010475116697">AaruHeaderV2</a>, <a class="el" href="structAaruMetadataJsonBlockHeader.html#a5e3db5d08dc09206cad6ea1b88b2db7d">AaruMetadataJsonBlockHeader</a>, <a class="el" href="structBlockHeader.html#a3b03f118fb2dc3dcef3f87a82238e358">BlockHeader</a>, <a class="el" href="structChecksumHeader.html#a2cb8589c2733e9a1cc0c8387da8ae3e3">ChecksumHeader</a>, <a class="el" href="structCicmMetadataBlock.html#aee270357b6dc394ed9ac5f22c9903c90">CicmMetadataBlock</a>, <a class="el" href="structDdtHeader2.html#a80a88ec68cd0332a57886ac363bfa4d1">DdtHeader2</a>, <a class="el" href="structDdtHeader.html#a640bdd80a0bab66d82d36e9d25ed86a4">DdtHeader</a>, <a class="el" href="structDumpHardwareHeader.html#aa5764ab144eef9a32c08f4475254442d">DumpHardwareHeader</a>, <a class="el" href="structGeometryBlockHeader.html#a233b19be8361b1c3c1963d8521924138">GeometryBlockHeader</a>, <a class="el" href="structIndexHeader2.html#a6b95ee733661cf13e56a46ecd1e048b0">IndexHeader2</a>, <a class="el" href="structIndexHeader3.html#a482f94fd93019dd2879d984bc8eecf67">IndexHeader3</a>, <a class="el" href="structIndexHeader.html#ae177ec4a99f07ed0e3caadf38a27268e">IndexHeader</a>, <a class="el" href="structMetadataBlockHeader.html#a16f0be711a2a0ddb48a0f092716e93dc">MetadataBlockHeader</a>, <a class="el" href="structTapeFileHeader.html#a36fe923f8d67004e0b0ae8eaf6535e1d">TapeFileHeader</a>, <a class="el" href="structTapePartitionHeader.html#ace597fc284e2191b65e69eb0be9f99f6">TapePartitionHeader</a>, <a class="el" href="structTracksHeader.html#a8f78b3d1336efc46e97bbd84deab8e80">TracksHeader</a></li>
<li>image_info&#160;:&#160;<a class="el" href="structaaruformat__context.html#ac970291b3449c04221827b9c2c18ac70">aaruformat_context</a></li>
<li>imageMajorVersion&#160;:&#160;<a class="el" href="structAaruHeader.html#a95bd4c3c038bf354c04216e0a025aff3">AaruHeader</a>, <a class="el" href="structAaruHeaderV2.html#af79ca31bcd428d1a54ac25c30d09b7a7">AaruHeaderV2</a></li>
<li>imageMinorVersion&#160;:&#160;<a class="el" href="structAaruHeader.html#a9eb2bde1126e58254c82d4205a9f0ad5">AaruHeader</a>, <a class="el" href="structAaruHeaderV2.html#ae2d6d3c7bc0a1956fb246cf7acbddeeb">AaruHeaderV2</a></li>
<li>ImageSize&#160;:&#160;<a class="el" href="structImageInfo.html#abca8e73a9655d810e6d30d36c3ab54d7">ImageInfo</a></li>
<li>imageStream&#160;:&#160;<a class="el" href="structaaruformat__context.html#ab516fae594bde4f76b75488d0a3ca3a8">aaruformat_context</a></li>
<li>in_memory_ddt&#160;:&#160;<a class="el" href="structaaruformat__context.html#a62885cab6ef674fd27b4de32ab4ee346">aaruformat_context</a></li>
<li>index_entries&#160;:&#160;<a class="el" href="structaaruformat__context.html#ab97a719a5b4186695b67143db7376152">aaruformat_context</a></li>
<li>indexOffset&#160;:&#160;<a class="el" href="structAaruHeader.html#aacb36b5521218ce37b786a3db520b96e">AaruHeader</a>, <a class="el" href="structAaruHeaderV2.html#a4ec4b1d593f5a0af19f6d7b8eaeada40">AaruHeaderV2</a></li>
<li>inited_edc&#160;:&#160;<a class="el" href="structCdEccContext.html#acd41974dc45317b3bc51e04300b16d2c">CdEccContext</a></li>
<li>is_tape&#160;:&#160;<a class="el" href="structaaruformat__context.html#a4d514102386b48bd51ac82c27bf9920a">aaruformat_context</a></li>
<li>is_writing&#160;:&#160;<a class="el" href="structaaruformat__context.html#a6f61f9ea20f4e3b791a0d6388dd43651">aaruformat_context</a></li>
<li>isrc&#160;:&#160;<a class="el" href="structTrackEntry.html#acb023e4728c59964c83fe85474c512c8">TrackEntry</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>