summaryrefslogtreecommitdiffstats
path: root/src/diagnostic/diagnostic-message.hpp
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-03-17 12:48:46 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2017-03-17 12:48:46 +0100
commit7591838644a3fcb5145b9ccc7200166debe7ba87 (patch)
tree90336690ab6e294e9d1937beb98a1d50a0b327c4 /src/diagnostic/diagnostic-message.hpp
parentf05cdb00aff6ba1d41a6d705d34bce42122f971f (diff)
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>
Diffstat (limited to 'src/diagnostic/diagnostic-message.hpp')
-rw-r--r--src/diagnostic/diagnostic-message.hpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/diagnostic/diagnostic-message.hpp b/src/diagnostic/diagnostic-message.hpp
index b25fea34..064904d2 100644
--- a/src/diagnostic/diagnostic-message.hpp
+++ b/src/diagnostic/diagnostic-message.hpp
@@ -38,17 +38,17 @@ enum UNIT {
INVALID
};
-/**
- * @brief - A representation of an OBD-II PID.
- */
+///
+/// @brief - A representation of an OBD-II PID.
+///
class diagnostic_message_t {
private:
- uint8_t pid_; /*!< pid - The 1 byte PID.*/
+ uint8_t pid_; /*!< pid_ - The 1 byte PID.*/
std::string generic_name_; /*!< generic_name_ - A human readable name to use for this PID when published.*/
int min_; /*!< min_ - Minimum value that can take this pid */
int max_; /*!< max_ - Maximum value that can take this pid */
enum UNIT unit_; /*!< unit_ : Which unit system is used by that pid. See enum UNIT above.*/
- float frequency_; /*!< frequency - The frequency to request this PID if supported by the vehicle when automatic, recurring OBD-II requests are enabled.*/
+ float frequency_; /*!< frequency_ - The frequency to request this PID if supported by the vehicle when automatic, recurring OBD-II requests are enabled.*/
DiagnosticResponseDecoder decoder_; /*!< decoder_ - An optional DiagnosticResponseDecoder to parse the payload of responses
* to this request. If the decoder is NULL, the output will include the raw payload
* instead of a parsed value.*/