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

Update documentation

Browse Source
This commit is contained in:
deeaitch committed 2026-10-07 20:24:35 -04:00
1 parent a6016248f8
commit bce707daf6
1 file changed
+11 -11
Download Patch File Download Diff File Expand all files Collapse all files
docs/html/md_README.html
+11 -11
View File
@@ -58,7 +58,7 @@ $(function() {
<div id="nav-sync" class="sync"></div> <div id="nav-sync" class="sync"></div>
</div> </div>
</div> </div>
<div id="splitbar" style="-moz-user-select:none;" <div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle"> class="ui-resizable-handle">
</div> </div>
</div> </div>
@@ -763,12 +763,12 @@ Mappings are available as &lt;tt&gt;SignalInfo::valueDescriptions&lt;/tt&gt; and
&lt;tt&gt;DecodeSignal::valueDescriptions&lt;/tt&gt;, and survive both database builders, including &lt;tt&gt;DecodeSignal::valueDescriptions&lt;/tt&gt;, and survive both database builders, including
&lt;tt&gt;TreeNode::GetSignal()&lt;/tt&gt;. Consumers can look up a decoded result directly: &lt;tt&gt;TreeNode::GetSignal()&lt;/tt&gt;. Consumers can look up a decoded result directly:
@icode{cpp} @icode{cpp}
const DecodedSignalValue &amp;value = decodedFrame.signals.at(0); const DecodedSignalValue &amp;value = decodedFrame.signals.at(0);
if (const std::string *description = value.GetValueDescription()) { if (const std::string *description = value.GetValueDescription()) {
std::cout &lt;&lt; *description; std::cout &lt;&lt; *description;
} }
@endicode @endicode
&lt;tt&gt;GetValueDescription()&lt;/tt&gt; uses the exact raw integer before factor/offset scaling. &lt;tt&gt;GetValueDescription()&lt;/tt&gt; uses the exact raw integer before factor/offset scaling.
It returns &lt;tt&gt;nullptr&lt;/tt&gt; for an invalid decode or an unknown value; numeric decoding It returns &lt;tt&gt;nullptr&lt;/tt&gt; for an invalid decode or an unknown value; numeric decoding
@@ -884,13 +884,13 @@ The root project declares &lt;tt&gt;tests.depends = core&lt;/tt&gt; for parallel
Build out of source with Qt 6.8.2: Build out of source with Qt 6.8.2:
@icode{sh} @icode{sh}
mkdir build mkdir build
cd build cd build
qmake6 ../dbc.pro qmake6 ../dbc.pro
make -j make -j
make check make check
@endicode @endicode
&lt;tt&gt;core/core_files.pri&lt;/tt&gt; lists the library sources and headers. &lt;tt&gt;core/core_files.pri&lt;/tt&gt; lists the library sources and headers.
Consumers include &lt;tt&gt;core/core.pri&lt;/tt&gt; for include paths and library linkage; the test Consumers include &lt;tt&gt;core/core.pri&lt;/tt&gt; for include paths and library linkage; the test
@@ -902,12 +902,12 @@ When building a consumer separately, pass
From the repository root: From the repository root:
@icode{sh} @icode{sh}
mkdir -p build/core mkdir -p build/core
cd build/core cd build/core
qmake6 ../../core/core.pro qmake6 ../../core/core.pro
make -j make -j
@endicode @endicode
qmake is still the build tool; this target does not link Qt libraries. qmake is still the build tool; this target does not link Qt libraries.
@@ -923,13 +923,13 @@ no display server is required. An explicit platform setting is preserved.
Enable its library and focused QtTest suite: Enable its library and focused QtTest suite:
@icode{sh} @icode{sh}
mkdir -p build-qt mkdir -p build-qt
cd build-qt cd build-qt
qmake6 ../dbc.pro CONFIG+=dbc_qt qmake6 ../dbc.pro CONFIG+=dbc_qt
make -j make -j
make check make check
@endicode @endicode
Consumers include &lt;tt&gt;qt/qt.pri&lt;/tt&gt; instead of &lt;tt&gt;core/core.pri&lt;/tt&gt;, and set Consumers include &lt;tt&gt;qt/qt.pri&lt;/tt&gt; instead of &lt;tt&gt;core/core.pri&lt;/tt&gt;, and set
&lt;tt&gt;DBC_CORE_BUILD_DIR&lt;/tt&gt; and &lt;tt&gt;DBC_QT_BUILD_DIR&lt;/tt&gt; to the corresponding library build &lt;tt&gt;DBC_CORE_BUILD_DIR&lt;/tt&gt; and &lt;tt&gt;DBC_QT_BUILD_DIR&lt;/tt&gt; to the corresponding library build
@@ -937,7 +937,7 @@ directories when building separately. A widget application also needs &lt;tt&gt;
&lt;tt&gt;no_keywords&lt;/tt&gt;, because core metadata has a &lt;tt&gt;signals&lt;/tt&gt; member; use &lt;tt&gt;Q_SIGNALS&lt;/tt&gt;, &lt;tt&gt;no_keywords&lt;/tt&gt;, because core metadata has a &lt;tt&gt;signals&lt;/tt&gt; member; use &lt;tt&gt;Q_SIGNALS&lt;/tt&gt;,
&lt;tt&gt;Q_SLOTS&lt;/tt&gt;, and &lt;tt&gt;Q_EMIT&lt;/tt&gt; in consuming Qt classes. &lt;tt&gt;Q_SLOTS&lt;/tt&gt;, and &lt;tt&gt;Q_EMIT&lt;/tt&gt; in consuming Qt classes.
@icode{cpp} @icode{cpp}
#include "<a class="el" href="dbc__parser_8h.html" title="Created: 2026-03-13 Author: Deeaitch (Dim. Himro)">dbc_parser.h</a>" #include "<a class="el" href="dbc__parser_8h.html" title="Created: 2026-03-13 Author: Deeaitch (Dim. Himro)">dbc_parser.h</a>"
#include "<a class="el" href="dbc__tree__builder_8h.html" title="Created: 2026-03-13 Author: Deeaitch (Dim. Himro)">dbc_tree_builder.h</a>" #include "<a class="el" href="dbc__tree__builder_8h.html" title="Created: 2026-03-13 Author: Deeaitch (Dim. Himro)">dbc_tree_builder.h</a>"
#include "<a class="el" href="dbc__tree__model_8h_source.html">dbc_tree_model.h</a>" #include "<a class="el" href="dbc__tree__model_8h_source.html">dbc_tree_model.h</a>"
@@ -952,7 +952,7 @@ view.expandAll();
view.show(); view.show();
// On reload, pass a newly built tree to SetTree(); to clear: // On reload, pass a newly built tree to SetTree(); to clear:
// model-&gt;SetTree(nullptr); // model-&gt;SetTree(nullptr);
@endicode @endicode
The root is invisible: frames are top-level rows, signals are their children. The root is invisible: frames are top-level rows, signals are their children.
Only column zero has children. &lt;tt&gt;parent()&lt;/tt&gt; always returns column zero. Only column zero has children. &lt;tt&gt;parent()&lt;/tt&gt; always returns column zero.