Skip to content

Commit ec681b6

Browse files
author
Amanda Butler
authored
Copy edit Thread.h
Copy edit file for active voice.
1 parent 3621536 commit ec681b6

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

rtos/Thread.h

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ class Thread : private mbed::NonCopyable<Thread> {
8181
@param stack_mem pointer to the stack area to be used by this thread (default: NULL).
8282
@param name name to be used for this thread. It has to stay allocated for the lifetime of the thread (default: NULL)
8383
84-
@note This function cannot be called from ISR context.
84+
@note You cannot call this function from ISR context.
8585
*/
8686
Thread(osPriority priority=osPriorityNormal,
8787
uint32_t stack_size=OS_STACK_SIZE,
@@ -106,7 +106,7 @@ class Thread : private mbed::NonCopyable<Thread> {
106106
}
107107
@endcode
108108
109-
@note This function cannot be called from ISR context.
109+
@note You cannot call this function from ISR context.
110110
*/
111111
MBED_DEPRECATED_SINCE("mbed-os-5.1",
112112
"Thread-spawning constructors hide errors. "
@@ -136,7 +136,7 @@ class Thread : private mbed::NonCopyable<Thread> {
136136
}
137137
@endcode
138138
139-
@note This function cannot be called from ISR context.
139+
@note You cannot call this function from ISR context.
140140
*/
141141
template <typename T>
142142
MBED_DEPRECATED_SINCE("mbed-os-5.1",
@@ -168,7 +168,7 @@ class Thread : private mbed::NonCopyable<Thread> {
168168
}
169169
@endcode
170170
171-
@note This function cannot be called from ISR context.
171+
@note You cannot call this function from ISR context.
172172
*/
173173
template <typename T>
174174
MBED_DEPRECATED_SINCE("mbed-os-5.1",
@@ -201,7 +201,7 @@ class Thread : private mbed::NonCopyable<Thread> {
201201
}
202202
@endcode
203203
204-
@note This function cannot be called from ISR context.
204+
@note You cannot call this function from ISR context.
205205
*/
206206
MBED_DEPRECATED_SINCE("mbed-os-5.1",
207207
"Thread-spawning constructors hide errors. "
@@ -219,7 +219,7 @@ class Thread : private mbed::NonCopyable<Thread> {
219219
@return status code that indicates the execution status of the function.
220220
@note a thread can only be started once
221221
222-
@note This function cannot be called from ISR context.
222+
@note You cannot call this function ISR context.
223223
*/
224224
osStatus start(mbed::Callback<void()> task);
225225

@@ -230,7 +230,7 @@ class Thread : private mbed::NonCopyable<Thread> {
230230
@deprecated
231231
The start function does not support cv-qualifiers. Replaced by start(callback(obj, method)).
232232
233-
@note This function cannot be called from ISR context.
233+
@note You cannot call this function from ISR context.
234234
*/
235235
template <typename T, typename M>
236236
MBED_DEPRECATED_SINCE("mbed-os-5.1",
@@ -244,37 +244,37 @@ class Thread : private mbed::NonCopyable<Thread> {
244244
@return status code that indicates the execution status of the function.
245245
@note not callable from interrupt
246246
247-
@note This function cannot be called from ISR context.
247+
@note You cannot call this function from ISR context.
248248
*/
249249
osStatus join();
250250

251251
/** Terminate execution of a thread and remove it from Active Threads
252252
@return status code that indicates the execution status of the function.
253253
254-
@note This function cannot be called from ISR context.
254+
@note You cannot call this function from ISR context.
255255
*/
256256
osStatus terminate();
257257

258258
/** Set priority of an active thread
259259
@param priority new priority value for the thread function.
260260
@return status code that indicates the execution status of the function.
261261
262-
@note This function cannot be called from ISR context.
262+
@note You cannot call this function from ISR context.
263263
*/
264264
osStatus set_priority(osPriority priority);
265265

266266
/** Get priority of an active thread
267267
@return current priority value of the thread function.
268268
269-
@note This function cannot be called from ISR context.
269+
@note You cannot call this function from ISR context.
270270
*/
271271
osPriority get_priority();
272272

273273
/** Set the specified Thread Flags for the thread.
274274
@param signals specifies the signal flags of the thread that should be set.
275275
@return signal flags after setting or osFlagsError in case of incorrect parameters.
276276
277-
@note This function may be called from ISR context.
277+
@note You may call this function from ISR context.
278278
*/
279279
int32_t signal_set(int32_t signals);
280280

@@ -304,50 +304,50 @@ class Thread : private mbed::NonCopyable<Thread> {
304304
/** State of this Thread
305305
@return the State of this Thread
306306
307-
@note This function cannot be called from ISR context.
307+
@note You cannot call this function from ISR context.
308308
*/
309309
State get_state();
310310

311311
/** Get the total stack memory size for this Thread
312312
@return the total stack memory size in bytes
313313
314-
@note This function cannot be called from ISR context.
314+
@note You cannot call this function from ISR context.
315315
*/
316316
uint32_t stack_size();
317317

318318
/** Get the currently unused stack memory for this Thread
319319
@return the currently unused stack memory in bytes
320320
321-
@note This function cannot be called from ISR context.
321+
@note You cannot call this function from ISR context.
322322
*/
323323
uint32_t free_stack();
324324

325325
/** Get the currently used stack memory for this Thread
326326
@return the currently used stack memory in bytes
327327
328-
@note This function cannot be called from ISR context.
328+
@note You cannot call this function from ISR context.
329329
*/
330330
uint32_t used_stack();
331331

332332
/** Get the maximum stack memory usage to date for this Thread
333333
@return the maximum stack memory usage to date in bytes
334334
335-
@note This function cannot be called from ISR context.
335+
@note You cannot call this function from ISR context.
336336
*/
337337
uint32_t max_stack();
338338

339339
/** Get thread name
340340
@return thread name or NULL if the name was not set.
341341
342-
@note This function may be called from ISR context.
342+
@note You may call this function from ISR context.
343343
*/
344344
const char *get_name();
345345

346346
/** Clears the specified Thread Flags of the currently running thread.
347347
@param signals specifies the signal flags of the thread that should be cleared.
348348
@return signal flags before clearing or osFlagsError in case of incorrect parameters.
349349
350-
@note This function cannot be called from ISR context.
350+
@note You cannot call this function from ISR context.
351351
*/
352352
static int32_t signal_clr(int32_t signals);
353353

@@ -356,49 +356,49 @@ class Thread : private mbed::NonCopyable<Thread> {
356356
@param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
357357
@return event flag information or error code. @note if @a millisec is set to 0 and flag is no set the event carries osOK value.
358358
359-
@note This function cannot be called from ISR context.
359+
@note You cannot call this function from ISR context.
360360
*/
361361
static osEvent signal_wait(int32_t signals, uint32_t millisec=osWaitForever);
362362

363363
/** Wait for a specified time period in millisec:
364364
@param millisec time delay value
365365
@return status code that indicates the execution status of the function.
366366
367-
@note This function cannot be called from ISR context.
367+
@note You cannot call this function from ISR context.
368368
*/
369369
static osStatus wait(uint32_t millisec);
370370

371371
/** Pass control to next thread that is in state READY.
372372
@return status code that indicates the execution status of the function.
373373
374-
@note This function cannot be called from ISR context.
374+
@note You cannot call this function from ISR context.
375375
*/
376376
static osStatus yield();
377377

378378
/** Get the thread id of the current running thread.
379379
@return thread ID for reference by other functions or NULL in case of error.
380380
381-
@note This function may be called from ISR context.
381+
@note You may call this function from ISR context.
382382
*/
383383
static osThreadId gettid();
384384

385385
/** Attach a function to be called by the RTOS idle task
386386
@param fptr pointer to the function to be called
387387
388-
@note This function may be called from ISR context.
388+
@note You may call this function from ISR context.
389389
*/
390390
static void attach_idle_hook(void (*fptr)(void));
391391

392392
/** Attach a function to be called when a task is killed
393393
@param fptr pointer to the function to be called
394394
395-
@note This function may be called from ISR context.
395+
@note You may call this function from ISR context.
396396
*/
397397
static void attach_terminate_hook(void (*fptr)(osThreadId id));
398398

399399
/** Thread destructor
400400
*
401-
* @note This function cannot be called from ISR context.
401+
* @note You cannot call this function from ISR context.
402402
*/
403403
virtual ~Thread();
404404

0 commit comments

Comments
 (0)