Skip to content

Commit d2f656d

Browse files
Yang LiWim Van Sebroeck
authored andcommitted
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>
1 parent b568b15 commit d2f656d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

drivers/watchdog/it87_wdt.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,12 +213,16 @@ static int wdt_stop(struct watchdog_device *wdd)
213213

214214
/**
215215
* wdt_set_timeout - set a new timeout value with watchdog ioctl
216+
* @wdd: pointer to the watchdog_device structure
216217
* @t: timeout value in seconds
217218
*
218219
* The hardware device has a 8 or 16 bit watchdog timer (depends on
219220
* chip version) that can be configured to count seconds or minutes.
220221
*
221222
* Used within WDIOC_SETTIMEOUT watchdog device ioctl.
223+
*
224+
* Return: 0 if the timeout was set successfully, or a negative error code on
225+
* failure.
222226
*/
223227

224228
static int wdt_set_timeout(struct watchdog_device *wdd, unsigned int t)

0 commit comments

Comments
 (0)