From: Jonathan Cameron <jic23@kernel.org>
To: "Nuno Sá" <noname.nuno@gmail.com>
Cc: "Randy Dunlap" <rdunlap@infradead.org>,
linux-kernel@vger.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 14:37:10 +0000 [thread overview]
Message-ID: <20251027143710.35ca032f@jic23-huawei> (raw)
In-Reply-To: <ff1af8b4d43ce31cbf94623e36b721b057ca4077.camel@gmail.com>
On Mon, 27 Oct 2025 13:03:54 +0000
Nuno Sá <noname.nuno@gmail.com> wrote:
> On Sat, 2025-10-25 at 19:47 -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'
> >
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > ---
>
> Thanks!
>
> Reviewed-by: Nuno Sá <nuno.sa@analog.com>
Applied. Thanks.
Jonathan
prev parent reply other threads:[~2025-10-27 14:37 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
2025-10-27 13:03 ` Nuno Sá
2025-10-27 14:37 ` Jonathan Cameron [this message]
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=20251027143710.35ca032f@jic23-huawei \
--to=jic23@kernel.org \
--cc=andy@kernel.org \
--cc=dlechner@baylibre.com \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=noname.nuno@gmail.com \
--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;
as well as URLs for NNTP newsgroup(s).