Changeset d16a9019 in rtems


Ignore:
Timestamp:
Apr 8, 2019, 8:27:58 AM (2 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
eab90bf
Parents:
86b05bf6
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/08/19 08:27:58)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:03)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    r86b05bf6 rd16a9019  
    11/**
    22 * @file
     3 *
     4 * @ingroup RTEMSScoreRWLock
    35 *
    46 * @brief Inlined Routines Associated with the SuperCore RWLock
     
    8890
    8991/**
    90  *  @brief Initialize a RWlock.
    91  *
    92  *  This routine initializes the RWLock based on the parameters passed.
    93  *
    94  *  @param[in] the_rwlock is the RWLock to initialize
     92 * @brief Initializes a RWlock.
     93 *
     94 * This routine initializes the RWLock.
     95 *
     96 * @param[out] the_rwlock is the RWLock to initialize.
    9597 */
    9698void _CORE_RWLock_Initialize(
     
    98100);
    99101
     102/**
     103 * @brief Destroys a RWlock.
     104 *
     105 * This routine destroys the RWLock.
     106 *
     107 * @param[out] the_rwlock is the RWLock to destroy.
     108 */
    100109RTEMS_INLINE_ROUTINE void _CORE_RWLock_Destroy(
    101110  CORE_RWLock_Control *the_rwlock
     
    105114}
    106115
     116/**
     117 * @brief Acquires the RWlock.
     118 *
     119 * @param[in, out] the_rwlock The RWlock to acquire.
     120 * @param queue_context The thread queue context.
     121 *
     122 * @return The executing thread.
     123 */
    107124RTEMS_INLINE_ROUTINE Thread_Control *_CORE_RWLock_Acquire(
    108125  CORE_RWLock_Control  *the_rwlock,
     
    125142}
    126143
     144/**
     145 * @brief Releases the RWlock.
     146 *
     147 * @param[in, out] the_rwlock The RWlock to release.
     148 * @param queue_context The thread queue context.
     149 */
    127150RTEMS_INLINE_ROUTINE void _CORE_RWLock_Release(
    128151  CORE_RWLock_Control  *the_rwlock,
     
    137160
    138161/**
    139  *  @brief Obtain RWLock for reading.
    140  *
    141  *  This routine attempts to obtain the RWLock for read access.
    142  *
    143  *  @param[in] the_rwlock is the RWLock to wait for
    144  *  @param[in] wait is true if the calling thread is willing to wait
     162 * @brief Obtains RWLock for reading.
     163 *
     164 * This routine attempts to obtain the RWLock for read access.
     165 *
     166 * @param[in, out] the_rwlock is the RWLock to wait for
     167 * @param wait Indicates whether the calling thread is willing to wait.
     168 * @param queue_context The thread queue context.
     169 *
     170 * @retval STATUS_SUCCESSFUL The RWlock was successfully seized.
     171 * @retval STATUS_UNAVAILABLE The RWlock is currently locked for writing
     172 *          and the calling thread is not willing to wait.
     173 * @retval STATUS_TIMEOUT A timeout occured.
    145174 */
    146175
     
    152181
    153182/**
    154  *  @brief Obtain RWLock for writing.
    155  *
    156  *  This routine attempts to obtain the RWLock for write exclusive access.
    157  *
    158  *  @param[in] the_rwlock is the RWLock to wait for
    159  *  @param[in] wait is true if the calling thread is willing to wait
     183 * @brief Obtains RWLock for writing.
     184 *
     185 * This routine attempts to obtain the RWLock for write exclusive access.
     186 *
     187 * @param[in, out] the_rwlock The RWLock to wait for.
     188 * @param wait Indicates whether the calling thread is willing to wait.
     189 * @param queue_context The thread queue context.
     190 *
     191 * @retval STATUS_SUCCESSFUL The RWLock was successfully obtained for write
     192 *          exclusive access.
     193 * @retval STATUS_UNAVAILABLE The RWlock is currently locked and the calling
     194 *          thread is not willing to wait.
     195 * @retval STATUS_TIMEOUT A timeout occurred.
    160196 */
    161197Status_Control _CORE_RWLock_Seize_for_writing(
     
    166202
    167203/**
    168  *  @brief Release the RWLock.
    169  *
    170  *  This routine manually releases @a the_rwlock.  All of the threads waiting
    171  *  for the RWLock will be readied.
    172  *
    173  *  @param[in] the_rwlock is the RWLock to surrender
    174  *
    175  *  @retval Status is returned to indicate successful or failure.
     204 * @brief Releases the RWLock.
     205 *
     206 * This routine manually releases @a the_rwlock.  All of the threads waiting
     207 * for the RWLock will be readied.
     208 *
     209 * @param[in, out] the_rwlock The RWLock to surrender.
     210 *
     211 * @return STATUS_SUCCESSFUL This method is always successful.
    176212 */
    177213Status_Control _CORE_RWLock_Surrender( CORE_RWLock_Control *the_rwlock );
Note: See TracChangeset for help on using the changeset viewer.