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

+38 -6
View File
@@ -111,13 +111,16 @@ Public Member Functions</h2></td></tr>
<tr class="separator:aa034c1510984a85f60ad6c0bd744d6e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a780d6e747a48b10a5eb0ab85448d2970" id="r_a780d6e747a48b10a5eb0ab85448d2970"><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="classDecodeDatabase.html#a780d6e747a48b10a5eb0ab85448d2970">FindFrame</a> (const <a class="el" href="structFrameKey.html">FrameKey</a> &amp;key) const</td></tr>
<tr class="separator:a780d6e747a48b10a5eb0ab85448d2970"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa96b62b4f3fff68ab651674760f60d6d" id="r_aa96b62b4f3fff68ab651674760f60d6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPgnLookupResult.html">PgnLookupResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDecodeDatabase.html#aa96b62b4f3fff68ab651674760f60d6d">FindFrameByPgn</a> (std::uint32_t pgn) const</td></tr>
<tr class="separator:aa96b62b4f3fff68ab651674760f60d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0af5b15b9953a4f6551c27ee9ae8b514" id="r_a0af5b15b9953a4f6551c27ee9ae8b514"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; const <a class="el" href="structDecodeSignal.html">DecodeSignal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDecodeDatabase.html#a0af5b15b9953a4f6551c27ee9ae8b514">FindSignal</a> (const <a class="el" href="structSignalKey.html">SignalKey</a> &amp;key) const</td></tr>
<tr class="memdesc:a0af5b15b9953a4f6551c27ee9ae8b514"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an owning signal handle, or an empty handle for a missing key. <br /></td></tr>
<tr class="separator:a0af5b15b9953a4f6551c27ee9ae8b514"><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>Immutable runtime snapshot. Copies share storage; reload replaces a snapshot. Owning lookup handles and decoded results keep old definitions alive. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00087">87</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8h_source.html#l00101">101</a> of file <a class="el" href="decode__database_8h_source.html">decode_database.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a51a44cf7c3f23c98ec8781afe0097c0c" name="a51a44cf7c3f23c98ec8781afe0097c0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51a44cf7c3f23c98ec8781afe0097c0c">&#9670;&#160;</a></span>DecodeDatabase()</h2>
@@ -149,7 +152,7 @@ Public Member Functions</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00101">101</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00111">111</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
</div>
</div>
@@ -170,7 +173,9 @@ Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>Borrowed view, valid while this snapshot remains alive and unchanged. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00105">105</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00115">115</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="examples_2main_8cpp_source.html#l00101">main()</a>.</p>
</div>
</div>
@@ -191,9 +196,32 @@ Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>Owning handles retain the entire snapshot across reload or destruction. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00110">110</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00120">120</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__decoder_8cpp_source.html#l00017">DbcDecoder::FindFrame()</a>.</p>
<p class="reference">Referenced by <a class="el" href="decode__database_8cpp_source.html#l00146">FindSignal()</a>.</p>
</div>
</div>
<a id="aa96b62b4f3fff68ab651674760f60d6d" name="aa96b62b4f3fff68ab651674760f60d6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa96b62b4f3fff68ab651674760f60d6d">&#9670;&#160;</a></span>FindFrameByPgn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structPgnLookupResult.html">PgnLookupResult</a> DecodeDatabase::FindFrameByPgn </td>
<td>(</td>
<td class="paramtype">std::uint32_t&#160;</td>
<td class="paramname"><em>pgn</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Only explicitly marked hasPgn frames participate; ambiguous results have no definition. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00130">130</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8h_source.html#l00094">PgnLookupResult::ambiguous</a>, and <a class="el" href="decode__database_8h_source.html#l00093">PgnLookupResult::definition</a>.</p>
</div>
</div>
@@ -213,7 +241,11 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00120">120</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p>Return an owning signal handle, or an empty handle for a missing key. </p>
<p class="definition">Definition at line <a class="el" href="decode__database_8cpp_source.html#l00146">146</a> of file <a class="el" href="decode__database_8cpp_source.html">decode_database.cpp</a>.</p>
<p class="reference">References <a class="el" href="decode__database_8cpp_source.html#l00120">FindFrame()</a>, <a class="el" href="definition__key_8h_source.html#l00046">SignalKey::frame</a>, <a class="el" href="decode__database_8h_source.html#l00046">DecodeSignal::name</a>, and <a class="el" href="definition__key_8h_source.html#l00047">SignalKey::name</a>.</p>
</div>
</div>