[PATCH v3] iio: backend: fix kernel-doc to avoid warnings and ensure consistency

[PATCH v3] iio: backend: fix kernel-doc to avoid warnings and ensure consistency

[Kriish Sharma]

Fix multiple kernel-doc warnings and make the documentation style
consistent in drivers/iio/industrialio-backend.c.

Changes include:
 - Add missing @chan parameter description in
   iio_backend_oversampling_ratio_set().
 - Add missing RETURNS section in iio_backend_get_priv().
 - Replace Return: with “RETURNS:” across the file for consistency.

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>
Suggested-by: David Lechner <dlechner@baylibre.com>
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
---
v3:
 - Changed Return: to RETURNS: for consistency across the file as
   suggested by David

v2: https://lore.kernel.org/all/20251027092159.918445-1-kriish.sharma2006@gmail.com

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

 drivers/iio/industrialio-backend.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/drivers/iio/industrialio-backend.c b/drivers/iio/industrialio-backend.c
index 23760652a046..447b694d6d5f 100644
--- a/drivers/iio/industrialio-backend.c
+++ b/drivers/iio/industrialio-backend.c
@@ -702,7 +702,7 @@ EXPORT_SYMBOL_NS_GPL(iio_backend_interface_type_get, "IIO_BACKEND");
  * interface/data bus. Hence, the backend device needs to be aware of it so
  * data can be correctly transferred.
  *
- * Return:
+ * RETURNS:
  * 0 on success, negative error number on failure.
  */
 int iio_backend_data_size_set(struct iio_backend *back, unsigned int size)
@@ -717,9 +717,10 @@ 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:
+ * RETURNS:
  * 0 on success, negative error number on failure.
  */
 int iio_backend_oversampling_ratio_set(struct iio_backend *back,
@@ -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

Re: [PATCH v3] iio: backend: fix kernel-doc to avoid warnings and ensure consistency

[Andy Shevchenko]

On Tue, Oct 28, 2025 at 09:33:26AM +0000, Kriish Sharma wrote:
> Fix multiple kernel-doc warnings and make the documentation style
> consistent in drivers/iio/industrialio-backend.c.
> 
> Changes include:
>  - Add missing @chan parameter description in
>    iio_backend_oversampling_ratio_set().
>  - Add missing RETURNS section in iio_backend_get_priv().
>  - Replace Return: with “RETURNS:” across the file for consistency.

Reviewed-by: Andy Shevchenko <andy@kernel.org>

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v3] iio: backend: fix kernel-doc to avoid warnings and ensure consistency

[Nuno Sá]

On Tue, 2025-10-28 at 09:33 +0000, Kriish Sharma wrote:
> Fix multiple kernel-doc warnings and make the documentation style
> consistent in drivers/iio/industrialio-backend.c.
> 
> Changes include:
>  - Add missing @chan parameter description in
>    iio_backend_oversampling_ratio_set().
>  - Add missing RETURNS section in iio_backend_get_priv().
>  - Replace Return: with “RETURNS:” across the file for consistency.
> 
> 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>
> Suggested-by: David Lechner <dlechner@baylibre.com>
> Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
> ---

Thanks for this!

Reviewed-by: Nuno Sá <nuno.sa@analog.com>

> v3:
>  - Changed Return: to RETURNS: for consistency across the file as
>    suggested by David
> 
> v2:
> https://lore.kernel.org/all/20251027092159.918445-1-kriish.sharma2006@gmail.com
> 
> v1:
> https://lore.kernel.org/all/20251025102008.253566-1-kriish.sharma2006@gmail.com
> 
>  drivers/iio/industrialio-backend.c | 8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/iio/industrialio-backend.c b/drivers/iio/industrialio-
> backend.c
> index 23760652a046..447b694d6d5f 100644
> --- a/drivers/iio/industrialio-backend.c
> +++ b/drivers/iio/industrialio-backend.c
> @@ -702,7 +702,7 @@ EXPORT_SYMBOL_NS_GPL(iio_backend_interface_type_get,
> "IIO_BACKEND");
>   * interface/data bus. Hence, the backend device needs to be aware of it so
>   * data can be correctly transferred.
>   *
> - * Return:
> + * RETURNS:
>   * 0 on success, negative error number on failure.
>   */
>  int iio_backend_data_size_set(struct iio_backend *back, unsigned int size)
> @@ -717,9 +717,10 @@ 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:
> + * RETURNS:
>   * 0 on success, negative error number on failure.
>   */
>  int iio_backend_oversampling_ratio_set(struct iio_backend *back,
> @@ -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)
>  {

Re: [PATCH v3] iio: backend: fix kernel-doc to avoid warnings and ensure consistency

[Jonathan Cameron]

On Tue, 28 Oct 2025 12:12:04 +0200
Andy Shevchenko <andriy.shevchenko@intel.com> wrote:

> On Tue, Oct 28, 2025 at 09:33:26AM +0000, Kriish Sharma wrote:
> > Fix multiple kernel-doc warnings and make the documentation style
> > consistent in drivers/iio/industrialio-backend.c.
> > 
> > Changes include:
> >  - Add missing @chan parameter description in
> >    iio_backend_oversampling_ratio_set().
> >  - Add missing RETURNS section in iio_backend_get_priv().
> >  - Replace Return: with “RETURNS:” across the file for consistency.  
> 
> Reviewed-by: Andy Shevchenko <andy@kernel.org>
> 
Applied.

Thanks,

Jonathan