diff options
author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-02 10:03:09 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-02 10:03:09 -0600 |
commit | 52adc808422cf415027c07c54910086227bcb973 (patch) | |
tree | 74d6da54a3d4ca2cc9f41dd93bf482f9c44a77ef /cpukit/rtems/src/partident.c | |
parent | score misc: Score misc: Clean up Doxygen #11 (GCI 2012) (diff) | |
download | rtems-52adc808422cf415027c07c54910086227bcb973.tar.bz2 |
score misc: Clean up Doxygen #12 (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/8025203
Diffstat (limited to 'cpukit/rtems/src/partident.c')
-rw-r--r-- | cpukit/rtems/src/partident.c | 27 |
1 files changed, 7 insertions, 20 deletions
diff --git a/cpukit/rtems/src/partident.c b/cpukit/rtems/src/partident.c index 83185c8a02..44b033956f 100644 --- a/cpukit/rtems/src/partident.c +++ b/cpukit/rtems/src/partident.c @@ -1,7 +1,11 @@ -/* - * Partition Manager - * +/** + * @file * + * @brief RTEMS Partition Name to Id + * @ingroup ClassicPart + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -23,23 +27,6 @@ #include <rtems/score/thread.h> #include <rtems/score/sysstate.h> -/* - * rtems_partition_ident - * - * This directive returns the system ID associated with - * the partition name. - * - * Input parameters: - * name - user defined partition name - * node - node(s) to be searched - * id - pointer to partition id - * - * Output parameters: - * *id - partition id - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_partition_ident( rtems_name name, uint32_t node, |