summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-04-20 17:41:16 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2017-04-20 17:41:16 +0200
commit211ce4dd58d40f33287354647b32bf241c5ddfdc (patch)
tree873af176264ad11bf7a659e197d2965f6934a74b
parentcfea1927c8f4fe4fcd5981284abb64da990940e0 (diff)
Update comments
Change-Id: Ib21f810170308a16462ffe9c174448a86bf791d4 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
-rw-r--r--CAN-binder/low-can-binding/can/can-bus-dev.cpp6
1 files changed, 4 insertions, 2 deletions
diff --git a/CAN-binder/low-can-binding/can/can-bus-dev.cpp b/CAN-binder/low-can-binding/can/can-bus-dev.cpp
index 6bd5e67f..765eda7f 100644
--- a/CAN-binder/low-can-binding/can/can-bus-dev.cpp
+++ b/CAN-binder/low-can-binding/can/can-bus-dev.cpp
@@ -50,14 +50,16 @@ uint32_t can_bus_dev_t::get_address() const
/// We try to open CAN socket and apply the following options
/// timestamp received messages and pass the socket to FD mode.
///
-/// @return -1 if something wrong.
+/// @param[in] bcm boolean value indicating wether or not we initialize a Broadcast CAN Manager socket.
+///
+/// @return socket value or -1 if something wrong.
int can_bus_dev_t::open(bool bcm)
{
DEBUG(binder_interface, "open_raw: CAN Handler socket : %d", can_socket_.socket());
return can_socket_.open(device_name_, bcm);
}
- // Set some option on the socket : timeout, timestamp and canfd frame usage.
+/// @brief Set some option on the socket, timestamp and canfd frame usage.
void can_bus_dev_t::configure()
{
if (can_socket_)