Generated foxygen documentation. Closes #1

This commit is contained in:
2026-06-14 20:51:56 -04:00
parent e2c07dde0d
commit dfec39d996
164 changed files with 25311 additions and 0 deletions

View File

@@ -0,0 +1,117 @@
<!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">
<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.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DBC framework: DecodeDatabase 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>
<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">DBC framework
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structDecodeDatabase-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">DecodeDatabase Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Runtime decode database with fast lookup by CAN ID.
<a href="structDecodeDatabase.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="decode__database_8h_source.html">decode_database.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2bd4ddfc2602c1de4e12a373bfc93072"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structDecodeFrame.html">DecodeFrame</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeDatabase.html#a2bd4ddfc2602c1de4e12a373bfc93072">frames</a></td></tr>
<tr class="separator:a2bd4ddfc2602c1de4e12a373bfc93072"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4fd1351008bb0dce337821a849100c5"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; <a class="el" href="structFrameKey.html">FrameKey</a>, std::size_t, <a class="el" href="structFrameKeyHasher.html">FrameKeyHasher</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDecodeDatabase.html#ae4fd1351008bb0dce337821a849100c5">frameIndexByKey</a></td></tr>
<tr class="separator:ae4fd1351008bb0dce337821a849100c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Runtime decode database with fast lookup by CAN ID. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00132">132</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ae4fd1351008bb0dce337821a849100c5" name="ae4fd1351008bb0dce337821a849100c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4fd1351008bb0dce337821a849100c5">&#9670;&nbsp;</a></span>frameIndexByKey</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt;<a class="el" href="structFrameKey.html">FrameKey</a>, std::size_t, <a class="el" href="structFrameKeyHasher.html">FrameKeyHasher</a>&gt; DecodeDatabase::frameIndexByKey</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00134">134</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>, and <a class="el" href="dbc__decoder_8cpp_source.html#l00014">DbcDecoder::FindFrame()</a>.</p>
</div>
</div>
<a id="a2bd4ddfc2602c1de4e12a373bfc93072" name="a2bd4ddfc2602c1de4e12a373bfc93072"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bd4ddfc2602c1de4e12a373bfc93072">&#9670;&nbsp;</a></span>frames</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structDecodeFrame.html">DecodeFrame</a>&gt; DecodeDatabase::frames</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00133">133</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>, <a class="el" href="dbc__decoder_8cpp_source.html#l00014">DbcDecoder::FindFrame()</a>, and <a class="el" href="main_8cpp_source.html#l00097">main()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="decode__database_8h_source.html">decode_database.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 14 2026 20:49:34 for DBC framework by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>