From f55231f5ba91116a7cd634c5905d266d643db8a8 Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Mon, 21 Jan 2019 18:40:05 +0000 Subject: Documentation fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12569 110e8d01-0319-4d1e-a829-52ad28d1bb01 --- os/hal/dox/crypto.dox | 8 +++--- os/hal/dox/hal_channels.dox | 20 --------------- os/hal/dox/hal_files.dox | 20 --------------- os/hal/dox/hal_interfacesdox | 60 +++++++++++++++++++++++++++++++++++++++++++ os/hal/dox/hal_ioblock.dox | 2 +- os/hal/dox/hal_objects.dox | 2 +- os/hal/dox/hal_persistent.dox | 20 --------------- os/hal/dox/hal_streams.dox | 20 --------------- os/hal/dox/main.dox | 2 +- os/hal/lib/streams/chprintf.c | 1 + 10 files changed, 68 insertions(+), 87 deletions(-) delete mode 100644 os/hal/dox/hal_channels.dox delete mode 100644 os/hal/dox/hal_files.dox create mode 100644 os/hal/dox/hal_interfacesdox delete mode 100644 os/hal/dox/hal_persistent.dox delete mode 100644 os/hal/dox/hal_streams.dox diff --git a/os/hal/dox/crypto.dox b/os/hal/dox/crypto.dox index 9f2ad850c..a04267123 100644 --- a/os/hal/dox/crypto.dox +++ b/os/hal/dox/crypto.dox @@ -15,10 +15,10 @@ */ /** - * @defgroup CRYPTO Crypto Driver - * @brief Generic Crypto Driver. - * @details This module implements a generic Cryptography driver. - * @pre In order to use the I2C driver the @p HAL_USE_CRY option + * @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/hal/dox/hal_channels.dox b/os/hal/dox/hal_channels.dox deleted file mode 100644 index 9b9503def..000000000 --- a/os/hal/dox/hal_channels.dox +++ /dev/null @@ -1,20 +0,0 @@ -/* - 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 IO_CHANNEL Abstract I/O Channel - * @ingroup HAL_INTERFACES - */ diff --git a/os/hal/dox/hal_files.dox b/os/hal/dox/hal_files.dox deleted file mode 100644 index b71136163..000000000 --- a/os/hal/dox/hal_files.dox +++ /dev/null @@ -1,20 +0,0 @@ -/* - 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_FILES Abstract Files - * @ingroup HAL_INTERFACES - */ diff --git a/os/hal/dox/hal_interfacesdox b/os/hal/dox/hal_interfacesdox new file mode 100644 index 000000000..c27305ad8 --- /dev/null +++ b/os/hal/dox/hal_interfacesdox @@ -0,0 +1,60 @@ +/* + 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_BLOCKS Blocks + * @ingroup HAL_INTERFACES_CLASSES + */ + +/** + * @defgroup HAL_INTERFACES Streams + * @ingroup HAL_INTERFACES_CLASSES + */ + +/** + * @defgroup HAL_STREAMS Abstract Streams Interface + * @ingroup HAL_INTERFACES + */ + +/** + * @defgroup IO_CHANNEL Abstract I/O Channel Interface + * @ingroup HAL_INTERFACES + */ + +/** + * @defgroup HAL_FILES Abstract Files Interface + * @ingroup HAL_INTERFACES + */ + +/** + * @defgroup HAL_PERSISTENT Abstract Persistent Storage Interface + * @ingroup HAL_INTERFACES + */ + +/** + * @defgroup HAL_MEMORY_STREAMS Memory Streams Class + * @ingroup HAL_INTERFACES + */ + +/** + * @defgroup HAL_NULL_STREAMS Null Streams Class + * @ingroup HAL_INTERFACES + */ + +/** + * @defgroup HAL_CHPRINTF Output Formatter Utility + * @ingroup HAL_INTERFACES + */ diff --git a/os/hal/dox/hal_ioblock.dox b/os/hal/dox/hal_ioblock.dox index 2a20e9148..cc839457d 100644 --- a/os/hal/dox/hal_ioblock.dox +++ b/os/hal/dox/hal_ioblock.dox @@ -16,7 +16,7 @@ /** * @defgroup IO_BLOCK Abstract I/O Block Device - * @ingroup HAL_INTERFACES + * @ingroup HAL_BLOCKS * * @section io_block_1 Driver State Machine * The drivers implementing this interface shall implement the following diff --git a/os/hal/dox/hal_objects.dox b/os/hal/dox/hal_objects.dox index 98450801c..140fb3c9f 100644 --- a/os/hal/dox/hal_objects.dox +++ b/os/hal/dox/hal_objects.dox @@ -16,5 +16,5 @@ /** * @defgroup HAL_BASE_OBJECT Base Object - * @ingroup HAL_INTERFACES + * @ingroup HAL_INTERFACES_CLASSES */ diff --git a/os/hal/dox/hal_persistent.dox b/os/hal/dox/hal_persistent.dox deleted file mode 100644 index 2be0dc473..000000000 --- a/os/hal/dox/hal_persistent.dox +++ /dev/null @@ -1,20 +0,0 @@ -/* - 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_PERSISTENT Abstract Persistent Storage - * @ingroup HAL_INTERFACES - */ diff --git a/os/hal/dox/hal_streams.dox b/os/hal/dox/hal_streams.dox deleted file mode 100644 index c21bbbf11..000000000 --- a/os/hal/dox/hal_streams.dox +++ /dev/null @@ -1,20 +0,0 @@ -/* - 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_STREAMS Abstract Streams - * @ingroup HAL_INTERFACES - */ diff --git a/os/hal/dox/main.dox b/os/hal/dox/main.dox index 187e00b25..1c543a3ff 100644 --- a/os/hal/dox/main.dox +++ b/os/hal/dox/main.dox @@ -114,7 +114,7 @@ */ /** - * @defgroup HAL_INTERFACES Interfaces and Classes + * @defgroup HAL_INTERFACES_CLASSES Interfaces and Classes * @brief HAL Interfaces and Classes. * * @ingroup IO diff --git a/os/hal/lib/streams/chprintf.c b/os/hal/lib/streams/chprintf.c index f83e5d54f..93c7b0cd3 100644 --- a/os/hal/lib/streams/chprintf.c +++ b/os/hal/lib/streams/chprintf.c @@ -24,6 +24,7 @@ * @brief Mini printf-like functionality. * * @addtogroup HAL_CHPRINTF + * @details Mini printf-like functionality. * @{ */ -- cgit v1.2.3