From a7e4de250436df590529cc7a295d099ade77d9d5 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Fri, 6 Mar 2015 14:33:08 -0600 Subject: Fix even more Doxygen issues --- cpukit/libcsupport/include/rtems/error.h | 2 +- cpukit/sapi/include/rtems/counter.h | 2 +- cpukit/score/include/rtems/score/cpusetimpl.h | 1 - cpukit/score/include/rtems/score/scheduler.h | 4 +++- cpukit/score/include/rtems/score/schedulercbs.h | 2 ++ cpukit/score/include/rtems/score/scheduleredf.h | 20 +++++++++++++++++--- cpukit/score/include/rtems/score/schedulerimpl.h | 3 ++- cpukit/score/include/rtems/score/schedulerpriority.h | 7 ++++++- .../rtems/score/schedulerpriorityaffinitysmp.h | 2 +- cpukit/score/include/rtems/score/schedulersimple.h | 8 +++++++- cpukit/score/include/rtems/score/threadimpl.h | 2 ++ 11 files changed, 42 insertions(+), 11 deletions(-) diff --git a/cpukit/libcsupport/include/rtems/error.h b/cpukit/libcsupport/include/rtems/error.h index cbcfa98614..c81cc66cc7 100644 --- a/cpukit/libcsupport/include/rtems/error.h +++ b/cpukit/libcsupport/include/rtems/error.h @@ -113,7 +113,7 @@ int rtems_error( * * @param[in] printf_format is a normal printf(3) format string, * with its concommitant arguments - * @param[in] @p arglist is a varargs list corresponding to + * @param[in] arglist is a varargs list corresponding to * printf_format * * @return the number of characters written. diff --git a/cpukit/sapi/include/rtems/counter.h b/cpukit/sapi/include/rtems/counter.h index bc46925fea..3b428402a8 100644 --- a/cpukit/sapi/include/rtems/counter.h +++ b/cpukit/sapi/include/rtems/counter.h @@ -123,7 +123,7 @@ rtems_counter_ticks rtems_counter_nanoseconds_to_ticks( * rtems_counter_nanoseconds_to_ticks() functions. It should be called during * system initialization by the board support package. * - * @param[in] uint32_t frequency The current counter frequency in Hz. + * @param[in] frequency The current counter frequency in Hz. */ void rtems_counter_initialize_converter( uint32_t frequency ); diff --git a/cpukit/score/include/rtems/score/cpusetimpl.h b/cpukit/score/include/rtems/score/cpusetimpl.h index a898d64cd8..226c3a1806 100644 --- a/cpukit/score/include/rtems/score/cpusetimpl.h +++ b/cpukit/score/include/rtems/score/cpusetimpl.h @@ -51,7 +51,6 @@ bool _CPU_set_Is_valid( const cpu_set_t *cpuset, size_t setsize ); * * @param[in] description is a string to print before the value. * @param[in] cpuset is the cpuset to validate - * @param[in] setsize is the number of CPUs in the cpuset */ void _CPU_set_Show( const char *description, const cpu_set_t *cpuset); diff --git a/cpukit/score/include/rtems/score/scheduler.h b/cpukit/score/include/rtems/score/scheduler.h index 8bace85f2a..67c6e2564c 100644 --- a/cpukit/score/include/rtems/score/scheduler.h +++ b/cpukit/score/include/rtems/score/scheduler.h @@ -488,7 +488,7 @@ void _Scheduler_default_Release_job( * This routine is invoked as part of processing each clock tick. * * @param[in] scheduler The scheduler. - * @param[in] execution An executing thread. + * @param[in] executing An executing thread. */ void _Scheduler_default_Tick( const Scheduler_Control *scheduler, @@ -512,6 +512,7 @@ void _Scheduler_default_Start_idle( /** * @brief Get affinity for the default scheduler. * + * @param[in] scheduler The scheduler instance. * @param[in] thread The associated thread. * @param[in] cpusetsize The size of the cpuset. * @param[out] cpuset Affinity set containing all CPUs. @@ -529,6 +530,7 @@ void _Scheduler_default_Start_idle( /** * @brief Set affinity for the default scheduler. * + * @param[in] scheduler The scheduler instance. * @param[in] thread The associated thread. * @param[in] cpusetsize The size of the cpuset. * @param[in] cpuset Affinity new affinity set. diff --git a/cpukit/score/include/rtems/score/schedulercbs.h b/cpukit/score/include/rtems/score/schedulercbs.h index b3381e0e43..5558d6e919 100644 --- a/cpukit/score/include/rtems/score/schedulercbs.h +++ b/cpukit/score/include/rtems/score/schedulercbs.h @@ -150,6 +150,7 @@ extern Scheduler_CBS_Server _Scheduler_CBS_Server_list[]; * remaining budget is sufficient. If not, the thread continues as a * new job in order to protect concurrent threads. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread will be unblocked. * * @note This has to be asessed as missed deadline of the current job. @@ -166,6 +167,7 @@ Scheduler_Void_or_thread _Scheduler_CBS_Unblock( * It is called only from Rate Monotonic manager in the beginning * of new period. Deadline has to be shifted and budget replenished. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread is the owner of the job. * @param[in] length of the new job from now. If equal to 0, * the job was cancelled or deleted. diff --git a/cpukit/score/include/rtems/score/scheduleredf.h b/cpukit/score/include/rtems/score/scheduleredf.h index e69569156d..9b0d1b4099 100644 --- a/cpukit/score/include/rtems/score/scheduleredf.h +++ b/cpukit/score/include/rtems/score/scheduleredf.h @@ -114,9 +114,11 @@ typedef struct { } Scheduler_EDF_Node; /** - * @brief Initialize EDF scheduler. + * @brief Initialize EDF scheduler. * - * This routine initializes the EDF scheduler. + * This routine initializes the EDF scheduler. + * + * @param[in] scheduler The scheduler instance. */ void _Scheduler_EDF_Initialize( const Scheduler_Control *scheduler ); @@ -128,6 +130,7 @@ void _Scheduler_EDF_Initialize( const Scheduler_Control *scheduler ); * any necessary scheduling operations including the selection of * a new heir thread. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread is the thread to be blocked. */ void _Scheduler_EDF_Block( @@ -141,6 +144,9 @@ void _Scheduler_EDF_Block( * * This kernel routine sets the heir thread to be the next ready thread * in the rbtree ready queue. + * + * @param[in] scheduler The scheduler instance. + * @param[in] the_thread being scheduled. */ void _Scheduler_EDF_Schedule( const Scheduler_Control *scheduler, @@ -149,6 +155,9 @@ void _Scheduler_EDF_Schedule( /** * @brief Initializes an EDF specific scheduler node of @a the_thread. + * + * @param[in] scheduler The scheduler instance. + * @param[in] the_thread being initialized. */ void _Scheduler_EDF_Node_initialize( const Scheduler_Control *scheduler, @@ -160,8 +169,10 @@ void _Scheduler_EDF_Node_initialize( * * This routine updates position in the ready queue of @a the_thread. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread will have its scheduler specific information * structure updated. + * @param[in] new_priority is the desired new priority. */ void _Scheduler_EDF_Update_priority( const Scheduler_Control *scheduler, @@ -176,6 +187,7 @@ void _Scheduler_EDF_Update_priority( * adds it to the ready queue and updates any appropriate scheduling * variables, for example the heir thread. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread will be unblocked. */ Scheduler_Void_or_thread _Scheduler_EDF_Unblock( @@ -203,7 +215,8 @@ Scheduler_Void_or_thread _Scheduler_EDF_Change_priority( * and place it back. The rbtree ready queue is responsible for FIFO ordering * in such a case. * - * @param[in,out] thread The yielding thread. + * @param[in] scheduler The scheduler instance. + * @param[in,out] the_thread The yielding thread. */ Scheduler_Void_or_thread _Scheduler_EDF_Yield( const Scheduler_Control *scheduler, @@ -230,6 +243,7 @@ int _Scheduler_EDF_Priority_compare ( * It is called only from Rate Monotonic manager in the beginning * of new period. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread is the owner of the job. * @param[in] deadline of the new job from now. If equal to 0, * the job was cancelled or deleted, thus a running task diff --git a/cpukit/score/include/rtems/score/schedulerimpl.h b/cpukit/score/include/rtems/score/schedulerimpl.h index 7bf4038b5e..43257c4a7a 100644 --- a/cpukit/score/include/rtems/score/schedulerimpl.h +++ b/cpukit/score/include/rtems/score/schedulerimpl.h @@ -471,8 +471,9 @@ RTEMS_INLINE_ROUTINE void _Scheduler_Tick( void ) /** * @brief Starts the idle thread for a particular processor. * + * @param[in] scheduler The scheduler instance. * @param[in,out] the_thread The idle thread for the processor. - * @parma[in,out] processor The processor for the idle thread. + * @param[in,out] cpu The processor for the idle thread. * * @see _Thread_Create_idle(). */ diff --git a/cpukit/score/include/rtems/score/schedulerpriority.h b/cpukit/score/include/rtems/score/schedulerpriority.h index de051a8114..5859af12f3 100644 --- a/cpukit/score/include/rtems/score/schedulerpriority.h +++ b/cpukit/score/include/rtems/score/schedulerpriority.h @@ -113,6 +113,7 @@ void _Scheduler_priority_Initialize( const Scheduler_Control *scheduler ); * any necessary scheduling operations including the selection of * a new heir thread. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread is the thread to be blocked */ void _Scheduler_priority_Block( @@ -148,6 +149,7 @@ void _Scheduler_priority_Update_priority( * that is, adds it to the ready queue and * updates any appropriate scheduling variables, for example the heir thread. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread will be unblocked */ Scheduler_Void_or_thread _Scheduler_priority_Unblock( @@ -179,7 +181,8 @@ Scheduler_Void_or_thread _Scheduler_priority_Change_priority( * + ready chain * + select heir * - * @param[in,out] thread The yielding thread. + * @param[in] scheduler The scheduler instance. + * @param[in,out] the_thread The yielding thread. */ Scheduler_Void_or_thread _Scheduler_priority_Yield( const Scheduler_Control *scheduler, @@ -190,6 +193,8 @@ Scheduler_Void_or_thread _Scheduler_priority_Yield( * @brief Compare two priorities. * * This routine compares two priorities. + * + * @retval >0 for p1 > p2; 0 for p1 == p2; <0 for p1 < p2. */ int _Scheduler_priority_Priority_compare( Priority_Control p1, diff --git a/cpukit/score/include/rtems/score/schedulerpriorityaffinitysmp.h b/cpukit/score/include/rtems/score/schedulerpriorityaffinitysmp.h index 91ffcd28e5..dd0085a681 100644 --- a/cpukit/score/include/rtems/score/schedulerpriorityaffinitysmp.h +++ b/cpukit/score/include/rtems/score/schedulerpriorityaffinitysmp.h @@ -129,7 +129,7 @@ bool _Scheduler_priority_affinity_SMP_Get_affinity( * @brief Change priority for the priority affinity SMP scheduler. * * @param[in] scheduler The scheduler of the thread. - * @param[in] thread The associated thread. + * @param[in] the_thread The associated thread. * @param[in] new_priority The new priority for the thread. * @param[in] prepend_it Append or prepend the thread to its priority FIFO. */ diff --git a/cpukit/score/include/rtems/score/schedulersimple.h b/cpukit/score/include/rtems/score/schedulersimple.h index 82b8c3d7b9..201c1b6628 100644 --- a/cpukit/score/include/rtems/score/schedulersimple.h +++ b/cpukit/score/include/rtems/score/schedulersimple.h @@ -80,6 +80,9 @@ void _Scheduler_simple_Initialize( const Scheduler_Control *scheduler ); * This routine sets the heir thread to be the next ready thread * on the ready queue by getting the first node in the scheduler * information. + * + * @param[in] scheduler The scheduler instance. + * @param[in] the_thread causing the scheduling operation. */ void _Scheduler_simple_Schedule( const Scheduler_Control *scheduler, @@ -100,7 +103,8 @@ void _Scheduler_simple_Schedule( * the timeslice counter is reset. The heir THREAD will be updated if the * running is also the currently the heir. * - * @param[in,out] thread The yielding thread. + * @param[in] scheduler The scheduler instance. + * @param[in,out] the_thread The yielding thread. */ Scheduler_Void_or_thread _Scheduler_simple_Yield( const Scheduler_Control *scheduler, @@ -115,6 +119,7 @@ Scheduler_Void_or_thread _Scheduler_simple_Yield( * any necessary scheduling operations including the selection of * a new heir thread. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread is the thread that is to be blocked */ void _Scheduler_simple_Block( @@ -129,6 +134,7 @@ void _Scheduler_simple_Block( * that is, adds it to the ready queue and * updates any appropriate scheduling variables, for example the heir thread. * + * @param[in] scheduler The scheduler instance. * @param[in] the_thread is the thread that is to be unblocked */ Scheduler_Void_or_thread _Scheduler_simple_Unblock( diff --git a/cpukit/score/include/rtems/score/threadimpl.h b/cpukit/score/include/rtems/score/threadimpl.h index c4e720751a..9d98fe863f 100644 --- a/cpukit/score/include/rtems/score/threadimpl.h +++ b/cpukit/score/include/rtems/score/threadimpl.h @@ -116,6 +116,7 @@ void _Thread_Start_multitasking( void ) RTEMS_COMPILER_NO_RETURN_ATTRIBUTE; * Set the Start.stack field to the address of the stack. * * @param[in] the_thread is the thread where the stack space is requested + * @param[in] stack_size is the stack space is requested * * @retval actual size allocated after any adjustment * @retval zero if the allocation failed @@ -322,6 +323,7 @@ void *_Thread_Global_construction( void ); * It is called by the watchdog handler. * * @param[in] id is the thread id + * @param[in] ignored is not used */ void _Thread_Delay_ended( Objects_Id id, -- cgit v1.2.3