summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/object.h
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-05 19:46:05 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-05 19:46:05 -0500
commit4efe1955132708b2e88fd046b04eee00fdad0c38 (patch)
tree301f1ef0121164b3fc3e180384594b91fffca1a7 /cpukit/rtems/include/rtems/rtems/object.h
parentrtems misc: Clean up Doxygen GCI Task #7 (diff)
downloadrtems-4efe1955132708b2e88fd046b04eee00fdad0c38.tar.bz2
rtems misc: Clean up Doxygen GCI Task #5
http://www.google-melange.com/gci/task/view/google/gci2012/8015207
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/object.h')
-rw-r--r--cpukit/rtems/include/rtems/rtems/object.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/object.h b/cpukit/rtems/include/rtems/rtems/object.h
index d8c1aa16f5..c59f1c98a8 100644
--- a/cpukit/rtems/include/rtems/rtems/object.h
+++ b/cpukit/rtems/include/rtems/rtems/object.h
@@ -73,6 +73,8 @@ typedef struct {
/**
* @brief Build Thirty-Two Bit Object Name
*
+ * RTEMS Object Helper -- Build an Object Id
+ *
* This function returns an object name composed of the four characters
* C1, C2, C3, and C4.
*
@@ -135,6 +137,8 @@ char *rtems_object_get_name(
* object. This can be used to set the name of objects
* which do not have a naming scheme per their API.
*
+ * RTEMS Object Helper -- Set Name of Object as String
+ *
* @param[in] id is the Id of the object to obtain the name of
* @param[out] name will be set to the name of the object
*
@@ -254,6 +258,7 @@ rtems_status_code rtems_object_set_name(
*
* @return This method returns the least valid value for
* class number for the specified @a api.
+ * RTEMS Object Helper -- Get Least Valid Class for an API
*/
int rtems_object_api_minimum_class(
int api