Skip to content

Commit be4985e

Browse files
author
Amanda Butler
authored
Edit Ticker.h
Make minor copy edits to existing text.
1 parent a920668 commit be4985e

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

drivers/Ticker.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ namespace mbed {
3535
*
3636
* Example:
3737
* @code
38-
* // Toggle the blinking led after 5 seconds
38+
* // Toggle the blinking LED after 5 seconds
3939
*
4040
* #include "mbed.h"
4141
*
@@ -70,7 +70,7 @@ class Ticker : public TimerEvent, private NonCopyable<Ticker> {
7070
{
7171
}
7272

73-
// When low power ticker is in use, then do not disable deep-sleep.
73+
// When low power ticker is in use, then do not disable deep sleep.
7474
Ticker(const ticker_data_t *data) : TimerEvent(data), _function(0), _lock_deepsleep(true)
7575
{
7676
#if DEVICE_LPTICKER
@@ -106,13 +106,13 @@ class Ticker : public TimerEvent, private NonCopyable<Ticker> {
106106
attach(callback(obj, method), t);
107107
}
108108

109-
/** Attach a function to be called by the Ticker, specifying the interval in micro-seconds
109+
/** Attach a function to be called by the Ticker, specifying the interval in microseconds
110110
*
111111
* @param func pointer to the function to be called
112112
* @param t the time between calls in micro-seconds
113113
*
114-
* @note setting @a t to a value shorter that it takes to process the ticker callback
115-
* will cause the system to hang. Ticker callback will be called constantly with no time
114+
* @note setting @a t to a value shorter than it takes to process the ticker callback
115+
* causes the system to hang. Ticker callback is called constantly with no time
116116
* for threads scheduling.
117117
*
118118
*/
@@ -128,11 +128,11 @@ class Ticker : public TimerEvent, private NonCopyable<Ticker> {
128128
core_util_critical_section_exit();
129129
}
130130

131-
/** Attach a member function to be called by the Ticker, specifying the interval in micro-seconds
131+
/** Attach a member function to be called by the Ticker, specifying the interval in microseconds
132132
*
133133
* @param obj pointer to the object to call the member function on
134134
* @param method pointer to the member function to be called
135-
* @param t the time between calls in micro-seconds
135+
* @param t the time between calls in microseconds
136136
* @deprecated
137137
* The attach_us function does not support cv-qualifiers. Replaced by
138138
* attach_us(callback(obj, method), t).
@@ -161,9 +161,9 @@ class Ticker : public TimerEvent, private NonCopyable<Ticker> {
161161
virtual void handler();
162162

163163
protected:
164-
us_timestamp_t _delay; /**< Time delay (in microseconds) for re-setting the multi-shot callback. */
164+
us_timestamp_t _delay; /**< Time delay (in microseconds) for resetting the multishot callback. */
165165
Callback<void()> _function; /**< Callback. */
166-
bool _lock_deepsleep; /**< Flag which indicates if deep-sleep should be disabled. */
166+
bool _lock_deepsleep; /**< Flag which indicates if deep sleep should be disabled. */
167167
#endif
168168
};
169169

0 commit comments

Comments
 (0)