Re: [PATCH] watchdog: document watchdog_init_timeout() wdd parameter

From: Guenter Roeck
Date: Thu Dec 14 2017 - 09:30:36 EST


On 12/13/2017 11:41 AM, Corentin Labbe wrote:
All parameters of watchdog_init_timeout() are documented with exception
of wdd, thus generating a build warning.

This patch document it and so remove the following build warning:
drivers/watchdog/watchdog_core.c:113: warning: No description found for parameter 'wdd'

Signed-off-by: Corentin Labbe <clabbe.montjoie@xxxxxxxxx>

Reviewed-by: Guenter Roeck <linux@xxxxxxxxxxxx>

---
drivers/watchdog/watchdog_core.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/watchdog/watchdog_core.c b/drivers/watchdog/watchdog_core.c
index 8a8d952f8df9..eb8fa25f8eb2 100644
--- a/drivers/watchdog/watchdog_core.c
+++ b/drivers/watchdog/watchdog_core.c
@@ -97,6 +97,7 @@ static void watchdog_check_min_max_timeout(struct watchdog_device *wdd)
/**
* watchdog_init_timeout() - initialize the timeout field
+ * @wdd: watchdog device
* @timeout_parm: timeout module parameter
* @dev: Device that stores the timeout-sec property
*