From 40f162e046764db29cd97ea0b9a37a7fb63b360d Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Mon, 21 Jan 2019 18:07:03 +0000 Subject: Documentation-related fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12568 110e8d01-0319-4d1e-a829-52ad28d1bb01 --- os/hal/lib/complex/serial_nor/hal_serial_nor.c | 1 + os/hal/lib/complex/serial_nor/hal_serial_nor.h | 2 +- os/hal/lib/streams/chprintf.c | 3 +++ 3 files changed, 5 insertions(+), 1 deletion(-) (limited to 'os/hal/lib') 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 -- cgit v1.2.3