summaryrefslogtreecommitdiffstats
path: root/cpukit/score/include/rtems/score/object.h
diff options
context:
space:
mode:
authorDaniel Georgiev <daniel.georgiev95@gmail.com>2012-12-01 09:53:45 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-01 09:53:45 -0500
commit5a58b1e4988eb1a0fb6311b25fd12c91bb7237d7 (patch)
tree842558afb925e4f9fe5a0ac74a7f25a7d6b181be /cpukit/score/include/rtems/score/object.h
parentscore misc: Score misc: Clean up Doxygen #10 (GCI 2012) (diff)
downloadrtems-5a58b1e4988eb1a0fb6311b25fd12c91bb7237d7.tar.bz2
score misc: Score misc: Clean up Doxygen #11 (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/8013204
Diffstat (limited to 'cpukit/score/include/rtems/score/object.h')
-rw-r--r--cpukit/score/include/rtems/score/object.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index 274347bb0b..f2f4469368 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -583,6 +583,7 @@ typedef enum {
#define OBJECTS_NAME_ERRORS_LAST OBJECTS_INVALID_NODE
/**
+ * @brief Object Name To Id
* This method converts an object name to an Id. It performs a look up
* using the object information block for this object class.
*
@@ -627,6 +628,7 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_string(
#endif
/**
+ * @brief Object Id To Name
* This function implements the common portion of the object Id
* to name directives. This function returns the name
* associated with object id.
@@ -647,6 +649,7 @@ Objects_Name_or_id_lookup_errors _Objects_Id_to_name (
);
/**
+ * @brief Get Object
* This function maps object ids to object control blocks.
* If id corresponds to a local object, then it returns
* the_object control pointer which maps to id and location