watchdog: Add kernel-doc for wdt_set_timeout()

The wdt_set_timeout function lacked a complete kernel-doc
description. This patch adds missing parameter and return
value descriptions in accordance with kernel-doc standards.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Reviewed-by: Guenter Roeck <linux@roeckus.net>
Link: https://lore.kernel.org/r/20240206093857.62444-1-yang.lee@linux.alibaba.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@linux-watchdog.org>

diff --git a/drivers/watchdog/it87_wdt.c b/drivers/watchdog/it87_wdt.c
index 9297a5891912748562f49921a7ff7dd925550304..3e8c15138eddadf5ff880788bad8dd1ebc3e483a 100644 (file)
--- a/drivers/watchdog/it87_wdt.c
+++ b/drivers/watchdog/it87_wdt.c
@@ -213,12 +213,16 @@ static int wdt_stop(struct watchdog_device *wdd)
 
 /**
  *     wdt_set_timeout - set a new timeout value with watchdog ioctl
+ *     @wdd: pointer to the watchdog_device structure
  *     @t: timeout value in seconds
  *
  *     The hardware device has a 8 or 16 bit watchdog timer (depends on
  *     chip version) that can be configured to count seconds or minutes.
  *
  *     Used within WDIOC_SETTIMEOUT watchdog device ioctl.
+ *
+ *     Return: 0 if the timeout was set successfully, or a negative error code on
+ *     failure.
  */
 
 static int wdt_set_timeout(struct watchdog_device *wdd, unsigned int t)