From: Andy Shevchenko <andriy.shevchenko@intel.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org,
"Jonathan Cameron" <jic23@kernel.org>,
"David Lechner" <dlechner@baylibre.com>,
"Nuno Sá" <nuno.sa@analog.com>,
"Andy Shevchenko" <andy@kernel.org>,
linux-iio@vger.kernel.org
Subject: Re: [PATCH] iio: imu: adis: fix all kernel-doc warnings in header file
Date: Mon, 27 Oct 2025 10:32:59 +0200 [thread overview]
Message-ID: <aP8uOznzM-ixyRLJ@smile.fi.intel.com> (raw)
In-Reply-To: <20251026024759.433956-1-rdunlap@infradead.org>
On Sat, Oct 25, 2025 at 07:47:59PM -0700, Randy Dunlap wrote:
> Correct and add to adis.h to resolve all kernel-doc warnings:
>
> - add a missing struct member description
> - change one non-kernel-doc comment to use /* instead of /**
> - correct function parameter @value to @val (7 locations)
> - add function return value comments (13 locations)
>
> Warning: include/linux/iio/imu/adis.h:97 struct member 'has_fifo'
> not described in 'adis_data'
> Warning: include/linux/iio/imu/adis.h:139 Incorrect use of kernel-doc
> format: * The state_lock is meant to be used during operations that
> require
> Warning: include/linux/iio/imu/adis.h:158 struct member '"__adis_"'
> not described in 'adis'
> Warning: include/linux/iio/imu/adis.h:264 function parameter 'val'
> not described in 'adis_write_reg'
> Warning: include/linux/iio/imu/adis.h:371 No description found for
> return value of 'adis_update_bits_base'
Thanks for fixing all these, Randy!
Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>
--
With Best Regards,
Andy Shevchenko
next prev parent reply other threads:[~2025-10-27 8:33 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-26 2:47 [PATCH] iio: imu: adis: fix all kernel-doc warnings in header file Randy Dunlap
2025-10-27 8:32 ` Andy Shevchenko [this message]
2025-10-27 13:03 ` Nuno Sá
2025-10-27 14:37 ` Jonathan Cameron
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aP8uOznzM-ixyRLJ@smile.fi.intel.com \
--to=andriy.shevchenko@intel.com \
--cc=andy@kernel.org \
--cc=dlechner@baylibre.com \
--cc=jic23@kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nuno.sa@analog.com \
--cc=rdunlap@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox