automotive/dbc
1
0 Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity

upfate doxygen

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/html/dbc__diagnostic_8h_source.html
+51 -40
View File
@@ -107,50 +107,61 @@ $(document).ready(function(){initNavTree('dbc__diagnostic_8h_source.html',''); i
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">enum class</span> DbcDiagnosticSeverity {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> Warning,</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> Error</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>};</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">enum class</span> DbcDiagnosticCode {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> FileOpenError,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> FileReadError,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> InvalidStatement,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> InvalidValueDescription,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> InvalidMultiplexing,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> UnsupportedStatement</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>};</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="foldopen" id="foldopen00025" data-start="{" data-end="};">
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structDbcDiagnostic.html"> 25</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structDbcDiagnostic.html">DbcDiagnostic</a> {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> DbcDiagnosticSeverity severity;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> DbcDiagnosticCode code;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> std::string filePath;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> std::size_t lineNumber; <span class="comment">// One-based physical line; zero for file-level errors.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> std::string message;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>};</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">enum class</span> DbcDiagnosticSeverity {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> Warning,</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> Error</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>};</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">enum class</span> DbcDiagnosticCode {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> FileOpenError,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> FileReadError,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> InvalidStatement,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> InvalidValueDescription,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> InvalidMultiplexing,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> UnsupportedStatement,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> InvalidAttribute,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> UnsupportedAttribute</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>};</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="};">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="structDbcDiagnostic.html"> 29</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structDbcDiagnostic.html">DbcDiagnostic</a> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structDbcDiagnostic.html#a75040a94f0313a606478020b0491f81d"> 30</a></span> DbcDiagnosticSeverity <a class="code hl_variable" href="structDbcDiagnostic.html#a75040a94f0313a606478020b0491f81d">severity</a>; </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="structDbcDiagnostic.html#aa315a4a40b15f2e8cb34264d94a0f914"> 31</a></span> DbcDiagnosticCode <a class="code hl_variable" href="structDbcDiagnostic.html#aa315a4a40b15f2e8cb34264d94a0f914">code</a>; </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structDbcDiagnostic.html#ac9f02705ed6a633cbb9526d0e392fb95"> 32</a></span> std::string <a class="code hl_variable" href="structDbcDiagnostic.html#ac9f02705ed6a633cbb9526d0e392fb95">filePath</a>; </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structDbcDiagnostic.html#adb201de8d32b768d5f559bed21e8f819"> 33</a></span> std::size_t <a class="code hl_variable" href="structDbcDiagnostic.html#adb201de8d32b768d5f559bed21e8f819">lineNumber</a>; </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structDbcDiagnostic.html#a124bae82eebeaef46426bd124685ef1b"> 34</a></span> std::string <a class="code hl_variable" href="structDbcDiagnostic.html#a124bae82eebeaef46426bd124685ef1b">message</a>; </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>};</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structDbcParseResult.html"> 33</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structDbcParseResult.html">DbcParseResult</a> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_struct" href="structDbcDatabase.html">DbcDatabase</a> database;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> std::vector&lt;DbcDiagnostic&gt; diagnostics;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">bool</span> HasErrors()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> <a class="code hl_struct" href="structDbcDiagnostic.html">DbcDiagnostic</a> &amp;diagnostic : diagnostics) {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">if</span> (diagnostic.severity == DbcDiagnosticSeverity::Error)</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> }</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>};</div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="};">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structDbcParseResult.html"> 38</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structDbcParseResult.html">DbcParseResult</a> {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="structDbcParseResult.html#abfa765d29a4397e8ddaf771bae21993e"> 39</a></span> <a class="code hl_struct" href="structDbcDatabase.html">DbcDatabase</a> <a class="code hl_variable" href="structDbcParseResult.html#abfa765d29a4397e8ddaf771bae21993e">database</a>; </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="structDbcParseResult.html#a3a1987b4381bb1e0a34dc09e31483679"> 40</a></span> std::vector&lt;DbcDiagnostic&gt; <a class="code hl_variable" href="structDbcParseResult.html#a3a1987b4381bb1e0a34dc09e31483679">diagnostics</a>; </div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="}">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structDbcParseResult.html#a4da8641de3f6b55c7447c4421e05d20d"> 43</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="structDbcParseResult.html#a4da8641de3f6b55c7447c4421e05d20d">HasErrors</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">for</span> (<span class="keyword">const</span> <a class="code hl_struct" href="structDbcDiagnostic.html">DbcDiagnostic</a> &amp;diagnostic: <a class="code hl_variable" href="structDbcParseResult.html#a3a1987b4381bb1e0a34dc09e31483679">diagnostics</a>) {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">if</span> (diagnostic.severity == DbcDiagnosticSeverity::Error)</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> }</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> }</div>
</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="preprocessor">#endif </span><span class="comment">/* DBC_DIAGNOSTIC_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="adbc__database_8h_html"><div class="ttname"><a href="dbc__database_8h.html">dbc_database.h</a></div><div class="ttdoc">Created: 2026-03-13 Author: Deeaitch (Dim. Himro)</div></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>};</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#endif </span><span class="comment">/* DBC_DIAGNOSTIC_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="adbc__database_8h_html"><div class="ttname"><a href="dbc__database_8h.html">dbc_database.h</a></div><div class="ttdoc">Parsed DBC database and attribute metadata.</div></div>
<div class="ttc" id="astructDbcDatabase_html"><div class="ttname"><a href="structDbcDatabase.html">DbcDatabase</a></div><div class="ttdoc">Parsed DBC content stored in a simple internal form.</div><div class="ttdef"><b>Definition</b> <a href="dbc__database_8h_source.html#l00022">dbc_database.h:22</a></div></div>
<div class="ttc" id="astructDbcDiagnostic_html"><div class="ttname"><a href="structDbcDiagnostic.html">DbcDiagnostic</a></div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00025">dbc_diagnostic.h:25</a></div></div>
<div class="ttc" id="astructDbcParseResult_html"><div class="ttname"><a href="structDbcParseResult.html">DbcParseResult</a></div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00033">dbc_diagnostic.h:33</a></div></div>
<div class="ttc" id="astructDbcDiagnostic_html"><div class="ttname"><a href="structDbcDiagnostic.html">DbcDiagnostic</a></div><div class="ttdoc">Diagnostic message and physical source location.</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00029">dbc_diagnostic.h:29</a></div></div>
<div class="ttc" id="astructDbcDiagnostic_html_a124bae82eebeaef46426bd124685ef1b"><div class="ttname"><a href="structDbcDiagnostic.html#a124bae82eebeaef46426bd124685ef1b">DbcDiagnostic::message</a></div><div class="ttdeci">std::string message</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00034">dbc_diagnostic.h:34</a></div></div>
<div class="ttc" id="astructDbcDiagnostic_html_a75040a94f0313a606478020b0491f81d"><div class="ttname"><a href="structDbcDiagnostic.html#a75040a94f0313a606478020b0491f81d">DbcDiagnostic::severity</a></div><div class="ttdeci">DbcDiagnosticSeverity severity</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00030">dbc_diagnostic.h:30</a></div></div>
<div class="ttc" id="astructDbcDiagnostic_html_aa315a4a40b15f2e8cb34264d94a0f914"><div class="ttname"><a href="structDbcDiagnostic.html#aa315a4a40b15f2e8cb34264d94a0f914">DbcDiagnostic::code</a></div><div class="ttdeci">DbcDiagnosticCode code</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00031">dbc_diagnostic.h:31</a></div></div>
<div class="ttc" id="astructDbcDiagnostic_html_ac9f02705ed6a633cbb9526d0e392fb95"><div class="ttname"><a href="structDbcDiagnostic.html#ac9f02705ed6a633cbb9526d0e392fb95">DbcDiagnostic::filePath</a></div><div class="ttdeci">std::string filePath</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00032">dbc_diagnostic.h:32</a></div></div>
<div class="ttc" id="astructDbcDiagnostic_html_adb201de8d32b768d5f559bed21e8f819"><div class="ttname"><a href="structDbcDiagnostic.html#adb201de8d32b768d5f559bed21e8f819">DbcDiagnostic::lineNumber</a></div><div class="ttdeci">std::size_t lineNumber</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00033">dbc_diagnostic.h:33</a></div></div>
<div class="ttc" id="astructDbcParseResult_html"><div class="ttname"><a href="structDbcParseResult.html">DbcParseResult</a></div><div class="ttdoc">Parsed database and diagnostics; the database is empty on error.</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00038">dbc_diagnostic.h:38</a></div></div>
<div class="ttc" id="astructDbcParseResult_html_a3a1987b4381bb1e0a34dc09e31483679"><div class="ttname"><a href="structDbcParseResult.html#a3a1987b4381bb1e0a34dc09e31483679">DbcParseResult::diagnostics</a></div><div class="ttdeci">std::vector&lt; DbcDiagnostic &gt; diagnostics</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00040">dbc_diagnostic.h:40</a></div></div>
<div class="ttc" id="astructDbcParseResult_html_a4da8641de3f6b55c7447c4421e05d20d"><div class="ttname"><a href="structDbcParseResult.html#a4da8641de3f6b55c7447c4421e05d20d">DbcParseResult::HasErrors</a></div><div class="ttdeci">bool HasErrors() const</div><div class="ttdoc">Return whether any diagnostic has error severity.</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00043">dbc_diagnostic.h:43</a></div></div>
<div class="ttc" id="astructDbcParseResult_html_abfa765d29a4397e8ddaf771bae21993e"><div class="ttname"><a href="structDbcParseResult.html#abfa765d29a4397e8ddaf771bae21993e">DbcParseResult::database</a></div><div class="ttdeci">DbcDatabase database</div><div class="ttdef"><b>Definition</b> <a href="dbc__diagnostic_8h_source.html#l00039">dbc_diagnostic.h:39</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->