diff options
| author |   Yang Li <yang.lee@linux.alibaba.com> | 2024-02-06 17:38:57 +0800 |
|---|---|---|
| committer |   Wim Van Sebroeck <wim@linux-watchdog.org> | 2024-03-03 14:17:27 +0100 |
| commit | d2f656dc4969e765de2db8564c4c38d135d9152b (patch) | |
| tree | 030d128f5ca483b884b524038b1347486f39f4f3 /drivers/watchdog | |
| parent | watchdog: core: Remove usage of the deprecated ida_simple_xx() API (diff) | |
| download | wireguard-linux-d2f656dc4969e765de2db8564c4c38d135d9152b.tar.xz wireguard-linux-d2f656dc4969e765de2db8564c4c38d135d9152b.zip | |
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>
Diffstat (limited to 'drivers/watchdog')
| -rw-r--r-- | drivers/watchdog/it87_wdt.c | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/drivers/watchdog/it87_wdt.c b/drivers/watchdog/it87_wdt.c index 9297a5891912..3e8c15138edd 100644 --- 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) |