score: Doxygen Clean Up Task #18

http://www.google-melange.com/gci/task/view/google/gci2012/8137204

1 files changed, 55 insertions, 47 deletions

diff --git a/cpukit/score/inline/rtems/score/address.inl b/cpukit/score/inline/rtems/score/address.inl
index c1c4f30b02..ba42fec92e 100644
--- a/cpukit/score/inline/rtems/score/address.inl
+++ b/cpukit/score/inline/rtems/score/address.inl
@@ -1,8 +1,10 @@
-/** 
- *  @file  rtems/score/address.inl
+/**
+ * @file
+ *
+ * @brief Inlined Routines Associated with Addresses
  *
- *  This include file contains the bodies of the routines
- *  about addresses which are inlined.
+ * This include file contains the bodies of the routines
+ * about addresses which are inlined.
  */
 
 /*
@@ -24,20 +26,22 @@
 #include <rtems/score/basedefs.h>
 
 /**
- *  @addtogroup ScoreAddress 
- *  @{
+ * @addtogroup ScoreAddress
+ *
+ * @{
  */
 
-/** @brief Add Offset to Address
+/**
+ * @brief Add offset to an address.
  *
- *  This function is used to add an @a offset to a @a base address.
- *  It returns the resulting address.  This address is typically
- *  converted to an access type before being used further.
+ * This function is used to add an @a offset to a @a base address.
+ * It returns the resulting address.  This address is typically
+ * converted to an access type before being used further.
  *
- *  @param[in] base is the base address.
- *  @param[in] offset is the offset to add to @a base.
+ * @param[in] base is the base address.
+ * @param[in] offset is the offset to add to @a base.
  *
- *  @return This method returns the resulting address.
+ * @return This method returns the resulting address.
  */
 #include <rtems/bspIo.h>
 RTEMS_INLINE_ROUTINE void *_Addresses_Add_offset (
@@ -48,16 +52,17 @@ RTEMS_INLINE_ROUTINE void *_Addresses_Add_offset (
   return (void *)((uintptr_t)base + offset);
 }
 
-/** @brief Subtract Offset from Offset
+/**
+ * @brief Subtract offset from offset.
  *
- *  This function is used to subtract an @a offset from a @a base
- *  address.  It returns the resulting address.  This address is
- *  typically converted to an access type before being used further.
+ * This function is used to subtract an @a offset from a @a base
+ * address.  It returns the resulting address.  This address is
+ * typically converted to an access type before being used further.
  *
- *  @param[in] base is the base address.
- *  @param[in] offset is the offset to subtract to @a base.
+ * @param[in] base is the base address.
+ * @param[in] offset is the offset to subtract to @a base.
  *
- *  @return This method returns the resulting address.
+ * @return This method returns the resulting address.
  */
 
 RTEMS_INLINE_ROUTINE void *_Addresses_Subtract_offset (
@@ -68,18 +73,19 @@ RTEMS_INLINE_ROUTINE void *_Addresses_Subtract_offset (
   return (void *)((uintptr_t)base - offset);
 }
 
-/** @brief Subtract Two Offsets
+/**
+ * @brief Subtract two offsets.
  *
- *  This function is used to subtract two addresses.  It returns the
- *  resulting offset.
+ * This function is used to subtract two addresses.  It returns the
+ * resulting offset.
  *
- *  @param[in] left is the address on the left hand side of the subtraction.
- *  @param[in] right is the address on the right hand side of the subtraction.
+ * @param[in] left is the address on the left hand side of the subtraction.
+ * @param[in] right is the address on the right hand side of the subtraction.
  *
- *  @return This method returns the resulting address.
+ * @return This method returns the resulting address.
  *
- *  @note  The cast of an address to an uint32_t makes this code
- *         dependent on an addresses being thirty two bits.
+ * @note  The cast of an address to an uint32_t makes this code
+ *        dependent on an addresses being thirty two bits.
  */
 RTEMS_INLINE_ROUTINE int32_t _Addresses_Subtract (
   const void *left,
@@ -89,16 +95,17 @@ RTEMS_INLINE_ROUTINE int32_t _Addresses_Subtract (
   return (int32_t) ((const char *) left - (const char *) right);
 }
 
-/** @brief Is Address Aligned
+/**
+ * @brief Is address aligned.
  *
- *  This function returns true if the given address is correctly
- *  aligned for this processor and false otherwise.  Proper alignment
- *  is based on correctness and efficiency.
+ * This function returns true if the given address is correctly
+ * aligned for this processor and false otherwise.  Proper alignment
+ * is based on correctness and efficiency.
  *
- *  @param[in] address is the address being checked for alignment.
+ * @param[in] address is the address being checked for alignment.
  *
- *  @return This method returns true if the address is aligned and
- *          false otherwise.
+ * @retval true The @a address is aligned.
+ * @retval false The @a address is not aligned.
  */
 RTEMS_INLINE_ROUTINE bool _Addresses_Is_aligned (
   const void *address
@@ -111,20 +118,21 @@ RTEMS_INLINE_ROUTINE bool _Addresses_Is_aligned (
 #endif
 }
 
-/** @brief Is Address In Range
+/**
+ * @brief Is address in range.
  *
- *  This function returns true if the given address is within the
- *  memory range specified and false otherwise.  base is the address
- *  of the first byte in the memory range and limit is the address
- *  of the last byte in the memory range.  The base address is
- *  assumed to be lower than the limit address.
+ * This function returns true if the given address is within the
+ * memory range specified and false otherwise.  base is the address
+ * of the first byte in the memory range and limit is the address
+ * of the last byte in the memory range.  The base address is
+ * assumed to be lower than the limit address.
  *
- *  @param[in] address is the address to check.
- *  @param[in] base is the lowest address of the range to check against.
- *  @param[in] limit is the highest address of the range to check against.
+ * @param[in] address is the address to check.
+ * @param[in] base is the lowest address of the range to check against.
+ * @param[in] limit is the highest address of the range to check against.
  *
- *  @return This method returns true if the given @a address is within the
- *  memory range specified and false otherwise.
+ * @retval true The @a address is within the memory range specified
+ * @retval false The @a address is not within the memory range specified.
  */
 RTEMS_INLINE_ROUTINE bool _Addresses_Is_in_range (
   const void *address,
@@ -135,7 +143,7 @@ RTEMS_INLINE_ROUTINE bool _Addresses_Is_in_range (
   return (address >= base && address <= limit);
 }
 
-/**@}*/
+/** @} */
 
 #endif
 /* end of include file */