summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/score/objectdata.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-30 14:00:08 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commit70dbafbf5ed26d0d434d6428d9f3de1be2ee502a (patch)
tree872ccc19606d492beddbdc2875a2ef79d8d8bcf0 /cpukit/include/rtems/score/objectdata.h
parentsapi: Canonicalize @defgroup and @file comments (diff)
downloadrtems-70dbafbf5ed26d0d434d6428d9f3de1be2ee502a.tar.bz2
config: Canonicalize @defgroup and @file comments
Adjust group identifier and names to be in line with a common pattern. Use common phrases for the group and file brief descriptions. Update #3706.
Diffstat (limited to 'cpukit/include/rtems/score/objectdata.h')
-rw-r--r--cpukit/include/rtems/score/objectdata.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/cpukit/include/rtems/score/objectdata.h b/cpukit/include/rtems/score/objectdata.h
index 56a1b8eb13..952c150e1f 100644
--- a/cpukit/include/rtems/score/objectdata.h
+++ b/cpukit/include/rtems/score/objectdata.h
@@ -3,7 +3,10 @@
*
* @ingroup RTEMSScoreObject
*
- * @brief Object Handler Data Structures
+ * @brief This header file provides data structures used by the implementation
+ * and the @ref RTEMSImplApplConfig to define instances of
+ * ::Objects_Information, ::_Objects_MP_Controls, and ultimately
+ * ::Thread_Configured_control.
*/
/*