[PATCH v2] iio: fix kernel-doc warnings in industrialio-backend.c

KRIISHSHARMA
2025-10-27T09:22:30Z

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