Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Message-ID: <ec5cc9e3-88d4-cc54-0490-7da87b65193b@infradead.org>
Date:   Wed, 9 Feb 2022 08:51:33 -0800
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.5.1
Subject: Re: [PATCH] watchdog: Improve watchdog_dev function documentation
Content-Language: en-US
To:     Daniel Bristot de Oliveira <bristot@kernel.org>,
        Wim Van Sebroeck <wim@linux-watchdog.org>,
        Guenter Roeck <linux@roeck-us.net>
Cc:     linux-watchdog@vger.kernel.org, linux-kernel@vger.kernel.org
References: <274cc9a2b34c7ffd042170fe2f8a5e55e22766b8.1644396833.git.bristot@redhat.com>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <274cc9a2b34c7ffd042170fe2f8a5e55e22766b8.1644396833.git.bristot@redhat.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

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@linux-watchdog.org>
> Cc: Guenter Roeck <linux@roeck-us.net>
> Cc: linux-watchdog@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org>
> ---
>  drivers/watchdog/watchdog_dev.c | 244 ++++++++++++++++----------------
>  1 file changed, 125 insertions(+), 119 deletions(-)
> 

thanks.
-- 
~Randy