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

+45 -7
View File
@@ -104,6 +104,9 @@ $(document).ready(function(){initNavTree('classDbcParser.html',''); initResizabl
<table class="memberdecls">
<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:a46bc3afcd103e704dc58bb4b073da73c" id="r_a46bc3afcd103e704dc58bb4b073da73c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDbcParser.html#a46bc3afcd103e704dc58bb4b073da73c">DbcParser</a> (<a class="el" href="structDbcParserOptions.html">DbcParserOptions</a> options={})</td></tr>
<tr class="memdesc:a46bc3afcd103e704dc58bb4b073da73c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a parser with explicit extended-frame interpretation options. <br /></td></tr>
<tr class="separator:a46bc3afcd103e704dc58bb4b073da73c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef72826942c9095d653fafa435855e56" id="r_aef72826942c9095d653fafa435855e56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structDbcDatabase.html">DbcDatabase</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDbcParser.html#aef72826942c9095d653fafa435855e56">ParseFile</a> (const std::string &amp;filePath) const</td></tr>
<tr class="memdesc:aef72826942c9095d653fafa435855e56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse DBC file. <br /></td></tr>
<tr class="separator:aef72826942c9095d653fafa435855e56"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -120,11 +123,44 @@ Public Member Functions</h2></td></tr>
<li>CM_ SG_</li>
<li>basic M / mN multiplexing</li>
<li>VAL_ signal value descriptions</li>
<li>BA_DEF_, BA_DEF_DEF_, BA_ typed attributes, frame format and cycle time</li>
</ul>
<p>Frame/signal comments support multiline quoted text and deferred references.</p>
<p>Reports unsupported statements as warnings, except SG_MUL_VAL_ which is an error. VERSION, NS_, BS_, BU_ and NS_ symbol declarations stay quiet. </p>
<p class="definition">Definition at line <a class="el" href="dbc__parser_8h_source.html#l00033">33</a> of file <a class="el" href="dbc__parser_8h_source.html">dbc_parser.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<p class="definition">Definition at line <a class="el" href="dbc__parser_8h_source.html#l00041">41</a> of file <a class="el" href="dbc__parser_8h_source.html">dbc_parser.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a46bc3afcd103e704dc58bb4b073da73c" name="a46bc3afcd103e704dc58bb4b073da73c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46bc3afcd103e704dc58bb4b073da73c">&#9670;&#160;</a></span>DbcParser()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DbcParser::DbcParser </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structDbcParserOptions.html">DbcParserOptions</a>&#160;</td>
<td class="paramname"><em>options</em> = <code>{}</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a parser with explicit extended-frame interpretation options. </p>
<p class="definition">Definition at line <a class="el" href="dbc__parser_8h_source.html#l00044">44</a> of file <a class="el" href="dbc__parser_8h_source.html">dbc_parser.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aef72826942c9095d653fafa435855e56" name="aef72826942c9095d653fafa435855e56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef72826942c9095d653fafa435855e56">&#9670;&#160;</a></span>ParseFile()</h2>
@@ -156,9 +192,11 @@ Public Member Functions</h2></td></tr>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="dbc__parser_8cpp_source.html#l00031">31</a> of file <a class="el" href="dbc__parser_8cpp_source.html">dbc_parser.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__parser_8cpp_source.html#l00061">61</a> of file <a class="el" href="dbc__parser_8cpp_source.html">dbc_parser.cpp</a>.</p>
<p class="reference">References <a class="el" href="dbc__parser_8cpp_source.html#l00044">ParseFileWithDiagnostics()</a>.</p>
<p class="reference">References <a class="el" href="dbc__diagnostic_8h_source.html#l00039">DbcParseResult::database</a>, <a class="el" href="dbc__diagnostic_8h_source.html#l00040">DbcParseResult::diagnostics</a>, and <a class="el" href="dbc__parser_8cpp_source.html#l00074">ParseFileWithDiagnostics()</a>.</p>
<p class="reference">Referenced by <a class="el" href="examples_2main_8cpp_source.html#l00101">main()</a>.</p>
</div>
</div>
@@ -181,11 +219,11 @@ Public Member Functions</h2></td></tr>
<p>Parse with warnings and a structured first error instead of throwing. </p>
<dl class="section return"><dt>Returns</dt><dd>Valid database with diagnostics; empty database on error. File errors use line zero; statement errors use physical one-based lines. Warnings indicate ignored syntax and possible incomplete decoding. </dd></dl>
<p class="definition">Definition at line <a class="el" href="dbc__parser_8cpp_source.html#l00044">44</a> of file <a class="el" href="dbc__parser_8cpp_source.html">dbc_parser.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="dbc__parser_8cpp_source.html#l00074">74</a> of file <a class="el" href="dbc__parser_8cpp_source.html">dbc_parser.cpp</a>.</p>
<p class="reference">References <a class="el" href="dbc__statement__handler_8cpp_source.html#l00388">DbcStatementDispatcher::Dispatch()</a>.</p>
<p class="reference">References <a class="el" href="dbc__diagnostic_8h_source.html#l00039">DbcParseResult::database</a>, <a class="el" href="dbc__statement__handler_8h_source.html#l00040">DbcDiagnosticError::diagnostic</a>, <a class="el" href="dbc__diagnostic_8h_source.html#l00040">DbcParseResult::diagnostics</a>, <a class="el" href="dbc__statement__handler_8cpp_source.html#l00390">DbcStatementDispatcher::Dispatch()</a>, and <a class="el" href="dbc__parser_8h_source.html#l00021">DbcParserOptions::enableJ1939</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__parser_8cpp_source.html#l00031">ParseFile()</a>.</p>
<p class="reference">Referenced by <a class="el" href="dbc__parser_8cpp_source.html#l00061">ParseFile()</a>.</p>
</div>
</div>