Commit 8e563b0d authored by Cristina Opriceana's avatar Cristina Opriceana Committed by Jonathan Cameron

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: default avatarCristina Opriceana <cristina.opriceana@gmail.com>
Signed-off-by: default avatarJonathan Cameron <jic23@kernel.org>
parent 655665d6
...@@ -40,7 +40,14 @@ static DEFINE_MUTEX(iio_trigger_list_lock); ...@@ -40,7 +40,14 @@ static DEFINE_MUTEX(iio_trigger_list_lock);
/** /**
* iio_trigger_read_name() - retrieve useful identifying name * iio_trigger_read_name() - retrieve useful identifying name
**/ * @dev: device associated with the iio_trigger
* @attr: pointer to the device_attribute structure that is
* being processed
* @buf: buffer to print the name into
*
* Return: a negative number on failure or the number of written
* characters on success.
*/
static ssize_t iio_trigger_read_name(struct device *dev, static ssize_t iio_trigger_read_name(struct device *dev,
struct device_attribute *attr, struct device_attribute *attr,
char *buf) char *buf)
...@@ -288,10 +295,17 @@ EXPORT_SYMBOL_GPL(iio_dealloc_pollfunc); ...@@ -288,10 +295,17 @@ EXPORT_SYMBOL_GPL(iio_dealloc_pollfunc);
/** /**
* iio_trigger_read_current() - trigger consumer sysfs query current trigger * iio_trigger_read_current() - trigger consumer sysfs query current trigger
* @dev: device associated with an industrial I/O device
* @attr: pointer to the device_attribute structure that
* is being processed
* @buf: buffer where the current trigger name will be printed into
* *
* For trigger consumers the current_trigger interface allows the trigger * For trigger consumers the current_trigger interface allows the trigger
* used by the device to be queried. * used by the device to be queried.
**/ *
* Return: a negative number on failure, the number of characters written
* on success or 0 if no trigger is available
*/
static ssize_t iio_trigger_read_current(struct device *dev, static ssize_t iio_trigger_read_current(struct device *dev,
struct device_attribute *attr, struct device_attribute *attr,
char *buf) char *buf)
...@@ -305,11 +319,18 @@ static ssize_t iio_trigger_read_current(struct device *dev, ...@@ -305,11 +319,18 @@ static ssize_t iio_trigger_read_current(struct device *dev,
/** /**
* iio_trigger_write_current() - trigger consumer sysfs set current trigger * iio_trigger_write_current() - trigger consumer sysfs set current trigger
* @dev: device associated with an industrial I/O device
* @attr: device attribute that is being processed
* @buf: string buffer that holds the name of the trigger
* @len: length of the trigger name held by buf
* *
* For trigger consumers the current_trigger interface allows the trigger * For trigger consumers the current_trigger interface allows the trigger
* used for this device to be specified at run time based on the trigger's * used for this device to be specified at run time based on the trigger's
* name. * name.
**/ *
* Return: negative error code on failure or length of the buffer
* on success
*/
static ssize_t iio_trigger_write_current(struct device *dev, static ssize_t iio_trigger_write_current(struct device *dev,
struct device_attribute *attr, struct device_attribute *attr,
const char *buf, const char *buf,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment