[PATCH 1/1] watchdog: wdat_wdt: Fix missing kerneldoc reported by W=1

[PATCH 1/1] watchdog: wdat_wdt: Fix missing kerneldoc reported by W=1

[vee.khee.wong]

From: Wong Vee Khee <vee.khee.wong@intel.com>

Fix the following warning while compiling with W=1.

drivers/watchdog/wdat_wdt.c:48: warning: Function parameter or member 'instructions' not described in 'wdat_wdt'

Signed-off-by: Wong Vee Khee <vee.khee.wong@intel.com>
---
 drivers/watchdog/wdat_wdt.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/watchdog/wdat_wdt.c b/drivers/watchdog/wdat_wdt.c
index 3065dd670a18..cec7917790e5 100644
--- a/drivers/watchdog/wdat_wdt.c
+++ b/drivers/watchdog/wdat_wdt.c
@@ -34,9 +34,9 @@ struct wdat_instruction {
  * @period: How long is one watchdog period in ms
  * @stopped_in_sleep: Is this watchdog stopped by the firmware in S1-S5
  * @stopped: Was the watchdog stopped by the driver in suspend
- * @actions: An array of instruction lists indexed by an action number from
- *           the WDAT table. There can be %NULL entries for not implemented
- *           actions.
+ * @instructions: An array of instruction lists indexed by an action number from
+ *                the WDAT table. There can be %NULL entries for not implemented
+ *                actions.
  */
 struct wdat_wdt {
 	struct platform_device *pdev;
-- 
2.17.0

Re: [PATCH 1/1] watchdog: wdat_wdt: Fix missing kerneldoc reported by W=1

[Guenter Roeck]

On 11/11/20 9:22 AM, vee.khee.wong@intel.com wrote:
> From: Wong Vee Khee <vee.khee.wong@intel.com>
> 
> Fix the following warning while compiling with W=1.
> 
> drivers/watchdog/wdat_wdt.c:48: warning: Function parameter or member 'instructions' not described in 'wdat_wdt'
> 
> Signed-off-by: Wong Vee Khee <vee.khee.wong@intel.com>

Reviewed-by: Guenter Roeck <linux@roeck-us.net>

> ---
>  drivers/watchdog/wdat_wdt.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/watchdog/wdat_wdt.c b/drivers/watchdog/wdat_wdt.c
> index 3065dd670a18..cec7917790e5 100644
> --- a/drivers/watchdog/wdat_wdt.c
> +++ b/drivers/watchdog/wdat_wdt.c
> @@ -34,9 +34,9 @@ struct wdat_instruction {
>   * @period: How long is one watchdog period in ms
>   * @stopped_in_sleep: Is this watchdog stopped by the firmware in S1-S5
>   * @stopped: Was the watchdog stopped by the driver in suspend
> - * @actions: An array of instruction lists indexed by an action number from
> - *           the WDAT table. There can be %NULL entries for not implemented
> - *           actions.
> + * @instructions: An array of instruction lists indexed by an action number from
> + *                the WDAT table. There can be %NULL entries for not implemented
> + *                actions.
>   */
>  struct wdat_wdt {
>  	struct platform_device *pdev;
>