@@ -81,7 +81,7 @@ class Thread : private mbed::NonCopyable<Thread> {
81
81
@param stack_mem pointer to the stack area to be used by this thread (default: NULL).
82
82
@param name name to be used for this thread. It has to stay allocated for the lifetime of the thread (default: NULL)
83
83
84
- @note This function cannot be called from ISR context.
84
+ @note You cannot call this function from ISR context.
85
85
*/
86
86
Thread (osPriority priority=osPriorityNormal,
87
87
uint32_t stack_size=OS_STACK_SIZE,
@@ -106,7 +106,7 @@ class Thread : private mbed::NonCopyable<Thread> {
106
106
}
107
107
@endcode
108
108
109
- @note This function cannot be called from ISR context.
109
+ @note You cannot call this function from ISR context.
110
110
*/
111
111
MBED_DEPRECATED_SINCE (" mbed-os-5.1" ,
112
112
" Thread-spawning constructors hide errors. "
@@ -136,7 +136,7 @@ class Thread : private mbed::NonCopyable<Thread> {
136
136
}
137
137
@endcode
138
138
139
- @note This function cannot be called from ISR context.
139
+ @note You cannot call this function from ISR context.
140
140
*/
141
141
template <typename T>
142
142
MBED_DEPRECATED_SINCE (" mbed-os-5.1" ,
@@ -168,7 +168,7 @@ class Thread : private mbed::NonCopyable<Thread> {
168
168
}
169
169
@endcode
170
170
171
- @note This function cannot be called from ISR context.
171
+ @note You cannot call this function from ISR context.
172
172
*/
173
173
template <typename T>
174
174
MBED_DEPRECATED_SINCE (" mbed-os-5.1" ,
@@ -201,7 +201,7 @@ class Thread : private mbed::NonCopyable<Thread> {
201
201
}
202
202
@endcode
203
203
204
- @note This function cannot be called from ISR context.
204
+ @note You cannot call this function from ISR context.
205
205
*/
206
206
MBED_DEPRECATED_SINCE (" mbed-os-5.1" ,
207
207
" Thread-spawning constructors hide errors. "
@@ -219,7 +219,7 @@ class Thread : private mbed::NonCopyable<Thread> {
219
219
@return status code that indicates the execution status of the function.
220
220
@note a thread can only be started once
221
221
222
- @note This function cannot be called from ISR context.
222
+ @note You cannot call this function ISR context.
223
223
*/
224
224
osStatus start (mbed::Callback<void ()> task);
225
225
@@ -230,7 +230,7 @@ class Thread : private mbed::NonCopyable<Thread> {
230
230
@deprecated
231
231
The start function does not support cv-qualifiers. Replaced by start(callback(obj, method)).
232
232
233
- @note This function cannot be called from ISR context.
233
+ @note You cannot call this function from ISR context.
234
234
*/
235
235
template <typename T, typename M>
236
236
MBED_DEPRECATED_SINCE (" mbed-os-5.1" ,
@@ -244,37 +244,37 @@ class Thread : private mbed::NonCopyable<Thread> {
244
244
@return status code that indicates the execution status of the function.
245
245
@note not callable from interrupt
246
246
247
- @note This function cannot be called from ISR context.
247
+ @note You cannot call this function from ISR context.
248
248
*/
249
249
osStatus join ();
250
250
251
251
/* * Terminate execution of a thread and remove it from Active Threads
252
252
@return status code that indicates the execution status of the function.
253
253
254
- @note This function cannot be called from ISR context.
254
+ @note You cannot call this function from ISR context.
255
255
*/
256
256
osStatus terminate ();
257
257
258
258
/* * Set priority of an active thread
259
259
@param priority new priority value for the thread function.
260
260
@return status code that indicates the execution status of the function.
261
261
262
- @note This function cannot be called from ISR context.
262
+ @note You cannot call this function from ISR context.
263
263
*/
264
264
osStatus set_priority (osPriority priority);
265
265
266
266
/* * Get priority of an active thread
267
267
@return current priority value of the thread function.
268
268
269
- @note This function cannot be called from ISR context.
269
+ @note You cannot call this function from ISR context.
270
270
*/
271
271
osPriority get_priority ();
272
272
273
273
/* * Set the specified Thread Flags for the thread.
274
274
@param signals specifies the signal flags of the thread that should be set.
275
275
@return signal flags after setting or osFlagsError in case of incorrect parameters.
276
276
277
- @note This function may be called from ISR context.
277
+ @note You may call this function from ISR context.
278
278
*/
279
279
int32_t signal_set (int32_t signals);
280
280
@@ -304,50 +304,50 @@ class Thread : private mbed::NonCopyable<Thread> {
304
304
/* * State of this Thread
305
305
@return the State of this Thread
306
306
307
- @note This function cannot be called from ISR context.
307
+ @note You cannot call this function from ISR context.
308
308
*/
309
309
State get_state ();
310
310
311
311
/* * Get the total stack memory size for this Thread
312
312
@return the total stack memory size in bytes
313
313
314
- @note This function cannot be called from ISR context.
314
+ @note You cannot call this function from ISR context.
315
315
*/
316
316
uint32_t stack_size ();
317
317
318
318
/* * Get the currently unused stack memory for this Thread
319
319
@return the currently unused stack memory in bytes
320
320
321
- @note This function cannot be called from ISR context.
321
+ @note You cannot call this function from ISR context.
322
322
*/
323
323
uint32_t free_stack ();
324
324
325
325
/* * Get the currently used stack memory for this Thread
326
326
@return the currently used stack memory in bytes
327
327
328
- @note This function cannot be called from ISR context.
328
+ @note You cannot call this function from ISR context.
329
329
*/
330
330
uint32_t used_stack ();
331
331
332
332
/* * Get the maximum stack memory usage to date for this Thread
333
333
@return the maximum stack memory usage to date in bytes
334
334
335
- @note This function cannot be called from ISR context.
335
+ @note You cannot call this function from ISR context.
336
336
*/
337
337
uint32_t max_stack ();
338
338
339
339
/* * Get thread name
340
340
@return thread name or NULL if the name was not set.
341
341
342
- @note This function may be called from ISR context.
342
+ @note You may call this function from ISR context.
343
343
*/
344
344
const char *get_name ();
345
345
346
346
/* * Clears the specified Thread Flags of the currently running thread.
347
347
@param signals specifies the signal flags of the thread that should be cleared.
348
348
@return signal flags before clearing or osFlagsError in case of incorrect parameters.
349
349
350
- @note This function cannot be called from ISR context.
350
+ @note You cannot call this function from ISR context.
351
351
*/
352
352
static int32_t signal_clr (int32_t signals);
353
353
@@ -356,49 +356,49 @@ class Thread : private mbed::NonCopyable<Thread> {
356
356
@param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
357
357
@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.
358
358
359
- @note This function cannot be called from ISR context.
359
+ @note You cannot call this function from ISR context.
360
360
*/
361
361
static osEvent signal_wait (int32_t signals, uint32_t millisec=osWaitForever);
362
362
363
363
/* * Wait for a specified time period in millisec:
364
364
@param millisec time delay value
365
365
@return status code that indicates the execution status of the function.
366
366
367
- @note This function cannot be called from ISR context.
367
+ @note You cannot call this function from ISR context.
368
368
*/
369
369
static osStatus wait (uint32_t millisec);
370
370
371
371
/* * Pass control to next thread that is in state READY.
372
372
@return status code that indicates the execution status of the function.
373
373
374
- @note This function cannot be called from ISR context.
374
+ @note You cannot call this function from ISR context.
375
375
*/
376
376
static osStatus yield ();
377
377
378
378
/* * Get the thread id of the current running thread.
379
379
@return thread ID for reference by other functions or NULL in case of error.
380
380
381
- @note This function may be called from ISR context.
381
+ @note You may call this function from ISR context.
382
382
*/
383
383
static osThreadId gettid ();
384
384
385
385
/* * Attach a function to be called by the RTOS idle task
386
386
@param fptr pointer to the function to be called
387
387
388
- @note This function may be called from ISR context.
388
+ @note You may call this function from ISR context.
389
389
*/
390
390
static void attach_idle_hook (void (*fptr)(void ));
391
391
392
392
/* * Attach a function to be called when a task is killed
393
393
@param fptr pointer to the function to be called
394
394
395
- @note This function may be called from ISR context.
395
+ @note You may call this function from ISR context.
396
396
*/
397
397
static void attach_terminate_hook (void (*fptr)(osThreadId id));
398
398
399
399
/* * Thread destructor
400
400
*
401
- * @note This function cannot be called from ISR context.
401
+ * @note You cannot call this function from ISR context.
402
402
*/
403
403
virtual ~Thread ();
404
404
0 commit comments