diff options
| author |   Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2018-05-25 18:53:52 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@automotivelinux.org> | 2018-05-25 18:53:52 +0000 |
| commit | 88befdfd812a58fb7a36e090278ad1e70003e925 (patch) | |
| tree | dd04c9b6d8d6e534e0c2687250b18a006964bd18 /low-can-binding/can/can-decoder.cpp | |
| parent | 438bf4912a1174c63fac77fe72e3b320c589f431 (diff) | |
| parent | 2eb313e5330dbfa1b6eab146b3698d8ffe054347 (diff) | |
Merge "Fixing typos made in comments"flounder_5.99.1flounder/5.99.15.99.1
Diffstat (limited to 'low-can-binding/can/can-decoder.cpp')
| -rw-r--r-- | low-can-binding/can/can-decoder.cpp | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/low-can-binding/can/can-decoder.cpp b/low-can-binding/can/can-decoder.cpp index 0c81d7a6..763bfcb0 100644 --- a/low-can-binding/can/can-decoder.cpp +++ b/low-can-binding/can/can-decoder.cpp @@ -22,10 +22,10 @@ #include "can-message-definition.hpp" #include "../binding/low-can-hat.hpp" -/// @brief Parse the signal's bitfield from the given data and return the raw +/// @brief Parses the signal's bitfield from the given data and returns the raw /// value. /// -/// @param[in] signal - The signal to parse from the data. +/// @param[in] signal - The signal to be parsed from the data. /// @param[in] message - can_message_t to parse /// /// @return Returns the raw value of the signal parsed as a bitfield from the given byte @@ -38,7 +38,7 @@ float decoder_t::parse_signal_bitfield(can_signal_t& signal, const can_message_t signal.get_offset()); } -/// @brief Wrap a raw CAN signal value in a DynamicField without modification. +/// @brief Wraps a raw CAN signal value in a DynamicField without modification. /// /// This is an implementation of the Signal type signature, and can be /// used directly in the can_signal_t.decoder field. |