aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/lib/streams/chprintf.c
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2019-01-21 18:07:03 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2019-01-21 18:07:03 +0000
commit40f162e046764db29cd97ea0b9a37a7fb63b360d (patch)
tree19c8b40f2932742d75b941b17070a6e44191812c /os/hal/lib/streams/chprintf.c
parentac1e9f31ced461e6a999e71eb1bc50965e1a1597 (diff)
downloadChibiOS-40f162e046764db29cd97ea0b9a37a7fb63b360d.tar.gz
ChibiOS-40f162e046764db29cd97ea0b9a37a7fb63b360d.tar.bz2
ChibiOS-40f162e046764db29cd97ea0b9a37a7fb63b360d.zip
Documentation-related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12568 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/hal/lib/streams/chprintf.c')
-rw-r--r--os/hal/lib/streams/chprintf.c3
1 files changed, 3 insertions, 0 deletions
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