summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/options.h
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@oarcorp.com>2012-12-28 09:48:37 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2012-12-28 09:48:37 -0600
commitb8fc260ff3b9008d260febeadd092f31fd37c10a (patch)
tree1f465b75af013e8e056a4761bf8ac396b6515fda /cpukit/rtems/include/rtems/rtems/options.h
parentlibfs: Doxygen Enhancement Task #4 (diff)
downloadrtems-b8fc260ff3b9008d260febeadd092f31fd37c10a.tar.bz2
Miscellaneous Doxygen clean-up
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/options.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/options.h b/cpukit/rtems/include/rtems/rtems/options.h
index 6b30cc3044..c42af1c431 100644
--- a/cpukit/rtems/include/rtems/rtems/options.h
+++ b/cpukit/rtems/include/rtems/rtems/options.h
@@ -25,7 +25,11 @@ extern "C" {
/**
* @defgroup ClassicOptions Classic API Options
*
- * This encapsulates functionality which XXX
+ * @ingroup ClassicRTEMS
+ *
+ * This encapsulates functionality related to the options argument
+ * to Classic API blocking operations. The primary option is whether
+ * or not a task is willing to wait for the operation to complete.
*/
/**@{*/