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

iio: trigger: Add missing fields in kernel docs

Fix kernel docs warnings by adding the missing description
for each of the existing function parameters.

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
8e563b0d 655665d6

+24 -3
+24 -3
drivers/iio/industrialio-trigger.c
··· 40 40 41 41 /** 42 42 * iio_trigger_read_name() - retrieve useful identifying name 43 - **/ 43 + * @dev: device associated with the iio_trigger 44 + * @attr: pointer to the device_attribute structure that is 45 + * being processed 46 + * @buf: buffer to print the name into 47 + * 48 + * Return: a negative number on failure or the number of written 49 + * characters on success. 50 + */ 44 51 static ssize_t iio_trigger_read_name(struct device *dev, 45 52 struct device_attribute *attr, 46 53 char *buf) ··· 295 288 296 289 /** 297 290 * iio_trigger_read_current() - trigger consumer sysfs query current trigger 291 + * @dev: device associated with an industrial I/O device 292 + * @attr: pointer to the device_attribute structure that 293 + * is being processed 294 + * @buf: buffer where the current trigger name will be printed into 298 295 * 299 296 * For trigger consumers the current_trigger interface allows the trigger 300 297 * used by the device to be queried. 301 - **/ 298 + * 299 + * Return: a negative number on failure, the number of characters written 300 + * on success or 0 if no trigger is available 301 + */ 302 302 static ssize_t iio_trigger_read_current(struct device *dev, 303 303 struct device_attribute *attr, 304 304 char *buf) ··· 319 305 320 306 /** 321 307 * iio_trigger_write_current() - trigger consumer sysfs set current trigger 308 + * @dev: device associated with an industrial I/O device 309 + * @attr: device attribute that is being processed 310 + * @buf: string buffer that holds the name of the trigger 311 + * @len: length of the trigger name held by buf 322 312 * 323 313 * For trigger consumers the current_trigger interface allows the trigger 324 314 * used for this device to be specified at run time based on the trigger's 325 315 * name. 326 - **/ 316 + * 317 + * Return: negative error code on failure or length of the buffer 318 + * on success 319 + */ 327 320 static ssize_t iio_trigger_write_current(struct device *dev, 328 321 struct device_attribute *attr, 329 322 const char *buf,