aboutsummaryrefslogtreecommitdiffstats
path: root/src/can/can-bus.hpp
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-03-17 12:48:46 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2017-03-17 12:48:46 +0100
commit7591838644a3fcb5145b9ccc7200166debe7ba87 (patch)
tree90336690ab6e294e9d1937beb98a1d50a0b327c4 /src/can/can-bus.hpp
parentf05cdb00aff6ba1d41a6d705d34bce42122f971f (diff)
Comments fixes, typo and formating.
No more warning when generate the docs and all comments follow the same formating. Change-Id: I80d4c5c2d64401c2e53a550c60155680c4f968ce Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'src/can/can-bus.hpp')
-rw-r--r--src/can/can-bus.hpp24
1 files changed, 12 insertions, 12 deletions
diff --git a/src/can/can-bus.hpp b/src/can/can-bus.hpp
index 9370d3b..eb47476 100644
--- a/src/can/can-bus.hpp
+++ b/src/can/can-bus.hpp
@@ -48,25 +48,25 @@
class can_bus_t
{
private:
- int conf_file_; /// < configuration file handle used to initialize can_bus_dev_t objects.
+ int conf_file_; ///< configuration file handle used to initialize can_bus_dev_t objects.
void can_decode_message();
- std::thread th_decoding_; /// < thread that'll handle decoding a can frame
- bool is_decoding_ = false; /// < boolean member controling thread while loop
+ std::thread th_decoding_; ///< thread that'll handle decoding a can frame
+ bool is_decoding_ = false; ///< boolean member controling thread while loop
void can_event_push();
- std::thread th_pushing_; /// < thread that'll handle pushing decoded can frame to subscribers
- bool is_pushing_ = false; /// < boolean member controling thread while loop
+ std::thread th_pushing_; ///< thread that'll handle pushing decoded can frame to subscribers
+ bool is_pushing_ = false; ///< boolean member controling thread while loop
- std::condition_variable new_can_message_cv_; /// < condition_variable use to wait until there is a new CAN message to read
- std::mutex can_message_mutex_; /// < mutex protecting the can_message_q_ queue.
- std::queue <can_message_t> can_message_q_; /// < queue that'll store can_message_t to decoded
+ std::condition_variable new_can_message_cv_; ///< condition_variable use to wait until there is a new CAN message to read
+ std::mutex can_message_mutex_; ///< mutex protecting the can_message_q_ queue.
+ std::queue <can_message_t> can_message_q_; ///< queue that'll store can_message_t to decoded
- std::condition_variable new_decoded_can_message_; /// < condition_variable use to wait until there is a new vehicle message to read from the queue vehicle_message_q_
- std::mutex decoded_can_message_mutex_; /// < mutex protecting the vehicle_message_q_ queue.
- std::queue <openxc_VehicleMessage> vehicle_message_q_; /// < queue that'll store openxc_VehicleMessage to pushed
+ std::condition_variable new_decoded_can_message_; ///< condition_variable use to wait until there is a new vehicle message to read from the queue vehicle_message_q_
+ std::mutex decoded_can_message_mutex_; ///< mutex protecting the vehicle_message_q_ queue.
+ std::queue <openxc_VehicleMessage> vehicle_message_q_; ///< queue that'll store openxc_VehicleMessage to pushed
- static std::map<std::string, std::shared_ptr<can_bus_dev_t>> can_devices_; /// < Can device map containing all can_bus_dev_t objects initialized during init_can_dev function
+ static std::map<std::string, std::shared_ptr<can_bus_dev_t>> can_devices_; ///< Can device map containing all can_bus_dev_t objects initialized during init_can_dev function
public:
can_bus_t(int conf_file);