Documentation-related fixes.

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

6 files changed, 27 insertions, 1 deletions

diff --git a/os/hal/dox/hal_persistent.dox b/os/hal/dox/hal_persistent.dox
new file mode 100644
index 000000000..2be0dc473
--- /dev/null
+++ b/os/hal/dox/hal_persistent.dox
@@ -0,0 +1,20 @@
+/*

+    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/include/hal_sio.h b/os/hal/include/hal_sio.h
index d72d57256..e10efeec4 100644
--- a/os/hal/include/hal_sio.h
+++ b/os/hal/include/hal_sio.h
@@ -132,6 +132,7 @@ typedef enum {
  * @note    If the FIFO is full then the behavior is unpredictable.

  *

  * @param[in] siop      pointer to the @p SIODriver object

+ * @param[in] data      frame to be written

  *

  * @xclass

  */

diff --git a/os/hal/lib/complex/serial_nor/hal_serial_nor.c b/os/hal/lib/complex/serial_nor/hal_serial_nor.c
index 0fd5b7dc1..695b0fd32 100644
--- a/os/hal/lib/complex/serial_nor/hal_serial_nor.c
+++ b/os/hal/lib/complex/serial_nor/hal_serial_nor.c
@@ -123,6 +123,7 @@ void bus_release(BUSDriver *busp) {
  * @brief   Returns a pointer to the device descriptor.

  *

  * @param[in] instance  instance pointer

+ * @return              Pointer to a static descriptor structure.

  */

 static const flash_descriptor_t *snor_get_descriptor(void *instance) {

   SNORDriver *devp = (SNORDriver *)instance;

diff --git a/os/hal/lib/complex/serial_nor/hal_serial_nor.h b/os/hal/lib/complex/serial_nor/hal_serial_nor.h
index f9f7a747f..7531368ca 100644
--- a/os/hal/lib/complex/serial_nor/hal_serial_nor.h
+++ b/os/hal/lib/complex/serial_nor/hal_serial_nor.h
@@ -15,7 +15,7 @@
 */

 

 /**

- * @file    serial_nor.h

+ * @file    hal_serial_nor.h

  * @brief   Serial NOR driver header.

  *

  * @addtogroup HAL_SERIAL_NOR

diff --git a/os/hal/lib/streams/chprintf.c b/os/hal/lib/streams/chprintf.c
index e9c4747e2..f83e5d54f 100644
--- a/os/hal/lib/streams/chprintf.c
+++ b/os/hal/lib/streams/chprintf.c
@@ -296,6 +296,8 @@ unsigned_common:
  *

  * @param[in] chp       pointer to a @p BaseSequentialStream implementing object

  * @param[in] fmt       formatting string

+ * @return              The number of bytes that would have been

+ *                      written to @p chp if no stream error occurs

  *

  * @api

  */

@@ -370,6 +372,7 @@ int chsnprintf(char *str, size_t size, const char *fmt, ...) {
  *

  * @param[in] str       pointer to a buffer

  * @param[in] size      maximum size of the buffer

+ * @param[in] fmt       formatting string

  * @param[in] ap        list of parameters

  * @return              The number of characters (excluding the

  *                      terminating NUL byte) that would have been

diff --git a/os/hal/templates/hal_sio_lld.h b/os/hal/templates/hal_sio_lld.h
index c8affa390..7b4761cbf 100644
--- a/os/hal/templates/hal_sio_lld.h
+++ b/os/hal/templates/hal_sio_lld.h
@@ -171,6 +171,7 @@ struct hal_sio_driver {
  * @note    If the FIFO is full then the behavior is unpredictable.

  *

  * @param[in] siop      pointer to the @p SIODriver object

+ * @param[in] data      frame to be written

  *

  * @notapi

  */