Changeset 1bd608b in rtems


Ignore:
Timestamp:
Apr 18, 2019, 7:54:49 AM (2 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
3238c162
Parents:
2463c10
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/18/19 07:54:49)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:05)
Message:

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

Update #3706.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/onceimpl.h

    r2463c10 r1bd608b  
    4040 */
    4141
     42/**
     43 * @brief Reacts according to the state of once_state.
     44 *
     45 * If once_state is ONCE_STATE_INIT, then the once state is set first to
     46 * ONCE_STATE_RUNNING and after calling the init routine it is set to
     47 * ONCE_STATE_COMPLETED. If once_state is ONCE_STATE_COMPLETED, nothing
     48 * happens. If once_state is not either one, this method waits for the
     49 * Once_Information_Mutex.
     50 *
     51 * @param once_state The once state.
     52 * @param init_routine The initialization routine called if @a once_state is ONCE_STATE_INIT.
     53 *
     54 * @return This method always returns zero upon termination.
     55 */
    4256int _Once( unsigned char *once_state, void ( *init_routine )( void ) );
    4357
     58/**
     59 * @brief Locks the Once_Information_Mutex and returns the thread life state.
     60 *
     61 * @return The thread life state (THREAD_LIFE_PROTECTED).
     62 */
    4463Thread_Life_state _Once_Lock( void );
    4564
     65/**
     66 * @brief Unlocks the Once_Information_Mutex and sets the thread life
     67 *      protection to thread_life_state.
     68 *
     69 * @param thread_life_state The thread life state to set the thread life
     70 *      protection to.
     71 */
    4672void _Once_Unlock( Thread_Life_state thread_life_state );
    4773
Note: See TracChangeset for help on using the changeset viewer.