Documentation-related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11988 110e8d01-0319-4d1e-a829-52ad28d1bb01

16 files changed, 104 insertions, 19 deletions

diff --git a/os/lib/dox/lib.dox b/os/lib/dox/lib.dox
new file mode 100644
index 000000000..4dfcdce58
--- /dev/null
+++ b/os/lib/dox/lib.dox
@@ -0,0 +1,85 @@
+/*

+    ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio.

+

+    This file is part of ChibiOS.

+

+    ChibiOS is free software; you can redistribute it and/or modify

+    it under the terms of the GNU General Public License as published by

+    the Free Software Foundation; either version 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS is distributed in the hope that it will be useful,

+    but WITHOUT ANY WARRANTY; without even the implied warranty of

+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+    GNU General Public License for more details.

+

+    You should have received a copy of the GNU General Public License

+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

+*/

+/**

+ * @defgroup oslib OS Library

+ * @details The OS Library is a set of RTOS extensions compatible with both

+ *          the RT and NIL RTOSes.

+ */

+

+/**

+ * @defgroup oslib_info Version Numbers and Identification

+ * @ingroup oslib

+ */

+

+/**

+ * @defgroup oslib_synchronization Synchronization

+ * @details Synchronization services.

+ * @ingroup oslib

+ */

+

+/**

+ * @defgroup oslib_binary_semaphores Binary Semaphores

+ * @ingroup oslib_synchronization

+ */

+

+/**

+ * @defgroup oslib_mailboxes Mailboxes

+ * @ingroup oslib_synchronization

+ */

+

+/**

+ * @defgroup oslib_pipes Pipes

+ * @ingroup oslib_synchronization

+ */

+

+/**

+ * @defgroup oslib_memory Memory Management

+ * @details Memory Management services.

+ * @ingroup oslib

+ */

+

+/**

+ * @defgroup oslib_memcore Core Memory Manager

+ * @ingroup oslib_memory

+ */

+

+/**

+ * @defgroup oslib_memheaps Memory Heaps

+ * @ingroup oslib_memory

+ */

+

+/**

+ * @defgroup oslib_mempools Memory Pools

+ * @ingroup oslib_memory

+ */

+

+/**

+ * @defgroup oslib_complex Complex Services

+ * @ingroup oslib

+ */

+

+/**

+ * @defgroup oslib_objects_fifos Objects FIFOs

+ * @ingroup oslib_complex

+ */

+

+/**

+ * @defgroup oslib_objects_factory Dynamic Objects Factory

+ * @ingroup oslib_complex

+ */

diff --git a/os/lib/include/chbsem.h b/os/lib/include/chbsem.h
index 77ca30c25..192aec86a 100644
--- a/os/lib/include/chbsem.h
+++ b/os/lib/include/chbsem.h
@@ -20,8 +20,6 @@
 /**

  * @file    chbsem.h

  * @brief   Binary semaphores structures and macros.

- *

- * @addtogroup binary_semaphores

  * @details Binary semaphores related APIs and services.

  *          <h2>Operation mode</h2>

  *          Binary semaphores are implemented as a set of inline functions

@@ -43,6 +41,8 @@
  *          implement the priority inheritance protocol.<br>

  *          In order to use the binary semaphores APIs the

  *          @p CH_CFG_USE_SEMAPHORES option must be enabled in @p chconf.h.

+ *

+ * @addtogroup oslib_binary_semaphores

  * @{

  */

 

diff --git a/os/lib/include/chfactory.h b/os/lib/include/chfactory.h
index 75f52e52f..0f66bf906 100644
--- a/os/lib/include/chfactory.h
+++ b/os/lib/include/chfactory.h
@@ -21,7 +21,7 @@
  * @file    chfactory.h

  * @brief   ChibiOS objects factory structures and macros.

  *

- * @addtogroup objects_factory

+ * @addtogroup oslib_objects_factory

  * @{

  */

 

diff --git a/os/lib/include/chlib.h b/os/lib/include/chlib.h
index 674561cb8..02f50e9c2 100644
--- a/os/lib/include/chlib.h
+++ b/os/lib/include/chlib.h
@@ -23,7 +23,7 @@
  * @details This header includes all the required library headers. This file

  *          is meant do be included by @p ch.h not directly by user.

  *

- * @addtogroup library_info

+ * @addtogroup oslib_info

  * @details OS Library related info.

  * @{

  */

diff --git a/os/lib/include/chmboxes.h b/os/lib/include/chmboxes.h
index 899a8ce1e..fd76b995a 100644
--- a/os/lib/include/chmboxes.h
+++ b/os/lib/include/chmboxes.h
@@ -21,7 +21,7 @@
  * @file    chmboxes.h

  * @brief   Mailboxes macros and structures.

  *

- * @addtogroup mailboxes

+ * @addtogroup oslib_mailboxes

  * @{

  */

 

diff --git a/os/lib/include/chmemcore.h b/os/lib/include/chmemcore.h
index 262796d84..b9b728389 100644
--- a/os/lib/include/chmemcore.h
+++ b/os/lib/include/chmemcore.h
@@ -21,7 +21,7 @@
  * @file    chmemcore.h

  * @brief   Core memory manager macros and structures.

  *

- * @addtogroup memcore

+ * @addtogroup oslib_memcore

  * @{

  */

 

diff --git a/os/lib/include/chmemheaps.h b/os/lib/include/chmemheaps.h
index c0ebcbb99..f20969a32 100644
--- a/os/lib/include/chmemheaps.h
+++ b/os/lib/include/chmemheaps.h
@@ -21,7 +21,7 @@
  * @file    chmemheaps.h

  * @brief   Memory heaps macros and structures.

  *

- * @addtogroup heaps

+ * @addtogroup oslib_memheaps

  * @{

  */

 

diff --git a/os/lib/include/chmempools.h b/os/lib/include/chmempools.h
index f8555c137..60d6a8da9 100644
--- a/os/lib/include/chmempools.h
+++ b/os/lib/include/chmempools.h
@@ -21,7 +21,7 @@
  * @file    chmempools.h

  * @brief   Memory Pools macros and structures.

  *

- * @addtogroup pools

+ * @addtogroup oslib_mempools

  * @{

  */

 

diff --git a/os/lib/include/chobjfifos.h b/os/lib/include/chobjfifos.h
index 51e7bf0a8..dfb0692ef 100644
--- a/os/lib/include/chobjfifos.h
+++ b/os/lib/include/chobjfifos.h
@@ -37,7 +37,7 @@
  *            can be blocking.

  *          .

  *

- * @addtogroup objects_fifo

+ * @addtogroup oslib_objects_fifos

  * @{

  */

 

diff --git a/os/lib/include/chpipes.h b/os/lib/include/chpipes.h
index 9e91614c4..c66c48d68 100644
--- a/os/lib/include/chpipes.h
+++ b/os/lib/include/chpipes.h
@@ -21,7 +21,7 @@
  * @file    chpipes.h
  * @brief   Pipes macros and structures.
  *
- * @addtogroup pipes
+ * @addtogroup oslib_pipes
  * @{
  */
 
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.

  *          <h2>Operation mode</h2>

  *          A mailbox is an asynchronous communication mechanism.<br>

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.

  *          <h2>Operation mode</h2>

  *          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.<br>

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.

  *          <h2>Operation mode</h2>

  *          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.

  *          <h2>Operation mode</h2>

  *          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.

  *          <h2>Operation mode</h2>

  *          A pipe is an asynchronous communication mechanism.<br>

@@ -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

  * @{

  */