.codebanner.json

{
    "folders": [
        "lib",
        "projects",
        "test"
    ],
    "include_patterns": [
        "*.cpp",
        "*.hpp",
        "*.h",
        "*.c"
    ],
    "exclude_patterns": [
        "projects/platformio/*"
    ],
    "license": "MIT - See LICENSE file",
    "project": "Scrutiny Debugger",
    "repo": "github.com/scrutinydebugger/scrutiny-embedded",
    "copyright_owner": "Scrutiny Debugger",
    "copyright_start_date": "2021",
    "copyright_end_date": null,
    "files": {
        "lib/inc/scrutiny.hpp": {
            "docstring": "Main .h file to be included in a project"
        },
        "lib/inc/scrutiny_config.hpp": {
            "docstring": "Definition of a run-time configuration of the scrutiny module.\nTo be filled in startup phase"
        },
        "lib/inc/scrutiny_loop_handler.hpp": {
            "docstring": "LoopHandler definition.\nLoop Handler is to be run in a specific time domain and will make some features available that depends on the execution requency such as embedded datalogging"
        },
        "lib/inc/scrutiny_main_handler.hpp": {
            "docstring": "The main scrutiny class to be manipulated by the user"
        },
        "lib/inc/scrutiny_setup.hpp": {
            "docstring": "Compile-time configuration of embedded Scrutiny module.\nThis configuration is global for the module and should be set once per project"
        },
        "lib/inc/scrutiny_software_id.hpp": {
            "docstring": "Contains the definition of the Scrutiny ID global var used for tagging of firmware."
        },
        "lib/inc/scrutiny_timebase.hpp": {
            "docstring": "Minimalist helper to keep track of time"
        },
        "lib/inc/scrutiny_types.hpp": {
            "docstring": "Aliases on the types used by the Scrutiny project"
        },
        "lib/inc/protocol/scrutiny_codec_v1_0.hpp": {
            "docstring": "Definitions of encode/decode functions for the scrutiny protocol V1.0"
        },
        "lib/inc/protocol/scrutiny_comm_handler.hpp": {
            "docstring": "Manage the tranport-ish layer of the communication protocol. Converts Request/Response to byte stream and validate CRC"
        },
        "lib/inc/protocol/scrutiny_protocol.hpp": {
            "docstring": "Main include file for the scrutiny protocol"
        },
        "lib/inc/protocol/scrutiny_protocol_definitions.hpp": {
            "docstring": "Defines Request/Rsponse objects and commands/subfunctions IDs.\n Not version specific"
        },
        "lib/src/scrutiny_config.cpp": {
            "docstring": "Implementation of the run-time Scrutiny configuration"
        },
        "lib/src/scrutiny_loop_handler.cpp": {
            "docstring": "LoopHandler implementation.\nLoop Handler is to be run in a specific time domain and will make some features available that depends on the execution requency such as embedded datalogging"
        },
        "lib/src/scrutiny_main_handler.cpp": {
            "docstring": "The main scrutiny class to be manipulated by the user."
        },
        "lib/src/scrutiny_software_id.cpp": {
            "docstring": "Instanciation of the global ID used for firmware tagging"
        },
        "lib/src/protocol/scrutiny_codec_v1_0.cpp": {
            "docstring": "Encode/Decode functions for the Scrutiny Protocol V1.0"
        },
        "lib/src/protocol/scrutiny_comm_handler.cpp": {
            "docstring": "Manage the tranport-ish layer of the communication protocol. Converts Request/Response to byte stream and validate CRC"
        },
        "lib/src/protocol/scrutiny_protocol_definitions.cpp": {
            "docstring": "Instanciation of protocol definitions such as magic payload."
        },
        "test/scrutiny_test.cpp": {
            "docstring": "Base class for CPP unit tests.\n All test should inherit this class.\n Includes bunch of helper for easy testing."
        },
        "test/test_crc.cpp": {
            "docstring": "Test CRC calculation"
        },
        "test/test_timebase.cpp": {
            "docstring": "Test our minimalist time tracker"
        },
        "test/scrutiny_test.hpp": {
            "docstring": "Base class for CPP unit tests.\n All test should inherit this class.\n Includes bunch of helper for easy testing."
        },
        "test/commands/test_comm_control.cpp": {
            "docstring": "Test the behaviour of the embedded module when CommControl commands are received"
        },
        "test/commands/test_get_info.cpp": {
            "docstring": "Test the behaviour of the embedded module when GetInfo commands are received"
        },
        "test/commands/test_memory_control.cpp": {
            "docstring": "Test the behaviour of the embedded module when MemoryControl commands are received"
        },
        "test/commands/test_user_command.cpp": {
            "docstring": "Test the behaviour of the embedded module when UserCommand commands are received"
        },
        "test/protocol/test_comm_handler.cpp": {
            "docstring": "Test the tranport-ish layer good behaviour at high level."
        },
        "test/protocol/test_protocol_rx_parsing.cpp": {
            "docstring": "Make sure reception of request bytes are correctly decoded"
        },
        "test/protocol/test_protocol_tx_parsing.cpp": {
            "docstring": "Make sure Response objects are correctly encoded in bytes"
        },
        "lib/inc/scrutiny_tools.hpp": {
            "docstring": "Some simple tools used across the project"
        },
        "projects/testapp/src/file1.cpp": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/testapp/src/argument_parser.cpp": {
            "docstring": "For CLI parsing"
        },
        "projects/testapp/src/main.cpp": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/testapp/src/file2.cpp": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/testapp/src/file3.cpp": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/testapp/src/comm_channels/udp_bridge.cpp": {
            "docstring": "Class that open a UDP port and handle a single client."
        },
        "projects/testapp/include/file1.hpp": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/testapp/include/file2.hpp": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/testapp/include/file3.hpp": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/testapp/include/comm_channels/udp_bridge.hpp": {
            "docstring": "Class that open a UDP port and handle a single client."
        },
        "projects/testapp/include/argument_parser.hpp": {
            "docstring": "For CLI parsing"
        },
        "projects/testapp/include/comm_channels/abstract_comm_channel.hpp": {
            "docstring": "Define the interface for a communication channel used by the testapp to run the scrutiny embedded lib"
        },
        "projects/testapp/include/comm_channels/nix_serial_port_bridge.hpp": {
            "docstring": "Class that make a *Nix Serial port available as a communication channel for the Testapp"
        },
        "projects/testapp/include/comm_channels/win_serial_port_bridge.hpp": {
            "docstring": "Class that make a Windows Serial port available as a communication channel for the Testapp"
        },
        "projects/testapp/src/comm_channels/nix_serial_port_bridge.cpp": {
            "docstring": "Class that make a *Nix Serial port available as a communication channel for the Testapp"
        },
        "projects/testapp/src/comm_channels/win_serial_port_bridge.cpp": {
            "docstring": "Class that make a Windows Serial port available as a communication channel for the Testapp"
        },
        "lib/inc/scrutiny_common_codecs.hpp": {
            "docstring": "Some codecs function used across the project"
        },
        "lib/inc/scrutiny_ipc.hpp": {
            "docstring": "Some tools for inter-process communications"
        },
        "lib/inc/datalogging/scrutiny_datalogging.hpp": {
            "docstring": "The datalogging main include"
        },
        "lib/inc/datalogging/scrutiny_datalogging_types.hpp": {
            "docstring": "Types used across datalogging feature"
        },
        "lib/inc/datalogging/scrutiny_datalogging_trigger.hpp": {
            "docstring": "The definition of the datalogging trigger conditions operators"
        },
        "lib/inc/datalogging/scrutiny_datalogger.hpp": {
            "docstring": "The definition of the datalogger object that should exist in each loop"
        },
        "lib/src/scrutiny_tools.cpp": {
            "docstring": "Some tools used across the project"
        },
        "lib/src/scrutiny_common_codecs.cpp": {
            "docstring": "Some common encoding/decoding functions used across the project."
        },
        "lib/src/datalogging/scrutiny_datalogger.cpp": {
            "docstring": "The implementation of the datalogger object that should exist in each loop "
        },
        "lib/src/datalogging/datalogging.cpp": {
            "docstring": "Implementation of some datalogging features"
        },
        "projects/testapp/src/include_test.cpp": {
            "docstring": "Just a file that make sure that we can include scrutiny.hpp in a blank file without breaking anything"
        },
        "test/test_ipc.cpp": {
            "docstring": "Test for the Inter-process communication tools"
        },
        "test/test_variable_fetching.cpp": {
            "docstring": "Test the capacity to read a variable from the memory given the debugging info"
        },
        "test/test_types.cpp": {
            "docstring": "Some tests dones on scrutiny types"
        },
        "test/commands/test_memory_control_rpv.cpp": {
            "docstring": "Test the memory control command dedicated for Runtime Published Values"
        },
        "test/datalogging/test_fetch_operands.cpp": {
            "docstring": "Test the capacity to decode an operand for log trigger"
        },
        "lib/src/datalogging/scrutiny_datalogging_trigger.cpp": {
            "docstring": "The implementation of the datalogging trigger conditions operators"
        },
        "test/datalogging/test_trigger_conditions.cpp": {
            "docstring": "Test datalogging trigger conditions"
        },
        "test/datalogging/test_datalogging_types.cpp": {
            "docstring": "Run some tests on datalogging types"
        },
        "lib/inc/datalogging/scrutiny_datalogging_data_encoding.hpp": {
            "docstring": "File to be included to get access to the datalogging encoders/readers. Abstract the handling of different encoding."
        },
        "lib/inc/datalogging/scrutiny_datalogger_raw_encoder.hpp": {
            "docstring": "Class that handles the encoding of the datalogger data. RawFormat just copy to memory, no encoding scheme."
        },
        "lib/src/datalogging/scrutiny_datalogger_raw_encoder.cpp": {
            "docstring": "Class that handles the encoding of the datalogger data. RawFormat just copy to memory, no encoding scheme."
        },
        "test/test_codecs.cpp": {
            "docstring": "Tests the different codecs function used across this project"
        },
        "test/commands/test_datalog_control.cpp": {
            "docstring": "Test the DataLogControl command used to configure, control and reads the datalogger"
        },
        "test/datalogging/test_datalogger.cpp": {
            "docstring": "Test suite for the datalogger object. Test its capacity to log, trigger access bitfields and report error on bad config."
        },
        "test/datalogging/raw_format_parser.hpp": {
            "docstring": "Class that can reads the data encoded by the datalogging encoder. It does what the server would do for testing purpose"
        },
        "test/datalogging/test_raw_encoder.cpp": {
            "docstring": "Test suite for the RawFormat encoder."
        },
        "test/datalogging/raw_format_parser.cpp": {
            "docstring": "Class that can reads the data encoded by the datalogging encoder. It does what the server would do for testing purpose"
        },
        "lib/inc/static_analysis_build_config.hpp": {
            "docstring": "Stubbed configuration file used for static analysis with hardcoded values instead of values coming from cmake"
        },
        "lib/inc/scrutiny_c_compatible_types.h": {
            "docstring": "Types declaration that are valid in both C and C++. The C++ library extend them, the C-Wrapper uses them directly"
        },
        "projects/c_testapp/include/argument_parser.h": {
            "docstring": "For CLI parsing"
        },
        "projects/c_testapp/include/tools.h": {
            "docstring": "Some tools used across the C TestApp project"
        },
        "projects/c_testapp/include/comm_channels/abstract_comm_channel.h": {
            "docstring": "Define the interface for a communication channel used by the testapp to run the scrutiny embedded lib"
        },
        "projects/c_testapp/include/comm_channels/nix_serial_port_bridge.h": {
            "docstring": "Serial interface fopr the C testapp. Used to talk with the server"
        },
        "projects/c_testapp/include/comm_channels/udp_bridge.h": {
            "docstring": "UDP interface fopr the C testapp. Used to talk with the server"
        },
        "projects/c_testapp/include/comm_channels/win_serial_port_bridge.h": {
            "docstring": "Serial interface fopr the C testapp. Used to talk with the server"
        },
        "projects/c_testapp/src/main.c": {
            "docstring": "Entry point of C TestApp"
        },
        "projects/c_testapp/src/argument_parser.c": {
            "docstring": "For CLI parsing"
        },
        "projects/c_testapp/src/include_test.c": {
            "docstring": "Just a file that make sure that we can include scrutiny.hpp in a blank file without breaking anything"
        },
        "projects/c_testapp/src/comm_channels/win_serial_port_bridge.c": {
            "docstring": "Serial interface fopr the C testapp. Used to talk with the server"
        },
        "projects/c_testapp/src/comm_channels/nix_serial_port_bridge.c": {
            "docstring": "Serial interface fopr the C testapp. Used to talk with the server"
        },
        "projects/c_testapp/src/comm_channels/udp_bridge.c": {
            "docstring": "UDP interface fopr the C testapp. Used to talk with the server"
        },
        "projects/c_testapp/include/file2.h": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/c_testapp/include/file1.h": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/c_testapp/src/file1.c": {
            "docstring": "Placeholder file for variable extraction test"
        },
        "projects/c_testapp/src/file2.c": {
            "docstring": "Placeholder file for variable extraction test"
        }
    }
}