Correct errors in comments
authorJonathan Aillet <jonathan.aillet@iot.bzh>
Thu, 29 Mar 2018 07:18:58 +0000 (09:18 +0200)
committerJonathan Aillet <jonathan.aillet@iot.bzh>
Mon, 9 Apr 2018 15:40:20 +0000 (17:40 +0200)
Change-Id: I1e02bdfe2473e776e35694b883f084077227853c
Signed-off-by: Jonathan Aillet <jonathan.aillet@iot.bzh>
low-can-binding/diagnostic/active-diagnostic-request.hpp
low-can-binding/diagnostic/diagnostic-message.hpp
low-can-binding/utils/timer.hpp

index 36f9e43..892feb5 100644 (file)
@@ -75,7 +75,7 @@ private:
        DiagnosticResponseCallback callback_; ///< callback_ - An optional DiagnosticResponseCallback to be notified whenever a
                                                                                  ///< response is received for this request.
        bool recurring_; ///< bool recurring_ - If true, this is a recurring request and it will remain as active until explicitly cancelled.
-                                        ///< The frequencyClock attribute controls how often a recurrin request is made.
+                                        ///< The frequencyClock attribute controls how often a recurring request is made.
        bool wait_for_multiple_responses_; ///< wait_for_multiple_responses_ - False by default, when any response is received for a request
                                                                           ///< it will be removed from the active list. If true, the request will remain active until the timeout
                                                                           ///< clock expires, to allow it to receive multiple response (e.g. to a functional broadcast request).
index 99c4811..873c7ff 100644 (file)
@@ -41,7 +41,7 @@ enum UNIT {
 
 class can_message_set_t;
 
-/// @brief - A representation of an OBD-II PID.
+/// @brief - A representation of an OBD-II PID Mode 01 (Note : An OBD-II PID mode 01 contains only one information).
 class diagnostic_message_t
 {
        private:
index a667022..52b1493 100644 (file)
@@ -37,7 +37,7 @@ class frequency_clock_t
 private:
        float unit_; ///< unit_ - multiplicator to make operation to be in the right unit (milli, micro, nano, etc)
        float frequency_; ///< the clock frequency in Hz.
-       uint64_t last_tick_; ///< the last time (in microseconds since startup) that the clock ticked.
+       uint64_t last_tick_; ///< the last time (in microseconds since epoch) that the clock ticked.
        time_function_t time_function_; ///<  a function returning current time
 
 public: