diff options
| author |   Romain Forlot <romain.forlot@iot.bzh> | 2017-02-20 19:37:50 +0000 |
|---|---|---|
| committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-02-21 10:59:19 +0000 |
| commit | 4bcb47864452b2d219572862aed3d173c3c0a945 (patch) | |
| tree | bc93d4dc94105a3188ff76b2c566fd0ed9dd3b56 /src/openxc-utils.hpp | |
| parent | e04572a03ceea68e47271a9651dbf27eb4e5a190 (diff) | |
Some cleaning and comments
Change-Id: Iad73e3a34c5638e012819506b56741f62cfa3e30
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'src/openxc-utils.hpp')
| -rw-r--r-- | src/openxc-utils.hpp | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/openxc-utils.hpp b/src/openxc-utils.hpp index b2b5c7f..295e99c 100644 --- 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); |