From ceff06f8fb8584bbbd8aa36e52c4133b5d27b495 Mon Sep 17 00:00:00 2001 From: Andreas Dachsberger Date: Mon, 15 Apr 2019 08:21:20 +0200 Subject: doxygen: score: adjust doc in schedulersmp.h to doxygen guidelines Update #3706. --- cpukit/include/rtems/score/schedulersmp.h | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/cpukit/include/rtems/score/schedulersmp.h b/cpukit/include/rtems/score/schedulersmp.h index afc504bb83..268585f0be 100644 --- a/cpukit/include/rtems/score/schedulersmp.h +++ b/cpukit/include/rtems/score/schedulersmp.h @@ -1,9 +1,9 @@ /** * @file * - * @brief SMP Scheduler API - * * @ingroup RTEMSScoreSchedulerSMP + * + * @brief SMP Scheduler API */ /* @@ -35,6 +35,8 @@ extern "C" { * * @ingroup RTEMSScoreScheduler * + * @brief SMP Scheduler + * * @{ */ @@ -112,6 +114,13 @@ typedef struct { Priority_Control priority; } Scheduler_SMP_Node; +/** + * @brief Starts an idle thread on the specified cpu. + * + * @param scheduler The scheduler instance. + * @param[in, out] idle The idle thread to schedule. + * @param[out] cpu The cpu to run the idle thread on. + */ void _Scheduler_SMP_Start_idle( const Scheduler_Control *scheduler, Thread_Control *idle, -- cgit v1.2.3