diff options
author | Christopher Kerl <zargyyoyo@gmail.com> | 2012-11-28 13:31:53 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-28 13:31:53 -0600 |
commit | d4d7899bb2730dc77331db202a2473818a7ea351 (patch) | |
tree | fc3204f40c34ba4da1e6db310dbdf82c81c8c6a7 /cpukit/score/src | |
parent | score misc: Clean up Doxygen (GCI 2012) (diff) | |
download | rtems-d4d7899bb2730dc77331db202a2473818a7ea351.tar.bz2 |
score misc: Clean up Doxygen #2 (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/7986213
Diffstat (limited to 'cpukit/score/src')
-rw-r--r-- | cpukit/score/src/chainextract.c | 22 | ||||
-rw-r--r-- | cpukit/score/src/chaininsert.c | 8 | ||||
-rw-r--r-- | cpukit/score/src/corebarrierrelease.c | 28 | ||||
-rw-r--r-- | cpukit/score/src/coresemseize.c | 29 | ||||
-rw-r--r-- | cpukit/score/src/corespinlock.c | 25 | ||||
-rw-r--r-- | cpukit/score/src/coretodmsecstoticks.c | 8 | ||||
-rw-r--r-- | cpukit/score/src/objectgetnameasstring.c | 8 | ||||
-rw-r--r-- | cpukit/score/src/rbtreefindheader.c | 26 | ||||
-rw-r--r-- | cpukit/score/src/schedulercbsdestroyserver.c | 8 | ||||
-rw-r--r-- | cpukit/score/src/schedulercbsdetachthread.c | 8 | ||||
-rw-r--r-- | cpukit/score/src/schedulercbsreleasejob.c | 8 | ||||
-rw-r--r-- | cpukit/score/src/scheduleredfprioritycompare.c | 8 | ||||
-rw-r--r-- | cpukit/score/src/schedulerprioritytick.c | 8 | ||||
-rw-r--r-- | cpukit/score/src/schedulersimpleblock.c | 10 | ||||
-rw-r--r-- | cpukit/score/src/threadget.c | 27 | ||||
-rw-r--r-- | cpukit/score/src/threadqdequeue.c | 26 | ||||
-rw-r--r-- | cpukit/score/src/threadqextractfifo.c | 25 | ||||
-rw-r--r-- | cpukit/score/src/threadsettransient.c | 14 | ||||
-rw-r--r-- | cpukit/score/src/timespecdividebyinteger.c | 6 | ||||
-rw-r--r-- | cpukit/score/src/ts64settozero.c | 8 |
20 files changed, 150 insertions, 160 deletions
diff --git a/cpukit/score/src/chainextract.c b/cpukit/score/src/chainextract.c index e2b36151e0..05a3fd61d5 100644 --- a/cpukit/score/src/chainextract.c +++ b/cpukit/score/src/chainextract.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Extracts a Node from a Chain + * + * @ingroup ScoreChain + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -16,20 +24,6 @@ #include <rtems/score/chain.h> #include <rtems/score/isr.h> -/* - * _Chain_Extract - * - * This kernel routine deletes the given node from a chain. - * - * Input parameters: - * node - pointer to node in chain to be deleted - * - * Output parameters: NONE - * - * INTERRUPT LATENCY: - * only case - */ - void _Chain_Extract( Chain_Node *node ) diff --git a/cpukit/score/src/chaininsert.c b/cpukit/score/src/chaininsert.c index 95e67aa539..c7b12129be 100644 --- a/cpukit/score/src/chaininsert.c +++ b/cpukit/score/src/chaininsert.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Extracts a node from a given chain + * + * @ingroup ScoreChain + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/corebarrierrelease.c b/cpukit/score/src/corebarrierrelease.c index bd238fe201..e6f7554fbb 100644 --- a/cpukit/score/src/corebarrierrelease.c +++ b/cpukit/score/src/corebarrierrelease.c @@ -1,10 +1,12 @@ -/* - * SuperCore Barrier Handler - * - * DESCRIPTION: +/** + * @file * - * This package is part of the implementation of the SuperCore Barrier Handler. + * @brief Manually releases the Barrier * + * @ingroup ScoreBarrier + */ + +/* * COPYRIGHT (c) 1989-2006. * On-Line Applications Research Corporation (OAR). * @@ -24,22 +26,6 @@ #include <rtems/score/thread.h> #include <rtems/score/threadq.h> -/* - * _CORE_barrier_Release - * - * Input parameters: - * the_barrier - the barrier to be flushed - * id - id of the object for a remote unblock - * api_barrier_mp_support - api dependent MP support actions - * - * Output parameters: - * CORE_BARRIER_STATUS_SUCCESSFUL - if successful - * core error code - if unsuccessful - * - * Output parameters: - * returns number of threads unblocked - */ - uint32_t _CORE_barrier_Release( CORE_barrier_Control *the_barrier, #if defined(RTEMS_MULTIPROCESSING) diff --git a/cpukit/score/src/coresemseize.c b/cpukit/score/src/coresemseize.c index 925290b8da..5ceaea72c2 100644 --- a/cpukit/score/src/coresemseize.c +++ b/cpukit/score/src/coresemseize.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 Core Semaphore Seize * + * @ingroup ScoreSemaphore + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -27,21 +27,6 @@ #include <rtems/score/threadq.h> #if defined(RTEMS_SCORE_CORESEM_ENABLE_SEIZE_BODY) -/* - * This routine attempts to allocate a core semaphore to the calling thread. - * - * Input parameters: - * the_semaphore - pointer to semaphore control block - * id - id of object to wait on - * wait - true if wait is allowed, false otherwise - * timeout - number of ticks to wait (0 means forever) - * - * Output parameters: NONE - * - * INTERRUPT LATENCY: - * available - * wait - */ void _CORE_semaphore_Seize( CORE_semaphore_Control *the_semaphore, diff --git a/cpukit/score/src/corespinlock.c b/cpukit/score/src/corespinlock.c index e90792d1e9..bc7084e468 100644 --- a/cpukit/score/src/corespinlock.c +++ b/cpukit/score/src/corespinlock.c @@ -1,10 +1,12 @@ -/* - * SuperCore Spinlock Handler - * - * DESCRIPTION: +/** + * @file * - * This package is part of the implementation of the SuperCore Spinlock Handler. + * @brief Initialize a Spinlock * + * @ingroup ScoreSpinlock + */ + +/* * COPYRIGHT (c) 1989-2006. * On-Line Applications Research Corporation (OAR). * @@ -23,19 +25,6 @@ #include <rtems/score/thread.h> #include <rtems/score/threadq.h> -/* - * _CORE_spinlock_Initialize - * - * This function initialize a spinlock and sets the initial value based - * on the given count. - * - * Input parameters: - * the_spinlock - the spinlock control block to initialize - * the_spinlock_attributes - the attributes specified at create time - * - * Output parameters: NONE - */ - void _CORE_spinlock_Initialize( CORE_spinlock_Control *the_spinlock, CORE_spinlock_Attributes *the_spinlock_attributes diff --git a/cpukit/score/src/coretodmsecstoticks.c b/cpukit/score/src/coretodmsecstoticks.c index 2f9128e45c..c55338ee47 100644 --- a/cpukit/score/src/coretodmsecstoticks.c +++ b/cpukit/score/src/coretodmsecstoticks.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Convert Microseconds to Ticks + * + * @ingroup ScoreTODConstants + */ + /* COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/score/src/objectgetnameasstring.c b/cpukit/score/src/objectgetnameasstring.c index db87bc283f..d818f72396 100644 --- a/cpukit/score/src/objectgetnameasstring.c +++ b/cpukit/score/src/objectgetnameasstring.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Extracts a Node from a Chain + * + * @ingroup Score + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/rbtreefindheader.c b/cpukit/score/src/rbtreefindheader.c index 99b0387052..2368a11428 100644 --- a/cpukit/score/src/rbtreefindheader.c +++ b/cpukit/score/src/rbtreefindheader.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Finds the Header of a Tree if it Exists + * + * @ingroup ScoreRBTree + */ + /* * Copyright (c) 2010 Gedare Bloom. * @@ -15,24 +23,6 @@ #include <rtems/score/rbtree.h> #include <rtems/score/isr.h> -/* - * _RBTree_Find_header - * - * This kernel routine returns a pointer to the rbtree header of the tree - * containing the given node. - * - * Input parameters: - * the_node - pointer to rbtree node - * - * Output parameters: - * return_header - pointer to control header of rbtree - * NULL - if there is no control header available (the node is not part - * of a tree) - * - * INTERRUPT LATENCY: - * only case - */ - RBTree_Control *_RBTree_Find_header( RBTree_Node *the_node ) diff --git a/cpukit/score/src/schedulercbsdestroyserver.c b/cpukit/score/src/schedulercbsdestroyserver.c index c839157afd..5030b6f098 100644 --- a/cpukit/score/src/schedulercbsdestroyserver.c +++ b/cpukit/score/src/schedulercbsdestroyserver.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Scheduler CBS Destroy Server + * + * @ingroup ScoreScheduler + */ + /* * Copyright (C) 2011 Petr Benes. * Copyright (C) 2011 On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/schedulercbsdetachthread.c b/cpukit/score/src/schedulercbsdetachthread.c index 0267790ce6..8be62f783d 100644 --- a/cpukit/score/src/schedulercbsdetachthread.c +++ b/cpukit/score/src/schedulercbsdetachthread.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Detach from the CBS Server + * + * @ingroup ScoreScheduler + */ + /* * Copyright (C) 2011 Petr Benes. * Copyright (C) 2011 On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/schedulercbsreleasejob.c b/cpukit/score/src/schedulercbsreleasejob.c index c276f8ca5e..aec5ac8721 100644 --- a/cpukit/score/src/schedulercbsreleasejob.c +++ b/cpukit/score/src/schedulercbsreleasejob.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Scheduler CBS Release Job + * + * @ingroup ScoreScheduler + */ + /* * Copyright (C) 2011 Petr Benes. * Copyright (C) 2011 On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/scheduleredfprioritycompare.c b/cpukit/score/src/scheduleredfprioritycompare.c index 692c17296c..60e950dae7 100644 --- a/cpukit/score/src/scheduleredfprioritycompare.c +++ b/cpukit/score/src/scheduleredfprioritycompare.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Compares Priorities of Threads + * + * @ingroup ScoreScheduler + */ + /* * Copyright (C) 2011 Petr Benes. * Copyright (C) 2011 On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/schedulerprioritytick.c b/cpukit/score/src/schedulerprioritytick.c index aa89c6c20d..afe6c76d34 100644 --- a/cpukit/score/src/schedulerprioritytick.c +++ b/cpukit/score/src/schedulerprioritytick.c @@ -1,3 +1,11 @@ +/** + * @file + * + * @brief Priority Scheduler At Tick Handler + * + * @ingroup ScoreScheduler + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/src/schedulersimpleblock.c b/cpukit/score/src/schedulersimpleblock.c index 50e66743e1..4287ddf2c6 100644 --- a/cpukit/score/src/schedulersimpleblock.c +++ b/cpukit/score/src/schedulersimpleblock.c @@ -1,6 +1,12 @@ -/* - * Scheduler Simple Handler / Block +/** + * @file + * + * @brief Simple Scheduler Block a Thread * + * @ingroup ScoreScheduler + */ + +/* * COPYRIGHT (c) 2011. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/score/src/threadget.c b/cpukit/score/src/threadget.c index de3dea652a..4bef8681b2 100644 --- a/cpukit/score/src/threadget.c +++ b/cpukit/score/src/threadget.c @@ -1,6 +1,12 @@ -/* - * Thread Handler - Object Id to Thread Pointer +/** + * @file + * + * @brief Maps Thread IDs to TCB Pointer * + * @ingroup ScoreThread + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * @@ -25,23 +31,6 @@ #include <rtems/score/thread.h> #include <rtems/score/threadq.h> - -/** - * This function maps thread IDs to thread control - * blocks. If ID corresponds to a local thread, then it - * returns the_thread control pointer which maps to ID - * and location is set to OBJECTS_LOCAL. If the thread ID is - * global and resides on a remote node, then location is set - * to OBJECTS_REMOTE, and the_thread is undefined. - * Otherwise, location is set to OBJECTS_ERROR and - * the_thread is undefined. - * - * @note The performance of many RTEMS services depends upon - * the quick execution of the "good object" path in this - * routine. If there is a possibility of saving a few - * cycles off the execution time, this routine is worth - * further optimization attention. - */ Thread_Control *_Thread_Get ( Objects_Id id, Objects_Locations *location diff --git a/cpukit/score/src/threadqdequeue.c b/cpukit/score/src/threadqdequeue.c index bdfd3286f1..93675fb16d 100644 --- a/cpukit/score/src/threadqdequeue.c +++ b/cpukit/score/src/threadqdequeue.c @@ -1,7 +1,12 @@ -/* - * Thread Queue Handler +/** + * @file * + * @brief Thread Queue Dequeue * + * @ingroup ScoreThreadQ + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -23,23 +28,6 @@ #include <rtems/score/threadq.h> #include <rtems/score/tqdata.h> -/* - * _Thread_queue_Dequeue - * - * This routine removes a thread from the specified threadq. If the - * threadq discipline is FIFO, it unblocks a thread, and cancels its - * timeout timer. Priority discipline is processed elsewhere. - * - * Input parameters: - * the_thread_queue - pointer to threadq - * - * Output parameters: - * returns - thread dequeued or NULL - * - * INTERRUPT LATENCY: - * check sync - */ - Thread_Control *_Thread_queue_Dequeue( Thread_queue_Control *the_thread_queue ) diff --git a/cpukit/score/src/threadqextractfifo.c b/cpukit/score/src/threadqextractfifo.c index e3e4ee431a..4dce010dc6 100644 --- a/cpukit/score/src/threadqextractfifo.c +++ b/cpukit/score/src/threadqextractfifo.c @@ -1,7 +1,12 @@ -/* - * Thread Queue Handler +/** + * @file * + * @brief Removes a Thread from a Thread Queue * + * @ingroup ScoreThreadQ + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -23,22 +28,6 @@ #include <rtems/score/threadq.h> #include <rtems/score/tqdata.h> -/* - * _Thread_queue_Extract_fifo - * - * This routine removes a specific thread from the specified threadq, - * deletes any timeout, and unblocks the thread. - * - * Input parameters: - * the_thread_queue - pointer to a threadq header - * the_thread - pointer to the thread to block - * - * Output parameters: NONE - * - * INTERRUPT LATENCY: - * EXTRACT_FIFO - */ - void _Thread_queue_Extract_fifo( Thread_queue_Control *the_thread_queue __attribute__((unused)), Thread_Control *the_thread diff --git a/cpukit/score/src/threadsettransient.c b/cpukit/score/src/threadsettransient.c index 1624e676bb..b09939684f 100644 --- a/cpukit/score/src/threadsettransient.c +++ b/cpukit/score/src/threadsettransient.c @@ -1,6 +1,12 @@ -/* - * Thread Handler / Thread Set Transient +/** + * @file + * + * @brief Sets the Transient State for a Thread * + * @ingroup ScoreThread + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * @@ -28,10 +34,6 @@ #include <rtems/score/threadq.h> #include <rtems/score/wkspace.h> -/* - * INTERRUPT LATENCY: - * only case - */ void _Thread_Set_transient( Thread_Control *the_thread ) diff --git a/cpukit/score/src/timespecdividebyinteger.c b/cpukit/score/src/timespecdividebyinteger.c index 85db7f10d9..33d21643ff 100644 --- a/cpukit/score/src/timespecdividebyinteger.c +++ b/cpukit/score/src/timespecdividebyinteger.c @@ -1,5 +1,9 @@ /** - * @file score/src/timespecdividebyinteger.c + * @file + * + * @brief Divide Timespec By Integer + * + * @ingroup Timespec */ /* diff --git a/cpukit/score/src/ts64settozero.c b/cpukit/score/src/ts64settozero.c index 9792a71a43..69c88a8461 100644 --- a/cpukit/score/src/ts64settozero.c +++ b/cpukit/score/src/ts64settozero.c @@ -1,6 +1,10 @@ /** - * @file score/src/ts64settozero.c -*/ + * @file + * + * @brief Zero a Timestamp64 Instance + * + * @ingroup SuperCore + */ /* * COPYRIGHT (c) 1989-2008. |