Changeset 776ec05 in rtems


Ignore:
Timestamp:
Apr 12, 2019, 11:16:01 AM (2 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
d0839dd
Parents:
391f92b9
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/12/19 11:16:01)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:04)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    r391f92b9 r776ec05  
    11/**
    2  *  @file
     2 * @file
    33 *
    4  *  @brief Manipulation of Threads Simple-Priority-Based Ready Queue
     4 * @ingroup RTEMSScoreSchedulerSimple
    55 *
    6  *  This include file contains all the constants and structures associated
    7  *  with the manipulation of threads on a simple-priority-based ready queue.
     6 * @brief Manipulation of Threads Simple-Priority-Based Ready Queue
     7 *
     8 * This include file contains all the constants and structures associated
     9 * with the manipulation of threads on a simple-priority-based ready queue.
    810 */
    911
     
    2729
    2830/**
    29  *  @defgroup RTEMSScoreSchedulerSimple Simple Priority Scheduler
     31 * @defgroup RTEMSScoreSchedulerSimple Simple Priority Scheduler
    3032 *
    31  *  @ingroup RTEMSScoreScheduler
     33 * @ingroup RTEMSScoreScheduler
     34 *
     35 * @brief Simple Priority Scheduler
     36 *
     37 * @{
    3238 */
    33 /**@{*/
    3439
    3540#define SCHEDULER_SIMPLE_MAXIMUM_PRIORITY 255
     
    7479
    7580/**
    76  *  @brief Initialize simple scheduler.
     81 * @brief Initializes simple scheduler.
    7782 *
    78  *  This routine initializes the simple scheduler.
     83 * This routine initializes the simple scheduler.
     84 *
     85 * @param scheduler The scheduler to be initialized.
    7986 */
    8087void _Scheduler_simple_Initialize( const Scheduler_Control *scheduler );
    8188
    8289/**
    83  *  This routine sets the heir thread to be the next ready thread
    84  *  on the ready queue by getting the first node in the scheduler
    85  *  information.
     90 * @brief Schedules threads.
    8691 *
    87  *  @param[in] scheduler The scheduler instance.
    88  *  @param[in] the_thread causing the scheduling operation.
     92 * This routine sets the heir thread to be the next ready thread
     93 * on the ready queue by getting the first node in the scheduler
     94 * information.
     95 *
     96 * @param scheduler The scheduler instance.
     97 * @param the_thread causing the scheduling operation.
    8998 */
    9099void _Scheduler_simple_Schedule(
     
    93102);
    94103
     104/**
     105 * @brief Performs the yield of a thread.
     106 *
     107 * @param scheduler The scheduler instance.
     108 * @param[in, out] the_thread The thread that performed the yield operation.
     109 * @param node The scheduler node of @a the_thread.
     110 */
    95111void _Scheduler_simple_Yield(
    96112  const Scheduler_Control *scheduler,
     
    99115);
    100116
     117/**
     118 * @brief Blocks the thread.
     119 *
     120 * @param scheduler The scheduler instance.
     121 * @param[in, out] the_thread The thread to block.
     122 * @param[in, out] node The @a thread's scheduler node.
     123 */
    101124void _Scheduler_simple_Block(
    102125  const Scheduler_Control *scheduler,
     
    105128);
    106129
     130/**
     131 * @brief Unblocks the thread.
     132 *
     133 * @param scheduler The scheduler instance.
     134 * @param[in, out] the_thread The thread to unblock.
     135 * @param[in, out] node The @a thread's scheduler node.
     136 */
    107137void _Scheduler_simple_Unblock(
    108138  const Scheduler_Control *scheduler,
     
    111141);
    112142
     143/**
     144 * @brief Updates the priority of the node.
     145 *
     146 * @param scheduler The scheduler instance.
     147 * @param the_thread The thread for the operation.
     148 * @param node The thread's scheduler node.
     149 */
    113150void _Scheduler_simple_Update_priority(
    114151  const Scheduler_Control *scheduler,
     
    117154);
    118155
    119 /**@}*/
     156/** @} */
    120157
    121158#ifdef __cplusplus
Note: See TracChangeset for help on using the changeset viewer.