watchdog: fix syntactic kernel-doc issues
authorLukas Bulwahn <lukas.bulwahn@gmail.com>
Mon, 22 Mar 2021 06:53:37 +0000 (07:53 +0100)
committerWim Van Sebroeck <wim@linux-watchdog.org>
Mon, 21 Jun 2021 06:49:09 +0000 (08:49 +0200)
commit4700df05d3848c8ceb92662792d45d938e533f5a
tree8195e43c79ea3f43627503dd1f9e8d02dba59a6d
parentfdc46a1485853e6d275b1ce68eb44986fa96480d
watchdog: fix syntactic kernel-doc issues

The command 'find drivers/watchdog | xargs ./scripts/kernel-doc -none'
reports a number of kernel-doc warnings in the watchdog subsystem.

Address the kernel-doc warnings that were purely syntactic issues with
kernel-doc comments.

The remaining kernel-doc warnings are of type "Excess function parameter"
and "Function parameter or member not described". These warnings would
need to be addressed in a second pass with a bit more insight into the
APIs and purpose of the functions in the watchdog subsystem.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Reviewed-by: Guenter Roeck <linux@roeck-us.net>
Link: https://lore.kernel.org/r/20210322065337.617-1-lukas.bulwahn@gmail.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@linux-watchdog.org>
drivers/watchdog/booke_wdt.c
drivers/watchdog/eurotechwdt.c
drivers/watchdog/mei_wdt.c
drivers/watchdog/octeon-wdt-main.c
drivers/watchdog/pc87413_wdt.c
drivers/watchdog/wdt.c
drivers/watchdog/wdt_pci.c