linux-iio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: KRIISHSHARMA <kriish.sharma2006@gmail.com>
To: nuno.sa@analog.com, olivier.moysan@foss.st.com, jic23@kernel.org,
	dlechner@baylibre.com, andy@kernel.org
Cc: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
	Kriish Sharma <kriish.sharma2006@gmail.com>,
	kernel test robot <lkp@intel.com>
Subject: [PATCH v2] iio: fix kernel-doc warnings in industrialio-backend.c
Date: Mon, 27 Oct 2025 09:21:59 +0000	[thread overview]
Message-ID: <20251027092159.918445-1-kriish.sharma2006@gmail.com> (raw)

From: Kriish Sharma <kriish.sharma2006@gmail.com>

Fix multiple kernel-doc warnings in drivers/iio/industrialio-backend.c,
including a missing description for the @chan parameter in
iio_backend_oversampling_ratio_set() and a missing return value
description in iio_backend_get_priv().

This addresses the warnings reported by kernel-doc and the kernel test
robot.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202506292344.HLJbrrgR-lkp@intel.com
Suggested-by: Andy Shevchenko <andy@kernel.org>
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
---

v2:
- Fixed another kernel-doc warning.

v1: https://lore.kernel.org/all/20251025102008.253566-1-kriish.sharma2006@gmail.com

 drivers/iio/industrialio-backend.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/iio/industrialio-backend.c b/drivers/iio/industrialio-backend.c
index 23760652a046..73704cc1bd03 100644
--- a/drivers/iio/industrialio-backend.c
+++ b/drivers/iio/industrialio-backend.c
@@ -717,6 +717,7 @@ EXPORT_SYMBOL_NS_GPL(iio_backend_data_size_set, "IIO_BACKEND");
 /**
  * iio_backend_oversampling_ratio_set - set the oversampling ratio
  * @back: Backend device
+ * @chan: Channel number
  * @ratio: The oversampling ratio - value 1 corresponds to no oversampling.
  *
  * Return:
@@ -1064,6 +1065,9 @@ EXPORT_SYMBOL_NS_GPL(__devm_iio_backend_get_from_fwnode_lookup, "IIO_BACKEND");
 /**
  * iio_backend_get_priv - Get driver private data
  * @back: Backend device
+ *
+ * RETURNS:
+ * Pointer to the driver private data associated with the backend.
  */
 void *iio_backend_get_priv(const struct iio_backend *back)
 {
-- 
2.34.1


             reply	other threads:[~2025-10-27  9:22 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-27  9:21 KRIISHSHARMA [this message]
2025-10-27  9:46 ` [PATCH v2] iio: fix kernel-doc warnings in industrialio-backend.c Andy Shevchenko
2025-10-27 15:35 ` David Lechner
2025-10-28  9:09   ` Andy Shevchenko
2025-10-28  9:36     ` Kriish Sharma

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=20251027092159.918445-1-kriish.sharma2006@gmail.com \
    --to=kriish.sharma2006@gmail.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=lkp@intel.com \
    --cc=nuno.sa@analog.com \
    --cc=olivier.moysan@foss.st.com \
    /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).