From 3dc0a9f88c749feee854511ee5911c475a62ee01 Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Sun, 15 Mar 2020 16:42:38 +0000 Subject: [PATCH] Documentation-related fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@13428 27425a3e-05d8-49a3-a47f-9c15f0e5edd8 --- doc/ex/Doxyfile_chm | 2 +- doc/ex/Doxyfile_html | 2 +- doc/full_rm/Doxyfile_html | 2 +- doc/hal-stm32f3/Doxyfile_html | 2 +- doc/hal/Doxyfile_chm | 2 +- doc/hal/Doxyfile_html | 2 +- doc/nil/Doxyfile_chm | 2 +- doc/nil/Doxyfile_html | 2 +- doc/rt/Doxyfile_chm | 2 +- doc/rt/Doxyfile_html | 2 +- os/hal/dox/hal_crypto.dox | 8 +++--- os/hal/dox/hal_dac.dox | 2 +- os/hal/dox/hal_efl.dox | 25 ++++++++++++++++++ os/hal/dox/hal_flash.dox | 4 +-- os/hal/dox/hal_trng.dox | 50 +++++++++++++++++------------------ os/nil/dox/nil.dox | 17 +++++++++++- os/oslib/dox/lib.dox | 15 +++++++++++ 17 files changed, 98 insertions(+), 43 deletions(-) create mode 100644 os/hal/dox/hal_efl.dox diff --git a/doc/ex/Doxyfile_chm b/doc/ex/Doxyfile_chm index 540068508..3bbd686a8 100644 --- a/doc/ex/Doxyfile_chm +++ b/doc/ex/Doxyfile_chm @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/EX # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.1.0 +PROJECT_NUMBER = 1.1.1 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/ex/Doxyfile_html b/doc/ex/Doxyfile_html index c63393ec6..a154f2e1c 100644 --- a/doc/ex/Doxyfile_html +++ b/doc/ex/Doxyfile_html @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/EX # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.1.0 +PROJECT_NUMBER = 1.1.1 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/full_rm/Doxyfile_html b/doc/full_rm/Doxyfile_html index 15d8a3641..94a30e241 100644 --- a/doc/full_rm/Doxyfile_html +++ b/doc/full_rm/Doxyfile_html @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.0.0 +PROJECT_NUMBER = 20.3.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/hal-stm32f3/Doxyfile_html b/doc/hal-stm32f3/Doxyfile_html index 6aaaeff83..39fccdc97 100644 --- a/doc/hal-stm32f3/Doxyfile_html +++ b/doc/hal-stm32f3/Doxyfile_html @@ -38,7 +38,7 @@ PROJECT_NAME = "ChibiOS/HAL for STM32F3xx" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 5.0.0 +PROJECT_NUMBER = 7.1.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/hal/Doxyfile_chm b/doc/hal/Doxyfile_chm index 0c234c916..55c56bc99 100644 --- a/doc/hal/Doxyfile_chm +++ b/doc/hal/Doxyfile_chm @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/HAL # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 7.0.0 +PROJECT_NUMBER = 7.1.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/hal/Doxyfile_html b/doc/hal/Doxyfile_html index 9d4d2a0b9..1398a0577 100644 --- a/doc/hal/Doxyfile_html +++ b/doc/hal/Doxyfile_html @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/HAL # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 7.0.0 +PROJECT_NUMBER = 7.1.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/nil/Doxyfile_chm b/doc/nil/Doxyfile_chm index c86f3fa46..f98e28d9c 100644 --- a/doc/nil/Doxyfile_chm +++ b/doc/nil/Doxyfile_chm @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/NIL # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 3.2.0 +PROJECT_NUMBER = 4.0.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/nil/Doxyfile_html b/doc/nil/Doxyfile_html index b89aa7b8b..5bc94c5c8 100644 --- a/doc/nil/Doxyfile_html +++ b/doc/nil/Doxyfile_html @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/NIL # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 3.2.0 +PROJECT_NUMBER = 4.0.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/rt/Doxyfile_chm b/doc/rt/Doxyfile_chm index cb64798ec..5b93e33cd 100644 --- a/doc/rt/Doxyfile_chm +++ b/doc/rt/Doxyfile_chm @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/RT # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 6.0.0 +PROJECT_NUMBER = 6.1.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/rt/Doxyfile_html b/doc/rt/Doxyfile_html index cc54bf7c8..d8cd7bdc0 100644 --- a/doc/rt/Doxyfile_html +++ b/doc/rt/Doxyfile_html @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/RT # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 6.0.0 +PROJECT_NUMBER = 6.1.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/os/hal/dox/hal_crypto.dox b/os/hal/dox/hal_crypto.dox index a04267123..b9ad2b157 100644 --- a/os/hal/dox/hal_crypto.dox +++ b/os/hal/dox/hal_crypto.dox @@ -15,10 +15,10 @@ */ /** - * @defgroup TRNG TRNG Driver - * @brief Generic True Random Numbers Generator Driver. - * @details This module implements a generic TRNG driver. - * @pre In order to use the TRNG driver the @p HAL_USE_TRNG option + * @defgroup CRYPTO Crypto Driver + * @brief Generic Crypto Driver. + * @details This module implements a generic Cryptography driver. + * @pre In order to use the crypto driver the @p HAL_USE_CRY option * must be enabled in @p halconf.h. * * @ingroup HAL_NORMAL_DRIVERS diff --git a/os/hal/dox/hal_dac.dox b/os/hal/dox/hal_dac.dox index c81f3a0bd..381e201b1 100644 --- a/os/hal/dox/hal_dac.dox +++ b/os/hal/dox/hal_dac.dox @@ -19,7 +19,7 @@ * @brief Generic DAC Driver. * @details This module implements a generic DAC (Digital to Analog Converter) * driver. - * @pre In order to use the MAC driver the @p HAL_USE_DAC option + * @pre In order to use the DAC driver the @p HAL_USE_DAC option * must be enabled in @p halconf.h. * * @ingroup HAL_NORMAL_DRIVERS diff --git a/os/hal/dox/hal_efl.dox b/os/hal/dox/hal_efl.dox new file mode 100644 index 000000000..02d8471a1 --- /dev/null +++ b/os/hal/dox/hal_efl.dox @@ -0,0 +1,25 @@ +/* + ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +/** + * @defgroup HAL_EFL EFL Driver + * @brief Generic Embedded Flash Driver. + * @details This module implements a generic embedded flash driver. + * @pre In order to use the EFL driver the @p HAL_USE_EFL option + * must be enabled in @p halconf.h. + * + * @ingroup HAL_NORMAL_DRIVERS + */ diff --git a/os/hal/dox/hal_flash.dox b/os/hal/dox/hal_flash.dox index 8be3efea8..748894496 100644 --- a/os/hal/dox/hal_flash.dox +++ b/os/hal/dox/hal_flash.dox @@ -15,8 +15,8 @@ */ /** - * @defgroup HAL_FLASH Generic NOR Flash Interface - * @brief HAL Generic NOR Flash Driver Interface. + * @defgroup HAL_FLASH Generic Flash Interface + * @brief HAL Generic Flash Driver Interface. * * @section flash_1 Driver State Machine * The flash driver implements a state machine internally, not all the driver diff --git a/os/hal/dox/hal_trng.dox b/os/hal/dox/hal_trng.dox index b9ad2b157..e28c60629 100644 --- a/os/hal/dox/hal_trng.dox +++ b/os/hal/dox/hal_trng.dox @@ -1,25 +1,25 @@ -/* - ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -*/ - -/** - * @defgroup CRYPTO Crypto Driver - * @brief Generic Crypto Driver. - * @details This module implements a generic Cryptography driver. - * @pre In order to use the crypto driver the @p HAL_USE_CRY option - * must be enabled in @p halconf.h. - * - * @ingroup HAL_NORMAL_DRIVERS - */ +/* + ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +/** + * @defgroup TRNG TRNG Driver + * @brief Generic True Random Numbers Generator Driver. + * @details This module implements a generic TRNG driver. + * @pre In order to use the TRNG driver the @p HAL_USE_TRNG option + * must be enabled in @p halconf.h. + * + * @ingroup HAL_NORMAL_DRIVERS + */ diff --git a/os/nil/dox/nil.dox b/os/nil/dox/nil.dox index f487fa249..9fd3af5ff 100644 --- a/os/nil/dox/nil.dox +++ b/os/nil/dox/nil.dox @@ -34,7 +34,22 @@ */ /** - * @defgroup NIL_KERNEL API + * @defgroup NIL_KERNEL Base API + * @ingroup NIL + */ + +/** + * @defgroup NIL_SEMAPHORES Semaphores + * @ingroup NIL + */ + +/** + * @defgroup NIL_EVENTS Events + * @ingroup NIL + */ + +/** + * @defgroup NIL_MESSAGES Synchronous Messages * @ingroup NIL */ diff --git a/os/oslib/dox/lib.dox b/os/oslib/dox/lib.dox index 4dfcdce58..362a608fe 100644 --- a/os/oslib/dox/lib.dox +++ b/os/oslib/dox/lib.dox @@ -48,6 +48,16 @@ * @ingroup oslib_synchronization */ +/** + * @defgroup oslib_delegates Delegate Threads + * @ingroup oslib_synchronization + */ + +/** + * @defgroup oslib_jobs_queues Jobs Queues + * @ingroup oslib_synchronization + */ + /** * @defgroup oslib_memory Memory Management * @details Memory Management services. @@ -79,6 +89,11 @@ * @ingroup oslib_complex */ +/** + * @defgroup oslib_objchaches Objects Caches + * @ingroup oslib_complex + */ + /** * @defgroup oslib_objects_factory Dynamic Objects Factory * @ingroup oslib_complex