doxygen style comments

Open-Agriculture · Feb 16, 2024 · 360e07e · 360e07e
1 parent 2a2f7f9
commit 360e07e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git 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
@@ -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;