From bf54252a053b6bdedb01ca71bacba5a661ea6215 Mon Sep 17 00:00:00 2001 From: Alexandre Devienne Date: Wed, 28 Nov 2012 14:14:50 -0600 Subject: Score misc: Clean up Doxygen #4 (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/7985215 --- cpukit/score/include/rtems/score/object.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'cpukit/score/include/rtems/score/object.h') diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h index c9176e7e5b..1dec9930d1 100644 --- a/cpukit/score/include/rtems/score/object.h +++ b/cpukit/score/include/rtems/score/object.h @@ -447,8 +447,13 @@ void _Objects_Extend_information( ); /** + * @brief Shrink an object class information record + * * This function shrink an object class information record. - * + * The object's name and object space are released. The local_table + * etc block does not shrink. The InActive list needs to be scanned + * to find the objects are remove them. + * * @param[in] information points to an object class information block. */ void _Objects_Shrink_information( -- cgit v1.2.3