score misc: Score misc: Clean up Doxygen #10 (GCI 2012)

This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.

http://www.google-melange.com/gci/task/view/google/gci2012/7983216
This commit is contained in:
Christopher Kerl
2012-12-01 09:47:07 -05:00
committed by Gedare Bloom
parent 809b726ae1
commit f839bf5ae2
31 changed files with 247 additions and 199 deletions
+10 -10
View File
@@ -92,16 +92,16 @@ typedef struct {
SCORE_EXTERN Chain_Control _API_extensions_List;
/**
* @brief Initialize the API Extensions Handler
* @brief Initialize the API Extensions Handler
*
* This routine initializes the API extension handler.
*/
void _API_extensions_Initialization( void );
/**
* @brief Add Extension Set to the Active Set
* @brief Add Extension Set to the Active Set
*
* This routine adds an extension to the active set of API extensions.
* This routine adds @a the_extension to the active set of API extensions.
*
* @param[in] the_extension is the extension set to add.
*/
@@ -110,23 +110,23 @@ void _API_extensions_Add(
);
#if defined(FUNCTIONALITY_NOT_CURRENTLY_USED_BY_ANY_API)
/**
* @brief Execute all Pre-Driver Extensions
*
* This routine executes all of the predriver callouts.
*/
/**
* @brief Execute all Pre-Driver Extensions
*
* This routine executes all of the predriver callouts.
*/
void _API_extensions_Run_predriver( void );
#endif
/**
* @brief Execute all Post-Driver Extensions
* @brief Execute all Post-Driver Extensions
*
* This routine executes all of the postdriver callouts.
*/
void _API_extensions_Run_postdriver( void );
/**
* @brief Execute all Post Context Switch Extensions
* @brief Execute all Post Context Switch Extensions
*
* This routine executes all of the post context switch callouts.
*/
+14 -6
View File
@@ -57,10 +57,12 @@ typedef struct {
SCORE_EXTERN Objects_Information _API_Mutex_Information;
/**
* @brief Performs the initialization necessary for this handler.
* @brief Initialization for the API Mutexe Handler.
*
* The value @a maximum_mutexes is the maximum number of API mutexes that may
* exist at any time.
* The value @a maximum_mutexes is the maximum number of API mutexes that may
* exist at any time.
*
* @param[in] Maximum_mutexex is the maximum number of API mutexes.
*/
void _API_Mutex_Initialization( uint32_t maximum_mutexes );
@@ -71,12 +73,18 @@ void _API_Mutex_Initialization( uint32_t maximum_mutexes );
void _API_Mutex_Allocate( API_Mutex_Control **mutex );
/**
* @brief Acquires the specified API mutex @a mutex.
* @brief Acquires the specified API mutex.
*/
void _API_Mutex_Lock( API_Mutex_Control *mutex );
void _API_Mutex_Lock(
API_Mutex_Control *mutex
);
/**
* @brief Releases the specified API mutex @a mutex.
* @brief Releases the Specified API Mutex
*
* Releases the specified @a mutex.
*
* @param[in] mutex is the mutex to be removed.
*/
void _API_Mutex_Unlock( API_Mutex_Control *mutex );
+15 -10
View File
@@ -336,22 +336,27 @@ uint32_t _CORE_message_queue_Flush(
*
* @param[in] the_message_queue points to the message queue to flush
*
* @return This method returns the number of message pending messages flushed.
* @return This method returns the number of pending messages flushed.
*
* - INTERRUPT LATENCY:
* + single case
*/
uint32_t _CORE_message_queue_Flush_support(
CORE_message_queue_Control *the_message_queue
);
#if defined(FUNCTIONALITY_NOT_CURRENTLY_USED_BY_ANY_API)
/**
* @brief Flush Waiting Threads.
*
* This function flushes the threads which are blocked on
* @a the_message_queue's pending message queue. They are
* unblocked whether blocked sending or receiving.
*
* @param[in] the_message_queue points to the message queue to flush
*/
/**
* @brief Flush Waiting Threads.
*
* This function flushes the threads which are blocked on
* @a the_message_queue's pending message queue. They are
* unblocked whether blocked sending or receiving. It returns
* the number of messages flushed from the queue.
*
* @param[in] the_message_queue points to the message queue to flush
* @return number of messages flushed from the queue
*/
void _CORE_message_queue_Flush_waiting_threads(
CORE_message_queue_Control *the_message_queue
);
@@ -182,7 +182,9 @@ void _CORE_RWLock_Obtain_for_writing(
);
/**
* This routine manually releases the RWLock. All of the threads waiting
* @brief Releases the RWLock
*
* This routine manually releases @a the_rwlock. All of the threads waiting
* for the RWLock will be readied.
*
* @param[in] the_rwlock is the RWLock to surrender
@@ -170,6 +170,8 @@ void _CORE_semaphore_Initialize(
#endif
/**
* @brief Surrenders a Unit to a Semaphore
*
* This routine frees a unit to the semaphore. If a task was blocked waiting
* for a unit from this semaphore, then that task will be readied and the unit
* given to that task. Otherwise, the unit will be returned to the semaphore.
+10 -6
View File
@@ -779,10 +779,12 @@ Objects_Information *_Objects_Get_information(
);
/**
* This function return the information structure given
* an id of an object.
* @brief Get Information of an Object from an ID
*
* @param[in] id is an object ID
* This function return the information structure given
* an @a id of an object.
*
* @param[in] id is the object ID to get the information from
*
* @return This method returns a pointer to the Object Information Table
* for the class of objects which corresponds to this object ID.
@@ -831,10 +833,12 @@ bool _Objects_Set_name(
);
/**
* This function removes the_object from the namespace.
* @brief Removes Object from Namespace
*
* @param[in] information points to an Object Information Table
* @param[in] the_object is a pointer to an object
* This function removes @a the_object from the namespace.
*
* @param[in] information points to an Object Information Table.
* @param[in] the_object is a pointer to an object.
*/
void _Objects_Namespace_remove(
Objects_Information *information,
@@ -131,18 +131,17 @@ typedef struct {
extern Scheduler_CBS_Server **_Scheduler_CBS_Server_list;
/**
* @brief Scheduler CBS Unblock
* @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 new job in order to protect concurrent threads.
*
* @note This has to be asessed as missed deadline of the current job.
* 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.
*
* @note This has to be asessed as missed deadline of the current job.
*/
void _Scheduler_CBS_Unblock(
Thread_Control *the_thread
@@ -301,10 +300,13 @@ int _Scheduler_CBS_Get_server_id (
);
/**
* @brief _Scheduler_CBS_Set_parameters
* @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.
*/
int _Scheduler_CBS_Set_parameters (
@@ -200,7 +200,7 @@ void _Scheduler_EDF_Enqueue(
);
/**
* @brief Scheduler EDF Enqueue first
* @brief Enqueues a thread to the ready queue
*
* This routine puts @a the_thread to the rbtree ready queue.
* For the EDF scheduler this is the same as @a _Scheduler_EDF_Enqueue.
+23 -2
View File
@@ -603,9 +603,17 @@ bool _Thread_Initialize(
);
/**
* @brief Initializes Thread and Executes it
*
* This routine initializes the executable information for a thread
* and makes it ready to execute. After this routine executes, the
* thread competes with all other threads for CPU time.
*
* @param the_thread is the thread to be initialized
* @param the_prototype
* @param entry_point
* @param pointer_argument
* @param numeric_argument
*/
bool _Thread_Start(
Thread_Control *the_thread,
@@ -690,9 +698,18 @@ void _Thread_Clear_state(
);
/**
* This routine sets the indicated states for @a the_thread. It performs
* @brief Sets States for a Thread
*
* This routine sets the indicated @a state for @a the_thread. It performs
* any necessary scheduling operations including the selection of
* a new heir thread.
*
* @param[in] the_thread is the thread to set the state for.
* @param[in] state is the state to set the_thread to.
*
* - INTERRUPT LATENCY:
* + ready chain
* + select map
*/
void _Thread_Set_state(
Thread_Control *the_thread,
@@ -716,8 +733,12 @@ void _Thread_Set_transient(
);
/**
* This routine initializes the context of the_thread to its
* @brief Initializes Enviroment for A Thread
*
* This routine initializes the context of @a the_thread to its
* appropriate starting state.
*
* @param[in] the_thread is the pointer to the thread control block.
*/
void _Thread_Load_environment(
Thread_Control *the_thread
+4 -4
View File
@@ -73,9 +73,9 @@ extern "C" {
#endif
/**
* @brief Set Timestamp to Seconds Nanosecond
* @brief Set Timestamp to Specified Seconds and Nanoseconds
*
* This method sets the timestamp to the specified seconds and nanoseconds
* This method sets the timestamp to the specified @a _seconds and @a _nanoseconds
* value.
*
* @param[in] _time points to the timestamp instance to validate.
@@ -328,9 +328,9 @@ extern "C" {
#endif
/**
* @brief Convert Timestamp to struct timespec
* @brief Convert Timestamp to Struct Timespec
*
* This method returns the seconds portion of the specified timestamp
* This method returns the seconds portion of the specified @a _timestamp.
*
* @param[in] _timestamp points to the timestamp
* @param[in] _timespec points to the timespec
+2 -2
View File
@@ -166,9 +166,9 @@ SCORE_EXTERN TOD_Control _TOD;
_Timestamp_Get_seconds(&_TOD.now)
/**
* @brief _TOD_Handler_initialization
* @brief Initializes the Time of Day Handler
*
* This routine performs the initialization necessary for this handler.
* Performs the initialization necessary for the Time Of Day handler.
*/
void _TOD_Handler_initialization(void);
+7 -19
View File
@@ -1,7 +1,12 @@
/* apiext.c
/**
* @file
*
* XXX
* @brief Holding for API Extension Functions
*
* @ingroup ScoreAPIExtension
*/
/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -17,19 +22,11 @@
#include <rtems/system.h>
#include <rtems/score/apiext.h>
/*
* _API_extensions_Initialization
*/
void _API_extensions_Initialization( void )
{
_Chain_Initialize_empty( &_API_extensions_List );
}
/*
* _API_extensions_Add
*/
void _API_extensions_Add(
API_extensions_Control *the_extension
)
@@ -38,9 +35,6 @@ void _API_extensions_Add(
}
#if defined(FUNCTIONALITY_NOT_CURRENTLY_USED_BY_ANY_API)
/*
* _API_extensions_Run_predriver
*/
void _API_extensions_Run_predriver( void )
{
@@ -59,10 +53,6 @@ void _API_extensions_Add(
}
#endif
/*
* _API_extensions_Run_postdriver
*/
void _API_extensions_Run_postdriver( void )
{
Chain_Node *the_node;
@@ -83,5 +73,3 @@ void _API_extensions_Run_postdriver( void )
(*the_extension->postdriver_hook)();
}
}
/* end of file */
+8
View File
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Initialization for the API Mutexe Handler.
*
* @ingroup ScoreAPIMutex
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
+8
View File
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Acquires the specified API mutex.
*
* @ingroup ScoreAPIMutex
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
+8
View File
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Releases the Specified API Mutex
*
* @ingroup ScoreAPIMutex
*/
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
+8 -25
View File
@@ -1,12 +1,12 @@
/**
* @file
*
* @brief Flush Messages Support Routine
*
* @ingroup ScoreMessageQueue
*/
/*
* CORE Message Queue Handler
*
* DESCRIPTION:
*
* This package is the implementation of the CORE Message Queue Handler.
* This core object provides task synchronization and communication functions
* via messages passed to queue objects.
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -28,23 +28,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/wkspace.h>
/*
* _CORE_message_queue_Flush_support
*
* This message handler routine removes all messages from a message queue
* and returns them to the inactive message pool. The number of messages
* flushed from the queue is returned
*
* Input parameters:
* the_message_queue - pointer to message queue
*
* Output parameters:
* returns - number of messages placed on inactive chain
*
* INTERRUPT LATENCY:
* only case
*/
uint32_t _CORE_message_queue_Flush_support(
CORE_message_queue_Control *the_message_queue
)
+8 -20
View File
@@ -1,12 +1,12 @@
/**
* @file
*
* @brief Flush Waiting Threads.
*
* @ingroup ScoreMessageQueue
*/
/*
* CORE Message Queue Handler
*
* DESCRIPTION:
*
* This package is the implementation of the CORE Message Queue Handler.
* This core object provides task synchronization and communication functions
* via messages passed to queue objects.
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -29,18 +29,6 @@
#include <rtems/score/wkspace.h>
#if defined(FUNCTIONALITY_NOT_CURRENTLY_USED_BY_ANY_API)
/*
* _CORE_message_queue_Flush_waiting_threads
*
* This function flushes the message_queue's task wait queue. The number
* of messages flushed from the queue is returned.
*
* Input parameters:
* the_message_queue - the message_queue to be flushed
*
* Output parameters:
* returns - the number of messages flushed from the queue
*/
void _CORE_message_queue_Flush_waiting_threads(
CORE_message_queue_Control *the_message_queue
+8 -13
View File
@@ -1,6 +1,12 @@
/*
* SuperCore RWLock Handler -- Release a RWLock
/**
* @file
*
* @brief Releases the RWLock
*
* @ingroup ScoreRWLock
*/
/*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
@@ -19,17 +25,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/watchdog.h>
/*
* _CORE_RWLock_Release
*
* This function releases the rwlock.
*
* Input parameters:
* the_rwlock - the rwlock control block to initialize
*
* Output parameters: NONE
*/
CORE_RWLock_Status _CORE_RWLock_Release(
CORE_RWLock_Control *the_rwlock
)
+8 -23
View File
@@ -1,12 +1,12 @@
/**
* @file
*
* @brief Surrenders a Unit to a Semaphore
*
* @ingroup ScoreSemaphore
*/
/*
* CORE Semaphore Handler
*
* DESCRIPTION:
*
* This package is the implementation of the CORE Semaphore Handler.
* This core object utilizes standard Dijkstra counting semaphores to provide
* synchronization and mutual exclusion capabilities.
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -26,21 +26,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
/*
* _CORE_semaphore_Surrender
*
* Input parameters:
* the_semaphore - the semaphore to be flushed
* id - id of parent semaphore
* api_semaphore_mp_support - api dependent MP support actions
*
* Output parameters:
* CORE_SEMAPHORE_STATUS_SUCCESSFUL - if successful
* core error code - if unsuccessful
*
* Output parameters:
*/
CORE_semaphore_Status _CORE_semaphore_Surrender(
CORE_semaphore_Control *the_semaphore,
Objects_Id id,
+6 -12
View File
@@ -1,5 +1,9 @@
/*
* Time of Day (TOD) Handler
/**
* @file
*
* @brief Initializes the Time of Day Handler
*
* @ingroup ScoreTODConstants
*/
/* COPYRIGHT (c) 1989-2008.
@@ -20,16 +24,6 @@
#include <rtems/score/tod.h>
#include <rtems/score/watchdog.h>
/*
* _TOD_Handler_initialization
*
* This routine initializes the time of day handler.
*
* Input parameters: NONE
*
* Output parameters: NONE
*/
void _TOD_Handler_initialization(void)
{
/* POSIX format TOD (timespec) */
+8
View File
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Get Information of an Object from an ID
*
* @ingroup Score
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
+8
View File
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Removes Object from Namespace
*
* @ingroup Score
*/
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Set Parameters for CBS Scheduling
*
* @ingroup ScoreScheduler
*/
/*
* Copyright (C) 2011 Petr Benes.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
+8
View File
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Unblocks a Thread from the Queue
*
* @ingroup ScoreScheduler
*/
/*
* Copyright (C) 2011 Petr Benes.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Enqueues a thread to the ready queue
*
* @ingroup ScoreScheduler
*/
/*
* Copyright (C) 2011 Petr Benes.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
+8
View File
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Scheduler EDF Yield
*
* @ingroup ScoreScheduler
*/
/*
* Copyright (C) 2011 Petr Benes.
* Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
+8 -15
View File
@@ -1,7 +1,12 @@
/**
* @file
*
* @brief Initializes Enviroment for A Thread
*
* @ingroup ScoreThread
*/
/*
* Thread Handler
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -27,18 +32,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/wkspace.h>
/*
* _Thread_Load_environment
*
* Load starting environment for another thread from its start area in the
* thread. Only called from t_restart and t_start.
*
* Input parameters:
* the_thread - thread control block pointer
*
* Output parameters: NONE
*/
void _Thread_Load_environment(
Thread_Control *the_thread
)
+8 -5
View File
@@ -1,3 +1,11 @@
/**
* @file
*
* @brief Sets States for a Thread
*
* @ingroup ScoreThread
*/
/*
* Thread Handler / Thread Set State
*
@@ -27,11 +35,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/wkspace.h>
/*
* INTERRUPT LATENCY:
* ready chain
* select map
*/
void _Thread_Set_state(
Thread_Control *the_thread,
States_Control state
+8 -13
View File
@@ -1,7 +1,12 @@
/**
* @file
*
* @brief Initializes Thread and Executes it
*
* @ingroup ScoreThread
*/
/*
* Thread Handler
*
*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -28,16 +33,6 @@
#include <rtems/score/userextimpl.h>
#include <rtems/score/wkspace.h>
/*
* _Thread_Start
*
* DESCRIPTION:
*
* This routine initializes the executable information for a thread
* and makes it ready to execute. After this routine executes, the
* thread competes with all other threads for CPU time.
*/
bool _Thread_Start(
Thread_Control *the_thread,
Thread_Start_types the_prototype,
+6 -2
View File
@@ -1,6 +1,10 @@
/**
* @file score/src/ts64set.c
*/
* @file
*
* @brief Set Timestamp to Specified Seconds and Nanoseconds
*
* @ingroup SuperCore
*/
/*
* COPYRIGHT (c) 1989-2008.
+6 -2
View File
@@ -1,6 +1,10 @@
/**
* @file score/src/ts64totimespec.c
*/
* @file
*
* @brief Convert Timestamp to Struct Timespec
*
* @ingroup SuperCore
*/
/*
* COPYRIGHT (c) 1989-2008.