diff options
| author | Mathew Kallada <matkallada@gmail.com> | 2012-11-29 20:01:26 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-29 20:01:26 -0600 |
| commit | 8396c18ee6eb60403730e5aa2480474c6109f823 (patch) | |
| tree | cf4b748114b60deb44fc865592d128f07899efe9 /cpukit/score/src/objectnametoidstring.c | |
| parent | score misc: Score misc: Clean up Doxygen #7 (GCI 2012) (diff) | |
| download | rtems-8396c18ee6eb60403730e5aa2480474c6109f823.tar.bz2 | |
Score misc: Clean up Doxygen #8 (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/7970221
Diffstat (limited to 'cpukit/score/src/objectnametoidstring.c')
| -rw-r--r-- | cpukit/score/src/objectnametoidstring.c | 26 |
1 files changed, 7 insertions, 19 deletions
diff --git a/cpukit/score/src/objectnametoidstring.c b/cpukit/score/src/objectnametoidstring.c index fae262a7db..1b88e06fb4 100644 --- a/cpukit/score/src/objectnametoidstring.c +++ b/cpukit/score/src/objectnametoidstring.c @@ -1,6 +1,11 @@ -/* - * Object Handler - Object ID to Name (String) +/** + * @file * + * @brief Object ID to Name + * @ingroup ScoreObject + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * @@ -28,23 +33,6 @@ #include <rtems/score/isr.h> #if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES) -/* - * _Objects_Name_to_id_string - * - * These kernel routines search the object table(s) for the given - * object name and returns the associated object id. - * - * Input parameters: - * information - object information - * name - user defined object name - * id - address of return ID - * - * Output parameters: - * id - object id - * OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - Objects_Name_or_id_lookup_errors _Objects_Name_to_id_string( Objects_Information *information, const char *name, |