Skip to content

Kernel.h doxygen update #8435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 7, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions rtos/Kernel.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,26 @@ namespace rtos {
namespace Kernel {

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

/** Attach a function to be called by the RTOS idle task
@param fptr pointer to the function to be called
/** Attach a function to be called by the RTOS idle task.
@param fptr pointer to the function to be called

@note You may call this function from ISR context.
*/
void attach_idle_hook(void (*fptr)(void));

/** Attach a function to be called when a task is killed
@param fptr pointer to the function to be called
/** Attach a function to be called when a thread terminates.
@param fptr pointer to the function to be called

@note You may call this function from ISR context.
*/
Expand Down