Fix all doxygen comments about parameters.

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

1 files changed, 15 insertions, 15 deletions

diff --git a/src/utils/openxc-utils.hpp b/src/utils/openxc-utils.hpp
index b7fa788..3a4883e 100644
--- a/src/utils/openxc-utils.hpp
+++ b/src/utils/openxc-utils.hpp
@@ -29,10 +29,10 @@
  *
  * @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
+ * @param[in] type - The type of message to build
+ * @param[in] message - simple message to include into openxc_VehicleMessage
  *
- * @return openxc_VehicleMessage - a vehicle message including simple message that will be convert into 
+ * @return 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);
@@ -42,10 +42,10 @@ openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicFiel
  *
  * @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
  *
- * @param[in] std::string name - const string reference name to assign to the created SimpleMessage
+ * @param[in] name - const string reference name to assign to the created SimpleMessage
  *  this will set has_name member to true and assign name to the name member. Maximum size for name is 
  *  set to 100 char.
- * @param[in] openxc_DynamicField value - const reference with DynamicField to assign to SimpleMessage
+ * @param[in] value - const reference with DynamicField to assign to SimpleMessage
  *  value.
  *
  * @return an openxc_SimpleMessage struct initialized with name and value provided.
@@ -57,7 +57,7 @@ openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_D
  *
  * @brief Build an openxc_DynamicField with a string value
  *
- * @param std::string value - const string reference value to assign to builded
+ * @param[in] value - const string reference value to assign to builded
  *  openxc_DynamicField.
  *
  * @return openxc_DynamicField initialized with a string value.
@@ -69,7 +69,7 @@ openxc_DynamicField build_DynamicField(const std::string& value);
  *
  * @brief Build an openxc_DynamicField with a double value
  *
- * @param double value - double value to assign to builded openxc_DynamicField.
+ * @param[in] value - double value to assign to builded openxc_DynamicField.
  *
  * @return openxc_DynamicField initialized with a double value.
  */
@@ -80,7 +80,7 @@ openxc_DynamicField build_DynamicField(double value);
  *
  * @brief Build an openxc_DynamicField with a boolean value
  *
- * @param bool value - boolean value to assign to builded openxc_DynamicField.
+ * @param[in] value - boolean value to assign to builded openxc_DynamicField.
  *
  * @return openxc_DynamicField initialized with a boolean value.
  */
@@ -91,9 +91,9 @@ openxc_DynamicField build_DynamicField(bool value);
  *
  * @brief Make a JSON object from a DynamicField
  *
- * @param[in] openxc_DynamicField field - openxc_DynamicField struct to convert into
+ * @param[in] field - openxc_DynamicField struct to convert into
  *  a json object.
- * @param[out] json_object pointer with the DynamicField converted
+ * @param[out] value - pointer to the object to set up.
  */
 void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value);
 
@@ -105,9 +105,9 @@ void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value);
  *  returned value will be a SimpleMessage with all field set at false.
  *  DynamicField from SimpleMessage will be boolean DynamicField set to false too.
  *
- * @param[in] openxc_VehicleMessage - const reference to openxc_VehicleMessage
+ * @param[in] v_msg - const reference to openxc_VehicleMessage
  *
- * @return openxc_SimpleMessage - SimpleMessage from the provided VehicleMessage.
+ * @return A simpleMessage from the provided VehicleMessage.
  */
 openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg);
 
@@ -116,11 +116,11 @@ openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg);
  *
  * @brief Make a JSON object from a SimpleMessage
  *
- * @param[in] openxc_SimpleMessage s_msg - const reference to an openxc_SimpleMessage 
+ * @param[in] s_msg - const reference to an openxc_SimpleMessage 
  * struct to convert into a json object.
- * @param[out] json_object pointer with the DynamicField converted
+ * @param[out] json - pointer with the DynamicField converted into json object
  * 
- * @return boolean value - true if SimpleMessage has been transformed into json object
+ * @return True if SimpleMessage has been transformed into json object
  *  and false if not. In such case, a json object is returned { "error": "error msg"}
  */
 bool jsonify_simple(const openxc_SimpleMessage& s_msg, json_object* json);
\ No newline at end of file