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>

1 files changed, 87 insertions, 87 deletions

diff --git a/src/utils/openxc-utils.cpp b/src/utils/openxc-utils.cpp
index 111ac1d3..52b49d29 100644
--- a/src/utils/openxc-utils.cpp
+++ b/src/utils/openxc-utils.cpp
@@ -20,17 +20,17 @@
 
 #include "../configuration.hpp"
 
-/**
- * @brief Build a specific VehicleMessage containing a DiagnosticResponse.
- *
- * @param[in] request - Original request use to retrieve decoder and callback
- * @param[in] response - Response to the request that will be decoded if decoder set
- *  and put into the DiagnosticResponse of the VehicleMessage.
- * @param[in] parsed_value - raw parsed value of the payload from CAN message
- *
- * @return a vehicle message including simple message that will be convert into 
- * a JSON object before being pushed to the subscribers
- */
+///
+/// @brief Build a specific VehicleMessage containing a DiagnosticResponse.
+///
+/// @param[in] request - Original request use to retrieve decoder and callback
+/// @param[in] response - Response to the request that will be decoded if decoder set
+///  and put into the DiagnosticResponse of the VehicleMessage.
+/// @param[in] parsed_value - raw parsed value of the payload from CAN message
+///
+/// @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(active_diagnostic_request_t* request, const DiagnosticResponse& response, float parsed_value)
 {
 	openxc_VehicleMessage message;
@@ -85,14 +85,14 @@ openxc_VehicleMessage build_VehicleMessage(active_diagnostic_request_t* request,
 	return message;
 }
 
-/**
- * @brief Build a specific VehicleMessage containing a SimpleMessage.
- *
- * @param[in] message - simple message to include into openxc_VehicleMessage
- *
- * @return a vehicle message including simple message that will be convert into 
- * a JSON object before being pushed to the subscribers
- */
+///
+/// @brief Build a specific VehicleMessage containing a SimpleMessage.
+///
+/// @param[in] message - simple message to include into openxc_VehicleMessage
+///
+/// @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(const openxc_SimpleMessage& message)
 {
 	openxc_VehicleMessage v;
@@ -107,12 +107,12 @@ openxc_VehicleMessage build_VehicleMessage(const openxc_SimpleMessage& message)
 	return v;
 }
 
-/**
- * @brief Build an empty VehicleMessage that isn't usable by at least the struct
- *  is initialized for the most part and can be use to check a false return value.
- *
- * @return A VehicleMessage with all boolean value to false.
- */
+///
+/// @brief Build an empty VehicleMessage that isn't usable by at least the struct
+///  is initialized for the most part and can be use to check a false return value.
+///
+/// @return A VehicleMessage with all boolean value to false.
+///
 openxc_VehicleMessage build_VehicleMessage()
 {
 	openxc_VehicleMessage v;
@@ -134,17 +134,17 @@ bool is_valid(const openxc_VehicleMessage& v)
 	return true;
 }
 
-/**
- * @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
- *
- * @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] value - const reference with DynamicField to assign to SimpleMessage
- *  value.
- *
- * @return an openxc_SimpleMessage struct initialized with name and value provided.
- */
+///
+/// @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
+///
+/// @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] value - const reference with DynamicField to assign to SimpleMessage
+///  value.
+///
+/// @return an openxc_SimpleMessage struct initialized with name and value provided.
+///
 openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value)
 {
 	openxc_SimpleMessage s;
@@ -157,14 +157,14 @@ openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_D
 	return s;
 }
 
-/**
- * @brief Build an openxc_DynamicField with a string value
- *
- * @param[in] value - const string reference value to assign to builded
- *  openxc_DynamicField.
- *
- * @return openxc_DynamicField initialized with a string value.
- */
+///
+/// @brief Build an openxc_DynamicField with a string value
+///
+/// @param[in] value - const string reference value to assign to builded
+///  openxc_DynamicField.
+///
+/// @return openxc_DynamicField initialized with a string value.
+///
 openxc_DynamicField build_DynamicField(const std::string& value)
 {
 	openxc_DynamicField d;
@@ -179,15 +179,15 @@ openxc_DynamicField build_DynamicField(const std::string& value)
 	return d;
 }
 
-/**
- * @fn openxc_DynamicField build_DynamicField(double value);
- *
- * @brief Build an openxc_DynamicField with a double value
- *
- * @param[in] value - double value to assign to builded openxc_DynamicField.
- *
- * @return openxc_DynamicField initialized with a double value.
- */
+///
+/// @fn openxc_DynamicField build_DynamicField(double value);
+///
+/// @brief Build an openxc_DynamicField with a double value
+///
+/// @param[in] value - double value to assign to builded openxc_DynamicField.
+///
+/// @return openxc_DynamicField initialized with a double value.
+///
 openxc_DynamicField build_DynamicField(double value)
 {
 	openxc_DynamicField d;
@@ -202,13 +202,13 @@ openxc_DynamicField build_DynamicField(double value)
 	return d;
 }
 
-/**
- * @brief Build an openxc_DynamicField with a boolean value
- *
- * @param[in] value - boolean value to assign to builded openxc_DynamicField.
- *
- * @return openxc_DynamicField initialized with a boolean value.
- */
+///
+/// @brief Build an openxc_DynamicField with a boolean value
+///
+/// @param[in] value - boolean value to assign to builded openxc_DynamicField.
+///
+/// @return openxc_DynamicField initialized with a boolean value.
+///
 openxc_DynamicField build_DynamicField(bool value)
 {
 	openxc_DynamicField d;
@@ -223,16 +223,16 @@ openxc_DynamicField build_DynamicField(bool value)
 	return d;
 }
 
-/**
- * @brief Extract the simple message value from an openxc_VehicleMessage
- *  and return it. If there isn't SimpleMessage in the VehicleMessage then
- *  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] v_msg - const reference to openxc_VehicleMessage
- *
- * @return A simpleMessage from the provided VehicleMessage.
- */
+///
+/// @brief Extract the simple message value from an openxc_VehicleMessage
+///  and return it. If there isn't SimpleMessage in the VehicleMessage then
+///  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] v_msg - const reference to openxc_VehicleMessage
+///
+/// @return A simpleMessage from the provided VehicleMessage.
+///
 openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg)
 {
 	if (v_msg.has_simple_message)
@@ -242,13 +242,13 @@ openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg)
 	return s_msg;
 }
 
-/**
- * @brief Make a JSON object from a DynamicField
- *
- * @param[in] field - openxc_DynamicField struct to convert into
- *  a json object.
- * @param[out] value - pointer to the object to set up.
- */
+///
+/// @brief Make a JSON object from a DynamicField
+///
+/// @param[in] field - openxc_DynamicField struct to convert into
+///  a json object.
+/// @param[out] value - pointer to the object to set up.
+///
 void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value)
 {
 	if(field.has_numeric_value)
@@ -259,16 +259,16 @@ void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value)
 		json_object_object_add(value, "value", json_object_new_string(field.string_value));
 }
 
-/**
- * @brief Make a JSON object from a SimpleMessage
- *
- * @param[in] s_msg - const reference to an openxc_SimpleMessage 
- * struct to convert into a json object.
- * @param[out] json - pointer with the DynamicField converted 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"}
- */
+///
+/// @brief Make a JSON object from a SimpleMessage
+///
+/// @param[in] s_msg - const reference to an openxc_SimpleMessage 
+/// struct to convert into a json object.
+/// @param[out] json - pointer with the DynamicField converted 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)
 {
 	if(s_msg.has_name)