diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-26 10:42:03 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 07:45:53 +0100 |
commit | c81ac0e750776294fce56f6744671e3090b0579a (patch) | |
tree | 5debbfe44cd0b4b117b5848b5c04cfe2fe8cd51b /cpukit/include/rtems/score/freechain.h | |
parent | rtems: Canonicalize implementation Doxygen groups (diff) | |
download | rtems-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/freechain.h')
-rw-r--r-- | cpukit/include/rtems/score/freechain.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/cpukit/include/rtems/score/freechain.h b/cpukit/include/rtems/score/freechain.h index 7db1101cff..76b028fba0 100644 --- a/cpukit/include/rtems/score/freechain.h +++ b/cpukit/include/rtems/score/freechain.h @@ -27,11 +27,11 @@ extern "C" { * * @ingroup RTEMSScore * - * @brief The Freechain Handler. + * @brief This group contains the Freechain Handler implementation. * - * The Freechain Handler is used to manage a chain of nodes, of which size can - * automatically increase when there is no free node left. This handler - * provides one data structure: Freechain_Control. + * This handler encapsulates functionality related to the management of + * free nodes of a user-defined size. If the chain of free nodes is empty + * during an allocation request, it can be dynamically extended. * * @{ */ |