From feb3833e4b66b7b1f2f5651be67e204e8bc7016e Mon Sep 17 00:00:00 2001 From: Naveen Kaje Date: Fri, 12 Oct 2018 09:51:53 -0500 Subject: [PATCH 1/3] Timer.h: Remove protected attributes from rendering on docs site --- drivers/Timer.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/drivers/Timer.h b/drivers/Timer.h index 9fafad945a..0ca0dc6965 100644 --- a/drivers/Timer.h +++ b/drivers/Timer.h @@ -95,6 +95,7 @@ public: */ us_timestamp_t read_high_resolution_us(); +#if !defined(DOXYGEN_ONLY) protected: us_timestamp_t slicetime(); int _running; // whether the timer is running @@ -103,6 +104,7 @@ protected: const ticker_data_t *_ticker_data; bool _lock_deepsleep; // flag which indicates if deep-sleep should be disabled }; +#endif } // namespace mbed From 615ae0b2ec1bc74b4338c827113ee5bf70f62536 Mon Sep 17 00:00:00 2001 From: Naveen Kaje Date: Fri, 12 Oct 2018 10:09:36 -0500 Subject: [PATCH 2/3] Timer.h: Update comments --- drivers/Timer.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/drivers/Timer.h b/drivers/Timer.h index 0ca0dc6965..37305a2af9 100644 --- a/drivers/Timer.h +++ b/drivers/Timer.h @@ -65,7 +65,7 @@ public: /** Reset the timer to 0. * - * If it was already counting, it will continue + * If it was already running, it will continue */ void reset(); @@ -92,6 +92,7 @@ public: operator float(); /** Get in a high resolution type the time passed in micro-seconds. + * Returns a 64 bit integer. */ us_timestamp_t read_high_resolution_us(); From 648eb39f7451f073136afc36a98205187677568a Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Fri, 12 Oct 2018 11:01:11 -0500 Subject: [PATCH 3/3] Copy edit Timer.h Copy edit existing text for minor grammar issues. --- drivers/Timer.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/drivers/Timer.h b/drivers/Timer.h index 37305a2af9..9cc3586d98 100644 --- a/drivers/Timer.h +++ b/drivers/Timer.h @@ -30,7 +30,7 @@ namespace mbed { * * Example: * @code - * // Count the time to toggle a LED + * // Count the time to toggle an LED * * #include "mbed.h" * @@ -75,15 +75,15 @@ public: */ float read(); - /** Get the time passed in milli-seconds + /** Get the time passed in milliseconds * - * @returns Time passed in milli seconds + * @returns Time passed in milliseconds */ int read_ms(); - /** Get the time passed in micro-seconds + /** Get the time passed in microseconds * - * @returns Time passed in micro seconds + * @returns Time passed in microseconds */ int read_us(); @@ -91,7 +91,7 @@ public: */ operator float(); - /** Get in a high resolution type the time passed in micro-seconds. + /** Get in a high resolution type the time passed in microseconds. * Returns a 64 bit integer. */ us_timestamp_t read_high_resolution_us(); @@ -103,7 +103,7 @@ protected: us_timestamp_t _start; // the start time of the latest slice us_timestamp_t _time; // any accumulated time from previous slices const ticker_data_t *_ticker_data; - bool _lock_deepsleep; // flag which indicates if deep-sleep should be disabled + bool _lock_deepsleep; // flag that indicates if deep sleep should be disabled }; #endif