diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-11-28 11:16:28 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 07:45:53 +0100 |
| commit | 3db9c820e55aad1e784bf926e551a7de8dae0cdf (patch) | |
| tree | fd01d124fb7622ad955d141bd1ff9ce35d8a1e71 /cpukit/include/rtems/rbheap.h | |
| parent | score: Canonicalize Doxygen @file comments (diff) | |
| download | rtems-3db9c820e55aad1e784bf926e551a7de8dae0cdf.tar.bz2 | |
sapi: 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/rbheap.h')
| -rw-r--r-- | cpukit/include/rtems/rbheap.h | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/cpukit/include/rtems/rbheap.h b/cpukit/include/rtems/rbheap.h index d772c1a284..0db72ebf93 100644 --- a/cpukit/include/rtems/rbheap.h +++ b/cpukit/include/rtems/rbheap.h @@ -1,7 +1,9 @@ /** * @file * - * @brief Red-Black Tree Heap API + * @ingroup RTEMSAPIRBHeap + * + * @brief This header file provides the Red-Black Tree Heap API. */ /* @@ -30,11 +32,12 @@ extern "C" { #endif /** - * @defgroup RBHeap Red-Black Tree Heap + * @defgroup RTEMSAPIRBHeap Red-Black Tree Heap * - * @ingroup RTEMSAPIClassic + * @ingroup RTEMSAPI * - * @brief Red-Black Tree Heap API. + * @brief The red-black tree heap provides a memory allocator using a red-black + * tree to maintain blocks of memory. * * The red-black tree heap provides a memory allocator suitable to implement * the malloc() and free() interface. It uses a first-fit allocation strategy. |