aboutsummaryrefslogtreecommitdiffstats
path: root/low-can-binding
diff options
context:
space:
mode:
authorJonathan Aillet <jonathan.aillet@iot.bzh>2018-03-29 09:18:58 +0200
committerJonathan Aillet <jonathan.aillet@iot.bzh>2018-04-09 17:40:20 +0200
commitddd4374f35df2d8b8e9b4ecf4890abba6fab3734 (patch)
treee6f7d98d69f2d6913d295361df50dc435e46cbdc /low-can-binding
parent12d04c471a5127219da5a313c546ab240c866fe6 (diff)
Correct errors in comments
Change-Id: I1e02bdfe2473e776e35694b883f084077227853c Signed-off-by: Jonathan Aillet <jonathan.aillet@iot.bzh>
Diffstat (limited to 'low-can-binding')
-rw-r--r--low-can-binding/diagnostic/active-diagnostic-request.hpp2
-rw-r--r--low-can-binding/diagnostic/diagnostic-message.hpp2
-rw-r--r--low-can-binding/utils/timer.hpp2
3 files changed, 3 insertions, 3 deletions
diff --git a/low-can-binding/diagnostic/active-diagnostic-request.hpp b/low-can-binding/diagnostic/active-diagnostic-request.hpp
index 36f9e43c..892feb50 100644
--- a/low-can-binding/diagnostic/active-diagnostic-request.hpp
+++ b/low-can-binding/diagnostic/active-diagnostic-request.hpp
@@ -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).
diff --git a/low-can-binding/diagnostic/diagnostic-message.hpp b/low-can-binding/diagnostic/diagnostic-message.hpp
index 99c48110..873c7ff2 100644
--- a/low-can-binding/diagnostic/diagnostic-message.hpp
+++ b/low-can-binding/diagnostic/diagnostic-message.hpp
@@ -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:
diff --git a/low-can-binding/utils/timer.hpp b/low-can-binding/utils/timer.hpp
index a667022a..52b14937 100644
--- a/low-can-binding/utils/timer.hpp
+++ b/low-can-binding/utils/timer.hpp
@@ -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: