From: Romain Forlot <romain.forlot@iot.bzh>
Date: Fri, 21 Apr 2017 16:20:55 +0000 (+0200)
Subject: Adding some comments
X-Git-Tag: 3.99.1~144
X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=commitdiff_plain;h=98766025818904420be6088e60453b885a05e9d7;p=apps%2Flow-level-can-service.git

Adding some comments

Change-Id: Ic47e808a0da94f79ca0341d1b4f46a02eef3fe84
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
---

diff --git a/CAN-binder/low-can-binding/configuration.hpp b/CAN-binder/low-can-binding/configuration.hpp
index c0a75e9..a3ab8ca 100644
--- a/CAN-binder/low-can-binding/configuration.hpp
+++ b/CAN-binder/low-can-binding/configuration.hpp
@@ -47,10 +47,10 @@ class configuration_t
 		diagnostic_manager_t diagnostic_manager_; ///< Diagnostic manager use to manage diagnostic message communication.
 		uint8_t active_message_set_ = 0; ///< Which is the active message set ? Default to 0.
 
-		std::vector<can_message_set_t> can_message_set_;
-		std::vector<std::vector<can_message_definition_t>> can_message_definition_;
-		std::vector<std::vector<can_signal_t>> can_signals_;
-		std::vector<std::vector<diagnostic_message_t>> diagnostic_messages_;
+		std::vector<can_message_set_t> can_message_set_; ///< Vector holding all message set from JSON signals description file
+		std::vector<std::vector<can_message_definition_t>> can_message_definition_; ///< Vector of vector holding all can message definition from JSON signals description file. This describe a CAN message. First vector map to message set
+		std::vector<std::vector<can_signal_t>> can_signals_; ///< Vector of vector holding all can signasl from JSON signals description file. A CAN signal is a part of a CAN message.  First vector map to message set
+		std::vector<std::vector<diagnostic_message_t>> diagnostic_messages_; ///< Vector of vector holding all diagnostics messages from JSON signals description file. First vector map to message set
 
 		configuration_t(); ///< Private constructor with implementation generated by the AGL generator.