diff options
author | Christopher Kerl <zargyyoyo@gmail.com> | 2012-12-01 09:47:07 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-01 09:47:07 -0500 |
commit | f839bf5ae259fe53353a00046adf2c9413df502a (patch) | |
tree | e636813af9a1b5af09df27c1a9a07873cb56a565 /cpukit/score/include/rtems/score/object.h | |
parent | Print MCSR and ESR. (diff) | |
download | rtems-f839bf5ae259fe53353a00046adf2c9413df502a.tar.bz2 |
score misc: Score misc: Clean up Doxygen #10 (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/7983216
Diffstat (limited to 'cpukit/score/include/rtems/score/object.h')
-rw-r--r-- | cpukit/score/include/rtems/score/object.h | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h index 6d43b39e81..274347bb0b 100644 --- a/cpukit/score/include/rtems/score/object.h +++ b/cpukit/score/include/rtems/score/object.h @@ -779,10 +779,12 @@ Objects_Information *_Objects_Get_information( ); /** + * @brief Get Information of an Object from an ID + * * This function return the information structure given - * an id of an object. + * an @a id of an object. * - * @param[in] id is an object ID + * @param[in] id is the object ID to get the information from * * @return This method returns a pointer to the Object Information Table * for the class of objects which corresponds to this object ID. @@ -831,10 +833,12 @@ bool _Objects_Set_name( ); /** - * This function removes the_object from the namespace. + * @brief Removes Object from Namespace * - * @param[in] information points to an Object Information Table - * @param[in] the_object is a pointer to an object + * This function removes @a the_object from the namespace. + * + * @param[in] information points to an Object Information Table. + * @param[in] the_object is a pointer to an object. */ void _Objects_Namespace_remove( Objects_Information *information, |