2024-02-06 09:39:23

by Yang Li

Subject: [PATCH -next] 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 <[email protected]>
---
drivers/watchdog/it87_wdt.c | 4 ++++
1 file changed, 4 insertions(+)

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)
--
2.20.1.7.g153144c

2024-02-06 15:38:41

by Guenter Roeck

Subject: Re: [PATCH -next] watchdog: Add kernel-doc for wdt_set_timeout()

On 2/6/24 01:38, Yang Li wrote:
> 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 <[email protected]>

Reviewed-by: Guenter Roeck <[email protected]>

> ---
> drivers/watchdog/it87_wdt.c | 4 ++++
> 1 file changed, 4 insertions(+)
>
> 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)