diff options
| author |   ydimitrov <y.dimitrov.14@gmail.com> | 2018-05-18 21:12:14 +0100 |
|---|---|---|
| committer | Yordan Dimitrov <y.dimitrov.14@gmail.com> | 2018-05-24 17:55:07 +0300 |
| commit | 2eb313e5330dbfa1b6eab146b3698d8ffe054347 (patch) | |
| tree | 0f17f7672995a800014fd7c3bf2c4a2c7d363b22 /low-can-binding/can/can-decoder.cpp | |
| parent | 985fe9e5689a8c411fdd69d044e5ba4d9e4955bf (diff) | |
Fixing typos made in comments
This change set fixes the comments made by previous contributors
v2: Fix line end
v3: Making changes to comments as suggested by reviewers
v4: Removing trailing spaces
v5: Clearing small typo in low-can-cb.cpp on line 142
Change-Id: Ifbcfc3b2d131d1db0b25e472955b21e98cc09f45
Signed-off-by: ydimitrov <y.dimitrov.14@gmail.com>
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. |