Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

iio: backend: fix kernel-doc to avoid warnings and ensure consistency

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>
Reviewed-by: Nuno Sá <nuno.sa@analog.com>
Reviewed-by: Andy Shevchenko <andy@kernel.org>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

authored by

Kriish Sharma and committed by
Jonathan Cameron
49708f45 59f40887

+6 -2
+6 -2
drivers/iio/industrialio-backend.c
··· 702 702 * interface/data bus. Hence, the backend device needs to be aware of it so 703 703 * data can be correctly transferred. 704 704 * 705 - * Return: 705 + * RETURNS: 706 706 * 0 on success, negative error number on failure. 707 707 */ 708 708 int iio_backend_data_size_set(struct iio_backend *back, unsigned int size) ··· 717 717 /** 718 718 * iio_backend_oversampling_ratio_set - set the oversampling ratio 719 719 * @back: Backend device 720 + * @chan: Channel number 720 721 * @ratio: The oversampling ratio - value 1 corresponds to no oversampling. 721 722 * 722 - * Return: 723 + * RETURNS: 723 724 * 0 on success, negative error number on failure. 724 725 */ 725 726 int iio_backend_oversampling_ratio_set(struct iio_backend *back, ··· 1065 1064 /** 1066 1065 * iio_backend_get_priv - Get driver private data 1067 1066 * @back: Backend device 1067 + * 1068 + * RETURNS: 1069 + * Pointer to the driver private data associated with the backend. 1068 1070 */ 1069 1071 void *iio_backend_get_priv(const struct iio_backend *back) 1070 1072 {