score: Doxygen Clean Up Task #2

1 files changed, 37 insertions, 32 deletions

diff --git a/cpukit/score/include/rtems/score/schedulercbs.h b/cpukit/score/include/rtems/score/schedulercbs.h
index d0bc5ee109..96fd6fac3f 100644
--- a/cpukit/score/include/rtems/score/schedulercbs.h
+++ b/cpukit/score/include/rtems/score/schedulercbs.h
@@ -1,6 +1,8 @@
 /**
  *  @file  rtems/score/schedulercbs.h
  *
+ *  @brief Thread manipulation for the CBS scheduler
+ *
  *  This include file contains all the constants and structures associated
  *  with the manipulation of threads for the CBS scheduler.
  */
@@ -31,8 +33,11 @@ extern "C" {
 #endif
 
 /**
- *  @addtogroup ScoreScheduler
+ *  @defgroup ScoreScheduler CBS Scheduler
  *
+ *  @ingroup Score
+ *
+ *  @addtogroup ScoreScheduler
  */
 /**@{*/
 
@@ -131,12 +136,12 @@ typedef struct {
 extern Scheduler_CBS_Server **_Scheduler_CBS_Server_list;
 
 /**
- *  @brief Unblocks a Thread from the Queue
+ *  @brief Unblocks a thread from the queue.
  *
  *  This routine adds @a the_thread to the scheduling decision, that is,
  *  adds it to the ready queue and updates any appropriate scheduling
- *  variables, for example the heir thread. It is checked whether the 
- *  remaining budget is sufficient. If not, the thread continues as a 
+ *  variables, for example the heir thread. It is checked whether the
+ *  remaining budget is sufficient. If not, the thread continues as a
  *  new job in order to protect concurrent threads.
  *
  *  @param[in] the_thread will be unblocked.
@@ -148,7 +153,7 @@ void _Scheduler_CBS_Unblock(
 );
 
 /**
- *  @brief Scheduler CBS Release job
+ *  @brief Called when a new job of task is released.
  *
  *  This routine is called when a new job of task is released.
  *  It is called only from Rate Monotonic manager in the beginning
@@ -169,16 +174,16 @@ void _Scheduler_CBS_Release_job (
  *
  *  Initializes the CBS library.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Initialize(void);
 
 /**
- *  @brief Attach Scheduler CBS Thread
+ *  @brief Attach a task to an already existing server.
  *
  *  Attach a task to an already existing server.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Attach_thread (
   Scheduler_CBS_Server_id server_id,
@@ -186,11 +191,11 @@ int _Scheduler_CBS_Attach_thread (
 );
 
 /**
- *  @brief _Scheduler_CBS_Detach_thread
+ *  @brief Detach from the CBS Server.
  *
  *  Detach from the CBS Server.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Detach_thread (
   Scheduler_CBS_Server_id server_id,
@@ -198,20 +203,20 @@ int _Scheduler_CBS_Detach_thread (
 );
 
 /**
- *  @brief _Scheduler_CBS_Cleanup
+ *  @brief Cleanup resources associated to the CBS Library.
  *
  *  Cleanup resources associated to the CBS Library.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Cleanup (void);
 
 /**
- *  @brief _Scheduler_CBS_Create_server
+ *  @brief Create a new server with specified parameters.
  *
  *  Create a new server with specified parameters.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Create_server (
   Scheduler_CBS_Parameters     *params,
@@ -220,25 +225,25 @@ int _Scheduler_CBS_Create_server (
 );
 
 /**
- *  @brief _Scheduler_CBS_Destroy_server
+ *  @brief Detach all tasks from a server and destroy it.
  *
  *  Detach all tasks from a server and destroy it.
  *
  *  @param[in] server_id is the ID of the server
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Destroy_server (
   Scheduler_CBS_Server_id server_id
 );
 
 /**
- *  @brief _Scheduler_CBS_Get_approved_budget
+ *  @brief Retrieve the approved budget.
  *
  *  Retrieve the budget that has been approved for the subsequent
  *  server instances.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Get_approved_budget (
   Scheduler_CBS_Server_id  server_id,
@@ -246,11 +251,11 @@ int _Scheduler_CBS_Get_approved_budget (
 );
 
 /**
- *  @brief _Scheduler_CBS_Get_remaining_budget
+ *  @brief Retrieve remaining budget for the current server instance.
  *
  *  Retrieve remaining budget for the current server instance.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Get_remaining_budget (
   Scheduler_CBS_Server_id  server_id,
@@ -258,15 +263,15 @@ int _Scheduler_CBS_Get_remaining_budget (
 );
 
 /**
- *  @brief Get relative time info
+ *  @brief Get relative time info.
  *
  *  Retrieve time info relative to @a server_id. The server status code is returned.
  *
  *  @param[in] server_id is the server to get the status code from.
  *  @param[in] exec_time is the execution time.
- *  @param[in] abs_time is not apparently used. 
+ *  @param[in] abs_time is not apparently used.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Get_execution_time (
   Scheduler_CBS_Server_id   server_id,
@@ -275,11 +280,11 @@ int _Scheduler_CBS_Get_execution_time (
 );
 
 /**
- *  @brief _Scheduler_CBS_Get_parameters
+ *  @brief Retrieve CBS scheduling parameters.
  *
  *  Retrieve CBS scheduling parameters.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Get_parameters (
   Scheduler_CBS_Server_id   server_id,
@@ -287,12 +292,12 @@ int _Scheduler_CBS_Get_parameters (
 );
 
 /**
- *  @brief Scheduler CBS Get Server id
+ *  @brief Get a thread server id.
  *
  *  Get a thread server id, or SCHEDULER_CBS_ERROR_NOT_FOUND if it is not
  *  attached to any server.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Get_server_id (
   rtems_id                 task_id,
@@ -300,14 +305,14 @@ int _Scheduler_CBS_Get_server_id (
 );
 
 /**
- *  @brief Set Parameters for CBS Scheduling
+ *  @brief Set parameters for CBS scheduling.
  *
  *  Change CBS scheduling parameters.
  *
  *  @param[in] server_id is the ID of the server.
  *  @param[in] parameters are the parameters to set.
  *
- *  @return status code.
+ *  @retval status code.
  */
 int _Scheduler_CBS_Set_parameters (
   Scheduler_CBS_Server_id   server_id,
@@ -315,7 +320,7 @@ int _Scheduler_CBS_Set_parameters (
 );
 
 /**
- *  @brief Scheduler CBS Budget overrun
+ *  @brief Invoked when a limited time quantum is exceeded.
  *
  *  This routine is invoked when a limited time quantum is exceeded.
  */
@@ -324,7 +329,7 @@ void _Scheduler_CBS_Budget_callout(
 );
 
 /**
- *  @brief Scheduler CBS Allocate
+ *  @brief Allocates CBS specific information of @a the_thread.
  *
  *  This routine allocates CBS specific information of @a the_thread.
  *
@@ -341,4 +346,4 @@ void *_Scheduler_CBS_Allocate(
 /**@}*/
 
 #endif
-/* end of include file */
+/* end of include file */
\ No newline at end of file