summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/inline/rtems/rtems/modes.inl
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-28 17:23:21 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2012-12-28 17:23:21 -0600
commit7ee5bc4ce1d2b596356a5c99ca1e2240ea1f8b62 (patch)
treef5e373ae2b8c710a41bcd2050d1bdd1777cc9c6b /cpukit/rtems/inline/rtems/rtems/modes.inl
parentHeader File Doxygen Enhancement Task #11 (diff)
downloadrtems-7ee5bc4ce1d2b596356a5c99ca1e2240ea1f8b62.tar.bz2
rtems: Doxygen Clean Up Task #3
Diffstat (limited to 'cpukit/rtems/inline/rtems/rtems/modes.inl')
-rw-r--r--cpukit/rtems/inline/rtems/rtems/modes.inl15
1 files changed, 8 insertions, 7 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/modes.inl b/cpukit/rtems/inline/rtems/rtems/modes.inl
index d1ad842c54..034032154e 100644
--- a/cpukit/rtems/inline/rtems/rtems/modes.inl
+++ b/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