[rtems commit] score misc: Score misc: Clean up Doxygen #10 (GCI 2012)
Gedare Bloom
gedare at rtems.org
Sat Dec 1 14:43:36 UTC 2012
Module: rtems
Branch: master
Commit: f839bf5ae259fe53353a00046adf2c9413df502a
Changeset: http://git.rtems.org/rtems/commit/?id=f839bf5ae259fe53353a00046adf2c9413df502a
Author: Christopher Kerl <zargyyoyo at gmail.com>
Date: Sat Dec 1 09:47:07 2012 -0500
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
---
cpukit/score/include/rtems/score/apiext.h | 20 +++++++-------
cpukit/score/include/rtems/score/apimutex.h | 20 ++++++++++----
cpukit/score/include/rtems/score/coremsg.h | 25 +++++++++++-------
cpukit/score/include/rtems/score/corerwlock.h | 4 ++-
cpukit/score/include/rtems/score/coresem.h | 2 +
cpukit/score/include/rtems/score/object.h | 14 ++++++---
cpukit/score/include/rtems/score/schedulercbs.h | 16 ++++++-----
cpukit/score/include/rtems/score/scheduleredf.h | 2 +-
cpukit/score/include/rtems/score/thread.h | 25 +++++++++++++++++-
cpukit/score/include/rtems/score/timestamp.h | 8 +++---
cpukit/score/include/rtems/score/tod.h | 4 +-
cpukit/score/src/apiext.c | 26 +++++--------------
cpukit/score/src/apimutex.c | 8 ++++++
cpukit/score/src/apimutexlock.c | 8 ++++++
cpukit/score/src/apimutexunlock.c | 8 ++++++
cpukit/score/src/coremsgflushsupp.c | 31 +++++-----------------
cpukit/score/src/coremsgflushwait.c | 26 +++++--------------
cpukit/score/src/corerwlockrelease.c | 21 ++++++---------
cpukit/score/src/coresemsurrender.c | 29 +++++----------------
cpukit/score/src/coretod.c | 18 ++++---------
cpukit/score/src/objectgetinfoid.c | 8 ++++++
cpukit/score/src/objectnamespaceremove.c | 8 ++++++
cpukit/score/src/schedulercbssetparameters.c | 8 ++++++
cpukit/score/src/schedulercbsunblock.c | 8 ++++++
cpukit/score/src/scheduleredfenqueuefirst.c | 8 ++++++
cpukit/score/src/scheduleredfyield.c | 8 ++++++
cpukit/score/src/threadloadenv.c | 21 +++++----------
cpukit/score/src/threadsetstate.c | 13 ++++++---
cpukit/score/src/threadstart.c | 19 +++++---------
cpukit/score/src/ts64set.c | 8 ++++-
cpukit/score/src/ts64totimespec.c | 8 ++++-
31 files changed, 240 insertions(+), 192 deletions(-)
diff --git a/cpukit/score/include/rtems/score/apiext.h b/cpukit/score/include/rtems/score/apiext.h
index afd828c..82910bf 100644
--- a/cpukit/score/include/rtems/score/apiext.h
+++ b/cpukit/score/include/rtems/score/apiext.h
@@ -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.
*/
diff --git a/cpukit/score/include/rtems/score/apimutex.h b/cpukit/score/include/rtems/score/apimutex.h
index 780b167..13b0ddd 100644
--- a/cpukit/score/include/rtems/score/apimutex.h
+++ b/cpukit/score/include/rtems/score/apimutex.h
@@ -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 );
diff --git a/cpukit/score/include/rtems/score/coremsg.h b/cpukit/score/include/rtems/score/coremsg.h
index fccebbf..0f468c8 100644
--- a/cpukit/score/include/rtems/score/coremsg.h
+++ b/cpukit/score/include/rtems/score/coremsg.h
@@ -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
);
diff --git a/cpukit/score/include/rtems/score/corerwlock.h b/cpukit/score/include/rtems/score/corerwlock.h
index f0d3477..6d97ab1 100644
--- a/cpukit/score/include/rtems/score/corerwlock.h
+++ b/cpukit/score/include/rtems/score/corerwlock.h
@@ -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
diff --git a/cpukit/score/include/rtems/score/coresem.h b/cpukit/score/include/rtems/score/coresem.h
index 243d009..d7a8494 100644
--- a/cpukit/score/include/rtems/score/coresem.h
+++ b/cpukit/score/include/rtems/score/coresem.h
@@ -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.
diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index 6d43b39..274347b 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -779,10 +779,12 @@ Objects_Information *_Objects_Get_information(
);
/**
+ * @brief Get Information of an Object from an ID
+ *
* This function return the information structure given
- * an id of an object.
+ * an @a id of an object.
*
- * @param[in] id is an object ID
+ * @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,
diff --git a/cpukit/score/include/rtems/score/schedulercbs.h b/cpukit/score/include/rtems/score/schedulercbs.h
index f4494d0..d0bc5ee 100644
--- a/cpukit/score/include/rtems/score/schedulercbs.h
+++ b/cpukit/score/include/rtems/score/schedulercbs.h
@@ -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.
+ * 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.
*
- * 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.
- *
- * @param[in] the_thread will be unblocked.
*/
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 (
diff --git a/cpukit/score/include/rtems/score/scheduleredf.h b/cpukit/score/include/rtems/score/scheduleredf.h
index 967733f..8381184 100644
--- a/cpukit/score/include/rtems/score/scheduleredf.h
+++ b/cpukit/score/include/rtems/score/scheduleredf.h
@@ -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.
diff --git a/cpukit/score/include/rtems/score/thread.h b/cpukit/score/include/rtems/score/thread.h
index 502ef8e..845b6e0 100644
--- a/cpukit/score/include/rtems/score/thread.h
+++ b/cpukit/score/include/rtems/score/thread.h
@@ -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
diff --git a/cpukit/score/include/rtems/score/timestamp.h b/cpukit/score/include/rtems/score/timestamp.h
index fb16886..951c374 100644
--- a/cpukit/score/include/rtems/score/timestamp.h
+++ b/cpukit/score/include/rtems/score/timestamp.h
@@ -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
diff --git a/cpukit/score/include/rtems/score/tod.h b/cpukit/score/include/rtems/score/tod.h
index 5d10a50..eb743b7 100644
--- a/cpukit/score/include/rtems/score/tod.h
+++ b/cpukit/score/include/rtems/score/tod.h
@@ -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);
diff --git a/cpukit/score/src/apiext.c b/cpukit/score/src/apiext.c
index b2ca87c..73dffee 100644
--- a/cpukit/score/src/apiext.c
+++ b/cpukit/score/src/apiext.c
@@ -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 */
diff --git a/cpukit/score/src/apimutex.c b/cpukit/score/src/apimutex.c
index 0329441..bc72c91 100644
--- a/cpukit/score/src/apimutex.c
+++ b/cpukit/score/src/apimutex.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Initialization for the API Mutexe Handler.
+ *
+ * @ingroup ScoreAPIMutex
+ */
+
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/score/src/apimutexlock.c b/cpukit/score/src/apimutexlock.c
index aa78279..174c858 100644
--- a/cpukit/score/src/apimutexlock.c
+++ b/cpukit/score/src/apimutexlock.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Acquires the specified API mutex.
+ *
+ * @ingroup ScoreAPIMutex
+ */
+
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/score/src/apimutexunlock.c b/cpukit/score/src/apimutexunlock.c
index e8ec597..6eb54fc 100644
--- a/cpukit/score/src/apimutexunlock.c
+++ b/cpukit/score/src/apimutexunlock.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Releases the Specified API Mutex
+ *
+ * @ingroup ScoreAPIMutex
+ */
+
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/score/src/coremsgflushsupp.c b/cpukit/score/src/coremsgflushsupp.c
index 77f56d6..4ea071f 100644
--- a/cpukit/score/src/coremsgflushsupp.c
+++ b/cpukit/score/src/coremsgflushsupp.c
@@ -1,12 +1,12 @@
-/*
- * CORE Message Queue Handler
- *
- * DESCRIPTION:
+/**
+ * @file
*
- * 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.
+ * @brief Flush Messages Support Routine
*
+ * @ingroup ScoreMessageQueue
+ */
+
+/*
* 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
)
diff --git a/cpukit/score/src/coremsgflushwait.c b/cpukit/score/src/coremsgflushwait.c
index 58de174..f2b1f08 100644
--- a/cpukit/score/src/coremsgflushwait.c
+++ b/cpukit/score/src/coremsgflushwait.c
@@ -1,12 +1,12 @@
-/*
- * CORE Message Queue Handler
- *
- * DESCRIPTION:
+/**
+ * @file
*
- * 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.
+ * @brief Flush Waiting Threads.
*
+ * @ingroup ScoreMessageQueue
+ */
+
+/*
* 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
diff --git a/cpukit/score/src/corerwlockrelease.c b/cpukit/score/src/corerwlockrelease.c
index b13d5f7..bcae4cb 100644
--- a/cpukit/score/src/corerwlockrelease.c
+++ b/cpukit/score/src/corerwlockrelease.c
@@ -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
)
diff --git a/cpukit/score/src/coresemsurrender.c b/cpukit/score/src/coresemsurrender.c
index 69e7168..3d306f8 100644
--- a/cpukit/score/src/coresemsurrender.c
+++ b/cpukit/score/src/coresemsurrender.c
@@ -1,12 +1,12 @@
-/*
- * CORE Semaphore Handler
- *
- * DESCRIPTION:
+/**
+ * @file
*
- * 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.
+ * @brief Surrenders a Unit to a Semaphore
*
+ * @ingroup ScoreSemaphore
+ */
+
+/*
* 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,
diff --git a/cpukit/score/src/coretod.c b/cpukit/score/src/coretod.c
index 1784a89..0cde95b 100644
--- a/cpukit/score/src/coretod.c
+++ b/cpukit/score/src/coretod.c
@@ -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) */
diff --git a/cpukit/score/src/objectgetinfoid.c b/cpukit/score/src/objectgetinfoid.c
index b8bdbaf..b6b1353 100644
--- a/cpukit/score/src/objectgetinfoid.c
+++ b/cpukit/score/src/objectgetinfoid.c
@@ -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).
diff --git a/cpukit/score/src/objectnamespaceremove.c b/cpukit/score/src/objectnamespaceremove.c
index 97ee95f..cd61845 100644
--- a/cpukit/score/src/objectnamespaceremove.c
+++ b/cpukit/score/src/objectnamespaceremove.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Removes Object from Namespace
+ *
+ * @ingroup Score
+ */
+
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/score/src/schedulercbssetparameters.c b/cpukit/score/src/schedulercbssetparameters.c
index 49774cc..5bbf866 100644
--- a/cpukit/score/src/schedulercbssetparameters.c
+++ b/cpukit/score/src/schedulercbssetparameters.c
@@ -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).
diff --git a/cpukit/score/src/schedulercbsunblock.c b/cpukit/score/src/schedulercbsunblock.c
index 1957862..529d571 100644
--- a/cpukit/score/src/schedulercbsunblock.c
+++ b/cpukit/score/src/schedulercbsunblock.c
@@ -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).
diff --git a/cpukit/score/src/scheduleredfenqueuefirst.c b/cpukit/score/src/scheduleredfenqueuefirst.c
index 8ad0d13..9f99140 100644
--- a/cpukit/score/src/scheduleredfenqueuefirst.c
+++ b/cpukit/score/src/scheduleredfenqueuefirst.c
@@ -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).
diff --git a/cpukit/score/src/scheduleredfyield.c b/cpukit/score/src/scheduleredfyield.c
index ff68838..d686254 100644
--- a/cpukit/score/src/scheduleredfyield.c
+++ b/cpukit/score/src/scheduleredfyield.c
@@ -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).
diff --git a/cpukit/score/src/threadloadenv.c b/cpukit/score/src/threadloadenv.c
index d2dd049..6cce54f 100644
--- a/cpukit/score/src/threadloadenv.c
+++ b/cpukit/score/src/threadloadenv.c
@@ -1,7 +1,12 @@
-/*
- * Thread Handler
+/**
+ * @file
*
+ * @brief Initializes Enviroment for A Thread
*
+ * @ingroup ScoreThread
+ */
+
+/*
* 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
)
diff --git a/cpukit/score/src/threadsetstate.c b/cpukit/score/src/threadsetstate.c
index 1372b5d..f72cdec 100644
--- a/cpukit/score/src/threadsetstate.c
+++ b/cpukit/score/src/threadsetstate.c
@@ -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
diff --git a/cpukit/score/src/threadstart.c b/cpukit/score/src/threadstart.c
index 550404a..d9ce62a 100644
--- a/cpukit/score/src/threadstart.c
+++ b/cpukit/score/src/threadstart.c
@@ -1,7 +1,12 @@
-/*
- * Thread Handler
+/**
+ * @file
*
+ * @brief Initializes Thread and Executes it
*
+ * @ingroup ScoreThread
+ */
+
+/*
* 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,
diff --git a/cpukit/score/src/ts64set.c b/cpukit/score/src/ts64set.c
index 16e3d7b..d06755d 100644
--- a/cpukit/score/src/ts64set.c
+++ b/cpukit/score/src/ts64set.c
@@ -1,6 +1,10 @@
/**
- * @file score/src/ts64set.c
-*/
+ * @file
+ *
+ * @brief Set Timestamp to Specified Seconds and Nanoseconds
+ *
+ * @ingroup SuperCore
+ */
/*
* COPYRIGHT (c) 1989-2008.
diff --git a/cpukit/score/src/ts64totimespec.c b/cpukit/score/src/ts64totimespec.c
index 69640fd..051fb27 100644
--- a/cpukit/score/src/ts64totimespec.c
+++ b/cpukit/score/src/ts64totimespec.c
@@ -1,6 +1,10 @@
/**
- * @file score/src/ts64totimespec.c
-*/
+ * @file
+ *
+ * @brief Convert Timestamp to Struct Timespec
+ *
+ * @ingroup SuperCore
+ */
/*
* COPYRIGHT (c) 1989-2008.
More information about the vc
mailing list