From 360e07edbd985652aba0a996768de2faf4c20c59 Mon Sep 17 00:00:00 2001 From: Abyl Ikhsanov Date: Fri, 16 Feb 2024 10:35:16 +0100 Subject: [PATCH] doxygen style comments --- isobus/include/isobus/isobus/can_message.hpp | 2 +- test/can_message_tests.cpp | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/isobus/include/isobus/isobus/can_message.hpp b/isobus/include/isobus/isobus/can_message.hpp index 990504db..675ebea1 100644 --- a/isobus/include/isobus/isobus/can_message.hpp +++ b/isobus/include/isobus/isobus/can_message.hpp @@ -253,7 +253,7 @@ namespace isobus /// @details This function will return 8 bytes at a specified index in the buffer but custom bit length /// We are iterating by full bytes (assembling a full byte) and shifting it into the final 64-bit value to return /// @param[in] index The index to get the 64-bit unsigned integer from - /// @param[in] length The length of bits to exctract from the buffer + /// @param[in] length The length of bits to extract from the buffer /// @param[in] format The byte format to use when reading the integer /// @return The 64-bit unsigned integer std::uint64_t get_data_custom_length(const std::uint32_t startBitIndex, const std::uint32_t length, const ByteFormat format = ByteFormat::LittleEndian) const; diff --git a/test/can_message_tests.cpp b/test/can_message_tests.cpp index 8637c73d..f5198447 100644 --- a/test/can_message_tests.cpp +++ b/test/can_message_tests.cpp @@ -51,7 +51,8 @@ TEST(CAN_MESSAGE_TESTS, DataCorrectnessTest) CANNetworkManager::CANNetwork.add_global_parameter_group_number_callback(0xE100, callback, nullptr); CANMessageFrame testFrame = {}; - testFrame.identifier = 0x18EEFFAA; /// So it could be added to the ControlFunction list + // First we are sending with EE00 PGN so manager could add to its control function list + testFrame.identifier = 0x18EEFFAA; testFrame.isExtendedFrame = true; testFrame.dataLength = 8; testFrame.data[0] = 0x01;