RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

doxygen: score: adjust doc in onceimpl.h to doxygen guidelines

Browse Source 
Update #3706.
This commit is contained in:
Andreas Dachsberger
2019-04-18 09:54:49 +02:00
committed by Sebastian Huber
parent 2463c100cc
commit 1bd608b91e
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
cpukit/include/rtems/score/onceimpl.h
View File

@@ -39,10 +39,36 @@ extern "C" {
* @{
*/
/**
* @brief Reacts according to the state of once_state.
*
* If once_state is ONCE_STATE_INIT, then the once state is set first to
* ONCE_STATE_RUNNING and after calling the init routine it is set to
* ONCE_STATE_COMPLETED. If once_state is ONCE_STATE_COMPLETED, nothing
* happens. If once_state is not either one, this method waits for the
* Once_Information_Mutex.
*
* @param once_state The once state.
* @param init_routine The initialization routine called if @a once_state is ONCE_STATE_INIT.
*
* @return This method always returns zero upon termination.
*/
int _Once( unsigned char *once_state, void ( *init_routine )( void ) );
/**
* @brief Locks the Once_Information_Mutex and returns the thread life state.
*
* @return The thread life state (THREAD_LIFE_PROTECTED).
*/
Thread_Life_state _Once_Lock( void );
/**
* @brief Unlocks the Once_Information_Mutex and sets the thread life
* protection to thread_life_state.
*
* @param thread_life_state The thread life state to set the thread life
* protection to.
*/
void _Once_Unlock( Thread_Life_state thread_life_state );
/** @} */