Multifixes: class and methods, typo, comments

[apps/agl-service-can-low-level.git] / src / openxc-utils.hpp

diff --git a/src/openxc-utils.hpp b/src/openxc-utils.hpp
index b2b5c7f..295e99c 100644 (file)
--- a/src/openxc-utils.hpp
+++ b/src/openxc-utils.hpp
@@ -22,6 +22,12 @@
 
 /**
  * @brief Build a specific VehicleMessage containing a SimpleMessage.
+ *
+ * @param[in] openxc_DynamicField_Type type - The type of message to build
+ * @param[in] openxc_SimpleMessage& message - simple message to include into openxc_VehicleMessage
+ *
+ * @return openxc_VehicleMessage - a vehicle message including simple message that will be convert into 
+ * a JSON object before being pushed to the subscribers
  */
 openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message);