update documentation

This commit is contained in:
deeaitch committed 2026-10-07 20:14:24 -04:00
1 parent 1d56a37090
commit 21d6f12163
190 files changed
+9608 -2928

No files matched your search

+11 -55
View File
@@ -106,15 +106,15 @@ $(document).ready(function(){initNavTree('structFrameInfo.html',''); initResizab
Public Attributes</h2></td></tr>
<tr class="memitem:abb53a7f93ed7abc0ea1ae4a8ccafcdcb" id="r_abb53a7f93ed7abc0ea1ae4a8ccafcdcb"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#abb53a7f93ed7abc0ea1ae4a8ccafcdcb">name</a></td></tr>
<tr class="separator:abb53a7f93ed7abc0ea1ae4a8ccafcdcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af470b0742c05bfbffc31c51a68f5c05e" id="r_af470b0742c05bfbffc31c51a68f5c05e"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#af470b0742c05bfbffc31c51a68f5c05e">canId</a></td></tr>
<tr class="memitem:af470b0742c05bfbffc31c51a68f5c05e" id="r_af470b0742c05bfbffc31c51a68f5c05e"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#af470b0742c05bfbffc31c51a68f5c05e">canId</a> = 0U</td></tr>
<tr class="separator:af470b0742c05bfbffc31c51a68f5c05e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34b726afaad2ac5c697fdb2ac070cdaf" id="r_a34b726afaad2ac5c697fdb2ac070cdaf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a34b726afaad2ac5c697fdb2ac070cdaf">isExtended</a></td></tr>
<tr class="memitem:a34b726afaad2ac5c697fdb2ac070cdaf" id="r_a34b726afaad2ac5c697fdb2ac070cdaf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a34b726afaad2ac5c697fdb2ac070cdaf">isExtended</a> = false</td></tr>
<tr class="separator:a34b726afaad2ac5c697fdb2ac070cdaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee518b33f1000bf0b7f6e4a87474c943" id="r_aee518b33f1000bf0b7f6e4a87474c943"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#aee518b33f1000bf0b7f6e4a87474c943">pgn</a></td></tr>
<tr class="memitem:aee518b33f1000bf0b7f6e4a87474c943" id="r_aee518b33f1000bf0b7f6e4a87474c943"><td class="memItemLeft" align="right" valign="top">std::uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#aee518b33f1000bf0b7f6e4a87474c943">pgn</a> = 0U</td></tr>
<tr class="separator:aee518b33f1000bf0b7f6e4a87474c943"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4737a5420213ad4304724e39f3a4e55d" id="r_a4737a5420213ad4304724e39f3a4e55d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a4737a5420213ad4304724e39f3a4e55d">hasPgn</a></td></tr>
<tr class="memitem:a4737a5420213ad4304724e39f3a4e55d" id="r_a4737a5420213ad4304724e39f3a4e55d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a4737a5420213ad4304724e39f3a4e55d">hasPgn</a> = false</td></tr>
<tr class="separator:a4737a5420213ad4304724e39f3a4e55d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2b198ea0f55e560c123d35e7b3ecab9" id="r_aa2b198ea0f55e560c123d35e7b3ecab9"><td class="memItemLeft" align="right" valign="top">std::uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#aa2b198ea0f55e560c123d35e7b3ecab9">dlc</a></td></tr>
<tr class="memitem:aa2b198ea0f55e560c123d35e7b3ecab9" id="r_aa2b198ea0f55e560c123d35e7b3ecab9"><td class="memItemLeft" align="right" valign="top">std::uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#aa2b198ea0f55e560c123d35e7b3ecab9">dlc</a> = 0U</td></tr>
<tr class="separator:aa2b198ea0f55e560c123d35e7b3ecab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92749ec3798d4211a505860fb389a9e8" id="r_a92749ec3798d4211a505860fb389a9e8"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFrameInfo.html#a92749ec3798d4211a505860fb389a9e8">transmitter</a></td></tr>
<tr class="separator:a92749ec3798d4211a505860fb389a9e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -127,35 +127,7 @@ Public Attributes</h2></td></tr>
<div class="textblock"><p>Describes one CAN frame from a DBC file. </p>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00024">24</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7f2d192b7969f7b60479a48e1f7eba61" name="a7f2d192b7969f7b60479a48e1f7eba61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f2d192b7969f7b60479a48e1f7eba61">&#9670;&#160;</a></span>FrameInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FrameInfo::FrameInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00035">35</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="abb53a7f93ed7abc0ea1ae4a8ccafcdcb" name="abb53a7f93ed7abc0ea1ae4a8ccafcdcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb53a7f93ed7abc0ea1ae4a8ccafcdcb">&#9670;&#160;</a></span>name</h2>
@@ -171,8 +143,6 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00025">25</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="af470b0742c05bfbffc31c51a68f5c05e" name="af470b0742c05bfbffc31c51a68f5c05e"></a>
@@ -182,7 +152,7 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t FrameInfo::canId</td>
<td class="memname">std::uint32_t FrameInfo::canId = 0U</td>
</tr>
</table>
</div><div class="memdoc">
@@ -190,8 +160,6 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00026">26</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a34b726afaad2ac5c697fdb2ac070cdaf" name="a34b726afaad2ac5c697fdb2ac070cdaf"></a>
@@ -201,7 +169,7 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FrameInfo::isExtended</td>
<td class="memname">bool FrameInfo::isExtended = false</td>
</tr>
</table>
</div><div class="memdoc">
@@ -209,8 +177,6 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00027">27</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="aee518b33f1000bf0b7f6e4a87474c943" name="aee518b33f1000bf0b7f6e4a87474c943"></a>
@@ -220,7 +186,7 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint32_t FrameInfo::pgn</td>
<td class="memname">std::uint32_t FrameInfo::pgn = 0U</td>
</tr>
</table>
</div><div class="memdoc">
@@ -228,8 +194,6 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00028">28</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a4737a5420213ad4304724e39f3a4e55d" name="a4737a5420213ad4304724e39f3a4e55d"></a>
@@ -239,7 +203,7 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FrameInfo::hasPgn</td>
<td class="memname">bool FrameInfo::hasPgn = false</td>
</tr>
</table>
</div><div class="memdoc">
@@ -247,8 +211,6 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00029">29</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="aa2b198ea0f55e560c123d35e7b3ecab9" name="aa2b198ea0f55e560c123d35e7b3ecab9"></a>
@@ -258,7 +220,7 @@ Public Attributes</h2></td></tr>
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::uint8_t FrameInfo::dlc</td>
<td class="memname">std::uint8_t FrameInfo::dlc = 0U</td>
</tr>
</table>
</div><div class="memdoc">
@@ -266,8 +228,6 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00030">30</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a92749ec3798d4211a505860fb389a9e8" name="a92749ec3798d4211a505860fb389a9e8"></a>
@@ -285,8 +245,6 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00031">31</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="ace75121294f9d89b762080ab5643293c" name="ace75121294f9d89b762080ab5643293c"></a>
@@ -304,8 +262,6 @@ Public Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="frame__info_8h_source.html#l00032">32</a> of file <a class="el" href="frame__info_8h_source.html">frame_info.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decode__builder_8cpp_source.html#l00014">DbcDecodeBuilder::Build()</a>.</p>
</div>
</div>
<a id="a3f7e25d67ddae22f2ed50823a5a26084" name="a3f7e25d67ddae22f2ed50823a5a26084"></a>