Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > linux.kernel > #1201673 > unrolled thread
| Started by | Cristina Opriceana <cristina.opriceana@gmail.com> |
|---|---|
| First post | 2015-08-06 14:00 +0200 |
| Last post | 2015-08-08 13:50 +0200 |
| Articles | 2 — 2 participants |
Back to article view | Back to linux.kernel
[PATCH v2] iio: trigger: Add missing fields in kernel docs Cristina Opriceana <cristina.opriceana@gmail.com> - 2015-08-06 14:00 +0200
Re: [PATCH v2] iio: trigger: Add missing fields in kernel docs Jonathan Cameron <jic23@kernel.org> - 2015-08-08 13:50 +0200
| From | Cristina Opriceana <cristina.opriceana@gmail.com> |
|---|---|
| Date | 2015-08-06 14:00 +0200 |
| Subject | [PATCH v2] iio: trigger: Add missing fields in kernel docs |
| Message-ID | <pUs01-82F-1@gated-at.bofh.it> |
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> --- Changes in v2: - Change @dev description in all functions to illustrate better the connection with IIO devices or IIO trigger. drivers/iio/industrialio-trigger.c | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/drivers/iio/industrialio-trigger.c b/drivers/iio/industrialio-trigger.c index d31098e..570606c 100644 --- a/drivers/iio/industrialio-trigger.c +++ b/drivers/iio/industrialio-trigger.c @@ -40,7 +40,14 @@ static DEFINE_MUTEX(iio_trigger_list_lock); /** * 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, struct device_attribute *attr, char *buf) @@ -288,10 +295,17 @@ EXPORT_SYMBOL_GPL(iio_dealloc_pollfunc); /** * 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 * 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, struct device_attribute *attr, char *buf) @@ -305,11 +319,18 @@ static ssize_t iio_trigger_read_current(struct device *dev, /** * 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 * used for this device to be specified at run time based on the trigger's * name. - **/ + * + * Return: negative error code on failure or length of the buffer + * on success + */ static ssize_t iio_trigger_write_current(struct device *dev, struct device_attribute *attr, const char *buf, -- 1.9.1 -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[toc] | [next] | [standalone]
| From | Jonathan Cameron <jic23@kernel.org> |
|---|---|
| Date | 2015-08-08 13:50 +0200 |
| Message-ID | <pVaNr-65A-13@gated-at.bofh.it> |
| In reply to | #1201673 |
On 06/08/15 12:56, Cristina Opriceana wrote: > 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> Applied to the togreg branch of iio.git Thanks, > --- > Changes in v2: > - Change @dev description in all functions to illustrate better the > connection with IIO devices or IIO trigger. > > drivers/iio/industrialio-trigger.c | 27 ++++++++++++++++++++++++--- > 1 file changed, 24 insertions(+), 3 deletions(-) > > diff --git a/drivers/iio/industrialio-trigger.c b/drivers/iio/industrialio-trigger.c > index d31098e..570606c 100644 > --- a/drivers/iio/industrialio-trigger.c > +++ b/drivers/iio/industrialio-trigger.c > @@ -40,7 +40,14 @@ static DEFINE_MUTEX(iio_trigger_list_lock); > > /** > * 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, > struct device_attribute *attr, > char *buf) > @@ -288,10 +295,17 @@ EXPORT_SYMBOL_GPL(iio_dealloc_pollfunc); > > /** > * 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 > * 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, > struct device_attribute *attr, > char *buf) > @@ -305,11 +319,18 @@ static ssize_t iio_trigger_read_current(struct device *dev, > > /** > * 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 > * used for this device to be specified at run time based on the trigger's > * name. > - **/ > + * > + * Return: negative error code on failure or length of the buffer > + * on success > + */ > static ssize_t iio_trigger_write_current(struct device *dev, > struct device_attribute *attr, > const char *buf, > -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[toc] | [prev] | [standalone]
Back to top | Article view | linux.kernel
csiph-web