Changeset 5ba93a5 in rtems


Ignore:
Timestamp:
Apr 16, 2019, 6:07:09 AM (6 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
6af85ee6
Parents:
fa3b4a2
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/16/19 06:07:09)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:05)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    rfa3b4a2 r5ba93a5  
    11/**
    22 * @file
     3 *
     4 * @ingroup RTEMSScoreStates
    35 *
    46 * @brief Inlined Routines Associated with Thread State Information
     
    2931/**
    3032 * @addtogroup RTEMSScoreStates
    31  */
    32 /**@{**/
     33 *
     34 * @{
     35 */
    3336
    3437/*
     
    142145
    143146/**
    144  * This function sets the given states_to_set into the current_state
    145  * passed in.  The result is returned to the user in current_state.
    146  *
    147  * @param[in] states_to_set is the state bits to set
    148  * @param[in] current_state is the state set to add them to
     147 * @brief Returns the result of setting the states to set to the given state.
     148 *
     149 * This function sets the given @a states_to_set into the @a current_state
     150 * passed in.  The result is returned to the user in @a current_state.
     151 *
     152 * @param states_to_set The state bits to set.
     153 * @param current_state The state set to add them to.
    149154 *
    150155 * @return This method returns the updated states value.
     
    159164
    160165/**
    161  * This function clears the given states_to_clear into the current_state
    162  * passed in.  The result is returned to the user in current_state.
    163  *
    164  * @param[in] states_to_clear is the state bits to clean
    165  * @param[in] current_state is the state set to remove them from
     166 * @brief Clears the states into the passed current state and returns the result.
     167 *
     168 * This function clears the given @a states_to_clear into the @a current_state
     169 * passed in.  The result is returned to the user in @a current_state.
     170 *
     171 * @param states_to_clear The state bits to clear.
     172 * @param current_state The state set to remove them from.
    166173 *
    167174 * @return This method returns the updated states value.
     
    176183
    177184/**
     185 * @brief Checks if the state is ready.
     186 *
    178187 * This function returns true if the_states indicates that the
    179188 * state is READY, and false otherwise.
    180189 *
    181  * @param[in] the_states is the task state set to test
    182  *
    183  * @return This method returns true if the desired state condition is set.
     190 * @param the_states The task state set to test.
     191 *
     192 * @retval true The state is ready.
     193 * @retval false The state is not ready.
    184194 */
    185195RTEMS_INLINE_ROUTINE bool _States_Is_ready (
     
    191201
    192202/**
     203 * @brief Checks if DORMANT state is set.
     204 *
    193205 * This function returns true if the DORMANT state is set in
    194  * the_states, and false otherwise.
    195  *
    196  * @param[in] the_states is the task state set to test
    197  *
    198  * @return This method returns true if the desired state condition is set.
     206 * @a the_states, and false otherwise.
     207 *
     208 * @param the_states The task state set to test.
     209 *
     210 * @retval true DORMANT state is set in @a the_states.
     211 * @retval false DORMANT state is not set in @a the_states.
    199212 */
    200213RTEMS_INLINE_ROUTINE bool _States_Is_dormant (
     
    206219
    207220/**
     221 * @brief Checks if SUSPENDED state is set.
     222 *
    208223 * This function returns true if the SUSPENDED state is set in
    209  * the_states, and false otherwise.
    210  *
    211  * @param[in] the_states is the task state set to test
    212  *
    213  * @return This method returns true if the desired state condition is set.
     224 * @a the_states, and false otherwise.
     225 *
     226 * @param the_states The task state set to test.
     227 *
     228 * @retval true SUSPENDED state is set in @a the_states.
     229 * @retval false SUSPENDED state is not set in @a the_states.
    214230 */
    215231RTEMS_INLINE_ROUTINE bool _States_Is_suspended (
     
    221237
    222238/**
     239 * @brief Checks if WAITING_FOR_TIME state is set.
     240 *
    223241 * This function returns true if the WAITING_FOR_TIME state is set in
    224  * the_states, and false otherwise.
    225  *
    226  * @param[in] the_states is the task state set to test
    227  *
    228  * @return This method returns true if the desired state condition is set.
     242 * @a the_states, and false otherwise.
     243 *
     244 * @param the_states The task state set to test.
     245 *
     246 * @retval true WAITING_FOR_TIME state is set in @a the_states.
     247 * @retval false WAITING_FOR_TIME state is not set in @a the_states.
    229248 */
    230249RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_rpc_reply (
     
    235254}
    236255
     256/**
     257 * @brief Checks if WAITING_FOR_JOIN_AT_EXIT state is set.
     258 *
     259 * This function returns true if the WAITING_FOR_JOIN_AT_EXIT state is set in
     260 * @a the_states, and false otherwise.
     261 *
     262 * @param the_states The task state set to test.
     263 *
     264 * @retval true WAITING_FOR_JOIN_AT_EXIT state is set in @a the_states.
     265 * @retval false WAITING_FOR_JOIN_AT_EXIT state is not set in @a the_states.
     266 */
    237267RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_join_at_exit(
    238268  States_Control the_states
     
    243273
    244274/**
     275 * @brief Checks if the state is set to be interruptible.
     276 *
    245277 * This function returns true if the task's state is set in
    246278 * way that allows it to be interrupted by a signal.
    247279 *
    248  * @param[in] the_states is the task state set to test
    249  *
    250  * @return This method returns true if the desired state condition is set.
     280 * @param the_states The task state set to test.
     281 *
     282 * @retval true @a the_states is interruptible.
     283 * @retval false @a the_states is not interruptible.
    251284 */
    252285RTEMS_INLINE_ROUTINE bool _States_Is_interruptible_by_signal (
     
    257290
    258291}
    259 /**
     292
     293/**
     294 * @brief Checks if the state is blocked waiting on a local resource.
     295 *
    260296 * This function returns true if one of the states which indicates
    261297 * that a task is blocked waiting for a local resource is set in
    262298 * the_states, and false otherwise.
    263299 *
    264  * @param[in] the_states is the task state set to test
    265  *
    266  * @return This method returns true if the desired state condition is set.
    267  */
    268 
     300 * @param the_states The task state set to test.
     301 *
     302 * @retval true The state indicates that the task is blocked waiting on a local
     303 *      resource.
     304 * @retval false The state indicates that the task is not blocked waiting on a
     305 *      local resource.
     306 */
    269307RTEMS_INLINE_ROUTINE bool _States_Is_locally_blocked (
    270308  States_Control the_states
Note: See TracChangeset for help on using the changeset viewer.