rtems: Doxygen Clean Up Task #3

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.

cpukit/rtems/inline/rtems/rtems/dpmem.inl

@@ -26,7 +26,8 @@
  */
 
 /**
- *  @brief Dual_ported_memory_Allocate
+ *  @brief Allocates a port control block from the inactive chain
+ *  of free port control blocks.
  *
  *  This routine allocates a port control block from the inactive chain
  *  of free port control blocks.
@@ -39,7 +40,8 @@ RTEMS_INLINE_ROUTINE Dual_ported_memory_Control
 }
 
 /**
- *  @brief Dual_ported_memory_Free
+ *  @brief Frees a port control block to the inactive chain
+ *  of free port control blocks.
  *
  *  This routine frees a port control block to the inactive chain
  *  of free port control blocks.
@@ -52,7 +54,7 @@ RTEMS_INLINE_ROUTINE void _Dual_ported_memory_Free (
 }
 
 /**
- *  @brief Dual_ported_memory_Get
+ *  @brief Maps port IDs to port control blocks.
  *
  *  This function maps port IDs to port control blocks.  If ID
  *  corresponds to a local port, then it returns the_port control
@@ -71,7 +73,7 @@ RTEMS_INLINE_ROUTINE Dual_ported_memory_Control *_Dual_ported_memory_Get (
 }
 
 /**
- *  @brief Dual_ported_memory_Is_null
+ *  @brief Checks if the_port is NULL.
  *
  *  This function returns true if the_port is NULL and false otherwise.
  */

cpukit/rtems/inline/rtems/rtems/eventset.inl

@@ -27,7 +27,7 @@
  */
 
 /**
- *  @brief Event_sets_Is_empty
+ *  @brief Checks if on events are posted in the event_set.
  *
  *  This function returns TRUE if on events are posted in the event_set,
  *  and FALSE otherwise.
@@ -40,7 +40,7 @@ RTEMS_INLINE_ROUTINE bool _Event_sets_Is_empty(
 }
 
 /**
- *  @brief Event_sets_Post
+ *  @brief Posts the given new_events into the event_set passed in.
  *
  *  This routine posts the given new_events into the event_set
  *  passed in.  The result is returned to the user in event_set.
@@ -54,7 +54,7 @@ RTEMS_INLINE_ROUTINE void _Event_sets_Post(
 }
 
 /**
- *  @brief Event_sets_Get
+ *  @brief Returns the events in event_condition that are set in event_set.
  *
  *  This function returns the events in event_condition which are
  *  set in event_set.
@@ -68,7 +68,7 @@ RTEMS_INLINE_ROUTINE rtems_event_set _Event_sets_Get(
 }
 
 /**
- *  @brief Event_sets_Clear
+ *  @brief Removes the events in mask from the event_set passed in.
  *
  *  This function removes the events in mask from the event_set
  *  passed in.  The result is returned to the user in event_set.

cpukit/rtems/inline/rtems/rtems/message.inl

@@ -28,7 +28,7 @@
  */
 
 /**
- *  @brief Message_queue_Is_null
+ *  @brief Check whether message queue is null.
  *
  *  This function places the_message at the rear of the outstanding
  *  messages on the_message_queue.
@@ -42,7 +42,8 @@ RTEMS_INLINE_ROUTINE bool _Message_queue_Is_null (
 
 
 /**
- *  @brief Message_queue_Free
+ *  @brief Deallocates a message queue control block into
+ *  the inactive chain of free message queue control blocks.
  *
  *  This routine deallocates a message queue control block into
  *  the inactive chain of free message queue control blocks.
@@ -55,7 +56,7 @@ RTEMS_INLINE_ROUTINE void _Message_queue_Free (
 }
 
 /**
- *  @brief Message_queue_Get
+ *  @brief Maps message queue IDs to message queue control blocks.
  *
  *  This function maps message queue IDs to message queue control
  *  blocks.  If ID corresponds to a local message queue, then it

cpukit/rtems/inline/rtems/rtems/modes.inl

@@ -26,7 +26,7 @@
  */
 
 /**
- *  @brief Modes_Mask_changed
+ *  @brief Checks if any of the mode flags in mask are set in mode_set.
  *
  *  This function returns TRUE if any of the mode flags in mask
  *  are set in mode_set, and FALSE otherwise.
@@ -40,7 +40,7 @@ RTEMS_INLINE_ROUTINE bool _Modes_Mask_changed (
 }
 
 /**
- *  @brief Modes_Is_asr_disabled
+ *  @brief Checks if mode_set says that Asynchronous Signal Processing is disabled.
  *
  *  This function returns TRUE if mode_set indicates that Asynchronous
  *  Signal Processing is disabled, and FALSE otherwise.
@@ -53,7 +53,7 @@ RTEMS_INLINE_ROUTINE bool _Modes_Is_asr_disabled (
 }
 
 /**
- *  @brief Modes_Is_preempt
+ *  @brief Checks if mode_set indicates that preemption is enabled.
  *
  *  This function returns TRUE if mode_set indicates that preemption
  *  is enabled, and FALSE otherwise.
@@ -66,7 +66,7 @@ RTEMS_INLINE_ROUTINE bool _Modes_Is_preempt (
 }
 
 /**
- *  @brief Modes_Is_timeslice
+ *  @brief Checks if mode_set indicates that timeslicing is enabled.
  *
  *  This function returns TRUE if mode_set indicates that timeslicing
  *  is enabled, and FALSE otherwise.
@@ -79,7 +79,7 @@ RTEMS_INLINE_ROUTINE bool _Modes_Is_timeslice (
 }
 
 /**
- *  @brief Modes_Get_interrupt_level
+ *  @brief Gets the interrupt level portion of the mode_set.
  *
  *  This function returns the interrupt level portion of the mode_set.
  */
@@ -91,7 +91,7 @@ RTEMS_INLINE_ROUTINE ISR_Level _Modes_Get_interrupt_level (
 }
 
 /**
- *  @brief Modes_Set_interrupt_level
+ *  @brief Sets the current interrupt level to that specified in the mode_set.
  *
  *  This routine sets the current interrupt level to that specified
  *  in the mode_set.
@@ -104,7 +104,8 @@ RTEMS_INLINE_ROUTINE void _Modes_Set_interrupt_level (
 }
 
 /**
- *  @brief Modes_Change
+ *  @brief Changes the modes in old_mode_set indicated by
+ *  mask to the requested values in new_mode_set.
  *
  *  This routine changes the modes in old_mode_set indicated by
  *  mask to the requested values in new_mode_set.  The resulting

cpukit/rtems/inline/rtems/rtems/options.inl

@@ -28,7 +28,7 @@
  */
 
 /**
- *  @brief Options_Is_no_wait
+ *  @brief Checks if the RTEMS_NO_WAIT option is enabled in option_set.
  *
  *  This function returns TRUE if the RTEMS_NO_WAIT option is enabled in
  *  option_set, and FALSE otherwise.
@@ -41,7 +41,7 @@ RTEMS_INLINE_ROUTINE bool _Options_Is_no_wait (
 }
 
 /**
- *  @brief Options_Is_any
+ *  @brief Checks if the RTEMS_EVENT_ANY option is enabled in OPTION_SET.
  *
  *  This function returns TRUE if the RTEMS_EVENT_ANY option is enabled in
  *  OPTION_SET, and FALSE otherwise.

cpukit/rtems/inline/rtems/rtems/part.inl

@@ -26,7 +26,7 @@
  */
 
 /**
- *  @brief Partition_Allocate_buffer
+ *  @brief Allocate a buffer from the_partition.
  *
  *  This function attempts to allocate a buffer from the_partition.
  *  If successful, it returns the address of the allocated buffer.
@@ -40,7 +40,7 @@ RTEMS_INLINE_ROUTINE void *_Partition_Allocate_buffer (
 }
 
 /**
- *  @brief Partition_Free_buffer
+ *  @brief Frees the_buffer to the_partition.
  *
  *  This routine frees the_buffer to the_partition.
  */
@@ -53,7 +53,7 @@ RTEMS_INLINE_ROUTINE void _Partition_Free_buffer (
 }
 
 /**
- *  @brief Partition_Is_buffer_on_boundary
+ *  @brief Checks whether is on a valid buffer boundary for the_partition.
  *
  *  This function returns TRUE if the_buffer is on a valid buffer
  *  boundary for the_partition, and FALSE otherwise.
@@ -74,7 +74,7 @@ RTEMS_INLINE_ROUTINE bool _Partition_Is_buffer_on_boundary (
 }
 
 /**
- *  @brief Partition_Is_buffer_valid
+ *  @brief Checks whether the_buffer is a valid buffer from the_partition.
  *
  *  This function returns TRUE if the_buffer is a valid buffer from
  *  the_partition, otherwise FALSE is returned.
@@ -97,7 +97,7 @@ RTEMS_INLINE_ROUTINE bool _Partition_Is_buffer_valid (
 }
 
 /**
- *  @brief Partition_Is_buffer_size_aligned
+ *  @brief Checks if partition is buffer size aligned.
  *
  *  This function returns TRUE if the use of the specified buffer_size
  *  will result in the allocation of buffers whose first byte is
@@ -111,7 +111,8 @@ RTEMS_INLINE_ROUTINE bool _Partition_Is_buffer_size_aligned (
 }
 
 /**
- *  @brief Partition_Allocate
+ *  @brief Allocates a partition control block from the
+ *  inactive chain of free partition control blocks.
  *
  *  This function allocates a partition control block from
  *  the inactive chain of free partition control blocks.
@@ -122,7 +123,8 @@ RTEMS_INLINE_ROUTINE Partition_Control *_Partition_Allocate ( void )
 }
 
 /**
- *  @brief Partition_Free
+ *  @brief Frees a partition control block to the
+ *  inactive chain of free partition control blocks.
  *
  *  This routine frees a partition control block to the
  *  inactive chain of free partition control blocks.
@@ -135,7 +137,7 @@ RTEMS_INLINE_ROUTINE void _Partition_Free (
 }
 
 /**
- *  @brief Partition_Get
+ *  @brief Maps partition IDs to partition control blocks.
  *
  *  This function maps partition IDs to partition control blocks.
  *  If ID corresponds to a local partition, then it returns
@@ -155,7 +157,7 @@ RTEMS_INLINE_ROUTINE Partition_Control *_Partition_Get (
 }
 
 /**
- *  @brief Partition_Is_null
+ *  @brief Checks if the_partition is NULL.
  *
  *  This function returns TRUE if the_partition is NULL
  *  and FALSE otherwise.

cpukit/rtems/inline/rtems/rtems/ratemon.inl

@@ -26,7 +26,8 @@
  */
 
 /**
- *  @brief Rate_monotonic_Allocate
+ *  @brief Allocates a period control block from
+ *  the inactive chain of free period control blocks.
  *
  *  This function allocates a period control block from
  *  the inactive chain of free period control blocks.
@@ -38,7 +39,8 @@ RTEMS_INLINE_ROUTINE Rate_monotonic_Control *_Rate_monotonic_Allocate( void )
 }
 
 /**
- *  @brief Rate_monotonic_Free
+ *  @brief Allocates a period control block from
+ *  the inactive chain of free period control blocks.
  *
  *  This routine allocates a period control block from
  *  the inactive chain of free period control blocks.
@@ -51,7 +53,7 @@ RTEMS_INLINE_ROUTINE void _Rate_monotonic_Free (
 }
 
 /**
- *  @brief Rate_monotonic_Get
+ *  @brief Maps period IDs to period control blocks.
  *
  *  This function maps period IDs to period control blocks.
  *  If ID corresponds to a local period, then it returns
@@ -69,7 +71,7 @@ RTEMS_INLINE_ROUTINE Rate_monotonic_Control *_Rate_monotonic_Get (
 }
 
 /**
- *  @brief Rate_monotonic_Is_active
+ *  @brief Checks if the_period is in the ACTIVE state.
  *
  *  This function returns TRUE if the_period is in the ACTIVE state,
  *  and FALSE otherwise.
@@ -82,7 +84,7 @@ RTEMS_INLINE_ROUTINE bool _Rate_monotonic_Is_active (
 }
 
 /**
- *  @brief Rate_monotonic_Is_inactive
+ *  @brief Checks if the_period is in the ACTIVE state.
  *
  *  This function returns TRUE if the_period is in the ACTIVE state,
  *  and FALSE otherwise.
@@ -95,7 +97,7 @@ RTEMS_INLINE_ROUTINE bool _Rate_monotonic_Is_inactive (
 }
 
 /**
- *  @brief Rate_monotonic_Is_expired
+ *  @brief Checks if the_period is in the EXPIRED state.
  *
  *  This function returns TRUE if the_period is in the EXPIRED state,
  *  and FALSE otherwise.
@@ -108,7 +110,7 @@ RTEMS_INLINE_ROUTINE bool _Rate_monotonic_Is_expired (
 }
 
 /**
- *  @brief Rate_monotonic_Is_null
+ *  @brief Checks if the_period is NULL.
  *
  *  This function returns TRUE if the_period is NULL and FALSE otherwise.
  */

cpukit/rtems/inline/rtems/rtems/sem.inl

@@ -26,7 +26,8 @@
  */
 
 /**
- *  @brief Semaphore_Allocate
+ *  @brief Allocates a semaphore control block from
+ *  the inactive chain of free semaphore control blocks.
  *
  *  This function allocates a semaphore control block from
  *  the inactive chain of free semaphore control blocks.
@@ -37,7 +38,8 @@ RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Allocate( void )
 }
 
 /**
- *  @brief Semaphore_Free
+ *  @brief Frees a semaphore control block to the
+ *  inactive chain of free semaphore control blocks.
  *
  *  This routine frees a semaphore control block to the
  *  inactive chain of free semaphore control blocks.
@@ -50,7 +52,7 @@ RTEMS_INLINE_ROUTINE void _Semaphore_Free (
 }
 
 /**
- *  @brief Semaphore_Get
+ *  @brief Maps semaphore IDs to semaphore control blocks.
  *
  *  This function maps semaphore IDs to semaphore control blocks.
  *  If ID corresponds to a local semaphore, then it returns
@@ -70,7 +72,7 @@ RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Get (
 }
 
 /**
- *  @brief Semaphore_Get (Interrupts disabled)
+ *  @brief Maps semaphore IDs to semaphore control blocks.
  *
  *  This function maps semaphore IDs to semaphore control blocks.
  *  If ID corresponds to a local semaphore, then it returns
@@ -91,7 +93,7 @@ RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Get_interrupt_disable (
 }
 
 /**
- *  @brief Semaphore_Is_null
+ *  @brief Checks if the_semaphore is NULL.
  *
  *  This function returns TRUE if the_semaphore is NULL and FALSE otherwise.
  */

cpukit/rtems/inline/rtems/rtems/status.inl

@@ -28,7 +28,7 @@
  */
 
 /**
- *  @brief rtems_is_status_successful
+ *  @brief Checks if the status code is equal to RTEMS_SUCCESSFUL.
  *
  *  This function returns TRUE if the status code is equal to RTEMS_SUCCESSFUL,
  *  and FALSE otherwise.
@@ -41,7 +41,7 @@ RTEMS_INLINE_ROUTINE bool rtems_is_status_successful(
 }
 
 /**
- *  @brief rtems_are_statuses_equal
+ *  @brief Checks if the status code1 is equal to code2.
  *
  *  This function returns TRUE if the status code1 is equal to code2,
  *  and FALSE otherwise.

cpukit/rtems/inline/rtems/rtems/tasks.inl

@@ -26,7 +26,7 @@
  */
 
 /**
- *  @brief RTEMS_tasks_Allocate
+ *  @brief Allocates a task control block.
  *
  *  This function allocates a task control block from
  *  the inactive chain of free task control blocks.
@@ -37,7 +37,7 @@ RTEMS_INLINE_ROUTINE Thread_Control *_RTEMS_tasks_Allocate( void )
 }
 
 /**
- *  @brief RTEMS_tasks_Free
+ *  @brief Frees a task control block.
  *
  *  This routine frees a task control block to the
  *  inactive chain of free task control blocks.
@@ -46,14 +46,14 @@ RTEMS_INLINE_ROUTINE void _RTEMS_tasks_Free (
   Thread_Control *the_task
 )
 {
-  _Objects_Free( 
+  _Objects_Free(
     _Objects_Get_information_id( the_task->Object.id ),
     &the_task->Object
   );
 }
 
 /**
- *  @brief RTEMS_tasks_Priority_to_Core
+ *  @brief Converts an RTEMS API priority into a core priority.
  *
  *  This function converts an RTEMS API priority into a core priority.
  */
@@ -65,7 +65,7 @@ RTEMS_INLINE_ROUTINE Priority_Control _RTEMS_tasks_Priority_to_Core(
 }
 
 /**
- *  @brief RTEMS_tasks_Priority_is_valid
+ *  @brief Checks whether the priority is a valid user task.
  *
  *  This function returns TRUE if the_priority is a valid user task priority
  *  and FALSE otherwise.