On 7/21/23 10:00, Andy Shevchenko wrote:
> The `scripts/kernel-doc -v -none -Wall` reports several issues
> with the kernel doc in IIO core C file. Update the comments
> accordingly.
>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
> Reviewed-by: Nuno Sa <nuno.sa@xxxxxxxxxx>
> ---
> drivers/iio/industrialio-core.c | 57 +++++++++++++++++++++------------
> 1 file changed, 37 insertions(+), 20 deletions(-)
>
> diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
> index 66cea23df7e0..a9b9804097ab 100644
> --- a/drivers/iio/industrialio-core.c
> +++ b/drivers/iio/industrialio-core.c
> @@ -594,7 +608,7 @@ EXPORT_SYMBOL_GPL(iio_show_mount_matrix);
> * If device is assigned no mounting matrix property, a default 3x3 identity
> * matrix will be filled in.
> *
> - * Return: 0 if success, or a negative error code on failure.
> + * Returns: 0 if success, or a negative error code on failure.
> */
> int iio_read_mount_matrix(struct device *dev, struct iio_mount_matrix *matrix)
> {
> @@ -1750,7 +1767,7 @@ static int iio_chrdev_open(struct inode *inode, struct file *filp)
> * @inode: Inode structure pointer for the char device
> * @filp: File structure pointer for the char device
> *
> - * Return: 0 for successful release
> + * Returns: 0 for successful release.
> */
As documented in Documentation/doc-guide/kernel-doc.rst:
The return value, if any, should be described in a dedicated section
named ``Return``.
However, as you (and I) have found, "Returns:" also works as a section name.
Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Thanks.
--
~Randy
