Skip to content

Commit 0a8f5e0

Browse files
Cruz Monrreal IICruz Monrreal II
authored andcommitted
Merge branch 'sen_KernelDoxyUpdate' of ssh://github.com/SenRamakri/mbed-os into rollup
2 parents edb6d9d + 2418d9c commit 0a8f5e0

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

rtos/Kernel.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,26 +33,26 @@ namespace rtos {
3333
namespace Kernel {
3434

3535
/** Read the current RTOS kernel millisecond tick count.
36-
The tick count corresponds to the tick count used by the RTOS for timing
37-
purposes. It increments monotonically from 0 at boot, hence effectively
36+
The tick count corresponds to the tick count the RTOS uses for timing
37+
purposes. It increments monotonically from 0 at boot, so it effectively
3838
never wraps. If the underlying RTOS only provides a 32-bit tick count,
3939
this method expands it to 64 bits.
4040
@return RTOS kernel current tick count
41-
@note mbed OS always uses millisecond RTOS ticks, and this could only wrap
42-
after half a billion years
41+
@note Mbed OS always uses millisecond RTOS ticks, and this could only wrap
42+
after half a billion years.
4343
@note You cannot call this function from ISR context.
4444
*/
4545
uint64_t get_ms_count();
4646

47-
/** Attach a function to be called by the RTOS idle task
48-
@param fptr pointer to the function to be called
47+
/** Attach a function to be called by the RTOS idle task.
48+
@param fptr pointer to the function to be called
4949
5050
@note You may call this function from ISR context.
5151
*/
5252
void attach_idle_hook(void (*fptr)(void));
5353

54-
/** Attach a function to be called when a task is killed
55-
@param fptr pointer to the function to be called
54+
/** Attach a function to be called when a thread terminates.
55+
@param fptr pointer to the function to be called
5656
5757
@note You may call this function from ISR context.
5858
*/

0 commit comments

Comments
 (0)