updated documentation
This commit is contained in:
121
docs/html/navtreedata.js
Normal file
121
docs/html/navtreedata.js
Normal file
@@ -0,0 +1,121 @@
|
||||
/*
|
||||
@licstart The following is the entire license notice for the JavaScript code in this file.
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (C) 1997-2020 by Dimitri van Heesch
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software
|
||||
and associated documentation files (the "Software"), to deal in the Software without restriction,
|
||||
including without limitation the rights to use, copy, modify, merge, publish, distribute,
|
||||
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or
|
||||
substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
|
||||
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
||||
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
@licend The above is the entire license notice for the JavaScript code in this file
|
||||
*/
|
||||
var NAVTREE =
|
||||
[
|
||||
[ "DBC Framework", "index.html", [
|
||||
[ "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 ]
|
||||
] ],
|
||||
[ "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 ]
|
||||
] ],
|
||||
[ "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", null ],
|
||||
[ "<tt>DecodedFrameValue</tt>", "md_README.html#autotoc_md47", null ],
|
||||
[ "<tt>DbcDecoder</tt>", "md_README.html#autotoc_md49", null ],
|
||||
[ "Parser Support", "md_README.html#autotoc_md51", null ],
|
||||
[ "Supported DBC Syntax", "md_README.html#autotoc_md53", null ],
|
||||
[ "Frame definition", "md_README.html#autotoc_md54", null ],
|
||||
[ "Signal definition", "md_README.html#autotoc_md56", null ],
|
||||
[ "Comments", "md_README.html#autotoc_md58", null ],
|
||||
[ "CAN ID Normalization", "md_README.html#autotoc_md60", null ],
|
||||
[ "PGN Extraction", "md_README.html#autotoc_md62", null ],
|
||||
[ "Decode Flow", "md_README.html#autotoc_md64", null ],
|
||||
[ "Intel and Motorola Extraction", "md_README.html#autotoc_md66", null ],
|
||||
[ "Example Usage", "md_README.html#autotoc_md68", null ],
|
||||
[ "Parse DBC", "md_README.html#autotoc_md69", null ],
|
||||
[ "Build UI tree", "md_README.html#autotoc_md70", null ],
|
||||
[ "Build runtime decode database", "md_README.html#autotoc_md71", null ],
|
||||
[ "Decode a raw frame", "md_README.html#autotoc_md72", null ],
|
||||
[ "Unified Decode Strategy", "md_README.html#autotoc_md74", [
|
||||
[ "live path", "md_README.html#autotoc_md75", null ],
|
||||
[ "trace path", "md_README.html#autotoc_md76", null ]
|
||||
] ],
|
||||
[ "Intended Use in FrameTap", "md_README.html#autotoc_md78", null ],
|
||||
[ "Why the Tree Is Not Enough", "md_README.html#autotoc_md80", null ],
|
||||
[ "Why No Abstract Factory Is Used", "md_README.html#autotoc_md82", null ],
|
||||
[ "Current Limitations", "md_README.html#autotoc_md84", null ],
|
||||
[ "Recommended Next Steps", "md_README.html#autotoc_md86", [
|
||||
[ "Stage 1 - already implemented", "md_README.html#autotoc_md87", null ],
|
||||
[ "Stage 2", "md_README.html#autotoc_md88", null ],
|
||||
[ "Stage 3", "md_README.html#autotoc_md89", null ],
|
||||
[ "Stage 4", "md_README.html#autotoc_md90", null ]
|
||||
] ],
|
||||
[ "Build Integration", "md_README.html#autotoc_md92", null ],
|
||||
[ "Summary", "md_README.html#autotoc_md94", [
|
||||
[ "Parsed representation", "md_README.html#autotoc_md95", null ],
|
||||
[ "Runtime decode representation", "md_README.html#autotoc_md96", null ]
|
||||
] ]
|
||||
] ],
|
||||
[ "Classes", "annotated.html", [
|
||||
[ "Class List", "annotated.html", "annotated_dup" ],
|
||||
[ "Class Index", "classes.html", null ],
|
||||
[ "Class Members", "functions.html", [
|
||||
[ "All", "functions.html", null ],
|
||||
[ "Functions", "functions_func.html", null ],
|
||||
[ "Variables", "functions_vars.html", null ]
|
||||
] ]
|
||||
] ],
|
||||
[ "Files", "files.html", [
|
||||
[ "File List", "files.html", "files_dup" ],
|
||||
[ "File Members", "globals.html", [
|
||||
[ "All", "globals.html", null ],
|
||||
[ "Enumerations", "globals_enum.html", null ]
|
||||
] ]
|
||||
] ]
|
||||
] ]
|
||||
];
|
||||
|
||||
var NAVTREEINDEX =
|
||||
[
|
||||
"annotated.html"
|
||||
];
|
||||
|
||||
var SYNCONMSG = 'click to disable panel synchronisation';
|
||||
var SYNCOFFMSG = 'click to enable panel synchronisation';
|
||||
Reference in New Issue
Block a user