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/include/rtems/score/chain.h | |
| 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/include/rtems/score/chain.h')
| -rw-r--r-- | cpukit/score/include/rtems/score/chain.h | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/cpukit/score/include/rtems/score/chain.h b/cpukit/score/include/rtems/score/chain.h index 651ee15291..53976e6d78 100644 --- a/cpukit/score/include/rtems/score/chain.h +++ b/cpukit/score/include/rtems/score/chain.h @@ -130,10 +130,12 @@ void _Chain_Initialize( * @brief Extract the specified node from a chain * * This routine extracts @a the_node from the chain on which it resides. - * It disables interrupts to ensure the atomicity of the - * extract operation. + * It disables interrupts to ensure the atomicity of the extract operation. * - * @arg the_node specifies the node to extract + * @param[in] the_node is the node to be extracted + * + * - INTERRUPT LATENCY: + * + single case */ void _Chain_Extract( Chain_Node *the_node @@ -160,9 +162,15 @@ Chain_Node *_Chain_Get( * * This routine inserts @a the_node on a chain immediately following * @a after_node. + * + * @param[in] after_node is the pointer to the node in chain to be inserted after + * @param[in] node is the pointer to the node to be inserted * * @note It disables interrupts to ensure the atomicity - * of the extract operation. + * of the insert operation. + * + * - INTERRUPT LATENCY: + * + single case */ void _Chain_Insert( Chain_Node *after_node, |