summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/score/percpu.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-11-26 10:42:03 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 07:45:53 +0100
commitc81ac0e750776294fce56f6744671e3090b0579a (patch)
tree5debbfe44cd0b4b117b5848b5c04cfe2fe8cd51b /cpukit/include/rtems/score/percpu.h
parente07088d9ba894d8d1fd4dba8b2ff03ccffebba05 (diff)
downloadrtems-c81ac0e750776294fce56f6744671e3090b0579a.tar.bz2
score: Canonicalize Doxygen groups
Adjust group identifier and names to be in line with a common pattern. Use common phrases for the group brief descriptions. Update #3706.
Diffstat (limited to 'cpukit/include/rtems/score/percpu.h')
-rw-r--r--cpukit/include/rtems/score/percpu.h14
1 files changed, 8 insertions, 6 deletions
diff --git a/cpukit/include/rtems/score/percpu.h b/cpukit/include/rtems/score/percpu.h
index 6ae2103d98..d2a904663b 100644
--- a/cpukit/include/rtems/score/percpu.h
+++ b/cpukit/include/rtems/score/percpu.h
@@ -78,14 +78,16 @@ struct _Thread_Control;
struct Scheduler_Context;
/**
- * @defgroup PerCPU RTEMS Per CPU Information
+ * @defgroup RTEMSScorePerCPU Per-CPU Information
*
- * @ingroup RTEMSScore
+ * @ingroup RTEMSScore
*
- * This defines the per CPU state information required by RTEMS
- * and the BSP. In an SMP configuration, there will be multiple
- * instances of this data structure -- one per CPU -- and the
- * current CPU number will be used as the index.
+ * @brief This group contains the implementation of the per-CPU information.
+ *
+ * The per-CPU information encapsulates state which is maintained for each
+ * configured processor in the system. There will be one instance of a
+ * ::Per_CPU_Control in the ::_Per_CPU_Information table for each configured
+ * processor in the system.
*/
/**@{*/