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

iio: core: Add function params for kernel docs

This patch adds the missing fields in kernel docs to remove
some warnings that appear when the IIO Documentation DocBook
is generated.

Signed-off-by: Cristina Opriceana <cristina.opriceana@gmail.com>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>

authored by

Cristina Opriceana and committed by
Jonathan Cameron
2498dcf6 5ab744d0

+20 -5
+20 -5
drivers/iio/industrialio-core.c
··· 406 406 407 407 /** 408 408 * iio_format_value() - Formats a IIO value into its string representation 409 - * @buf: The buffer to which the formated value gets written 410 - * @type: One of the IIO_VAL_... constants. This decides how the val and val2 411 - * parameters are formatted. 412 - * @vals: pointer to the values, exact meaning depends on the type parameter. 409 + * @buf: The buffer to which the formatted value gets written 410 + * @type: One of the IIO_VAL_... constants. This decides how the val 411 + * and val2 parameters are formatted. 412 + * @size: Number of IIO value entries contained in vals 413 + * @vals: Pointer to the values, exact meaning depends on the 414 + * type parameter. 415 + * 416 + * Return: 0 by default, a negative number on failure or the 417 + * total number of characters written for a type that belongs 418 + * to the IIO_VAL_... constant. 413 419 */ 414 420 ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals) 415 421 { ··· 1102 1096 1103 1097 /** 1104 1098 * iio_chrdev_open() - chrdev file open for buffer access and ioctls 1099 + * @inode: Inode structure for identifying the device in the file system 1100 + * @filp: File structure for iio device used to keep and later access 1101 + * private data 1102 + * 1103 + * Return: 0 on success or -EBUSY if the device is already opened 1105 1104 **/ 1106 1105 static int iio_chrdev_open(struct inode *inode, struct file *filp) 1107 1106 { ··· 1125 1114 1126 1115 /** 1127 1116 * iio_chrdev_release() - chrdev file close buffer access and ioctls 1128 - **/ 1117 + * @inode: Inode structure pointer for the char device 1118 + * @filp: File structure pointer for the char device 1119 + * 1120 + * Return: 0 for successful release 1121 + */ 1129 1122 static int iio_chrdev_release(struct inode *inode, struct file *filp) 1130 1123 { 1131 1124 struct iio_dev *indio_dev = container_of(inode->i_cdev,