]> git.itanic.dy.fi Git - linux-stable/commitdiff
watchdog: mlx_wdt: fix all kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 18 Dec 2023 06:26:59 +0000 (22:26 -0800)
committerWim Van Sebroeck <wim@linux-watchdog.org>
Sun, 24 Dec 2023 09:44:40 +0000 (10:44 +0100)
Correct kernel-doc warnings as reported by kernel test robot:

mlx_wdt.c:56: warning: Function parameter or member 'wdt_type' not described in 'mlxreg_wdt'
mlx_wdt.c:56: warning: Excess struct member 'device' description in 'mlxreg_wdt'
mlx_wdt.c:56: warning: Excess struct member 'timeout' description in 'mlxreg_wdt'
mlx_wdt.c:56: warning: Excess struct member 'wd_type' description in 'mlxreg_wdt'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202312171701.xNkzdgdi-lkp@intel.com/
Cc: Michael Shych <michaelsh@nvidia.com>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: linux-watchdog@vger.kernel.org
Reviewed-by: Guenter Roeck <linux@roeck-us.net>
Link: https://lore.kernel.org/r/20231218062659.26916-1-rdunlap@infradead.org
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@linux-watchdog.org>
drivers/watchdog/mlx_wdt.c

index 667e2c5b3431c7f758215a16338e59e4ba7327e5..5dc69363f06ae06a77130e9f893912e91635f2ae 100644 (file)
  * struct mlxreg_wdt - wd private data:
  *
  * @wdd:       watchdog device;
- * @device:    basic device;
  * @pdata:     data received from platform driver;
  * @regmap:    register map of parent device;
- * @timeout:   defined timeout in sec.;
  * @action_idx:        index for direct access to action register;
  * @timeout_idx:index for direct access to TO register;
  * @tleft_idx: index for direct access to time left register;
  * @ping_idx:  index for direct access to ping register;
  * @reset_idx: index for direct access to reset cause register;
  * @regmap_val_sz: size of value in register map;
- * @wd_type:   watchdog HW type;
+ * @wdt_type:  watchdog HW type;
  */
 struct mlxreg_wdt {
        struct watchdog_device wdd;