Changeset 7d2cc98 in rtems


Ignore:
Timestamp:
Apr 18, 2019, 6:57:32 AM (6 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
eb84cc3f
Parents:
5791a3c
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/18/19 06:57:32)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:05)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    r5791a3c r7d2cc98  
    3131/**
    3232 * @addtogroup RTEMSScoreUserExt
    33  */
    34 /** @{ **/
     33 *
     34 * @{
     35 */
    3536
    3637/**
     
    7879/**
    7980 * @name Extension Maintainance
    80  */
    81 /** @{ **/
    82 
     81 *
     82 * @{
     83 */
     84
     85/**
     86 * @brief Initializes the user extensions handler.
     87 */
    8388void _User_extensions_Handler_initialization( void );
    8489
     90/**
     91 * @brief Adds a user extension.
     92 *
     93 * @param extension The user extension to add.
     94 */
    8595void _User_extensions_Add_set(
    8696  User_extensions_Control *extension
    8797);
    8898
     99/**
     100 * @brief Adds a user extension.
     101 *
     102 * @param extension The user extension to add.
     103 */
    89104RTEMS_INLINE_ROUTINE void _User_extensions_Add_API_set(
    90105  User_extensions_Control *extension
     
    94109}
    95110
     111/**
     112 * @brief Adds a user extension with the given extension table as callouts.
     113 *
     114 * @param[in, out] extension The user extension to add.
     115 * @param extension_table Is set as callouts for @a extension.
     116 */
    96117RTEMS_INLINE_ROUTINE void _User_extensions_Add_set_with_table(
    97118  User_extensions_Control     *extension,
     
    104125}
    105126
     127/**
     128 * @brief Removes a user extension.
     129 *
     130 * @param extension The user extension to remove.
     131 */
    106132void _User_extensions_Remove_set(
    107133  User_extensions_Control *extension
     
    126152} User_extensions_Thread_create_context;
    127153
     154/**
     155 * @brief Creates a visitor.
     156 *
     157 * @param executing The currently executing thread.
     158 * @param[in, out] arg Is used as the thread create context for the operation.
     159 * @param callouts The user extension table for the operation.
     160 */
    128161void _User_extensions_Thread_create_visitor(
    129162  Thread_Control              *executing,
     
    132165);
    133166
     167/**
     168 * @brief Deletes a visitor.
     169 *
     170 * @param executing The currently executing thread.
     171 * @param[in, out] arg Parameter for the callout.
     172 * @param callouts The user extension table for the operation.
     173 */
    134174void _User_extensions_Thread_delete_visitor(
    135175  Thread_Control              *executing,
     
    138178);
    139179
     180/**
     181 * @brief Starts a visitor.
     182 *
     183 * @param executing The currently executing thread.
     184 * @param arg Parameter for the callout.
     185 * @param callouts The user extension table for the operation.
     186 */
    140187void _User_extensions_Thread_start_visitor(
    141188  Thread_Control              *executing,
     
    144191);
    145192
     193/**
     194 * @brief Restarts a visitor.
     195 *
     196 * @param executing The currently executing thread.
     197 * @param arg Parameter for the callout.
     198 * @param callouts The user extension table for the operation.
     199 */
    146200void _User_extensions_Thread_restart_visitor(
    147201  Thread_Control              *executing,
     
    150204);
    151205
     206/**
     207 * @brief Calls the begin function of the thread callout for the visitor.
     208 *
     209 * @param executing The currently executing thread.
     210 * @param arg This parameter is unused.
     211 * @param callouts The user extension table for the operation.
     212 */
    152213void _User_extensions_Thread_begin_visitor(
    153214  Thread_Control              *executing,
     
    156217);
    157218
     219/**
     220 * @brief Calls the exitted function of the thread callout for the visitor.
     221 *
     222 * @param executing The currently executing thread.
     223 * @param arg This parameter is unused.
     224 * @param callouts The user extension table for the operation.
     225 */
    158226void _User_extensions_Thread_exitted_visitor(
    159227  Thread_Control              *executing,
     
    167235} User_extensions_Fatal_context;
    168236
     237/**
     238 * @brief Calls the fatal function of the thread callout for the visitor.
     239 *
     240 * @param executing The currently executing thread.
     241 * @param arg Is used as the user extension fatal context.
     242 * @param callouts The user extension table for the operation.
     243 */
    169244void _User_extensions_Fatal_visitor(
    170245  Thread_Control              *executing,
     
    173248);
    174249
     250/**
     251 * @brief Terminates a visitor.
     252 *
     253 * @param executing The currently executing thread.
     254 * @param arg This parameter is unused.
     255 * @param callouts The user extension table for the operation.
     256 */
    175257void _User_extensions_Thread_terminate_visitor(
    176258  Thread_Control              *executing,
     
    183265 *
    184266 * @param[in, out] arg The argument passed to the visitor.
    185  * @param[in] visitor The visitor for each extension.
    186  * @param[in] direction The iteration direction for dynamic extensions.
     267 * @param visitor The visitor for each extension.
     268 * @param direction The iteration direction for dynamic extensions.
    187269 */
    188270void _User_extensions_Iterate(
     
    199281/** @{ **/
    200282
     283/**
     284 * @brief Creates a thread.
     285 *
     286 * @param[out] created The thread to create.
     287 *
     288 * @retval true The operation succeeded.
     289 * @retval false The operation failed.
     290 */
    201291static inline bool _User_extensions_Thread_create( Thread_Control *created )
    202292{
     
    212302}
    213303
     304/**
     305 * @brief Deletes a thread.
     306 *
     307 * @param[out] created The thread to delete.
     308 */
    214309static inline void _User_extensions_Thread_delete( Thread_Control *deleted )
    215310{
     
    221316}
    222317
     318/**
     319 * @brief Starts a thread.
     320 *
     321 * @param created The thread to start.
     322 */
    223323static inline void _User_extensions_Thread_start( Thread_Control *started )
    224324{
     
    230330}
    231331
     332/**
     333 * @brief Restarts a thread.
     334 *
     335 * @param created The thread to restart.
     336 */
    232337static inline void _User_extensions_Thread_restart( Thread_Control *restarted )
    233338{
     
    239344}
    240345
     346/**
     347 * @brief Begins a thread.
     348 *
     349 * @param created The thread to begin.
     350 */
    241351static inline void _User_extensions_Thread_begin( Thread_Control *executing )
    242352{
     
    248358}
    249359
     360/**
     361 * @brief Switches the thread from the executing to the heir.
     362 *
     363 * @param executing The currently executing thread.
     364 * @param heir The thread that will switch with @a executing.
     365 */
    250366static inline void _User_extensions_Thread_switch(
    251367  Thread_Control *executing,
     
    289405}
    290406
     407/**
     408 * @brief A user extension thread exitted.
     409 *
     410 * @param created The thread.
     411 */
    291412static inline void _User_extensions_Thread_exitted( Thread_Control *executing )
    292413{
     
    298419}
    299420
     421/**
     422 * @brief Forwards all visitors that there was a fatal failure.
     423 *
     424 * @param source The error source.
     425 * @param error The error.
     426 */
    300427static inline void _User_extensions_Fatal(
    301428  Internal_errors_Source source,
     
    312439}
    313440
     441/**
     442 * @brief Terminates the executing thread.
     443 *
     444 * @param executing The currently executing thread.
     445 */
    314446static inline void _User_extensions_Thread_terminate(
    315447  Thread_Control *executing
     
    323455}
    324456
     457/**
     458 * @brief Disables interrupts and acquires the lock context.
     459 *
     460 * @param lock_context The lock context to acquire.
     461 */
    325462static inline void _User_extensions_Acquire( ISR_lock_Context *lock_context )
    326463{
     
    331468}
    332469
     470/**
     471 * @brief Releases the lock context and enables interrupts.
     472 *
     473 * @param lock_context The lock context to release.
     474 */
    333475static inline void _User_extensions_Release( ISR_lock_Context *lock_context )
    334476{
     
    339481}
    340482
     483/**
     484 * @brief Destroys all user extension iterators of a thread.
     485 *
     486 * @param[in, out] the_thread The thread to destroy all user extension
     487 *      iterators of.
     488 */
    341489static inline void _User_extensions_Destroy_iterators(
    342490  Thread_Control *the_thread
Note: See TracChangeset for help on using the changeset viewer.