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/include/rtems/rtems/part.h | |
| 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/include/rtems/rtems/part.h')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/part.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h index c30bc419d6..8415f9ca5b 100644 --- a/cpukit/rtems/include/rtems/rtems/part.h +++ b/cpukit/rtems/include/rtems/rtems/part.h @@ -111,7 +111,7 @@ rtems_status_code rtems_partition_create( ); /** - * @brief rtems_partition_ident + * @brief RTEMS Partition Ident * * This routine implements the rtems_partition_ident directive. * This directive returns the partition ID associated with name. @@ -120,6 +120,13 @@ rtems_status_code rtems_partition_create( * extent of the search for the ID of the partition named name. * The search can be limited to a particular node or allowed to * encompass all nodes. + * + * @param[in] name is the user defined partition name + * @param[in] node is(are) the node(s) to be searched + * @param[in] id is the pointer to partition id + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and + * *id filled in with the partition id */ rtems_status_code rtems_partition_ident( rtems_name name, |