Update documentation
This commit is contained in:
1 parent
a6016248f8
commit
bce707daf6
1 file changed
+11
-11
+11
-11
@@ -58,7 +58,7 @@ $(function() {
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
@@ -763,12 +763,12 @@ Mappings are available as <tt>SignalInfo::valueDescriptions</tt> and
|
||||
<tt>DecodeSignal::valueDescriptions</tt>, and survive both database builders, including
|
||||
<tt>TreeNode::GetSignal()</tt>. Consumers can look up a decoded result directly:
|
||||
|
||||
@icode{cpp}
|
||||
@icode{cpp}
|
||||
const DecodedSignalValue &value = decodedFrame.signals.at(0);
|
||||
if (const std::string *description = value.GetValueDescription()) {
|
||||
std::cout << *description;
|
||||
}
|
||||
@endicode
|
||||
@endicode
|
||||
|
||||
<tt>GetValueDescription()</tt> uses the exact raw integer before factor/offset scaling.
|
||||
It returns <tt>nullptr</tt> for an invalid decode or an unknown value; numeric decoding
|
||||
@@ -884,13 +884,13 @@ The root project declares <tt>tests.depends = core</tt> for parallel
|
||||
|
||||
Build out of source with Qt 6.8.2:
|
||||
|
||||
@icode{sh}
|
||||
@icode{sh}
|
||||
mkdir build
|
||||
cd build
|
||||
qmake6 ../dbc.pro
|
||||
make -j
|
||||
make check
|
||||
@endicode
|
||||
@endicode
|
||||
|
||||
<tt>core/core_files.pri</tt> lists the library sources and headers.
|
||||
Consumers include <tt>core/core.pri</tt> for include paths and library linkage; the test
|
||||
@@ -902,12 +902,12 @@ When building a consumer separately, pass
|
||||
|
||||
From the repository root:
|
||||
|
||||
@icode{sh}
|
||||
@icode{sh}
|
||||
mkdir -p build/core
|
||||
cd build/core
|
||||
qmake6 ../../core/core.pro
|
||||
make -j
|
||||
@endicode
|
||||
@endicode
|
||||
|
||||
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:
|
||||
|
||||
@icode{sh}
|
||||
@icode{sh}
|
||||
mkdir -p build-qt
|
||||
cd build-qt
|
||||
qmake6 ../dbc.pro CONFIG+=dbc_qt
|
||||
make -j
|
||||
make check
|
||||
@endicode
|
||||
@endicode
|
||||
|
||||
Consumers include <tt>qt/qt.pri</tt> instead of <tt>core/core.pri</tt>, and set
|
||||
<tt>DBC_CORE_BUILD_DIR</tt> and <tt>DBC_QT_BUILD_DIR</tt> to the corresponding library build
|
||||
@@ -937,7 +937,7 @@ directories when building separately. A widget application also needs <tt>
|
||||
<tt>no_keywords</tt>, because core metadata has a <tt>signals</tt> member; use <tt>Q_SIGNALS</tt>,
|
||||
<tt>Q_SLOTS</tt>, and <tt>Q_EMIT</tt> 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__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>"
|
||||
@@ -952,7 +952,7 @@ view.expandAll();
|
||||
view.show();
|
||||
// On reload, pass a newly built tree to SetTree(); to clear:
|
||||
// model->SetTree(nullptr);
|
||||
@endicode
|
||||
@endicode
|
||||
|
||||
The root is invisible: frames are top-level rows, signals are their children.
|
||||
Only column zero has children. <tt>parent()</tt> always returns column zero.
|
||||
|
||||
Reference in new issue
Block a user