From 75724bf2992143f21eadf3b00b1d99e6860512b0 Mon Sep 17 00:00:00 2001 From: Alexander Wachter Date: Wed, 19 Feb 2020 18:37:50 +0100 Subject: [PATCH] doc: hwinfo: Clarify return values. Change the doxygen doc from "negative on error" to -ENOSUP and negative value on driver specific errors. Signed-off-by: Alexander Wachter --- include/drivers/hwinfo.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/include/drivers/hwinfo.h b/include/drivers/hwinfo.h index 97238ce7971..fde8f220cb2 100644 --- a/include/drivers/hwinfo.h +++ b/include/drivers/hwinfo.h @@ -39,7 +39,9 @@ extern "C" { * @param buffer Buffer to write the ID to. * @param length Max length of the buffer. * - * @retval size of the device ID copied or negative on error. + * @retval size of the device ID copied. + * @retval -ENOTSUP if there is no implementation for the particular device. + * @retval any negative value on driver specific errors. */ __syscall ssize_t hwinfo_get_device_id(u8_t *buffer, size_t length);