summaryrefslogtreecommitdiffstats
path: root/cpukit/score/src/threadqfirstpriority.c
diff options
context:
space:
mode:
authorChristopher Kerl <zargyyoyo@gmail.com>2012-11-29 13:39:17 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-11-29 13:39:17 -0600
commit1b4758602f55e215f02e384d459c3319c6e1abab (patch)
tree8305bbedfdfec434394affeb87b86584320ea2e1 /cpukit/score/src/threadqfirstpriority.c
parentscore misc: Score misc: Clean up Doxygen #5 (diff)
downloadrtems-1b4758602f55e215f02e384d459c3319c6e1abab.tar.bz2
score misc: Score misc: Clean up Doxygen #6 (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/7976215
Diffstat (limited to 'cpukit/score/src/threadqfirstpriority.c')
-rw-r--r--cpukit/score/src/threadqfirstpriority.c21
1 files changed, 8 insertions, 13 deletions
diff --git a/cpukit/score/src/threadqfirstpriority.c b/cpukit/score/src/threadqfirstpriority.c
index c14f382b08..eefc88b168 100644
--- a/cpukit/score/src/threadqfirstpriority.c
+++ b/cpukit/score/src/threadqfirstpriority.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Returns Highest Priority Thread on Thread Queue
+ *
+ * @ingroup ScoreThreadQ
+ */
+
/*
* Thread Queue Handler
*
@@ -23,19 +31,6 @@
#include <rtems/score/threadq.h>
#include <rtems/score/tqdata.h>
-/*
- * _Thread_queue_First_priority
- *
- * This routines returns a pointer to the first thread on the
- * specified threadq.
- *
- * Input parameters:
- * the_thread_queue - pointer to thread queue
- *
- * Output parameters:
- * returns - first thread or NULL
- */
-
Thread_Control *_Thread_queue_First_priority (
Thread_queue_Control *the_thread_queue
)