aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-11-04 19:35:12 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2026-10-08 20:15:08 +01:00
parent d036b284ef
commit e358b1ca0e
514 changed files with 42794 additions and 29088 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
docs/html/structDumpHardwareEntriesWithData.html
View File

@@ -3,12 +3,12 @@
<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.16.1"/>
<meta name="generator" content="Doxygen 1.18.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: DumpHardwareEntriesWithData Struct 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="codefolding.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>
@@ -35,22 +35,47 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<!-- Generated by Doxygen 1.18.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="application/json" id="doxygen-config">
{
"relPath": "",
"generateTreeView": true,
"searchEngine": true,
"serverBasedSearch": false,
"disableIndex": false,
"dynamicMenus": true,
"fullSidebar": false
}
</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 id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
<ul class="sm sm-dox" id="main-menu">
<li id="searchBoxPos2">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div><!-- main-nav -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
@@ -58,20 +83,16 @@ $(function() {
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
<div id="splitbar" class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('structDumpHardwareEntriesWithData.html','',''); });
document.addEventListener('DOMContentLoaded',() => { initNavTree('structDumpHardwareEntriesWithData.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 id="MSearchSelectWindow">
</div>
<!-- iframe showing the search results (closed by default) -->
@@ -125,7 +146,7 @@ Data Fields</h2></td></tr>
<div class="textblock"><p>In-memory representation of a dump hardware entry plus decoded variable-length fields &amp; extents. </p>
<p>All string pointers are NUL-terminated UTF-8 copies of on-disk data (or NULL if absent). extents array may be NULL when no ranges were recorded. Freed during context teardown. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00411">411</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00432">432</a> of file <a class="el" href="context_8h_source.html">context.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="a9b5f7b438c99ede6988179b7b89915df" name="a9b5f7b438c99ede6988179b7b89915df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b5f7b438c99ede6988179b7b89915df">&#9670;&#160;</a></span>entry</h2>
@@ -141,9 +162,9 @@ Data Fields</h2></td></tr>
<p>Fixed-size header with lengths &amp; counts. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00413">413</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00434">434</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -161,9 +182,9 @@ Data Fields</h2></td></tr>
<p>Array of extents (entry.extents elements) or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00414">414</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00435">435</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -181,9 +202,9 @@ Data Fields</h2></td></tr>
<p>Firmware version string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00418">418</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00439">439</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -201,9 +222,9 @@ Data Fields</h2></td></tr>
<p>Manufacturer string (UTF-8) or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00415">415</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00436">436</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -221,9 +242,9 @@ Data Fields</h2></td></tr>
<p>Model string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00416">416</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00437">437</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -241,9 +262,9 @@ Data Fields</h2></td></tr>
<p>Hardware revision string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00417">417</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00438">438</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -261,9 +282,9 @@ Data Fields</h2></td></tr>
<p>Serial number string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00419">419</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00440">440</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -281,9 +302,9 @@ Data Fields</h2></td></tr>
<p>Dump software name or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00420">420</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00441">441</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -301,9 +322,9 @@ Data Fields</h2></td></tr>
<p>Host operating system string or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00422">422</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00443">443</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -321,9 +342,9 @@ Data Fields</h2></td></tr>
<p>Dump software version or NULL. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00421">421</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00442">442</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l03986">write_dumphw_block()</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close__write_8c_source.html#l04210">write_dumphw_block()</a>.</p>
</div>
</div>
@@ -344,7 +365,7 @@ Data Fields</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structDumpHardwareEntriesWithData.html">DumpHardwareEntriesWithData</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.16.1 </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.18.0 </li>
</ul>
</div>
</body>