upfate doxygen

This commit is contained in:
deeaitch committed 2026-10-20 13:40:44 -04:00
1 parent a55d1c58ed
commit c43222939f
433 files changed
+15617 -7061

No files matched your search

+56 -11
View File
@@ -106,16 +106,19 @@ $(document).ready(function(){initNavTree('classDbcDecoder.html',''); initResizab
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4005c4311f57b7faf21c0cb31463039c" id="r_a4005c4311f57b7faf21c0cb31463039c"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; const <a class="el" href="structDecodeFrame.html">DecodeFrame</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDbcDecoder.html#a4005c4311f57b7faf21c0cb31463039c">FindFrame</a> (const <a class="el" href="classDecodeDatabase.html">DecodeDatabase</a> &amp;database, std::uint32_t canId, bool isExtended) const</td></tr>
<tr class="memdesc:a4005c4311f57b7faf21c0cb31463039c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find frame definition by CAN ID. <br /></td></tr>
<tr class="memdesc:a4005c4311f57b7faf21c0cb31463039c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find exact CAN ID first, then unique PGN among explicitly J1939 definitions. <br /></td></tr>
<tr class="separator:a4005c4311f57b7faf21c0cb31463039c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a345951ffe5d943a70d3a1ea1f39e74f7" id="r_a345951ffe5d943a70d3a1ea1f39e74f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structDecodedFrameValue.html">DecodedFrameValue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDbcDecoder.html#a345951ffe5d943a70d3a1ea1f39e74f7">Decode</a> (const <a class="el" href="classDecodeDatabase.html">DecodeDatabase</a> &amp;database, const <a class="el" href="structRawCanFrame.html">RawCanFrame</a> &amp;frame) const</td></tr>
<tr class="memdesc:a345951ffe5d943a70d3a1ea1f39e74f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode one raw CAN frame. <br /></td></tr>
<tr class="separator:a345951ffe5d943a70d3a1ea1f39e74f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade48a94b6fcda6563bd1b2c6ff49439e" id="r_ade48a94b6fcda6563bd1b2c6ff49439e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structDecodedFrameValue.html">DecodedFrameValue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDbcDecoder.html#ade48a94b6fcda6563bd1b2c6ff49439e">Decode</a> (const <a class="el" href="classDecodeDatabase.html">DecodeDatabase</a> &amp;database, const <a class="el" href="structRawCanFrame.html">RawCanFrame</a> &amp;frame, const std::vector&lt; <a class="el" href="structSignalKey.html">SignalKey</a> &gt; &amp;selection) const</td></tr>
<tr class="memdesc:ade48a94b6fcda6563bd1b2c6ff49439e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode selected signals in selection order using stable keys. An empty selection returns no signals. Multiplex selectors are read internally. Frame status summarizes selected signals; short payload still takes precedence. Unknown/ambiguous frames return before checking the selection. For PGN matches, selection keys must belong to the matched DBC definition. <br /></td></tr>
<tr class="separator:ade48a94b6fcda6563bd1b2c6ff49439e"><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 CAN decoder using prebuilt decode database. </p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00084">84</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8h_source.html#l00086">86</a> of file <a class="el" href="dbc__decoder_8h_source.html">dbc_decoder.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4005c4311f57b7faf21c0cb31463039c" name="a4005c4311f57b7faf21c0cb31463039c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4005c4311f57b7faf21c0cb31463039c">&#9670;&#160;</a></span>FindFrame()</h2>
@@ -149,7 +152,7 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Find frame definition by CAN ID. </p>
<p>Find exact CAN ID first, then unique PGN among explicitly J1939 definitions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">database</td><td>Runtime decode database. </td></tr>
@@ -158,18 +161,16 @@ Public Member Functions</h2></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Owning immutable frame handle or nullptr. Safe across reload. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Owning immutable handle, or nullptr for missing/ambiguous matches. Safe across reload. </dd></dl>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8cpp_source.html#l00017">17</a> of file <a class="el" href="dbc__decoder_8cpp_source.html">dbc_decoder.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8cpp_source.html#l00020">20</a> of file <a class="el" href="dbc__decoder_8cpp_source.html">dbc_decoder.cpp</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8cpp_source.html#l00110">DecodeDatabase::FindFrame()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00023">Decode()</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8h_source.html#l00093">PgnLookupResult::definition</a>.</p>
</div>
</div>
<a id="a345951ffe5d943a70d3a1ea1f39e74f7" name="a345951ffe5d943a70d3a1ea1f39e74f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a345951ffe5d943a70d3a1ea1f39e74f7">&#9670;&#160;</a></span>Decode()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a345951ffe5d943a70d3a1ea1f39e74f7">&#9670;&#160;</a></span>Decode() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -204,9 +205,53 @@ Public Member Functions</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Decoded frame value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8cpp_source.html#l00023">23</a> of file <a class="el" href="dbc__decoder_8cpp_source.html">dbc_decoder.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8cpp_source.html#l00036">36</a> of file <a class="el" href="dbc__decoder_8cpp_source.html">dbc_decoder.cpp</a>.</p>
<p class="reference">References <a class="el" href="dbc__decoder_8h_source.html#l00025">RawCanFrame::canId</a>, <a class="el" href="dbc__decoder_8h_source.html#l00027">RawCanFrame::data</a>, <a class="el" href="dbc__decoder_8h_source.html#l00053">DecodedSignalValue::definition</a>, <a class="el" href="dbc__decoder_8h_source.html#l00072">DecodedFrameValue::definition</a>, <a class="el" href="dbc__decoder_8cpp_source.html#l00017">FindFrame()</a>, <a class="el" href="dbc__decoder_8h_source.html#l00026">RawCanFrame::isExtended</a>, <a class="el" href="dbc__decoder_8h_source.html#l00054">DecodedSignalValue::key</a>, <a class="el" href="dbc__decoder_8h_source.html#l00073">DecodedFrameValue::key</a>, <a class="el" href="dbc__decoder_8h_source.html#l00076">DecodedFrameValue::status</a>, <a class="el" href="dbc__decoder_8h_source.html#l00057">DecodedSignalValue::valid</a>, and <a class="el" href="dbc__decoder_8h_source.html#l00075">DecodedFrameValue::valid</a>.</p>
<p class="reference">Referenced by <a class="el" href="examples_2main_8cpp_source.html#l00101">main()</a>.</p>
</div>
</div>
<a id="ade48a94b6fcda6563bd1b2c6ff49439e" name="ade48a94b6fcda6563bd1b2c6ff49439e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade48a94b6fcda6563bd1b2c6ff49439e">&#9670;&#160;</a></span>Decode() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structDecodedFrameValue.html">DecodedFrameValue</a> DbcDecoder::Decode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classDecodeDatabase.html">DecodeDatabase</a> &amp;&#160;</td>
<td class="paramname"><em>database</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structRawCanFrame.html">RawCanFrame</a> &amp;&#160;</td>
<td class="paramname"><em>frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; <a class="el" href="structSignalKey.html">SignalKey</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>selection</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode selected signals in selection order using stable keys. An empty selection returns no signals. Multiplex selectors are read internally. Frame status summarizes selected signals; short payload still takes precedence. Unknown/ambiguous frames return before checking the selection. For PGN matches, selection keys must belong to the matched DBC definition. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::invalid_argument</td><td>for a foreign frame key, unknown signal, or duplicate key. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="dbc__decoder_8cpp_source.html#l00041">41</a> of file <a class="el" href="dbc__decoder_8cpp_source.html">dbc_decoder.cpp</a>.</p>
</div>
</div>