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 f078c6e..295e99c 100644 (file)
--- a/src/openxc-utils.hpp
+++ b/src/openxc-utils.hpp
@@ -18,34 +18,42 @@
 
 #pragma once
 
-/*
- * Build a specific VehicleMessage containing a SimpleMessage.
+#include "openxc.pb.h"
+
+/**
+ * @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);
+openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message);
 
-/*
- * Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
+/**
+ * @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
  */
 openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value);
-/* 
- * Build an openxc_DynamicField depending what we pass as argument
+/**
+ * @brief Build an openxc_DynamicField depending what we pass as argument
  */
 openxc_DynamicField build_DynamicField(const std::string& value);
 
-/* 
- * Build an openxc_DynamicField depending what we pass as argument
+/**
+ * @brief Build an openxc_DynamicField depending what we pass as argument
  */
 openxc_DynamicField build_DynamicField(double value);
 
-/* 
- * Build an openxc_DynamicField depending what we pass as argument
+/**
+ * @brief Build an openxc_DynamicField depending what we pass as argument
  */
 openxc_DynamicField build_DynamicField(bool value);
 
 void jsonify_DynamicField(const openxc_DynamicField& field, const json_object& value);
 
-/* Extract the simple message value from an openxc_VehicleMessage
+/**
+ * @brief Extract the simple message value from an openxc_VehicleMessage
  * and return it, or null if there isn't.
  */
 openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg);