lib: cbprintf: fix documentation errors
A prototype missed the condition for its availability; another
documented arguments that are not present.
Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
diff --git a/include/sys/cbprintf.h b/include/sys/cbprintf.h
index e32c88f..0d29ab7 100644
--- a/include/sys/cbprintf.h
+++ b/include/sys/cbprintf.h
@@ -98,6 +98,9 @@
/** @brief snprintf using Zephyrs cbprintf infrastructure.
*
+ * @note This function is available only when `CONFIG_CBPRINTF_LIBC_SUBSTS` is
+ * selected.
+ *
* @note The functionality of this function is significantly reduced
* when `CONFIG_CBPRINTF_NANO` is selected.
*
@@ -112,7 +115,7 @@
* @param ... arguments corresponding to the conversion specifications found
* within @p format.
*
- * return The number of characters that would have been written to @p
+ * @return The number of characters that would have been written to @p
* str, excluding the terminating null byte. This is greater than the
* number actually written if @p size is too small.
*/
@@ -135,12 +138,9 @@
* @param format a standard ISO C format string with characters and conversion
* specifications.
*
- * @param ... arguments corresponding to the conversion specifications found
- * within @p format.
- *
* @param ap a reference to the values to be converted.
*
- * return The number of characters that would have been written to @p
+ * @return The number of characters that would have been written to @p
* str, excluding the terminating null byte. This is greater than the
* number actually written if @p size is too small.
*/
