update documentation
This commit is contained in:
deeaitch committed
1 parent
1d56a37090
commit
21d6f12163
190 files changed
+9608
-2928
No files matched your search
+101
-68
@@ -25,84 +25,116 @@
|
||||
var NAVTREE =
|
||||
[
|
||||
[ "DBC Framework", "index.html", [
|
||||
[ "Changelog", "md_changelog.html", [
|
||||
[ "Unreleased", "md_changelog.html#autotoc_md1", [
|
||||
[ "2026-10-07", "md_changelog.html#autotoc_md2", [
|
||||
[ "Added", "md_changelog.html#autotoc_md3", null ],
|
||||
[ "Changed", "md_changelog.html#autotoc_md4", null ],
|
||||
[ "Fixed", "md_changelog.html#autotoc_md5", null ]
|
||||
] ],
|
||||
[ "2026-10-06", "md_changelog.html#autotoc_md6", [
|
||||
[ "Added", "md_changelog.html#autotoc_md7", null ]
|
||||
] ],
|
||||
[ "2026-10-05", "md_changelog.html#autotoc_md8", [
|
||||
[ "Changed", "md_changelog.html#autotoc_md9", null ],
|
||||
[ "Fixed", "md_changelog.html#autotoc_md10", null ],
|
||||
[ "Documentation and maintenance", "md_changelog.html#autotoc_md11", null ]
|
||||
] ],
|
||||
[ "2026-10-01", "md_changelog.html#autotoc_md12", [
|
||||
[ "Changed", "md_changelog.html#autotoc_md13", null ],
|
||||
[ "Fixed", "md_changelog.html#autotoc_md14", null ]
|
||||
] ]
|
||||
] ],
|
||||
[ "v1.0 — 2026-06-14", "md_changelog.html#autotoc_md15", [
|
||||
[ "Documentation", "md_changelog.html#autotoc_md16", null ],
|
||||
[ "Initial implementation — 2026-03-13", "md_changelog.html#autotoc_md17", [
|
||||
[ "Added", "md_changelog.html#autotoc_md18", null ],
|
||||
[ "Documentation and maintenance", "md_changelog.html#autotoc_md19", null ]
|
||||
] ]
|
||||
] ]
|
||||
] ],
|
||||
[ "DBC Parser and Runtime Decode Module Documentation", "md_README.html", [
|
||||
[ "Overview", "md_README.html#autotoc_md1", null ],
|
||||
[ "High-Level Architecture", "md_README.html#autotoc_md3", [
|
||||
[ "1. Parse and UI path", "md_README.html#autotoc_md4", null ],
|
||||
[ "2. Runtime decode path", "md_README.html#autotoc_md5", null ]
|
||||
[ "Overview", "md_README.html#autotoc_md21", null ],
|
||||
[ "High-Level Architecture", "md_README.html#autotoc_md23", [
|
||||
[ "1. Parse and UI path", "md_README.html#autotoc_md24", null ],
|
||||
[ "2. Runtime decode path", "md_README.html#autotoc_md25", null ]
|
||||
] ],
|
||||
[ "Why the Runtime Decode Layer Exists", "md_README.html#autotoc_md7", null ],
|
||||
[ "Module Layout", "md_README.html#autotoc_md9", [
|
||||
[ "Parsed DBC structures", "md_README.html#autotoc_md10", null ],
|
||||
[ "UI tree structures", "md_README.html#autotoc_md11", null ],
|
||||
[ "Runtime decode structures", "md_README.html#autotoc_md12", null ],
|
||||
[ "Runtime decoder", "md_README.html#autotoc_md13", null ],
|
||||
[ "Parser", "md_README.html#autotoc_md14", null ],
|
||||
[ "Demo", "md_README.html#autotoc_md15", null ]
|
||||
[ "Why the Runtime Decode Layer Exists", "md_README.html#autotoc_md27", null ],
|
||||
[ "Module Layout", "md_README.html#autotoc_md29", null ],
|
||||
[ "Parsed Data Structures", "md_README.html#autotoc_md31", null ],
|
||||
[ "<tt>SignalInfo</tt>", "md_README.html#autotoc_md32", null ],
|
||||
[ "<tt>FrameInfo</tt>", "md_README.html#autotoc_md34", null ],
|
||||
[ "<tt>DbcDatabase</tt>", "md_README.html#autotoc_md36", null ],
|
||||
[ "UI Tree Layer", "md_README.html#autotoc_md38", null ],
|
||||
[ "<tt>TreeNode</tt>", "md_README.html#autotoc_md39", null ],
|
||||
[ "Runtime Decode Layer", "md_README.html#autotoc_md41", null ],
|
||||
[ "Purpose", "md_README.html#autotoc_md42", null ],
|
||||
[ "<tt>ByteOrder</tt>", "md_README.html#autotoc_md44", null ],
|
||||
[ "<tt>ValueType</tt>", "md_README.html#autotoc_md46", null ],
|
||||
[ "<tt>DecodeSignal</tt>", "md_README.html#autotoc_md48", null ],
|
||||
[ "<tt>DecodeFrame</tt>", "md_README.html#autotoc_md50", null ],
|
||||
[ "<tt>FrameKey</tt>", "md_README.html#autotoc_md52", null ],
|
||||
[ "<tt>DecodeDatabase</tt>", "md_README.html#autotoc_md54", null ],
|
||||
[ "Decoder Layer", "md_README.html#autotoc_md56", null ],
|
||||
[ "<tt>RawCanFrame</tt>", "md_README.html#autotoc_md57", null ],
|
||||
[ "<tt>DecodedSignalValue</tt>", "md_README.html#autotoc_md59", [
|
||||
[ "Raw value representation and precision", "md_README.html#autotoc_md61", null ]
|
||||
] ],
|
||||
[ "Parsed Data Structures", "md_README.html#autotoc_md17", null ],
|
||||
[ "<tt>SignalInfo</tt>", "md_README.html#autotoc_md18", null ],
|
||||
[ "<tt>FrameInfo</tt>", "md_README.html#autotoc_md20", null ],
|
||||
[ "<tt>DbcDatabase</tt>", "md_README.html#autotoc_md22", null ],
|
||||
[ "UI Tree Layer", "md_README.html#autotoc_md24", null ],
|
||||
[ "<tt>TreeNode</tt>", "md_README.html#autotoc_md25", null ],
|
||||
[ "Runtime Decode Layer", "md_README.html#autotoc_md27", null ],
|
||||
[ "Purpose", "md_README.html#autotoc_md28", null ],
|
||||
[ "<tt>ByteOrder</tt>", "md_README.html#autotoc_md30", null ],
|
||||
[ "<tt>ValueType</tt>", "md_README.html#autotoc_md32", null ],
|
||||
[ "<tt>DecodeSignal</tt>", "md_README.html#autotoc_md34", null ],
|
||||
[ "<tt>DecodeFrame</tt>", "md_README.html#autotoc_md36", null ],
|
||||
[ "<tt>FrameKey</tt>", "md_README.html#autotoc_md38", null ],
|
||||
[ "<tt>DecodeDatabase</tt>", "md_README.html#autotoc_md40", null ],
|
||||
[ "Decoder Layer", "md_README.html#autotoc_md42", null ],
|
||||
[ "<tt>RawCanFrame</tt>", "md_README.html#autotoc_md43", null ],
|
||||
[ "<tt>DecodedSignalValue</tt>", "md_README.html#autotoc_md45", [
|
||||
[ "Raw value representation and precision", "md_README.html#autotoc_md47", null ]
|
||||
[ "<tt>DecodedFrameValue</tt>", "md_README.html#autotoc_md63", null ],
|
||||
[ "<tt>DbcDecoder</tt>", "md_README.html#autotoc_md65", null ],
|
||||
[ "Parser Support", "md_README.html#autotoc_md67", null ],
|
||||
[ "Supported DBC Syntax", "md_README.html#autotoc_md69", null ],
|
||||
[ "Frame definition", "md_README.html#autotoc_md70", [
|
||||
[ "Frame validation and parse errors", "md_README.html#autotoc_md72", null ]
|
||||
] ],
|
||||
[ "<tt>DecodedFrameValue</tt>", "md_README.html#autotoc_md49", null ],
|
||||
[ "<tt>DbcDecoder</tt>", "md_README.html#autotoc_md51", null ],
|
||||
[ "Parser Support", "md_README.html#autotoc_md53", null ],
|
||||
[ "Supported DBC Syntax", "md_README.html#autotoc_md55", null ],
|
||||
[ "Frame definition", "md_README.html#autotoc_md56", [
|
||||
[ "Frame validation and parse errors", "md_README.html#autotoc_md58", null ]
|
||||
[ "Signal definition", "md_README.html#autotoc_md74", [
|
||||
[ "Signal validation and parse errors", "md_README.html#autotoc_md76", null ]
|
||||
] ],
|
||||
[ "Signal definition", "md_README.html#autotoc_md60", [
|
||||
[ "Signal validation and parse errors", "md_README.html#autotoc_md62", null ]
|
||||
[ "Basic multiplexing", "md_README.html#autotoc_md78", null ],
|
||||
[ "Comments", "md_README.html#autotoc_md80", null ],
|
||||
[ "CAN ID Normalization", "md_README.html#autotoc_md82", null ],
|
||||
[ "PGN Extraction", "md_README.html#autotoc_md84", null ],
|
||||
[ "Decode Flow", "md_README.html#autotoc_md86", null ],
|
||||
[ "Intel and Motorola Extraction", "md_README.html#autotoc_md88", null ],
|
||||
[ "Example Usage", "md_README.html#autotoc_md90", [
|
||||
[ "Parse DBC", "md_README.html#autotoc_md91", null ],
|
||||
[ "Build UI tree", "md_README.html#autotoc_md92", null ],
|
||||
[ "Build runtime decode database", "md_README.html#autotoc_md93", null ],
|
||||
[ "Decode a raw frame", "md_README.html#autotoc_md94", null ]
|
||||
] ],
|
||||
[ "Comments", "md_README.html#autotoc_md64", null ],
|
||||
[ "CAN ID Normalization", "md_README.html#autotoc_md66", null ],
|
||||
[ "PGN Extraction", "md_README.html#autotoc_md68", null ],
|
||||
[ "Decode Flow", "md_README.html#autotoc_md70", null ],
|
||||
[ "Intel and Motorola Extraction", "md_README.html#autotoc_md72", null ],
|
||||
[ "Example Usage", "md_README.html#autotoc_md74", null ],
|
||||
[ "Parse DBC", "md_README.html#autotoc_md75", null ],
|
||||
[ "Build UI tree", "md_README.html#autotoc_md76", null ],
|
||||
[ "Build runtime decode database", "md_README.html#autotoc_md77", null ],
|
||||
[ "Decode a raw frame", "md_README.html#autotoc_md78", null ],
|
||||
[ "Unified Decode Strategy", "md_README.html#autotoc_md80", [
|
||||
[ "live path", "md_README.html#autotoc_md81", null ],
|
||||
[ "trace path", "md_README.html#autotoc_md82", null ]
|
||||
[ "Unified Decode Strategy", "md_README.html#autotoc_md96", [
|
||||
[ "live path", "md_README.html#autotoc_md97", null ],
|
||||
[ "trace path", "md_README.html#autotoc_md98", null ]
|
||||
] ],
|
||||
[ "Intended Use in FrameTap", "md_README.html#autotoc_md84", null ],
|
||||
[ "Why the Tree Is Not Enough", "md_README.html#autotoc_md86", null ],
|
||||
[ "Statement Handler Factory", "md_README.html#autotoc_md88", null ],
|
||||
[ "Current Limitations", "md_README.html#autotoc_md90", null ],
|
||||
[ "Recommended Next Steps", "md_README.html#autotoc_md92", [
|
||||
[ "Stage 1 - already implemented", "md_README.html#autotoc_md93", null ],
|
||||
[ "Stage 2", "md_README.html#autotoc_md94", null ],
|
||||
[ "Stage 3", "md_README.html#autotoc_md95", null ],
|
||||
[ "Stage 4", "md_README.html#autotoc_md96", null ]
|
||||
[ "Intended Use in FrameTap", "md_README.html#autotoc_md100", null ],
|
||||
[ "Why the Tree Is Not Enough", "md_README.html#autotoc_md102", null ],
|
||||
[ "Statement Handler Factory", "md_README.html#autotoc_md104", null ],
|
||||
[ "Signal value descriptions (<tt>VAL_</tt>)", "md_README.html#autotoc_md106", null ],
|
||||
[ "Current Limitations", "md_README.html#autotoc_md108", null ],
|
||||
[ "Recommended Next Steps", "md_README.html#autotoc_md110", [
|
||||
[ "Stage 1 - already implemented", "md_README.html#autotoc_md111", null ],
|
||||
[ "Stage 2", "md_README.html#autotoc_md112", null ],
|
||||
[ "Stage 3", "md_README.html#autotoc_md113", null ],
|
||||
[ "Stage 4", "md_README.html#autotoc_md114", null ]
|
||||
] ],
|
||||
[ "Build Integration", "md_README.html#autotoc_md98", null ],
|
||||
[ "Summary", "md_README.html#autotoc_md100", [
|
||||
[ "Parsed representation", "md_README.html#autotoc_md101", null ],
|
||||
[ "Runtime decode representation", "md_README.html#autotoc_md102", null ]
|
||||
[ "Build Integration", "md_README.html#autotoc_md116", [
|
||||
[ "Build core without Qt libraries", "md_README.html#autotoc_md117", null ],
|
||||
[ "Optional Qt model adapter", "md_README.html#autotoc_md118", null ],
|
||||
[ "Standalone tree tests without Qt", "md_README.html#autotoc_md119", null ],
|
||||
[ "Build and run the demo", "md_README.html#autotoc_md120", null ],
|
||||
[ "Generate API documentation", "md_README.html#autotoc_md121", null ]
|
||||
] ],
|
||||
[ "Regression tests", "md_README.html#autotoc_md103", null ]
|
||||
[ "Regression tests", "md_README.html#autotoc_md123", null ],
|
||||
[ "Measuring code coverage", "md_README.html#autotoc_md124", [
|
||||
[ "GCC, gcov, and LCOV on Debian/Ubuntu", "md_README.html#autotoc_md125", null ],
|
||||
[ "Configure the GCC coverage build in Qt Creator", "md_README.html#autotoc_md126", null ]
|
||||
] ]
|
||||
] ],
|
||||
[ "QtTest regression tests", "md_tests_2README.html", [
|
||||
[ "Decoder coverage", "md_tests_2README.html#autotoc_md105", null ],
|
||||
[ "Parser coverage", "md_tests_2README.html#autotoc_md106", null ]
|
||||
[ "Decoder coverage", "md_tests_2README.html#autotoc_md128", null ],
|
||||
[ "Parser coverage", "md_tests_2README.html#autotoc_md129", null ],
|
||||
[ "Tree and optional model tests", "md_tests_2README.html#autotoc_md130", null ],
|
||||
[ "Additional regression coverage", "md_tests_2README.html#autotoc_md131", null ]
|
||||
] ],
|
||||
[ "Classes", "annotated.html", [
|
||||
[ "Class List", "annotated.html", "annotated_dup" ],
|
||||
@@ -126,7 +158,8 @@ var NAVTREE =
|
||||
|
||||
var NAVTREEINDEX =
|
||||
[
|
||||
"annotated.html"
|
||||
"annotated.html",
|
||||
"structSignalInfo.html#ace290724f9801521609aedaa946d61f1"
|
||||
];
|
||||
|
||||
var SYNCONMSG = 'click to disable panel synchronisation';
|
||||
|
||||
Reference in new issue
Block a user