summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/score/status.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-27 17:21:23 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commit9278f3d04f1e26071cb98a5e2940177abc40b6d8 (patch)
tree9f5d198e4af5ad22b96012a17ce0a23769acf01f /cpukit/include/rtems/score/status.h
parentrtems: Canonicalize Doxygen @file comments (diff)
downloadrtems-9278f3d04f1e26071cb98a5e2940177abc40b6d8.tar.bz2
score: Canonicalize Doxygen @file comments
Use common phrases for the file brief descriptions. Update #3706.
Diffstat (limited to 'cpukit/include/rtems/score/status.h')
-rw-r--r--cpukit/include/rtems/score/status.h21
1 files changed, 21 insertions, 0 deletions
diff --git a/cpukit/include/rtems/score/status.h b/cpukit/include/rtems/score/status.h
index 820ce5ffa1..352f76e34d 100644
--- a/cpukit/include/rtems/score/status.h
+++ b/cpukit/include/rtems/score/status.h
@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @ingroup RTEMSScoreStatus
+ *
+ * @brief This header file provides the interfaces of the
+ * @ref RTEMSScoreStatus.
+ */
+
/*
* Copyright (c) 2016 embedded brains GmbH. All rights reserved.
*
@@ -25,6 +34,16 @@ extern "C" {
#endif /* __cplusplus */
/**
+ * @defgroup RTEMSScoreStatus Operation Status Support
+ *
+ * @ingroup RTEMSScore
+ *
+ * @brief This group contains the Operation Status Support implementation.
+ *
+ * @{
+ */
+
+/**
* @brief Status code parts for the Classic API.
*
* Must be in synchronization with rtems_status_code.
@@ -133,6 +152,8 @@ typedef enum {
STATUS_BUILD( STATUS_CLASSIC_UNSATISFIED, EAGAIN )
} Status_Control;
+/** @} */
+
#ifdef __cplusplus
}
#endif /* __cplusplus */