summaryrefslogtreecommitdiffstats
path: root/cpukit/score/src/chain.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/chain.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/chain.c')
-rw-r--r--cpukit/score/src/chain.c22
1 files changed, 8 insertions, 14 deletions
diff --git a/cpukit/score/src/chain.c b/cpukit/score/src/chain.c
index fb3916c285..7e63107876 100644
--- a/cpukit/score/src/chain.c
+++ b/cpukit/score/src/chain.c
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Initialize a Chain Header
+ *
+ * @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_Initialize
- *
- * This kernel routine initializes a doubly linked chain.
- *
- * Input parameters:
- * the_chain - pointer to chain header
- * starting_address - starting address of first node
- * number_nodes - number of nodes in chain
- * node_size - size of node in bytes
- *
- * Output parameters: NONE
- */
-
void _Chain_Initialize(
Chain_Control *the_chain,
void *starting_address,