diff options
Diffstat (limited to 'src/can/can-message.cpp')
| -rw-r--r-- | src/can/can-message.cpp | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/src/can/can-message.cpp b/src/can/can-message.cpp index 71e4879..68279e2 100644 --- a/src/can/can-message.cpp +++ b/src/can/can-message.cpp @@ -38,7 +38,7 @@ can_message_t::can_message_t() /** * @brief Retrieve id_ member value. * -* @return uint32_t id_ class member +* @return id_ class member */ uint32_t can_message_t::get_id() const { @@ -48,7 +48,7 @@ uint32_t can_message_t::get_id() const /** * @brief Retrieve RTR flag member. * -* @return bool rtr_flags_ class member +* @return rtr_flags_ class member */ bool can_message_t::get_rtr_flag_() const { @@ -58,7 +58,7 @@ bool can_message_t::get_rtr_flag_() const /** * @brief Retrieve format_ member value. * -* @return CanMessageFormat format_ class member +* @return format_ class member */ int can_message_t::get_format() const { @@ -68,9 +68,9 @@ int can_message_t::get_format() const } /** -* @brief Retrieve format_ member value. +* @brief Retrieve flags_ member value. * -* @return CanMessageFormat format_ class member +* @return flags_ class member */ uint8_t can_message_t::get_flags() const { @@ -80,7 +80,7 @@ uint8_t can_message_t::get_flags() const /** * @brief Retrieve data_ member value. * -* @return uint8_t data_ pointer to the first element +* @return pointer to the first element * of class member data_ */ const uint8_t* can_message_t::get_data() const @@ -91,7 +91,7 @@ const uint8_t* can_message_t::get_data() const /** * @brief Retrieve length_ member value. * -* @return uint8_t length_ class member +* @return length_ class member */ uint8_t can_message_t::get_length() const { @@ -122,7 +122,7 @@ void can_message_t::set_max_data_length(size_t nbytes) * @brief Control whether the object is correctly initialized * to be sent over the CAN bus * -* @return true if object correctly initialized and false if not... +* @return true if object correctly initialized and false if not. */ bool can_message_t::is_correct_to_send() { @@ -142,7 +142,7 @@ bool can_message_t::is_correct_to_send() * Preferred way to initialize these members by using * convert_from_canfd_frame method. * -* @param uint32_t id_ class member +* @param[in] id_ class member */ void can_message_t::set_id_and_format(const uint32_t new_id) { @@ -170,7 +170,7 @@ void can_message_t::set_id_and_format(const uint32_t new_id) * Preferred way to initialize these members by using * convert_from_canfd_frame method. * -* @param CanMessageFormat format_ class member +* @param[in] new_format - class member */ void can_message_t::set_format(const CanMessageFormat new_format) { @@ -181,13 +181,13 @@ void can_message_t::set_format(const CanMessageFormat new_format) } /** -* @brief Set format_ member value. Deducing from the can_id +* @brief Set format_ member value. Deduced from the can_id * of a canfd_frame. * * Preferred way to initialize these members by using * convert_from_canfd_frame method. * -* @param uint32_t can_id integer from a canfd_frame +* @param[in] can_id - integer from a canfd_frame */ void can_message_t::set_format(const uint32_t can_id) { @@ -205,7 +205,7 @@ void can_message_t::set_format(const uint32_t can_id) * Preferred way to initialize these members by using * convert_from_canfd_frame method. * -* @param CanMessageFormat format_ class member +* @param[in] format_ - class member */ void can_message_t::set_flags(const uint8_t flags) { @@ -218,7 +218,7 @@ void can_message_t::set_flags(const uint8_t flags) * Preferred way to initialize these members by using * convert_from_canfd_frame method. * -* @param uint8_t length_ array with a max size of 8 elements. +* @param[in] new_length - array with a max size of 8 elements. */ void can_message_t::set_length(const uint8_t new_length) { @@ -236,7 +236,7 @@ void can_message_t::set_length(const uint8_t new_length) * Preferred way to initialize these members by using * convert_from_canfd_frame method. * -* @param uint8_t data_ array with a max size of 8 elements. +* @param[in] new_data - array with a max size of 8 elements. */ void can_message_t::set_data(const __u8* new_data) { @@ -255,9 +255,9 @@ void can_message_t::set_data(const __u8* new_data) * * This is the preferred way to initialize class members. * -* @param canfd_frame struct read from can bus device. +* @param[in] args - struct read from can bus device. */ -void can_message_t::convert_from_canfd_frame(const std::pair<struct canfd_frame&, size_t>args) +void can_message_t::convert_from_canfd_frame(const std::pair<struct canfd_frame&, size_t> args) { // May be it's overkill to assign member of the pair... May be it will change... struct canfd_frame frame = args.first; |