Skip to content

Commit

Permalink
fixing parameter for doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
Abyl Ikhsanov committed Feb 16, 2024
1 parent 360e07e commit 83c08f5
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion isobus/include/isobus/isobus/can_message.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -248,11 +248,12 @@ namespace isobus
/// @return True if (all) the bit(s) are set, false otherwise
bool get_bool_at(const std::uint32_t byteIndex, const std::uint8_t bitIndex, const std::uint8_t length = 1) const;


/// @brief Get a 64-bit unsinged integer from the buffer at a specific index but custom length
/// Why 64 bit? Because we do not know the length and it could be 10 bits or 54 so better to convert everything into 64 bit
/// @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] startBitIndex The index to get the 64-bit unsigned integer from
/// @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
Expand Down

0 comments on commit 83c08f5

Please sign in to comment.