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-bus-dev.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-bus-dev.cpp')
| -rw-r--r-- | src/can/can-bus-dev.cpp | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/src/can/can-bus-dev.cpp b/src/can/can-bus-dev.cpp index a574b42d..dd2f51f7 100644 --- a/src/can/can-bus-dev.cpp +++ b/src/can/can-bus-dev.cpp @@ -204,9 +204,14 @@ int can_bus_dev_t::send(can_message_t& can_msg) return 0; } -/// @brief Send a can message from a can_message_t object. -/// @param[in] can bus used to send the message -/// @param[in] can_msg the can message object to send +/// @brief Static method used to send diagnostic CAN message +/// that follow isotp SendShimsMessage signature. This method is launched +/// from diagnostic manager's' same name method. It will use the diagnostic +/// manager configured CAN bus device to send the CAN message. +/// +/// @param[in] arbitration_id - CAN arbitration id. +/// @param[in] data - CAN message payload to send +/// @param[in] size - size of the data to send bool can_bus_dev_t::shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size) { ssize_t nbytes; |