Re: [PATCH] watchdog: Improve watchdog_dev function documentation

[Randy Dunlap]

Hi Daniel,

On 2/9/22 01:08, Daniel Bristot de Oliveira wrote:
> Adjust function comments to the kernel doc format. It
> also adjusts some variable names and adds return values.
> 
> No functional change.

After applying the patch, I still see 3 warnings:

watchdog_dev.c:1127: warning: No description found for return value of 'watchdog_dev_register'
watchdog_dev.c:1169: warning: No description found for return value of 'watchdog_set_last_hw_keepalive'
watchdog_dev.c:1197: warning: No description found for return value of 'watchdog_dev_init'


Ah, I see. The format for function Return in kernel-doc is:

 * Return: func return info here

> Cc: Wim Van Sebroeck <wim@xxxxxxxxxxxxxxxxxx>
> Cc: Guenter Roeck <linux@xxxxxxxxxxxx>
> Cc: linux-watchdog@xxxxxxxxxxxxxxx
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> Signed-off-by: Daniel Bristot de Oliveira <bristot@xxxxxxxxxx>
> ---
>  drivers/watchdog/watchdog_dev.c | 244 ++++++++++++++++----------------
>  1 file changed, 125 insertions(+), 119 deletions(-)
> 

thanks.
-- 
~Randy