From 7ee5bc4ce1d2b596356a5c99ca1e2240ea1f8b62 Mon Sep 17 00:00:00 2001
From: Mathew Kallada <matkallada@gmail.com>
Date: Fri, 28 Dec 2012 17:23:21 -0600
Subject: rtems: Doxygen Clean Up Task #3

---
 cpukit/rtems/inline/rtems/rtems/attr.inl | 38 ++++++++++++++++++++------------
 1 file changed, 24 insertions(+), 14 deletions(-)

(limited to 'cpukit/rtems/inline/rtems/rtems/attr.inl')

diff --git a/cpukit/rtems/inline/rtems/rtems/attr.inl b/cpukit/rtems/inline/rtems/rtems/attr.inl
index 75d62ad601..126259a067 100644
--- a/cpukit/rtems/inline/rtems/rtems/attr.inl
+++ b/cpukit/rtems/inline/rtems/rtems/attr.inl
@@ -29,7 +29,7 @@
  */
 
 /**
- *  @brief Attributes_Set
+ *  @brief Sets the requested new_attributes in the attribute_set passed in.
  *
  *  This function sets the requested new_attributes in the attribute_set
  *  passed in.  The result is returned to the user.
@@ -43,7 +43,8 @@ RTEMS_INLINE_ROUTINE rtems_attribute _Attributes_Set (
 }
 
 /**
- *  @brief Attributes_Clear
+ *  @brief Clears the requested new_attributes in the attribute_set
+ *  passed in.
  *
  *  This function clears the requested new_attributes in the attribute_set
  *  passed in.  The result is returned to the user.
@@ -57,7 +58,8 @@ RTEMS_INLINE_ROUTINE rtems_attribute _Attributes_Clear (
 }
 
 /**
- *  @brief Attributes_Is_floating_point
+ *  @brief Checks if the floating point attribute is
+ *  enabled in the attribute_set.
  *
  *  This function returns TRUE if the floating point attribute is
  *  enabled in the attribute_set and FALSE otherwise.
@@ -71,7 +73,8 @@ RTEMS_INLINE_ROUTINE bool _Attributes_Is_floating_point(
 
 #if defined(RTEMS_MULTIPROCESSING)
 /**
- *  @brief Attributes_Is_global
+ *  @brief Checks if the global object attribute is enabled in
+ *  the attribute_set.
  *
  *  This function returns TRUE if the global object attribute is
  *  enabled in the attribute_set and FALSE otherwise.
@@ -85,7 +88,7 @@ RTEMS_INLINE_ROUTINE bool _Attributes_Is_global(
 #endif
 
 /**
- *  @brief Attributes_Is_priority
+ *  @brief Checks if the priority attribute is enabled in the attribute_set.
  *
  *  This function returns TRUE if the priority attribute is
  *  enabled in the attribute_set and FALSE otherwise.
@@ -98,7 +101,8 @@ RTEMS_INLINE_ROUTINE bool _Attributes_Is_priority(
 }
 
 /**
- *  @brief Attributes_Is_binary_semaphore
+ *  @brief Checks if the binary semaphore attribute is
+ *  enabled in the attribute_set.
  *
  *  This function returns TRUE if the binary semaphore attribute is
  *  enabled in the attribute_set and FALSE otherwise.
@@ -111,21 +115,23 @@ RTEMS_INLINE_ROUTINE bool _Attributes_Is_binary_semaphore(
 }
 
 /**
- *  @brief Attributes_Is_simple_binary_semaphore
+ *  @brief Checks if the simple binary semaphore attribute is
+ *  enabled in the attribute_set
  *
  *  This function returns TRUE if the simple binary semaphore attribute is
  *  enabled in the attribute_set and FALSE otherwise.
  */
 RTEMS_INLINE_ROUTINE bool _Attributes_Is_simple_binary_semaphore(
   rtems_attribute attribute_set
-) 
+)
 {
   return
     ((attribute_set & RTEMS_SEMAPHORE_CLASS) == RTEMS_SIMPLE_BINARY_SEMAPHORE);
-}  
+}
 
 /**
- *  @brief Attributes_Is_counting_semaphore
+ *  @brief Checks if the counting semaphore attribute is
+ *  enabled in the attribute_set
  *
  *  This function returns TRUE if the counting semaphore attribute is
  *  enabled in the attribute_set and FALSE otherwise.
@@ -138,7 +144,8 @@ RTEMS_INLINE_ROUTINE bool _Attributes_Is_counting_semaphore(
 }
 
 /**
- *  @brief Attributes_Is_inherit_priority
+ *  @brief Checks if the priority inheritance attribute
+ *  is enabled in the attribute_set
  *
  *  This function returns TRUE if the priority inheritance attribute
  *  is enabled in the attribute_set and FALSE otherwise.
@@ -151,7 +158,8 @@ RTEMS_INLINE_ROUTINE bool _Attributes_Is_inherit_priority(
 }
 
 /**
- *  @brief Attributes_Is_priority_ceiling
+ *  @brief Checks if the priority ceiling attribute
+ *  is enabled in the attribute_set
  *
  *  This function returns TRUE if the priority ceiling attribute
  *  is enabled in the attribute_set and FALSE otherwise.
@@ -164,7 +172,8 @@ RTEMS_INLINE_ROUTINE bool _Attributes_Is_priority_ceiling(
 }
 
 /**
- *  @brief Attributes_Is_barrier_automatic
+ *  @brief Checks if the barrier automatic release
+ *  attribute is enabled in the attribute_set
  *
  *  This function returns TRUE if the barrier automatic release
  *  attribute is enabled in the attribute_set and FALSE otherwise.
@@ -177,7 +186,8 @@ RTEMS_INLINE_ROUTINE bool _Attributes_Is_barrier_automatic(
 }
 
 /**
- *  @brief Attributes_Is_system_task
+ *  @brief Checks if the system task attribute
+ *  is enabled in the attribute_set.
  *
  *  This function returns TRUE if the system task attribute
  *  is enabled in the attribute_set and FALSE otherwise.
-- 
cgit v1.2.3