diff options
Diffstat (limited to 'src/openxc-utils.hpp')
-rw-r--r-- | src/openxc-utils.hpp | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/src/openxc-utils.hpp b/src/openxc-utils.hpp index f078c6eb..b2b5c7fb 100644 --- a/src/openxc-utils.hpp +++ b/src/openxc-utils.hpp @@ -18,34 +18,36 @@ #pragma once -/* - * Build a specific VehicleMessage containing a SimpleMessage. +#include "openxc.pb.h" + +/** + * @brief Build a specific VehicleMessage containing a SimpleMessage. */ -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); |