From 027131e086ec7d8f5f6f4de941d3d0a3cc0d1ea4 Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Tue, 20 Dec 2022 14:22:45 +0000 Subject: [PATCH] Version numbers, documentation fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@15898 27425a3e-05d8-49a3-a47f-9c15f0e5edd8 --- doc/build/hal/Doxyfile_chm | 2 +- doc/build/hal/Doxyfile_html | 3 ++- os/hal/dox/hal_buffererd_sio.dox | 25 +++++++++++++++++++++++++ os/hal/include/hal_sio.h | 4 +--- 4 files changed, 29 insertions(+), 5 deletions(-) create mode 100644 os/hal/dox/hal_buffererd_sio.dox diff --git a/doc/build/hal/Doxyfile_chm b/doc/build/hal/Doxyfile_chm index d8e802ce2..b43a79446 100644 --- a/doc/build/hal/Doxyfile_chm +++ b/doc/build/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 = 8.0.0 +PROJECT_NUMBER = 8.4.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/build/hal/Doxyfile_html b/doc/build/hal/Doxyfile_html index 9ca6fbdd9..1901044f2 100644 --- a/doc/build/hal/Doxyfile_html +++ b/doc/build/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 = 8.0.0 +PROJECT_NUMBER = 8.4.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 @@ -857,6 +857,7 @@ INPUT = ./src \ ../../../os/hal/src \ ../../../os/hal/include \ ../../../os/hal/lib/streams \ + ../../../os/hal/lib/complex/buffered_sio \ ../../../os/hal/lib/complex/mfs \ ../../../os/hal/lib/complex/serial_nor \ ../../../os/hal/templates \ diff --git a/os/hal/dox/hal_buffererd_sio.dox b/os/hal/dox/hal_buffererd_sio.dox new file mode 100644 index 000000000..16a89f6b8 --- /dev/null +++ b/os/hal/dox/hal_buffererd_sio.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_BUFFERED_SIO Buffered SIO Driver + * @brief Buffered SIO Driver. + * @details This module implements circular buffers and events on top + * of a SIO driver. The behavior of the legacy Serial driver + * is emulated. + * + * @ingroup HAL_COMPLEX_DRIVERS + */ diff --git a/os/hal/include/hal_sio.h b/os/hal/include/hal_sio.h index 2333e0dea..5c1d45eb2 100644 --- a/os/hal/include/hal_sio.h +++ b/os/hal/include/hal_sio.h @@ -347,7 +347,7 @@ struct hal_sio_driver { * @brief Clears flags from the enabled events flags mask. * * @param[in] siop pointer to the @p SIODriver object - * @param[in] flags enabled events mask to be cleared + * @param[in] mask enabled events mask to be cleared * * @xclass */ @@ -527,7 +527,6 @@ struct hal_sio_driver { * @brief Wakes up the TX-waiting thread. * * @param[in] siop pointer to the @p SIODriver object - * @param[in] msg the wake up message * * @notapi */ @@ -541,7 +540,6 @@ struct hal_sio_driver { * @brief Wakes up the TXend-waiting thread. * * @param[in] siop pointer to the @p SIODriver object - * @param[in] msg the wake up message * * @notapi */