Update doc revision and pdf cover.

[apps/agl-service-can-low-level.git] / CAN-binder / low-can-binding / can / can-message.cpp

diff --git a/CAN-binder/low-can-binding/can/can-message.cpp b/CAN-binder/low-can-binding/can/can-message.cpp
index 9389494..057bc71 100644 (file)
--- a/CAN-binder/low-can-binding/can/can-message.cpp
+++ b/CAN-binder/low-can-binding/can/can-message.cpp
@@ -84,7 +84,7 @@ bool can_message_t::get_rtr_flag_() const
 ///
 /// @brief Retrieve format_ member value.
 ///
-/// @return format_ class member
+/// @return format_ class member. Default to INVALID.
 ///
 can_message_format_t can_message_t::get_format() const
 {
@@ -149,12 +149,10 @@ void can_message_t::set_timestamp(uint64_t timestamp)
        timestamp_ = timestamp;
 }
 
-///
 /// @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()
 {
        if (id_ != 0 && length_ != 0 && format_ != can_message_format_t::INVALID)
@@ -167,20 +165,18 @@ bool can_message_t::is_correct_to_send()
        return false;
 }
 
-///
 /// @brief Set format_ member value.
 ///
 /// Preferred way to initialize these members by using
 /// convert_from_canfd_frame method.
 ///
 /// @param[in] new_format - class member
-///
 void can_message_t::set_format(const can_message_format_t new_format)
 {
        if(new_format == can_message_format_t::STANDARD || new_format == can_message_format_t::EXTENDED || new_format == can_message_format_t::INVALID)
                format_ = new_format;
        else
-               ERROR(binder_interface, "%s: Can set format, wrong format chosen", __FUNCTION__);
+               ERROR("Can set format, wrong format chosen");
 }
 
 /// @brief Take a canfd_frame struct to initialize class members
@@ -191,7 +187,6 @@ void can_message_t::set_format(const can_message_format_t new_format)
 /// @param[in] nbytes - bytes read from socket read operation.
 ///
 /// @return A can_message_t object fully initialized with canfd_frame values.
-///
 can_message_t can_message_t::convert_from_frame(const struct canfd_frame& frame, size_t nbytes, uint64_t timestamp)
 {
        uint8_t maxdlen, length, flags = (uint8_t)NULL;
@@ -203,15 +198,15 @@ can_message_t can_message_t::convert_from_frame(const struct canfd_frame& frame,
        switch(nbytes)
        {
                case CANFD_MTU:
-                       DEBUG(binder_interface, "%s: Got an CAN FD frame", __FUNCTION__);
+                       DEBUG("Got an CAN FD frame");
                        maxdlen = CANFD_MAX_DLEN;
                        break;
                case CAN_MTU:
-                       DEBUG(binder_interface, "%s: Got a legacy CAN frame", __FUNCTION__);
+                       DEBUG("Got a legacy CAN frame");
                        maxdlen = CAN_MAX_DLEN;
                        break;
                default:
-                       ERROR(binder_interface, "%s: unsupported CAN frame", __FUNCTION__);
+                       ERROR("unsupported CAN frame");
                        break;
        }
 
@@ -265,13 +260,21 @@ can_message_t can_message_t::convert_from_frame(const struct canfd_frame& frame,
                                data.push_back(frame.data[i]);
                        };
 
-               DEBUG(binder_interface, "%s: Found id: %X, format: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X", __FUNCTION__,
+               DEBUG("Found id: %X, format: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X",
                                                                id, (uint8_t)format, length, data[0], data[1], data[2], data[3], data[4], data[5], data[6], data[7]);
        }
 
        return can_message_t(maxdlen, id, length, format, rtr_flag, flags, data, timestamp);
 }
 
+/// @brief Take a can_frame struct to initialize class members
+///
+/// This is the preferred way to initialize class members.
+///
+/// @param[in] frame - can_frame to convert coming from a read of CAN socket
+/// @param[in] nbytes - bytes read from socket read operation.
+///
+/// @return A can_message_t object fully initialized with can_frame values.
 can_message_t can_message_t::convert_from_frame(const struct can_frame& frame, size_t nbytes, uint64_t timestamp)
 {
        uint8_t maxdlen, length, flags = (uint8_t)NULL;
@@ -282,12 +285,12 @@ can_message_t can_message_t::convert_from_frame(const struct can_frame& frame, s
 
        if(nbytes <= CAN_MTU)
        {
-                       DEBUG(binder_interface, "%s: Got a legacy CAN frame", __FUNCTION__);
+                       DEBUG("Got a legacy CAN frame");
                        maxdlen = CAN_MAX_DLEN;
        }
        else
        {
-                       ERROR(binder_interface, "%s: unsupported CAN frame", __FUNCTION__);
+                       ERROR("unsupported CAN frame");
        }
 
        if (frame.can_id & CAN_ERR_FLAG)
@@ -336,20 +339,18 @@ can_message_t can_message_t::convert_from_frame(const struct can_frame& frame, s
                                data.push_back(frame.data[i]);
                        };
 
-//             DEBUG(binder_interface, "%s: Found id: %X, format: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X", __FUNCTION__,
+//             DEBUG("Found id: %X, format: %X, length: %X, data %02X%02X%02X%02X%02X%02X%02X%02X",
 //                                                             id, (uint8_t)format, length, data[0], data[1], data[2], data[3], data[4], data[5], data[6], data[7]);
        }
 
        return can_message_t(maxdlen, id, length, format, rtr_flag, flags, data, timestamp);
 }
 
-///
 /// @brief Take all initialized class's members and build an
 /// canfd_frame struct that can be use to send a CAN message over
 /// the bus.
 ///
 /// @return canfd_frame struct built from class members.
-///
 struct canfd_frame can_message_t::convert_to_canfd_frame()
 {
        canfd_frame frame;
@@ -361,11 +362,16 @@ struct canfd_frame can_message_t::convert_to_canfd_frame()
                ::memcpy(frame.data, get_data(), length_);
        }
        else
-               ERROR(binder_interface, "%s: can_message_t not correctly initialized to be sent", __FUNCTION__);
+               ERROR("can_message_t not correctly initialized to be sent");
 
        return frame;
 }
 
+/// @brief Take all initialized class's members and build an
+/// can_frame struct that can be use to send a CAN message over
+/// the bus.
+///
+/// @return can_frame struct built from class members.
 struct can_frame can_message_t::convert_to_can_frame()
 {
        can_frame frame;
@@ -377,7 +383,7 @@ struct can_frame can_message_t::convert_to_can_frame()
                ::memcpy(frame.data, get_data(), length_);
        }
        else
-               ERROR(binder_interface, "%s: can_message_t not correctly initialized to be sent", __FUNCTION__);
+               ERROR("can_message_t not correctly initialized to be sent");
 
        return frame;
 }