Skip to content

Add the Doxygen note to non-supported RTOS kernel APIs. #12872

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.

Sign up for GitHub

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 1 commit into from
Apr 29, 2020
Merged

Add the Doxygen note to non-supported RTOS kernel APIs. #12872

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions rtos/Kernel.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,15 @@ uint64_t get_ms_count();
@param fptr pointer to the function to be called

@note You may call this function from ISR context.
@note Bare metal profile: This API is not supported.
*/
void attach_idle_hook(void (*fptr)(void));

/** 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.
@note Bare metal profile: This API is not supported.
*/
void attach_thread_terminate_hook(void (*fptr)(osThreadId_t id));

Expand Down