From 380a8d3808c38b2e3f2d97a3c2bf5094e0f0386a Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Thu, 3 May 2018 11:19:35 +0000 Subject: Documentation-related fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11988 110e8d01-0319-4d1e-a829-52ad28d1bb01 --- os/lib/src/chfactory.c | 2 +- os/lib/src/chmboxes.c | 2 +- os/lib/src/chmemcore.c | 6 +++--- os/lib/src/chmemheaps.c | 2 +- os/lib/src/chmempools.c | 2 +- os/lib/src/chpipes.c | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) (limited to 'os/lib/src') diff --git a/os/lib/src/chfactory.c b/os/lib/src/chfactory.c index dbb13cab8..8384efc2a 100644 --- a/os/lib/src/chfactory.c +++ b/os/lib/src/chfactory.c @@ -21,7 +21,7 @@ * @file chfactory.c * @brief ChibiOS objects factory and registry code. * - * @addtogroup objects_factory + * @addtogroup oslib_objects_factory * @details The object factory is a subsystem that allows to: * - Register static objects by name. * - Dynamically create objects and assign them a name. diff --git a/os/lib/src/chmboxes.c b/os/lib/src/chmboxes.c index b0ca43877..1b23bf2e0 100644 --- a/os/lib/src/chmboxes.c +++ b/os/lib/src/chmboxes.c @@ -21,7 +21,7 @@ * @file chmboxes.c * @brief Mailboxes code. * - * @addtogroup mailboxes + * @addtogroup oslib_mailboxes * @details Asynchronous messages. *

Operation mode

* A mailbox is an asynchronous communication mechanism.
diff --git a/os/lib/src/chmemcore.c b/os/lib/src/chmemcore.c index bb3832171..5dc3ce446 100644 --- a/os/lib/src/chmemcore.c +++ b/os/lib/src/chmemcore.c @@ -21,7 +21,7 @@ * @file chmemcore.c * @brief Core memory manager code. * - * @addtogroup memcore + * @addtogroup oslib_memcore * @details Core Memory Manager related APIs and services. *

Operation mode

* The core memory manager is a simplified allocator that only @@ -30,8 +30,8 @@ * This allocator is meant as a memory blocks provider for the * other allocators such as: * - C-Runtime allocator (through a compiler specific adapter module). - * - Heap allocator (see @ref heaps). - * - Memory pools allocator (see @ref pools). + * - Heap allocator (see @ref oslib_memheaps). + * - Memory pools allocator (see @ref oslib_mempools). * . * By having a centralized memory provider the various allocators * can coexist and share the main memory.
diff --git a/os/lib/src/chmemheaps.c b/os/lib/src/chmemheaps.c index fc01b7ccc..2646f2929 100644 --- a/os/lib/src/chmemheaps.c +++ b/os/lib/src/chmemheaps.c @@ -21,7 +21,7 @@ * @file chmemheaps.c * @brief Memory heaps code. * - * @addtogroup memheaps + * @addtogroup oslib_memheaps * @details Heap Allocator related APIs. *

Operation mode

* The heap allocator implements a first-fit strategy and its APIs diff --git a/os/lib/src/chmempools.c b/os/lib/src/chmempools.c index bd631d5b0..43078c951 100644 --- a/os/lib/src/chmempools.c +++ b/os/lib/src/chmempools.c @@ -21,7 +21,7 @@ * @file chmempools.c * @brief Memory Pools code. * - * @addtogroup pools + * @addtogroup oslib_mempools * @details Memory Pools related APIs and services. *

Operation mode

* The Memory Pools APIs allow to allocate/free fixed size objects in diff --git a/os/lib/src/chpipes.c b/os/lib/src/chpipes.c index 05b47f369..65df6d530 100644 --- a/os/lib/src/chpipes.c +++ b/os/lib/src/chpipes.c @@ -20,8 +20,6 @@ /** * @file chpipes.c * @brief Pipes code. - * - * @addtogroup pipes * @details Byte pipes. *

Operation mode

* A pipe is an asynchronous communication mechanism.
@@ -34,6 +32,8 @@ * @pre In order to use the pipes APIs the @p CH_CFG_USE_PIPES * option must be enabled in @p chconf.h. * @note Compatible with RT and NIL. + * + * @addtogroup oslib_pipes * @{ */ -- cgit v1.2.3