diff options
| author |   Romain Forlot <romain.forlot@iot.bzh> | 2017-03-14 00:13:57 +0100 |
|---|---|---|
| committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-03-16 17:15:55 +0100 |
| commit | d1282ada6335171914a23c328c8a17c809557e62 (patch) | |
| tree | 7671bd00a72c1df319a033e136629dac912c7495 /src/can/can-message.cpp | |
| parent | 990b25bf850f797f499a326713cad1f7076ab8d1 (diff) | |
Improve Doxygen comments and formating.
Change-Id: Ia39e78aca00a49c7cee5e42d26ba1ef2b49d3709
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'src/can/can-message.cpp')
| -rw-r--r-- | src/can/can-message.cpp | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/can/can-message.cpp b/src/can/can-message.cpp index 36cce92..cc4adb4 100644 --- a/src/can/can-message.cpp +++ b/src/can/can-message.cpp @@ -136,7 +136,10 @@ void can_message_t::set_format(const can_message_format_t new_format) * * This is the preferred way to initialize class members. * -* @param[in] args - struct read from can bus device. +* @param[in] frame - canfd_frame to convert coming from a read of CAN socket +* @param[in] nbyte - 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_canfd_frame(const struct canfd_frame& frame, size_t nbytes) { |