score: Doxygen Clean Up Task #1

1 files changed, 41 insertions, 32 deletions

diff --git a/cpukit/score/include/rtems/score/object.h b/cpukit/score/include/rtems/score/object.h
index 91173c335a..6361730900 100644
--- a/cpukit/score/include/rtems/score/object.h
+++ b/cpukit/score/include/rtems/score/object.h
@@ -1,6 +1,8 @@
 /**
  * @file  rtems/score/object.h
  *
+ * @brief Constants and Structures Associated with the Object Handler
+ *
  * This include file contains all the constants and structures associated
  * with the Object Handler.  This Handler provides mechanisms which
  * can be used to initialize and manipulate all objects which have ids.
@@ -40,6 +42,7 @@ extern "C" {
  *
  * @brief Provides services for all APIs.
  */
+/**@{*/
 
 /**
  * @defgroup ScoreCPU CPU Architecture Support
@@ -48,12 +51,14 @@ extern "C" {
  *
  * @brief Provides CPU architecture dependent services.
  */
+/**@{*/
 
 /**
  *  @defgroup ScoreObject Object Handler
  *
  *  @ingroup Score
  */
+/**@{*/
 
 /**
  *  The following type defines the control block used to manage
@@ -502,20 +507,18 @@ void _Objects_Initialize_information (
  *
  *  @param[in] api is the API of interest
  *
- *  @return A positive integer on success and 0 otherwise.
+ *  @retval A positive integer on success and 0 otherwise.
  */
 unsigned int _Objects_API_maximum_class(
   uint32_t api
 );
 
 /**
- *  @brief Allocate Object
+ *  @brief Allocate an object.
  *
- *  This function allocates a object control block from
+ *  This function allocates an object control block from
  *  the inactive chain of free object control blocks.
  *
- *  @brief Allocate Object
- *
  *  @param[in] information points to an object class information block.
  */
 Objects_Control *_Objects_Allocate(
@@ -523,9 +526,9 @@ Objects_Control *_Objects_Allocate(
 );
 
 /**
- *  @brief Free Object
+ *  @brief Free an object.
  *
- *  This function frees a object control block to the
+ *  This function frees an object control block to the
  *  inactive chain of free object control blocks.
  *
  *  @param[in] information points to an object class information block.
@@ -583,7 +586,8 @@ typedef enum {
 #define OBJECTS_NAME_ERRORS_LAST  OBJECTS_INVALID_NODE
 
 /**
- *  @brief Object Name To Id
+ *  @brief Converts an object name to an Id.
+ *
  *  This method converts an object name to an Id.  It performs a look up
  *  using the object information block for this object class.
  *
@@ -592,7 +596,7 @@ typedef enum {
  *  @param[in] node is the set of nodes to search.
  *  @param[in] id will contain the Id if the search is successful.
  *
- *  @return This method returns one of the values from the
+ *  @retval This method returns one of the values from the
  *          @ref Objects_Name_or_id_lookup_errors enumeration to indicate
  *          successful or failure.  On success @a id will contain the Id of
  *          the requested object.
@@ -606,7 +610,7 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_u32(
 
 #if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES)
 /**
- *  @brief Object ID to Name
+ *  @brief Converts an object name to an Id.
  *
  *  This method converts an object name to an Id.  It performs a look up
  *  using the object information block for this object class.
@@ -615,7 +619,7 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_u32(
  *  @param[in] name is the name of the object to find.
  *  @param[in] id will contain the Id if the search is successful.
  *
- *  @return This method returns one of the values from the
+ *  @retval This method returns one of the values from the
  *          @ref Objects_Name_or_id_lookup_errors enumeration to indicate
  *          successful or failure.  On success @a id will contain the Id of
  *          the requested object.
@@ -628,7 +632,8 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_string(
 #endif
 
 /**
- *  @brief Object Id To Name
+ *  @brief Implements the common portion of the object Id to name directives.
+ *
  *  This function implements the common portion of the object Id
  *  to name directives.  This function returns the name
  *  associated with object id.
@@ -636,7 +641,7 @@ Objects_Name_or_id_lookup_errors _Objects_Name_to_id_string(
  *  @param[in] id is the Id of the object whose name we are locating.
  *  @param[in] name will contain the name of the object, if found.
  *
- *  @return This method returns one of the values from the
+ *  @retval This method returns one of the values from the
  *          @ref Objects_Name_or_id_lookup_errors enumeration to indicate
  *          successful or failure.  On success @a name will contain the name of
  *          the requested object.
@@ -649,7 +654,8 @@ Objects_Name_or_id_lookup_errors _Objects_Id_to_name (
 );
 
 /**
- *  @brief Get Object
+ *  @brief Maps object ids to object control blocks.
+ *
  *  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
@@ -663,7 +669,7 @@ Objects_Name_or_id_lookup_errors _Objects_Id_to_name (
  *  @param[in] id is the Id of the object whose name we are locating.
  *  @param[in] location will contain an indication of success or failure.
  *
- *  @return This method returns one of the values from the
+ *  @retval This method returns one of the values from the
  *          @ref Objects_Name_or_id_lookup_errors enumeration to indicate
  *          successful or failure.  On success @a id will contain the Id of
  *          the requested object.
@@ -680,7 +686,7 @@ Objects_Control *_Objects_Get (
 );
 
 /**
- *  @brief Object Get Isr Disable
+ *  @brief Maps object ids to object control blocks.
  *
  *  This function maps object ids to object control blocks.
  *  If id corresponds to a local object, then it returns
@@ -696,7 +702,7 @@ Objects_Control *_Objects_Get (
  *  @param[in] location will contain an indication of success or failure.
  *  @param[in] level is the interrupt level being turned.
  *
- *  @return This method returns one of the values from the
+ *  @retval This method returns one of the values from the
  *          @ref Objects_Name_or_id_lookup_errors enumeration to indicate
  *          successful or failure.  On success @a name will contain the name of
  *          the requested object.
@@ -714,7 +720,7 @@ Objects_Control *_Objects_Get_isr_disable(
 );
 
 /**
- *  @brief  Get No protection Object
+ *  @brief  Maps object ids to object control blocks.
  *
  *  This function maps object ids to object control blocks.
  *  If id corresponds to a local object, then it returns
@@ -729,7 +735,7 @@ Objects_Control *_Objects_Get_isr_disable(
  *  @param[in] id is the Id of the object whose name we are locating.
  *  @param[in] location will contain an indication of success or failure.
  *
- *  @return This method returns one of the values from the
+ *  @retval This method returns one of the values from the
  *          @ref Objects_Name_or_id_lookup_errors enumeration to indicate
  *          successful or failure.  On success @a id will contain the Id of
  *          the requested object.
@@ -753,7 +759,7 @@ Objects_Control *_Objects_Get_no_protection(
  *  @param[in] location_p will contain an indication of success or failure.
  *  @param[in] next_id_p is the Id of the next object we will look at.
  *
- *  @return This method returns the pointer to the object located or
+ *  @retval This method returns the pointer to the object located or
  *          NULL on error.
  */
 Objects_Control *_Objects_Get_next(
@@ -764,7 +770,7 @@ Objects_Control *_Objects_Get_next(
 );
 
 /**
- *  @brief Get Object Information
+ *  @brief Get object information.
  *
  *  This function return the information structure given
  *  an the API and Class.  This can be done independent of
@@ -773,7 +779,7 @@ Objects_Control *_Objects_Get_next(
  *  @param[in] the_api indicates the API for the information we want
  *  @param[in] the_class indicates the Class for the information we want
  *
- *  @return This method returns a pointer to the Object Information Table
+ *  @retval This method returns a pointer to the Object Information Table
  *          for the class of objects which corresponds to this object ID.
  */
 Objects_Information *_Objects_Get_information(
@@ -782,14 +788,14 @@ Objects_Information *_Objects_Get_information(
 );
 
 /**
- *  @brief Get Information of an Object from an ID
+ *  @brief Get information of an object from an ID.
  *
  *  This function return the information structure given
  *  an @a id of an object.
  *
  *  @param[in] id is the object ID to get the information from
  *
- *  @return This method returns a pointer to the Object Information Table
+ *  @retval This method returns a pointer to the Object Information Table
  *          for the class of objects which corresponds to this object ID.
  */
 Objects_Information *_Objects_Get_information_id(
@@ -797,7 +803,7 @@ Objects_Information *_Objects_Get_information_id(
 );
 
 /**
- *  @brief _Objects_Get_name_as_string
+ *  @brief Gets object name in the form of a C string.
  *
  *  This method objects the name of an object and returns its name
  *  in the form of a C string.  It attempts to be careful about
@@ -807,7 +813,7 @@ Objects_Information *_Objects_Get_information_id(
  *  @param[in] length indicates the length of the caller's buffer
  *  @param[in] name points a string which will be filled in.
  *
- *  @return This method returns @a name or NULL on error. @a *name will
+ *  @retval This method returns @a name or NULL on error. @a *name will
  *          contain the name if successful.
  */
 char *_Objects_Get_name_as_string(
@@ -817,7 +823,7 @@ char *_Objects_Get_name_as_string(
 );
 
 /**
- *  @brief Set Objects Name
+ *  @brief Set objects name.
  *
  *  This method sets the object name to either a copy of a string
  *  or up to the first four characters of the string based upon
@@ -827,7 +833,7 @@ char *_Objects_Get_name_as_string(
  *  @param[in] the_object is the object to operate upon
  *  @param[in] name is a pointer to the name to use
  *
- *  @return If successful, true is returned.  Otherwise false is returned.
+ *  @retval If successful, true is returned.  Otherwise false is returned.
  */
 bool _Objects_Set_name(
   Objects_Information *information,
@@ -836,7 +842,7 @@ bool _Objects_Set_name(
 );
 
 /**
- *  @brief Removes Object from Namespace
+ *  @brief Removes object from namespace.
  *
  *  This function removes @a the_object from the namespace.
  *
@@ -849,7 +855,7 @@ void _Objects_Namespace_remove(
 );
 
 /**
- *  @brief Close Object
+ *  @brief Close object.
  *
  *  This function removes the_object control pointer and object name
  *  in the Local Pointer and Local Name Tables.
@@ -867,7 +873,7 @@ void _Objects_Close(
  *
  * @param[in] information The object information table.
  *
- * @return The count of active objects.
+ * @retval The count of active objects.
  */
 Objects_Maximum _Objects_Active_count(
   const Objects_Information *information
@@ -886,5 +892,8 @@ Objects_Maximum _Objects_Active_count(
 }
 #endif
 
+/**@}*/
+/**@}*/
+/**@}*/
 #endif
-/* end of include file */
+/* end of include file */
\ No newline at end of file